import * as outputs from "../types/output"; export declare namespace Adm { interface GetKnowledgebasesFilter { name: string; regex?: boolean; values: string[]; } interface GetKnowledgebasesKnowledgeBaseCollection { /** * List of knowledge base summaries. */ items: outputs.Adm.GetKnowledgebasesKnowledgeBaseCollectionItem[]; } interface GetKnowledgebasesKnowledgeBaseCollectionItem { /** * A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified. */ id: string; /** * A filter to return only Knowledge Bases that match the specified lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The creation date and time of the knowledge base (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeCreated: string; /** * The date and time the knowledge base was last updated (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeUpdated: string; } interface GetRemediationRecipeDetectConfiguration { /** * 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. */ exclusions: string[]; /** * 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. */ maxPermissibleCvssV2score: number; /** * 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. */ maxPermissibleCvssV3score: number; /** * The maximum ADM Severity. A vulnerability with an severity below this value is not considered for remediation. */ maxPermissibleSeverity: string; /** * 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. */ upgradePolicy: string; } interface GetRemediationRecipeNetworkConfiguration { /** * The list of Oracle Cloud Identifiers ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) corresponding to Network Security Groups. */ nsgIds: string[]; /** * The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subnet. */ subnetId: string; } interface GetRemediationRecipeScmConfiguration { /** * The branch used by ADM to patch vulnerabilities. */ branch: string; /** * 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. */ buildFileLocation: string; /** * The type of External Source Code Management. */ externalScmType: string; /** * 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. */ isAutomergeEnabled: boolean; /** * The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Oracle Cloud Infrastructure DevOps repository. */ ociCodeRepositoryId: string; /** * 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. */ patSecretId: string; /** * 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] */ repositoryUrl: string; /** * The type of Source Code Management. */ scmType: string; /** * The username that will be used to authenticate with Jenkins. */ username: string; } interface GetRemediationRecipeVerifyConfiguration { /** * Additional key-value pairs passed as parameters to the build service when running an experiment. */ additionalParameters: { [key: string]: string; }; /** * The type of Build Service. */ buildServiceType: string; /** * The URL that locates the Jenkins pipeline. */ jenkinsUrl: string; /** * The name of the Jenkins pipeline job that identifies the build pipeline. */ jobName: string; /** * 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. */ patSecretId: string; /** * The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the user's DevOps Build Pipeline. */ pipelineId: string; /** * 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] */ repositoryUrl: string; /** * 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. */ triggerSecretId: string; /** * The username that will be used to authenticate with Jenkins. */ username: string; /** * The name of the GitHub Actions workflow that defines the build pipeline. */ workflowName: string; } interface GetRemediationRecipesFilter { name: string; regex?: boolean; values: string[]; } interface GetRemediationRecipesRemediationRecipeCollection { items: outputs.Adm.GetRemediationRecipesRemediationRecipeCollectionItem[]; } interface GetRemediationRecipesRemediationRecipeCollectionItem { /** * A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A configuration to define the constraints when detecting vulnerable dependencies and recommending remediations. */ detectConfigurations: outputs.Adm.GetRemediationRecipesRemediationRecipeCollectionItemDetectConfiguration[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified. */ id: string; /** * Boolean indicating if a run should be automatically triggered once the Knowledge Base contents are updated. */ isRunTriggeredOnKbChange: boolean; /** * The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the knowledge base. */ knowledgeBaseId: string; /** * 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. */ networkConfigurations: outputs.Adm.GetRemediationRecipesRemediationRecipeCollectionItemNetworkConfiguration[]; /** * A configuration for the Source Code Management tool/platform used by a remediation recipe. */ scmConfigurations: outputs.Adm.GetRemediationRecipesRemediationRecipeCollectionItemScmConfiguration[]; /** * A filter to return only Remediation Recipes that match the specified lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The creation date and time of the Remediation Recipe (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeCreated: string; /** * The date and time the Remediation Recipe was last updated (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeUpdated: string; /** * 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. */ verifyConfigurations: outputs.Adm.GetRemediationRecipesRemediationRecipeCollectionItemVerifyConfiguration[]; } interface GetRemediationRecipesRemediationRecipeCollectionItemDetectConfiguration { /** * 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. */ exclusions: string[]; /** * 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. */ maxPermissibleCvssV2score: number; /** * 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. */ maxPermissibleCvssV3score: number; /** * The maximum ADM Severity. A vulnerability with an severity below this value is not considered for remediation. */ maxPermissibleSeverity: string; /** * 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. */ upgradePolicy: string; } interface GetRemediationRecipesRemediationRecipeCollectionItemNetworkConfiguration { /** * The list of Oracle Cloud Identifiers ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) corresponding to Network Security Groups. */ nsgIds: string[]; /** * The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subnet. */ subnetId: string; } interface GetRemediationRecipesRemediationRecipeCollectionItemScmConfiguration { /** * The branch used by ADM to patch vulnerabilities. */ branch: string; /** * 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. */ buildFileLocation: string; /** * The type of External Source Code Management. */ externalScmType: string; /** * 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. */ isAutomergeEnabled: boolean; /** * The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Oracle Cloud Infrastructure DevOps repository. */ ociCodeRepositoryId: string; /** * 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. */ patSecretId: string; /** * 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] */ repositoryUrl: string; /** * The type of Source Code Management. */ scmType: string; /** * The username that will be used to authenticate with Jenkins. */ username: string; } interface GetRemediationRecipesRemediationRecipeCollectionItemVerifyConfiguration { /** * Additional key-value pairs passed as parameters to the build service when running an experiment. */ additionalParameters: { [key: string]: string; }; /** * The type of Build Service. */ buildServiceType: string; /** * The URL that locates the Jenkins pipeline. */ jenkinsUrl: string; /** * The name of the Jenkins pipeline job that identifies the build pipeline. */ jobName: string; /** * 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. */ patSecretId: string; /** * The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the user's DevOps Build Pipeline. */ pipelineId: string; /** * 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] */ repositoryUrl: string; /** * 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. */ triggerSecretId: string; /** * The username that will be used to authenticate with Jenkins. */ username: string; /** * The name of the GitHub Actions workflow that defines the build pipeline. */ workflowName: string; } interface GetRemediationRunApplicationDependencyRecommendationsApplicationDependencyRecommendationCollection { /** * List of application recommendation summaries. */ items: outputs.Adm.GetRemediationRunApplicationDependencyRecommendationsApplicationDependencyRecommendationCollectionItem[]; } interface GetRemediationRunApplicationDependencyRecommendationsApplicationDependencyRecommendationCollectionItem { /** * List of (application dependencies) node identifiers from which this node depends. */ applicationDependencyNodeIds: string[]; /** * A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given. */ gav: string; /** * Unique node identifier of an application dependency with an associated Recommendation, e.g. nodeId1. */ nodeId: string; /** * A filter to return only resources that match the entire purl given. */ purl: string; /** * Recommended application dependency in "group:artifact:version" (GAV) format, e.g. org.graalvm.nativeimage:svm:21.2.0. */ recommendedGav: string; /** * Recommended application dependency in purl format, e.g. pkg:maven/org.graalvm.nativeimage/svm@21.2.0 */ recommendedPurl: string; } interface GetRemediationRunApplicationDependencyRecommendationsFilter { name: string; regex?: boolean; values: string[]; } interface GetRemediationRunStage { /** * Information about the current step within the given stage. */ summary: string; /** * The creation date and time of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeCreated: string; /** * The date and time of the finish of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeFinished: string; /** * The date and time of the start of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeStarted: string; /** * The type of stage. */ type: string; } interface GetRemediationRunStagePipelineProperty { /** * Unique identifier for the pipeline or action created in the Verify stage. */ pipelineIdentifier: string; /** * The web link to the pipeline from the Verify stage. */ pipelineUrl: string; } interface GetRemediationRunStagePullRequestProperty { /** * Unique identifier for the pull or merge request created in the recommend stage. */ pullRequestIdentifier: string; /** * The web link to the pull or merge request created in the recommend stage. */ pullRequestUrl: string; } interface GetRemediationRunStagesFilter { name: string; regex?: boolean; values: string[]; } interface GetRemediationRunStagesRemediationRunStageCollection { items: outputs.Adm.GetRemediationRunStagesRemediationRunStageCollectionItem[]; } interface GetRemediationRunStagesRemediationRunStageCollectionItem { /** * The Oracle Cloud identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the vulnerability audit. */ auditId: string; /** * The next type of stage in the remediation run. */ nextStageType: string; /** * Pipeline properties which result from the run of the verify stage. */ pipelineProperties: outputs.Adm.GetRemediationRunStagesRemediationRunStageCollectionItemPipelineProperty[]; /** * The previous type of stage in the remediation run. */ previousStageType: string; /** * Pull request properties from recommend stage of the remediation run. */ pullRequestProperties: outputs.Adm.GetRemediationRunStagesRemediationRunStageCollectionItemPullRequestProperty[]; /** * Count of recommended application dependencies to update. */ recommendedUpdatesCount: number; /** * Unique Remediation Run identifier path parameter. */ remediationRunId: string; /** * A filter to return only Stages that match the specified status. */ status: string; /** * Information about the current step within the stage. */ summary: string; /** * The creation date and time of the remediation run stage (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeCreated: string; /** * The date and time of the finish of the remediation run stage (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeFinished: string; /** * The date and time of the start of the remediation run stage (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeStarted: string; /** * A filter to return only Stages that match the specified type. */ type: string; } interface GetRemediationRunStagesRemediationRunStageCollectionItemPipelineProperty { /** * Unique identifier for the pipeline or action created in the Verify stage. */ pipelineIdentifier: string; /** * The web link to the pipeline from the Verify stage. */ pipelineUrl: string; } interface GetRemediationRunStagesRemediationRunStageCollectionItemPullRequestProperty { /** * Unique identifier for the pull or merge request created in the recommend stage. */ pullRequestIdentifier: string; /** * The web link to the pull or merge request created in the recommend stage. */ pullRequestUrl: string; } interface GetRemediationRunsFilter { name: string; regex?: boolean; values: string[]; } interface GetRemediationRunsRemediationRunCollection { items: outputs.Adm.GetRemediationRunsRemediationRunCollectionItem[]; } interface GetRemediationRunsRemediationRunCollectionItem { /** * A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified. */ compartmentId: string; /** * The type of the current stage of the remediation run. */ currentStageType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified. */ id: string; /** * A filter to return only resources that match the specified Remediation Recipe identifier. */ remediationRecipeId: string; /** * The source that triggered the Remediation Recipe. */ remediationRunSource: string; /** * The list of remediation run stage summaries. */ stages: outputs.Adm.GetRemediationRunsRemediationRunCollectionItemStage[]; /** * A filter to return only Remediation Runs that match the specified lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The creation date and time of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeCreated: string; /** * The date and time of the finish of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeFinished: string; /** * The date and time of the start of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeStarted: string; /** * The date and time the remediation run was last updated (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeUpdated: string; } interface GetRemediationRunsRemediationRunCollectionItemStage { /** * Information about the current step within the given stage. */ summary: string; /** * The creation date and time of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeCreated: string; /** * The date and time of the finish of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeFinished: string; /** * The date and time of the start of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeStarted: string; /** * The type of stage. */ type: string; } interface GetVulnerabilityAuditApplicationDependency { applicationDependencyNodeIds: string[]; gav: string; nodeId: string; purl: string; } interface GetVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollection { /** * List of vulnerability audit summaries. */ items: outputs.Adm.GetVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItem[]; } interface GetVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItem { /** * List of application dependencies on which this application dependency depends, each identified by its nodeId. */ applicationDependencyNodeIds: string[]; /** * A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given. */ gav: string; /** * Indicates if the artifact is found in the knowledge base, this field is deprecated and will be removed in the future. */ isFoundInKnowledgeBase: boolean; /** * Unique identifier of an application dependency, for example nodeId1. */ nodeId: string; /** * A filter to return only resources that match the entire purl given. */ purl: string; /** * List of vulnerabilities for the application dependency. */ vulnerabilities: outputs.Adm.GetVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerability[]; /** * Potential issues in the artifact identifiers (purls) provided by the user, that the user is alerted about. ADM supports the following warnings: * * MISSING_VERSION: Missing version * * INCORRECT_FORMAT_VERSION: Version can not be parsed according to the ecosystem * * UNKNOWN_ECOSYSTEM: The purl's ecosystem is unknown to ADM * * INCORRECT_FORMAT_EPOCH: Epoch qualifier can not be parsed according to the ecosystem * * MISSING_DISTRO: The distro qualifier is required for the ecosystem, but was not provided in the purl * * UNKNOWN_DISTRO: ADM does not have data for the provided distro value for the given ecosystem * * MISSING_ARCH: The arch qualifier is required for the ecosystem and distro, but was not provided in the purl * * UNKNOWN_ARCH: ADM does not have data for the provided arch value for the given ecosystem and distro * * EPOCH_VALUE_MISMATCH: Epoch value in qualifier is not the same as the epoch value in version * * INVALID_PURL: The provided PURL could not be parsed */ warnings: string[]; } interface GetVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerability { /** * 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. */ cvssV2score: number; /** * 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. */ cvssV3score: number; /** * Unique vulnerability identifier, e.g. CVE-1999-0067. */ id: string; /** * 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 `null`. */ isFalsePositive: boolean; /** * Indicates if the vulnerability was ignored according to the audit configuration. */ isIgnored: boolean; /** * List of artifact version ranges affected by a particular vulnerability. */ matchingVulnerableArtifactVersionRanges: outputs.Adm.GetVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange[]; /** * List of reported metrics by the source. */ metrics: outputs.Adm.GetVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMetric[]; /** * ADM qualitative severity score. Can be either NONE, LOW, MEDIUM, HIGH or CRITICAL. */ severity: string; /** * Source that published the vulnerability */ source: string; } interface GetVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange { /** * The version immediately after the last affected version. Versions up to, but not including this version, are vulnerable. */ versionEndExcluding: string; /** * 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. */ versionEndIncluding: string; /** * 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. */ versionStartExcluding: string; /** * The first version affected by the vulnerability. This version and those following it are considered vulnerable until versionEndExcluding or versionEndIncluding is reached. */ versionStartIncluding: string; } interface GetVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMetric { /** * Numerical representation of metric (if exists). For example for CVSS vectors, the score is the base score according to the CVSS scoring system. */ score: number; /** * Source that published the vulnerability */ source: string; /** * Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity. */ type: string; /** * Value of the vulnerability metric e.g., a string representation of a severity value or a cvss vector. */ value: string; } interface GetVulnerabilityAuditApplicationDependencyVulnerabilitiesFilter { name: string; regex?: boolean; values: string[]; } interface GetVulnerabilityAuditApplicationDependencyVulnerabilityItem { /** * List of Application Dependencies on which this Application Dependency depends, each identified by its nodeId. */ applicationDependencyNodeIds: string[]; /** * A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given. */ gav: string; /** * Indicates if the artifact is found in the knowledge base. */ isFoundInKnowledgeBase: boolean; /** * Unique identifier of an Application Dependency, for example nodeId1. */ nodeId: string; purl: string; /** * List of vulnerabilities for the Application Dependency. */ vulnerabilities: outputs.Adm.GetVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerability[]; } interface GetVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerability { /** * Common Vulnerability Scoring System (CVSS) Version 2. */ cvssV2score: number; /** * Common Vulnerability Scoring System (CVSS) Version 3. */ cvssV3score: number; /** * Unique vulnerability identifier, e.g. CVE-1999-0067. */ id: string; isFalsePositive: boolean; /** * Indicates if the vulnerability was ignored according to the audit configuration. */ isIgnored: boolean; matchingVulnerableArtifactVersionRanges: outputs.Adm.GetVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMatchingVulnerableArtifactVersionRange[]; metrics: outputs.Adm.GetVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMetric[]; severity: string; source: string; } interface GetVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMatchingVulnerableArtifactVersionRange { versionEndExcluding: string; versionEndIncluding: string; versionStartExcluding: string; versionStartIncluding: string; } interface GetVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMetric { score: number; source: string; type: string; value: string; } interface GetVulnerabilityAuditConfiguration { /** * A vulnerable application dependency is ignored if its name matches any of the items in `exclusions`. An asterisk (*) in the dependency pattern acts as a wildcard and matches zero or more characters. */ exclusions: string[]; /** * A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score. */ maxPermissibleCvssV2score: number; /** * A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score. */ maxPermissibleCvssV3score: number; /** * A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleSeverity. */ maxPermissibleSeverity: string; } interface GetVulnerabilityAuditSource { /** * Description of the external resource source. */ description: string; /** * 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. */ ociResourceId: string; /** * Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity. */ type: string; } interface GetVulnerabilityAuditUsageData { /** * The Object Storage bucket to read the usage data from. */ bucket: string; /** * The Object Storage namespace to read the usage data from. */ namespace: string; /** * The Object Storage object name to read the usage data from. */ object: string; /** * The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name. */ sourceType: string; } interface GetVulnerabilityAuditVulnerability { /** * 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. */ cvssV2score: number; /** * 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. */ cvssV3score: number; /** * Unique vulnerability identifier, e.g. CVE-1999-0067. */ id: string; /** * 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 `null`. */ isFalsePositive: boolean; /** * Indicates if the vulnerability was ignored according to the audit configuration. */ isIgnored: boolean; /** * List of artifact version ranges affected by a particular vulnerability. */ matchingVulnerableArtifactVersionRanges: outputs.Adm.GetVulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange[]; /** * List of reported metrics by the source. */ metrics: outputs.Adm.GetVulnerabilityAuditVulnerabilityMetric[]; /** * ADM qualitative severity score. Can be either NONE, LOW, MEDIUM, HIGH or CRITICAL. */ severity: string; /** * Source that published the vulnerability */ source: string; } interface GetVulnerabilityAuditVulnerabilityFilter { name: string; regex?: boolean; values: string[]; } interface GetVulnerabilityAuditVulnerabilityItem { isDirectVulnerability: boolean; metrics: outputs.Adm.GetVulnerabilityAuditVulnerabilityItemMetric[]; references: string[]; relatedVulnerabilities: outputs.Adm.GetVulnerabilityAuditVulnerabilityItemRelatedVulnerability[]; severity: string; source: string; status: string; timeCreated: string; timeUpdated: string; vulnerabilityDescription: string; vulnerabilityId: string; vulnerabilitySummary: string; } interface GetVulnerabilityAuditVulnerabilityItemMetric { score: number; source: string; type: string; value: string; } interface GetVulnerabilityAuditVulnerabilityItemRelatedVulnerability { id: string; source: string; } interface GetVulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange { /** * The version immediately after the last affected version. Versions up to, but not including this version, are vulnerable. */ versionEndExcluding: string; /** * 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. */ versionEndIncluding: string; /** * 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. */ versionStartExcluding: string; /** * The first version affected by the vulnerability. This version and those following it are considered vulnerable until versionEndExcluding or versionEndIncluding is reached. */ versionStartIncluding: string; } interface GetVulnerabilityAuditVulnerabilityMetric { /** * Numerical representation of metric (if exists). For example for CVSS vectors, the score is the base score according to the CVSS scoring system. */ score: number; /** * Source that published the vulnerability */ source: string; /** * Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity. */ type: string; /** * Value of the vulnerability metric e.g., a string representation of a severity value or a cvss vector. */ value: string; } interface GetVulnerabilityAuditsFilter { name: string; regex?: boolean; values: string[]; } interface GetVulnerabilityAuditsVulnerabilityAuditCollection { items: outputs.Adm.GetVulnerabilityAuditsVulnerabilityAuditCollectionItem[]; } interface GetVulnerabilityAuditsVulnerabilityAuditCollectionItem { applicationDependencies: outputs.Adm.GetVulnerabilityAuditsVulnerabilityAuditCollectionItemApplicationDependency[]; /** * 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. */ buildType: string; /** * A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified. */ compartmentId: string; /** * Configuration for a vulnerability audit. A vulnerable application dependency is ignored if its name does match any of the items in `exclusions`, or all of the associated Vulnerabilies have a CVSS v2 score below `maxPermissibleCvssV2Score` and a CVSS v3 score below `maxPermissibleCvssV3Score`. type: object */ configurations: outputs.Adm.GetVulnerabilityAuditsVulnerabilityAuditCollectionItemConfiguration[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified. */ id: string; /** * A filter to return only successful or failed Vulnerability Audits. */ isSuccess: boolean; /** * A filter to return only Audits that were created against the specified knowledge base. */ knowledgeBaseId: string; /** * Details on the lifecycle state. */ lifecycleDetails: string; /** * Maximum Common Vulnerability Scoring System Version 2 score observed for non-ignored vulnerable application dependencies. */ maxObservedCvssV2score: number; /** * Maximum Common Vulnerability Scoring System Version 2 score observed for vulnerable application dependencies including ignored ones. */ maxObservedCvssV2scoreWithIgnored: number; /** * Maximum Common Vulnerability Scoring System Version 3 score observed for non-ignored vulnerable application dependencies. */ maxObservedCvssV3score: number; /** * Maximum Common Vulnerability Scoring System Version 3 score observed for vulnerable application dependencies including ignored ones. */ maxObservedCvssV3scoreWithIgnored: number; /** * Maximum ADM Severity observed for non-ignored vulnerable application dependencies. */ maxObservedSeverity: string; /** * Maximum ADM Severity observed for vulnerable application dependencies including ignored ones. */ maxObservedSeverityWithIgnored: string; /** * Source that published the vulnerability */ sources: outputs.Adm.GetVulnerabilityAuditsVulnerabilityAuditCollectionItemSource[]; /** * A filter to return only Vulnerability Audits that match the specified lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The creation date and time of the vulnerability audit (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeCreated: string; /** * The update date and time of the vulnerability audit (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeUpdated: string; /** * 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. */ usageDatas: outputs.Adm.GetVulnerabilityAuditsVulnerabilityAuditCollectionItemUsageData[]; /** * List of vulnerabilities found in the vulnerability audit. If a vulnerability affects multiple dependencies, the metadata returned here consists of audit-wide aggregates. */ vulnerabilities: outputs.Adm.GetVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerability[]; /** * Count of non-ignored vulnerable application dependencies. */ vulnerableArtifactsCount: number; /** * Count of all vulnerable application dependencies. */ vulnerableArtifactsCountWithIgnored: number; } interface GetVulnerabilityAuditsVulnerabilityAuditCollectionItemApplicationDependency { applicationDependencyNodeIds: string[]; gav: string; nodeId: string; purl: string; } interface GetVulnerabilityAuditsVulnerabilityAuditCollectionItemConfiguration { /** * A vulnerable application dependency is ignored if its name matches any of the items in `exclusions`. An asterisk (*) in the dependency pattern acts as a wildcard and matches zero or more characters. */ exclusions: string[]; /** * A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score. */ maxPermissibleCvssV2score: number; /** * A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score. */ maxPermissibleCvssV3score: number; /** * A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleSeverity. */ maxPermissibleSeverity: string; } interface GetVulnerabilityAuditsVulnerabilityAuditCollectionItemSource { /** * Description of the external resource source. */ description: string; /** * 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. */ ociResourceId: string; /** * Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity. */ type: string; } interface GetVulnerabilityAuditsVulnerabilityAuditCollectionItemUsageData { /** * The Object Storage bucket to read the usage data from. */ bucket: string; /** * The Object Storage namespace to read the usage data from. */ namespace: string; /** * The Object Storage object name to read the usage data from. */ object: string; /** * The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name. */ sourceType: string; } interface GetVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerability { /** * 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. */ cvssV2score: number; /** * 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. */ cvssV3score: number; /** * A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified. */ id: string; /** * 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 `null`. */ isFalsePositive: boolean; /** * Indicates if the vulnerability was ignored according to the audit configuration. */ isIgnored: boolean; /** * List of artifact version ranges affected by a particular vulnerability. */ matchingVulnerableArtifactVersionRanges: outputs.Adm.GetVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange[]; /** * List of reported metrics by the source. */ metrics: outputs.Adm.GetVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMetric[]; /** * ADM qualitative severity score. Can be either NONE, LOW, MEDIUM, HIGH or CRITICAL. */ severity: string; /** * Source that published the vulnerability */ source: string; } interface GetVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange { /** * The version immediately after the last affected version. Versions up to, but not including this version, are vulnerable. */ versionEndExcluding: string; /** * 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. */ versionEndIncluding: string; /** * 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. */ versionStartExcluding: string; /** * The first version affected by the vulnerability. This version and those following it are considered vulnerable until versionEndExcluding or versionEndIncluding is reached. */ versionStartIncluding: string; } interface GetVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMetric { /** * Numerical representation of metric (if exists). For example for CVSS vectors, the score is the base score according to the CVSS scoring system. */ score: number; /** * Source that published the vulnerability */ source: string; /** * Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity. */ type: string; /** * Value of the vulnerability metric e.g., a string representation of a severity value or a cvss vector. */ value: string; } interface RemediationRecipeDetectConfiguration { /** * (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. */ exclusions: string[]; /** * (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. */ maxPermissibleCvssV2score: number; /** * (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. */ maxPermissibleCvssV3score: number; /** * (Updatable) The maximum ADM Severity. A vulnerability with an severity below this value is not considered for remediation. */ maxPermissibleSeverity: string; /** * (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. */ upgradePolicy: string; } interface RemediationRecipeNetworkConfiguration { /** * (Updatable) The list of Oracle Cloud Identifiers ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) corresponding to Network Security Groups. */ nsgIds: string[]; /** * (Updatable) The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subnet. */ subnetId: string; } interface RemediationRecipeScmConfiguration { /** * (Updatable) The branch used by ADM to patch vulnerabilities. */ branch: string; /** * (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. */ buildFileLocation: string; /** * (Updatable) The type of External Source Code Management. */ externalScmType: string; /** * (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. */ isAutomergeEnabled: boolean; /** * (Updatable) The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Oracle Cloud Infrastructure DevOps repository. */ ociCodeRepositoryId: string; /** * (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. */ patSecretId: string; /** * (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] */ repositoryUrl: string; /** * (Updatable) The type of Source Code Management. */ scmType: string; /** * (Updatable) The username for the SCM (to perform operations such as cloning or pushing via HTTP). */ username: string; } interface RemediationRecipeVerifyConfiguration { /** * (Updatable) Additional key-value pairs passed as parameters to the build service when running an experiment. */ additionalParameters: { [key: string]: string; }; /** * (Updatable) The type of Build Service. */ buildServiceType: string; /** * (Updatable) The URL that locates the Jenkins pipeline. */ jenkinsUrl: string; /** * (Updatable) The name of the Jenkins pipeline job that identifies the build pipeline. */ jobName: string; /** * (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. */ patSecretId: string; /** * (Updatable) The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the user's DevOps Build Pipeline. */ pipelineId: string; /** * (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] */ repositoryUrl: string; /** * (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. */ triggerSecretId: string; /** * (Updatable) The username that will be used to authenticate with Jenkins. */ username: string; /** * (Updatable) The name of the GitHub Actions workflow that defines the build pipeline. */ workflowName: string; } interface RemediationRunStage { /** * Information about the current step within the given stage. */ summary: string; /** * The creation date and time of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeCreated: string; /** * The date and time of the finish of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeFinished: string; /** * The date and time of the start of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeStarted: string; /** * The type of stage. */ type: string; } interface VulnerabilityAuditApplicationDependency { /** * List of application dependencies on which this application dependency depends, each identified by its nodeId. */ applicationDependencyNodeIds: string[]; /** * Group Artifact Version (GAV) identifier (Group:Artifact:Version). Example: org.graalvm.nativeimage:svm:21.1.0. "N/A" for non-maven artifacts. */ gav: string; /** * 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.) */ nodeId: string; /** * Package URL identifier, e.g. pkg:maven/org.graalvm.nativeimage/svm@21.1.0 */ purl: string; } interface VulnerabilityAuditConfiguration { /** * A vulnerable application dependency is ignored if its name matches any of the items in `exclusions`. An asterisk (*) in the dependency pattern acts as a wildcard and matches zero or more characters. */ exclusions: string[]; /** * A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score. */ maxPermissibleCvssV2score: number; /** * A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score. */ maxPermissibleCvssV3score: number; /** * A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleSeverity. */ maxPermissibleSeverity: string; } interface VulnerabilityAuditSource { /** * Description of the external resource source. */ description: string; /** * 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. */ ociResourceId: string; /** * Source type of the vulnerability audit. */ type: string; } interface VulnerabilityAuditUsageData { /** * The Object Storage bucket to read the usage data from. */ bucket: string; /** * The Object Storage namespace to read the usage data from. */ namespace: string; /** * The Object Storage object name to read the usage data from. */ object: string; /** * The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ sourceType: string; } interface VulnerabilityAuditVulnerability { /** * 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. */ cvssV2score: number; /** * 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. */ cvssV3score: number; /** * Unique vulnerability identifier, e.g. CVE-1999-0067. */ id: string; /** * 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 `null`. */ isFalsePositive: boolean; /** * Indicates if the vulnerability was ignored according to the audit configuration. */ isIgnored: boolean; /** * List of artifact version ranges affected by a particular vulnerability. */ matchingVulnerableArtifactVersionRanges: outputs.Adm.VulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange[]; /** * List of reported metrics by the source. */ metrics: outputs.Adm.VulnerabilityAuditVulnerabilityMetric[]; /** * ADM qualitative severity score. Can be either NONE, LOW, MEDIUM, HIGH or CRITICAL. */ severity: string; /** * vulnerability audit source. */ source: string; } interface VulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange { /** * The version immediately after the last affected version. Versions up to, but not including this version, are vulnerable. */ versionEndExcluding: string; /** * 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. */ versionEndIncluding: string; /** * 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. */ versionStartExcluding: string; /** * The first version affected by the vulnerability. This version and those following it are considered vulnerable until versionEndExcluding or versionEndIncluding is reached. */ versionStartIncluding: string; } interface VulnerabilityAuditVulnerabilityMetric { /** * Numerical representation of metric (if exists). For example for CVSS vectors, the score is the base score according to the CVSS scoring system. */ score: number; /** * vulnerability audit source. */ source: string; /** * Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity. */ type: string; /** * Value of the vulnerability metric e.g., a string representation of a severity value or a cvss vector. */ value: string; } } export declare namespace AiDocument { interface GetModelComponentModel { /** * A unique model identifier. */ modelId: string; } interface GetModelLock { /** * The lock compartment ID. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * When the model was created, as an RFC3339 datetime string. */ timeCreated: string; /** * Lock type. */ type: string; } interface GetModelMetric { /** * Summary of count of samples used during model training. */ datasetSummaries: outputs.AiDocument.GetModelMetricDatasetSummary[]; /** * List of metrics entries per label. */ labelMetricsReports: outputs.AiDocument.GetModelMetricLabelMetricsReport[]; /** * The type of the Document model. */ modelType: string; /** * Overall Metrics report for Document Classification Model. */ overallMetricsReports: outputs.AiDocument.GetModelMetricOverallMetricsReport[]; } interface GetModelMetricDatasetSummary { /** * Number of samples used for testing the model. */ testSampleCount: number; /** * Number of samples used for training the model. */ trainingSampleCount: number; /** * Number of samples used for validating the model. */ validationSampleCount: number; } interface GetModelMetricLabelMetricsReport { /** * List of document classification confidence report. */ confidenceEntries: outputs.AiDocument.GetModelMetricLabelMetricsReportConfidenceEntry[]; /** * Total test documents in the label. */ documentCount: number; /** * Label name */ label: string; /** * Mean average precision under different thresholds */ meanAveragePrecision: number; } interface GetModelMetricLabelMetricsReportConfidenceEntry { /** * accuracy under the threshold */ accuracy: number; /** * f1Score under the threshold */ f1score: number; /** * Precision under the threshold */ precision: number; /** * Recall under the threshold */ recall: number; /** * Threshold used to calculate precision and recall. */ threshold: number; } interface GetModelMetricOverallMetricsReport { /** * List of document classification confidence report. */ confidenceEntries: outputs.AiDocument.GetModelMetricOverallMetricsReportConfidenceEntry[]; /** * Total test documents in the label. */ documentCount: number; /** * Mean average precision under different thresholds */ meanAveragePrecision: number; } interface GetModelMetricOverallMetricsReportConfidenceEntry { /** * accuracy under the threshold */ accuracy: number; /** * f1Score under the threshold */ f1score: number; /** * Precision under the threshold */ precision: number; /** * Recall under the threshold */ recall: number; /** * Threshold used to calculate precision and recall. */ threshold: number; } interface GetModelModelSubType { /** * The model sub type for PRE_TRAINED_KEY_VALUE_EXTRACTION The allowed values are: * * `RECEIPT` * * `INVOICE` * * `PASSPORT` * * `DRIVER_LICENSE` * * `HEALTH_INSURANCE_ID` */ modelSubType: string; /** * The type of the Document model. */ modelType: string; } interface GetModelTestingDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; /** * The namespace name of the Object Storage bucket that contains the input data file. */ namespace: string; /** * The object name of the input data file. */ object: string; } interface GetModelTrainingDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; /** * The namespace name of the Object Storage bucket that contains the input data file. */ namespace: string; /** * The object name of the input data file. */ object: string; } interface GetModelValidationDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; /** * The namespace name of the Object Storage bucket that contains the input data file. */ namespace: string; /** * The object name of the input data file. */ object: string; } interface GetModelsFilter { name: string; regex?: boolean; values: string[]; } interface GetModelsModelCollection { items: outputs.AiDocument.GetModelsModelCollectionItem[]; } interface GetModelsModelCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * 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. */ componentModels: outputs.AiDocument.GetModelsModelCollectionItemComponentModel[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * An optional description of the model. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The filter to find the model with the given identifier. */ id: string; /** * Number of replicas required for this model. */ inferenceUnits: number; /** * Set to true when the model is created by using multiple key value extraction models. */ isComposedModel: boolean; /** * 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. */ isQuickMode: boolean; /** * The collection of labels used to train the custom model. */ labels: string[]; /** * The document language for model training, abbreviated according to the BCP 47 syntax. */ language: string; /** * A message describing the current state in more detail, that can provide actionable information if training failed. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.AiDocument.GetModelsModelCollectionItemLock[]; /** * The maximum model training time in hours, expressed as a decimal fraction. */ maxTrainingTimeInHours: number; /** * Trained Model Metrics. */ metrics: outputs.AiDocument.GetModelsModelCollectionItemMetric[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of active custom Key Value model that need to be composed. */ modelId: string; /** * The model sub type for PRE_TRAINED_KEY_VALUE_EXTRACTION The allowed values are: * * `RECEIPT` * * `INVOICE` * * `PASSPORT` * * `DRIVER_LICENSE` * * `HEALTH_INSURANCE_ID` */ modelSubTypes: outputs.AiDocument.GetModelsModelCollectionItemModelSubType[]; /** * The type of the Document model. */ modelType: string; /** * The version of the model. */ modelVersion: string; /** * The ID of the project for which to list the objects. */ projectId: string; /** * The filter to match models with the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` */ systemTags: { [key: string]: string; }; /** * The tenancy id of the model. */ tenancyId: string; /** * The base entity which is the input for creating and training a model. */ testingDatasets: outputs.AiDocument.GetModelsModelCollectionItemTestingDataset[]; /** * When the model was created, as an RFC3339 datetime string. */ timeCreated: string; /** * When the model was updated, as an RFC3339 datetime string. */ timeUpdated: string; /** * The total hours actually used for model training. */ trainedTimeInHours: number; /** * The base entity which is the input for creating and training a model. */ trainingDatasets: outputs.AiDocument.GetModelsModelCollectionItemTrainingDataset[]; /** * The base entity which is the input for creating and training a model. */ validationDatasets: outputs.AiDocument.GetModelsModelCollectionItemValidationDataset[]; } interface GetModelsModelCollectionItemComponentModel { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of active custom Key Value model that need to be composed. */ modelId: string; } interface GetModelsModelCollectionItemLock { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * When the model was created, as an RFC3339 datetime string. */ timeCreated: string; /** * Lock type. */ type: string; } interface GetModelsModelCollectionItemMetric { /** * Summary of count of samples used during model training. */ datasetSummaries: outputs.AiDocument.GetModelsModelCollectionItemMetricDatasetSummary[]; /** * List of metrics entries per label. */ labelMetricsReports: outputs.AiDocument.GetModelsModelCollectionItemMetricLabelMetricsReport[]; /** * The type of the Document model. */ modelType: string; /** * Overall Metrics report for Document Classification Model. */ overallMetricsReports: outputs.AiDocument.GetModelsModelCollectionItemMetricOverallMetricsReport[]; } interface GetModelsModelCollectionItemMetricDatasetSummary { /** * Number of samples used for testing the model. */ testSampleCount: number; /** * Number of samples used for training the model. */ trainingSampleCount: number; /** * Number of samples used for validating the model. */ validationSampleCount: number; } interface GetModelsModelCollectionItemMetricLabelMetricsReport { /** * List of document classification confidence report. */ confidenceEntries: outputs.AiDocument.GetModelsModelCollectionItemMetricLabelMetricsReportConfidenceEntry[]; /** * Total test documents in the label. */ documentCount: number; /** * Label name */ label: string; /** * Mean average precision under different thresholds */ meanAveragePrecision: number; } interface GetModelsModelCollectionItemMetricLabelMetricsReportConfidenceEntry { /** * accuracy under the threshold */ accuracy: number; /** * f1Score under the threshold */ f1score: number; /** * Precision under the threshold */ precision: number; /** * Recall under the threshold */ recall: number; /** * Threshold used to calculate precision and recall. */ threshold: number; } interface GetModelsModelCollectionItemMetricOverallMetricsReport { /** * List of document classification confidence report. */ confidenceEntries: outputs.AiDocument.GetModelsModelCollectionItemMetricOverallMetricsReportConfidenceEntry[]; /** * Total test documents in the label. */ documentCount: number; /** * Mean average precision under different thresholds */ meanAveragePrecision: number; } interface GetModelsModelCollectionItemMetricOverallMetricsReportConfidenceEntry { /** * accuracy under the threshold */ accuracy: number; /** * f1Score under the threshold */ f1score: number; /** * Precision under the threshold */ precision: number; /** * Recall under the threshold */ recall: number; /** * Threshold used to calculate precision and recall. */ threshold: number; } interface GetModelsModelCollectionItemModelSubType { /** * The model sub type for PRE_TRAINED_KEY_VALUE_EXTRACTION The allowed values are: * * `RECEIPT` * * `INVOICE` * * `PASSPORT` * * `DRIVER_LICENSE` * * `HEALTH_INSURANCE_ID` */ modelSubType: string; /** * The type of the Document model. */ modelType: string; } interface GetModelsModelCollectionItemTestingDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; /** * The namespace name of the Object Storage bucket that contains the input data file. */ namespace: string; /** * The object name of the input data file. */ object: string; } interface GetModelsModelCollectionItemTrainingDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; /** * The namespace name of the Object Storage bucket that contains the input data file. */ namespace: string; /** * The object name of the input data file. */ object: string; } interface GetModelsModelCollectionItemValidationDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; /** * The namespace name of the Object Storage bucket that contains the input data file. */ namespace: string; /** * The object name of the input data file. */ object: string; } interface GetProcessorJobInputLocation { /** * Raw document data with Base64 encoding. */ data: string; /** * The list of ObjectLocations. */ objectLocations: outputs.AiDocument.GetProcessorJobInputLocationObjectLocation[]; /** * The page ranges to be analysed. */ pageRanges: string[]; /** * The type of input location. The allowed values are: * * `OBJECT_STORAGE_LOCATIONS`: A list of object locations in Object Storage. * * `INLINE_DOCUMENT_CONTENT`: The content of an inline document. */ sourceType: string; } interface GetProcessorJobInputLocationObjectLocation { /** * The Object Storage bucket name. */ bucket: string; /** * The Object Storage namespace. */ namespace: string; /** * The Object Storage object name. */ object: string; /** * The page ranges to be analysed. */ pageRanges: string[]; } interface GetProcessorJobOutputLocation { /** * The Object Storage bucket name. */ bucket: string; /** * The Object Storage namespace. */ namespace: string; /** * The Object Storage folder name. */ prefix: string; } interface GetProcessorJobProcessorConfig { /** * The document type. */ documentType: string; /** * The types of document analysis requested. */ features: outputs.AiDocument.GetProcessorJobProcessorConfigFeature[]; /** * Whether or not to generate a ZIP file containing the results. */ isZipOutputEnabled: boolean; /** * The document language, abbreviated according to the BCP 47 Language-Tag syntax. */ language: string; /** * Unique identifier custom model OCID that should be used for inference. */ modelId: string; /** * A string-to-object map where the key is the normalization field and the object contains information about the field. */ normalizationFields: outputs.AiDocument.GetProcessorJobProcessorConfigNormalizationField[]; /** * The type of the processor. */ processorType: string; } interface GetProcessorJobProcessorConfigFeature { /** * The type of document analysis requested. The allowed values are: * * `LANGUAGE_CLASSIFICATION`: Detect the language. * * `TEXT_EXTRACTION`: Recognize text. * * `TABLE_EXTRACTION`: Detect and extract data in tables. * * `KEY_VALUE_EXTRACTION`: Extract form fields. * * `DOCUMENT_CLASSIFICATION`: Identify the type of document. * * `DOCUMENT_ELEMENTS_EXTRACTION`: Extract information from bar code */ featureType: string; /** * Whether or not to generate a searchable PDF file. */ generateSearchablePdf: boolean; /** * The maximum number of results to return. */ maxResults: number; /** * Unique identifier custom model OCID that should be used for inference. */ modelId: string; /** * Whether checkbox detection feature is enabled or disabled. */ selectionMarkDetection: boolean; /** * The custom model tenancy ID when modelId represents aliasName. */ tenancyId: string; } interface GetProcessorJobProcessorConfigNormalizationField { /** * A wrapped map. */ maps: outputs.AiDocument.GetProcessorJobProcessorConfigNormalizationFieldMap[]; } interface GetProcessorJobProcessorConfigNormalizationFieldMap { /** * A string mapping to the normalization type. */ normalizationType: string; } interface GetProjectLock { /** * The lock compartment ID. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * When the project was created, as an RFC3339 datetime string. */ timeCreated: string; /** * Lock type. */ type: string; } interface GetProjectsFilter { name: string; regex?: boolean; values: string[]; } interface GetProjectsProjectCollection { items: outputs.AiDocument.GetProjectsProjectCollectionItem[]; } interface GetProjectsProjectCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * An optional description of the project. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The filter to find the project with the given identifier. */ id: string; /** * A message describing the current state in more detail, that can provide actionable information if creation failed. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.AiDocument.GetProjectsProjectCollectionItemLock[]; /** * The filter to match projects with the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` */ systemTags: { [key: string]: string; }; /** * When the project was created, as an RFC3339 datetime string. */ timeCreated: string; /** * When the project was updated, as an RFC3339 datetime string. */ timeUpdated: string; } interface GetProjectsProjectCollectionItemLock { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * When the project was created, as an RFC3339 datetime string. */ timeCreated: string; /** * Lock type. */ type: string; } interface ModelComponentModel { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of active custom Key Value model that need to be composed. */ modelId: string; } interface ModelLock { /** * (Updatable) The compartment identifier. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * When the model was created, as an RFC3339 datetime string. */ timeCreated: string; /** * Lock type. */ type: string; } interface ModelMetric { /** * Summary of count of samples used during model training. */ datasetSummaries: outputs.AiDocument.ModelMetricDatasetSummary[]; /** * List of metrics entries per label. */ labelMetricsReports: outputs.AiDocument.ModelMetricLabelMetricsReport[]; /** * The type of the Document model. */ modelType: string; /** * Overall Metrics report for Document Classification Model. */ overallMetricsReports: outputs.AiDocument.ModelMetricOverallMetricsReport[]; } interface ModelMetricDatasetSummary { /** * Number of samples used for testing the model. */ testSampleCount: number; /** * Number of samples used for training the model. */ trainingSampleCount: number; /** * Number of samples used for validating the model. */ validationSampleCount: number; } interface ModelMetricLabelMetricsReport { /** * List of document classification confidence report. */ confidenceEntries: outputs.AiDocument.ModelMetricLabelMetricsReportConfidenceEntry[]; /** * Total test documents in the label. */ documentCount: number; /** * Label name */ label: string; /** * Mean average precision under different thresholds */ meanAveragePrecision: number; } interface ModelMetricLabelMetricsReportConfidenceEntry { /** * accuracy under the threshold */ accuracy: number; /** * f1Score under the threshold */ f1score: number; /** * Precision under the threshold */ precision: number; /** * Recall under the threshold */ recall: number; /** * Threshold used to calculate precision and recall. */ threshold: number; } interface ModelMetricOverallMetricsReport { /** * List of document classification confidence report. */ confidenceEntries: outputs.AiDocument.ModelMetricOverallMetricsReportConfidenceEntry[]; /** * Total test documents in the label. */ documentCount: number; /** * Mean average precision under different thresholds */ meanAveragePrecision: number; } interface ModelMetricOverallMetricsReportConfidenceEntry { /** * accuracy under the threshold */ accuracy: number; /** * f1Score under the threshold */ f1score: number; /** * Precision under the threshold */ precision: number; /** * Recall under the threshold */ recall: number; /** * Threshold used to calculate precision and recall. */ threshold: number; } interface ModelModelSubType { /** * The model sub type for PRE_TRAINED_KEY_VALUE_EXTRACTION The allowed values are: * * `RECEIPT` * * `INVOICE` * * `PASSPORT` * * `DRIVER_LICENSE` * * `HEALTH_INSURANCE_ID` */ modelSubType: string; /** * Sub type model based on the model type. The allowed values are: * * `PRE_TRAINED_KEY_VALUE_EXTRACTION` * * `PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION` */ modelType: string; } interface ModelTestingDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; /** * The namespace name of the Object Storage bucket that contains the input data file. */ namespace: string; /** * The object name of the input data file. */ object: string; } interface ModelTrainingDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; /** * The namespace name of the Object Storage bucket that contains the input data file. */ namespace: string; /** * The object name of the input data file. */ object: string; } interface ModelValidationDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; /** * The namespace name of the Object Storage bucket that contains the input data file. */ namespace: string; /** * The object name of the input data file. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ object: string; } interface ProcessorJobInputLocation { /** * Raw document data with Base64 encoding. */ data: string; /** * The list of ObjectLocations. */ objectLocations: outputs.AiDocument.ProcessorJobInputLocationObjectLocation[]; /** * The page ranges to be analysed. */ pageRanges: string[]; /** * The type of input location. The allowed values are: * * `OBJECT_STORAGE_LOCATIONS`: A list of object locations in Object Storage. * * `INLINE_DOCUMENT_CONTENT`: The content of an inline document. */ sourceType: string; } interface ProcessorJobInputLocationObjectLocation { /** * The Object Storage bucket name. */ bucket: string; /** * The Object Storage namespace name. */ namespace: string; /** * The Object Storage object name. */ object: string; /** * The page ranges to be analysed. */ pageRanges: string[]; } interface ProcessorJobOutputLocation { /** * The Object Storage bucket name. */ bucket: string; /** * The Object Storage namespace. */ namespace: string; /** * The Object Storage folder name. */ prefix: string; } interface ProcessorJobProcessorConfig { /** * The document type. */ documentType: string; /** * The types of document analysis requested. */ features: outputs.AiDocument.ProcessorJobProcessorConfigFeature[]; /** * Whether or not to generate a ZIP file containing the results. */ isZipOutputEnabled: boolean; /** * The document language, abbreviated according to the BCP 47 Language-Tag syntax. */ language: string; /** * Unique identifier custom model OCID that should be used for inference. */ modelId: string; /** * A string-to-object map where the key is the normalization field and the object contains information about the field. */ normalizationFields?: outputs.AiDocument.ProcessorJobProcessorConfigNormalizationField[]; /** * The type of the processor. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ processorType: string; } interface ProcessorJobProcessorConfigFeature { /** * The type of document analysis requested. The allowed values are: * * `LANGUAGE_CLASSIFICATION`: Detect the language. * * `TEXT_EXTRACTION`: Recognize text. * * `TABLE_EXTRACTION`: Detect and extract data in tables. * * `KEY_VALUE_EXTRACTION`: Extract form fields. * * `DOCUMENT_CLASSIFICATION`: Identify the type of document. * * `DOCUMENT_ELEMENTS_EXTRACTION`: Extract information from bar code */ featureType: string; /** * Whether or not to generate a searchable PDF file. */ generateSearchablePdf: boolean; /** * The maximum number of results to return. */ maxResults: number; /** * Unique identifier custom model OCID that should be used for inference. */ modelId: string; /** * Whether checkbox detection feature is enabled or disabled. */ selectionMarkDetection: boolean; /** * The custom model tenancy ID when modelId represents aliasName. */ tenancyId: string; } interface ProcessorJobProcessorConfigNormalizationField { /** * A wrapped map. */ maps: outputs.AiDocument.ProcessorJobProcessorConfigNormalizationFieldMap[]; } interface ProcessorJobProcessorConfigNormalizationFieldMap { /** * A string mapping to the normalization type. */ normalizationType: string; } interface ProjectLock { /** * (Updatable) The compartment identifier. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * When the project was created, as an RFC3339 datetime string. */ timeCreated: string; /** * Lock type. */ type: string; } } export declare namespace AiLanguage { interface GetEndpointsEndpointCollection { items: outputs.AiLanguage.GetEndpointsEndpointCollectionItem[]; } interface GetEndpointsEndpointCollectionItem { /** * Unique name across user tenancy in a region to identify an endpoint to be used for inferencing. */ alias: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A short description of the endpoint. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier endpoint OCID of an endpoint that is immutable on creation. */ id: string; /** * Number of replicas required for this endpoint. */ inferenceUnits: number; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state. */ lifecycleDetails: string; /** * The ID of the trained model for which to list the endpoints. */ modelId: string; /** * The ID of the project for which to list the objects. */ projectId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the endpoint was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the endpoint was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetJobInputConfiguration { /** * model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails} */ configuration: { [key: string]: { [key: string]: string; }; }; /** * Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list */ documentTypes: string[]; } interface GetJobInputLocation { /** * Object Storage bucket name. */ bucket: string; /** * locationType */ locationType: string; /** * Object Storage namespace name. */ namespace: string; /** * List of objects to be processed */ objectNames: string[]; } interface GetJobModelMetadataDetail { /** * model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails} */ configuration: { [key: string]: { [key: string]: string; }; }; /** * Unique identifier endpoint OCID that should be used for inference */ endpointId: string; /** * Language code supported * * auto : Automatically detect language * * ar : Arabic * * pt-BR : Brazilian Portuguese * * cs : Czech * * da : Danish * * nl : Dutch * * en : English * * fi : Finnish * * fr : French * * fr-CA : Canadian French * * de : German * * it : Italian * * ja : Japanese * * ko : Korean * * no : Norwegian * * pl : Polish * * ro : Romanian * * zh-CN : Simplified Chinese * * es : Spanish * * sv : Swedish * * zh-TW : Traditional Chinese * * tr : Turkish * * el : Greek * * he : Hebrew */ languageCode: string; /** * Unique identifier model OCID that should be used for inference */ modelId: string; /** * model type to used for inference allowed values are * * LANGUAGE_SENTIMENT_ANALYSIS * * LANGUAGE_DETECTION * * TEXT_CLASSIFICATION * * NAMED_ENTITY_RECOGNITION * * KEY_PHRASE_EXTRACTION * * LANGUAGE_PII_ENTITIES * * LANGUAGE_TRANSLATION */ modelType: string; } interface GetJobOutputLocation { /** * Object Storage bucket name. */ bucket: string; /** * Object Storage namespace name. */ namespace: string; /** * The prefix (directory) in an Object Storage bucket. */ prefix: string; } interface GetJobsFilter { name: string; regex?: boolean; values: string[]; } interface GetJobsJobCollection { items: outputs.AiLanguage.GetJobsJobCollectionItem[]; } interface GetJobsJobCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files. */ completedDocuments: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job. */ createdBy: string; /** * A short description of the job. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files. */ failedDocuments: number; /** * Unique identifier(OCID). */ id: string; /** * input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types */ inputConfigurations: outputs.AiLanguage.GetJobsJobCollectionItemInputConfiguration[]; /** * 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 */ inputLocations: outputs.AiLanguage.GetJobsJobCollectionItemInputLocation[]; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * 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 */ modelMetadataDetails: outputs.AiLanguage.GetJobsJobCollectionItemModelMetadataDetail[]; /** * Object storage output location to write inference results */ outputLocations: outputs.AiLanguage.GetJobsJobCollectionItemOutputLocation[]; /** * Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files. */ pendingDocuments: number; /** * How much progress the operation has made, vs the total amount of work that must be performed. */ percentComplete: number; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * Job accepted time. */ timeAccepted: string; /** * Job finished time. */ timeCompleted: string; /** * Job started time. */ timeStarted: string; /** * Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files. */ totalDocuments: number; /** * Time to live duration in days for Job. Job will be available till max 90 days. */ ttlInDays: number; /** * warnings count */ warningsCount: number; } interface GetJobsJobCollectionItemInputConfiguration { /** * model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails} */ configuration: { [key: string]: { [key: string]: string; }; }; /** * Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list */ documentTypes: string[]; } interface GetJobsJobCollectionItemInputLocation { /** * Object Storage bucket name. */ bucket: string; /** * locationType */ locationType: string; /** * Object Storage namespace name. */ namespace: string; /** * List of objects to be processed */ objectNames: string[]; } interface GetJobsJobCollectionItemModelMetadataDetail { /** * model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails} */ configuration: { [key: string]: { [key: string]: string; }; }; /** * Unique identifier endpoint OCID that should be used for inference */ endpointId: string; /** * Language code supported * * auto : Automatically detect language * * ar : Arabic * * pt-BR : Brazilian Portuguese * * cs : Czech * * da : Danish * * nl : Dutch * * en : English * * fi : Finnish * * fr : French * * fr-CA : Canadian French * * de : German * * it : Italian * * ja : Japanese * * ko : Korean * * no : Norwegian * * pl : Polish * * ro : Romanian * * zh-CN : Simplified Chinese * * es : Spanish * * sv : Swedish * * zh-TW : Traditional Chinese * * tr : Turkish * * el : Greek * * he : Hebrew */ languageCode: string; /** * Unique identifier model OCID that should be used for inference */ modelId: string; /** * model type to used for inference allowed values are * * LANGUAGE_SENTIMENT_ANALYSIS * * LANGUAGE_DETECTION * * TEXT_CLASSIFICATION * * NAMED_ENTITY_RECOGNITION * * KEY_PHRASE_EXTRACTION * * LANGUAGE_PII_ENTITIES * * LANGUAGE_TRANSLATION */ modelType: string; } interface GetJobsJobCollectionItemOutputLocation { /** * Object Storage bucket name. */ bucket: string; /** * Object Storage namespace name. */ namespace: string; /** * The prefix (directory) in an Object Storage bucket. */ prefix: string; } interface GetModelEvaluationResult { /** * List of text classification metrics */ classMetrics: outputs.AiLanguage.GetModelEvaluationResultClassMetric[]; /** * class level confusion matrix */ confusionMatrix: string; /** * List of entity metrics */ entityMetrics: outputs.AiLanguage.GetModelEvaluationResultEntityMetric[]; /** * labels */ labels: string[]; /** * Model level named entity recognition metrics */ metrics: outputs.AiLanguage.GetModelEvaluationResultMetric[]; /** * Model type */ modelType: string; } interface GetModelEvaluationResultClassMetric { /** * F1-score, is a measure of a model’s accuracy on a dataset */ f1: number; /** * Entity label */ label: string; /** * 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) */ precision: number; /** * 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. */ recall: number; /** * number of samples in the test set */ support: number; } interface GetModelEvaluationResultEntityMetric { /** * F1-score, is a measure of a model’s accuracy on a dataset */ f1: number; /** * Entity label */ label: string; /** * 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) */ precision: number; /** * 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. */ recall: number; } interface GetModelEvaluationResultMetric { /** * The fraction of the labels that were correctly recognised . */ accuracy: number; /** * F1-score, is a measure of a model’s accuracy on a dataset */ macroF1: number; /** * 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) */ macroPrecision: number; /** * 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. */ macroRecall: number; /** * F1-score, is a measure of a model’s accuracy on a dataset */ microF1: number; /** * 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) */ microPrecision: number; /** * 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. */ microRecall: number; /** * F1-score, is a measure of a model’s accuracy on a dataset */ weightedF1: number; /** * 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) */ weightedPrecision: number; /** * 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. */ weightedRecall: number; } interface GetModelEvaluationResultsEvaluationResultCollection { /** * List of model evaluation analysis */ items: outputs.AiLanguage.GetModelEvaluationResultsEvaluationResultCollectionItem[]; } interface GetModelEvaluationResultsEvaluationResultCollectionItem { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * For CSV format location is rowId(1 is header) and for JSONL location is jsonL line sequence(1 is metadata) */ location: string; /** * Model type */ modelType: string; /** * List of true(actual) entities in test data for NER model */ predictedEntities: outputs.AiLanguage.GetModelEvaluationResultsEvaluationResultCollectionItemPredictedEntity[]; /** * List of predicted labels by custom multi class or multi label TextClassification model */ predictedLabels: string[]; /** * For CSV format location is rowId(1 is header) and for JSONL location is jsonL line sequence(1 is metadata) */ record: string; /** * List of true(actual) entities in test data for NER model */ trueEntities: outputs.AiLanguage.GetModelEvaluationResultsEvaluationResultCollectionItemTrueEntity[]; /** * List of true(actual) labels in test data for multi class or multi label TextClassification */ trueLabels: string[]; } interface GetModelEvaluationResultsEvaluationResultCollectionItemPredictedEntity { /** * Length of text */ length: number; /** * Starting index on text. */ offset: number; /** * Type of entity text like PER, LOC, GPE, NOPE etc. */ type: string; } interface GetModelEvaluationResultsEvaluationResultCollectionItemTrueEntity { /** * Length of text */ length: number; /** * Starting index on text. */ offset: number; /** * Type of entity text like PER, LOC, GPE, NOPE etc. */ type: string; } interface GetModelEvaluationResultsFilter { name: string; regex?: boolean; values: string[]; } interface GetModelModelDetail { /** * classification Modes */ classificationModes: outputs.AiLanguage.GetModelModelDetailClassificationMode[]; /** * supported language default value is en */ languageCode: string; /** * Model type */ modelType: string; /** * 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 <>::<>_<>::<> ex: ai-lang::NER_V1::CUSTOM-V0 */ version: string; } interface GetModelModelDetailClassificationMode { /** * classification Modes */ classificationMode: string; /** * 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 <>::<>_<>::<> ex: ai-lang::NER_V1::CUSTOM-V0 */ version: string; } interface GetModelTestStrategy { /** * This information will define the test strategy different datasets for test and validation(optional) dataset. */ strategyType: string; /** * Possible data set type */ testingDatasets: outputs.AiLanguage.GetModelTestStrategyTestingDataset[]; /** * Possible data set type */ validationDatasets: outputs.AiLanguage.GetModelTestStrategyValidationDataset[]; } interface GetModelTestStrategyTestingDataset { /** * Data Science Labelling Service OCID */ datasetId: string; /** * Possible data sets */ datasetType: string; /** * Possible object storage location types */ locationDetails: outputs.AiLanguage.GetModelTestStrategyTestingDatasetLocationDetail[]; } interface GetModelTestStrategyTestingDatasetLocationDetail { /** * Object storage bucket name */ bucket: string; /** * Possible object storage location types */ locationType: string; /** * Object storage namespace */ namespace: string; /** * Array of files which need to be processed in the bucket */ objectNames: string[]; } interface GetModelTestStrategyValidationDataset { /** * Data Science Labelling Service OCID */ datasetId: string; /** * Possible data sets */ datasetType: string; /** * Possible object storage location types */ locationDetails: outputs.AiLanguage.GetModelTestStrategyValidationDatasetLocationDetail[]; } interface GetModelTestStrategyValidationDatasetLocationDetail { /** * Object storage bucket name */ bucket: string; /** * Possible object storage location types */ locationType: string; /** * Object storage namespace */ namespace: string; /** * Array of files which need to be processed in the bucket */ objectNames: string[]; } interface GetModelTrainingDataset { /** * Data Science Labelling Service OCID */ datasetId: string; /** * Possible data sets */ datasetType: string; /** * Possible object storage location types */ locationDetails: outputs.AiLanguage.GetModelTrainingDatasetLocationDetail[]; } interface GetModelTrainingDatasetLocationDetail { /** * Object storage bucket name */ bucket: string; /** * Possible object storage location types */ locationType: string; /** * Object storage namespace */ namespace: string; /** * Array of files which need to be processed in the bucket */ objectNames: string[]; } interface GetModelsFilter { name: string; regex?: boolean; values: string[]; } interface GetModelsModelCollection { items: outputs.AiLanguage.GetModelsModelCollectionItem[]; } interface GetModelsModelCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A short description of the Model. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * model training results of different models */ evaluationResults: outputs.AiLanguage.GetModelsModelCollectionItemEvaluationResult[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier model OCID of a model that is immutable on creation */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state. */ lifecycleDetails: string; /** * Possible model types */ modelDetails: outputs.AiLanguage.GetModelsModelCollectionItemModelDetail[]; /** * The ID of the project for which to list the objects. */ projectId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Possible strategy as testing and validation(optional) dataset. */ testStrategies: outputs.AiLanguage.GetModelsModelCollectionItemTestStrategy[]; /** * The time the the model was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the model was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Possible data set type */ trainingDatasets: outputs.AiLanguage.GetModelsModelCollectionItemTrainingDataset[]; /** * 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 <>::<>_<>::<> ex: ai-lang::NER_V1::CUSTOM-V0 */ version: string; } interface GetModelsModelCollectionItemEvaluationResult { /** * List of text classification metrics */ classMetrics: outputs.AiLanguage.GetModelsModelCollectionItemEvaluationResultClassMetric[]; /** * class level confusion matrix */ confusionMatrix: string; /** * List of entity metrics */ entityMetrics: outputs.AiLanguage.GetModelsModelCollectionItemEvaluationResultEntityMetric[]; /** * labels */ labels: string[]; /** * Model level named entity recognition metrics */ metrics: outputs.AiLanguage.GetModelsModelCollectionItemEvaluationResultMetric[]; /** * Model type */ modelType: string; } interface GetModelsModelCollectionItemEvaluationResultClassMetric { /** * F1-score, is a measure of a model’s accuracy on a dataset */ f1: number; /** * Entity label */ label: string; /** * 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) */ precision: number; /** * 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. */ recall: number; /** * number of samples in the test set */ support: number; } interface GetModelsModelCollectionItemEvaluationResultEntityMetric { /** * F1-score, is a measure of a model’s accuracy on a dataset */ f1: number; /** * Entity label */ label: string; /** * 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) */ precision: number; /** * 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. */ recall: number; } interface GetModelsModelCollectionItemEvaluationResultMetric { /** * The fraction of the labels that were correctly recognised . */ accuracy: number; /** * F1-score, is a measure of a model’s accuracy on a dataset */ macroF1: number; /** * 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) */ macroPrecision: number; /** * 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. */ macroRecall: number; /** * F1-score, is a measure of a model’s accuracy on a dataset */ microF1: number; /** * 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) */ microPrecision: number; /** * 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. */ microRecall: number; /** * F1-score, is a measure of a model’s accuracy on a dataset */ weightedF1: number; /** * 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) */ weightedPrecision: number; /** * 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. */ weightedRecall: number; } interface GetModelsModelCollectionItemModelDetail { /** * classification Modes */ classificationModes: outputs.AiLanguage.GetModelsModelCollectionItemModelDetailClassificationMode[]; /** * supported language default value is en */ languageCode: string; /** * Model type */ modelType: string; /** * 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 <>::<>_<>::<> ex: ai-lang::NER_V1::CUSTOM-V0 */ version: string; } interface GetModelsModelCollectionItemModelDetailClassificationMode { /** * classification Modes */ classificationMode: string; /** * 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 <>::<>_<>::<> ex: ai-lang::NER_V1::CUSTOM-V0 */ version: string; } interface GetModelsModelCollectionItemTestStrategy { /** * This information will define the test strategy different datasets for test and validation(optional) dataset. */ strategyType: string; /** * Possible data set type */ testingDatasets: outputs.AiLanguage.GetModelsModelCollectionItemTestStrategyTestingDataset[]; /** * Possible data set type */ validationDatasets: outputs.AiLanguage.GetModelsModelCollectionItemTestStrategyValidationDataset[]; } interface GetModelsModelCollectionItemTestStrategyTestingDataset { /** * Data Science Labelling Service OCID */ datasetId: string; /** * Possible data sets */ datasetType: string; /** * Possible object storage location types */ locationDetails: outputs.AiLanguage.GetModelsModelCollectionItemTestStrategyTestingDatasetLocationDetail[]; } interface GetModelsModelCollectionItemTestStrategyTestingDatasetLocationDetail { /** * Object storage bucket name */ bucket: string; /** * Possible object storage location types */ locationType: string; /** * Object storage namespace */ namespace: string; /** * Array of files which need to be processed in the bucket */ objectNames: string[]; } interface GetModelsModelCollectionItemTestStrategyValidationDataset { /** * Data Science Labelling Service OCID */ datasetId: string; /** * Possible data sets */ datasetType: string; /** * Possible object storage location types */ locationDetails: outputs.AiLanguage.GetModelsModelCollectionItemTestStrategyValidationDatasetLocationDetail[]; } interface GetModelsModelCollectionItemTestStrategyValidationDatasetLocationDetail { /** * Object storage bucket name */ bucket: string; /** * Possible object storage location types */ locationType: string; /** * Object storage namespace */ namespace: string; /** * Array of files which need to be processed in the bucket */ objectNames: string[]; } interface GetModelsModelCollectionItemTrainingDataset { /** * Data Science Labelling Service OCID */ datasetId: string; /** * Possible data sets */ datasetType: string; /** * Possible object storage location types */ locationDetails: outputs.AiLanguage.GetModelsModelCollectionItemTrainingDatasetLocationDetail[]; } interface GetModelsModelCollectionItemTrainingDatasetLocationDetail { /** * Object storage bucket name */ bucket: string; /** * Possible object storage location types */ locationType: string; /** * Object storage namespace */ namespace: string; /** * Array of files which need to be processed in the bucket */ objectNames: string[]; } interface GetProjectsFilter { name: string; regex?: boolean; values: string[]; } interface GetProjectsProjectCollection { items: outputs.AiLanguage.GetProjectsProjectCollectionItem[]; } interface GetProjectsProjectCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A short description of a project. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier OCID of the project */ id: string; /** * A message describing the current state in more detail. */ lifecycleDetails: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the resource was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface JobInputConfiguration { /** * 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 */ configuration?: { [key: string]: { [key: string]: string; }; }; /** * Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list */ documentTypes: string[]; } interface JobInputLocation { /** * Object Storage bucket name. */ bucket: string; /** * locationType */ locationType: string; /** * Object Storage namespace name. */ namespace: string; /** * List of objects to be processed */ objectNames?: string[]; } interface JobModelMetadataDetail { /** * model configuration details For PII : < ENTITY_TYPE , ConfigurationDetails> ex."ORACLE":{ "mode" : "MASK","maskingCharacter" : "&","leaveCharactersUnmasked": 3,"isUnmaskedFromEnd" : true } For language translation : { "targetLanguageCodes" : ConfigurationDetails} */ configuration?: { [key: string]: { [key: string]: string; }; }; /** * Unique identifier endpoint OCID that should be used for inference */ endpointId: string; /** * Language code supported * * auto : Automatically detect language * * ar : Arabic * * pt-BR : Brazilian Portuguese * * cs : Czech * * da : Danish * * nl : Dutch * * en : English * * fi : Finnish * * fr : French * * fr-CA : Canadian French * * de : German * * it : Italian * * ja : Japanese * * ko : Korean * * no : Norwegian * * pl : Polish * * ro : Romanian * * zh-CN : Simplified Chinese * * es : Spanish * * sv : Swedish * * zh-TW : Traditional Chinese * * tr : Turkish * * el : Greek * * he : Hebrew */ languageCode: string; /** * Unique identifier model OCID that should be used for inference */ modelId: string; /** * model type to used for inference allowed values are * * LANGUAGE_SENTIMENT_ANALYSIS * * LANGUAGE_DETECTION * * TEXT_CLASSIFICATION * * NAMED_ENTITY_RECOGNITION * * KEY_PHRASE_EXTRACTION * * LANGUAGE_PII_ENTITIES * * LANGUAGE_TRANSLATION */ modelType: string; } interface JobOutputLocation { /** * Object Storage bucket name. */ bucket: string; /** * Object Storage namespace name. */ namespace: string; /** * The prefix (directory) in an Object Storage bucket. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ prefix: string; } interface ModelEvaluationResult { /** * List of text classification metrics */ classMetrics: outputs.AiLanguage.ModelEvaluationResultClassMetric[]; /** * class level confusion matrix */ confusionMatrix: string; /** * List of entity metrics */ entityMetrics: outputs.AiLanguage.ModelEvaluationResultEntityMetric[]; /** * labels */ labels: string[]; /** * Model level named entity recognition metrics */ metrics: outputs.AiLanguage.ModelEvaluationResultMetric[]; /** * Model type */ modelType: string; } interface ModelEvaluationResultClassMetric { /** * F1-score, is a measure of a model’s accuracy on a dataset */ f1: number; /** * Entity label */ label: string; /** * 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) */ precision: number; /** * 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. */ recall: number; /** * number of samples in the test set */ support: number; } interface ModelEvaluationResultEntityMetric { /** * F1-score, is a measure of a model’s accuracy on a dataset */ f1: number; /** * Entity label */ label: string; /** * 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) */ precision: number; /** * 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. */ recall: number; } interface ModelEvaluationResultMetric { /** * The fraction of the labels that were correctly recognised . */ accuracy: number; /** * F1-score, is a measure of a model’s accuracy on a dataset */ macroF1: number; /** * 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) */ macroPrecision: number; /** * 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. */ macroRecall: number; /** * F1-score, is a measure of a model’s accuracy on a dataset */ microF1: number; /** * 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) */ microPrecision: number; /** * 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. */ microRecall: number; /** * F1-score, is a measure of a model’s accuracy on a dataset */ weightedF1: number; /** * 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) */ weightedPrecision: number; /** * 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. */ weightedRecall: number; } interface ModelModelDetails { /** * possible text classification modes */ classificationMode: outputs.AiLanguage.ModelModelDetailsClassificationMode; /** * supported language default value is en */ languageCode: string; /** * Model type */ modelType: string; /** * Optional pre trained model version. if nothing specified latest pre trained model will be used. Supported versions can be found at /modelTypes/{modelType} */ version: string; } interface ModelModelDetailsClassificationMode { /** * classification Modes */ classificationMode: string; /** * Optional if nothing specified latest base model will be used for training. Supported versions can be found at /modelTypes/{modelType} */ version: string; } interface ModelTestStrategy { /** * This information will define the test strategy different datasets for test and validation(optional) dataset. */ strategyType: string; /** * Possible data set type */ testingDataset: outputs.AiLanguage.ModelTestStrategyTestingDataset; /** * Possible data set type */ validationDataset: outputs.AiLanguage.ModelTestStrategyValidationDataset; } interface ModelTestStrategyTestingDataset { /** * Data Science Labelling Service OCID */ datasetId: string; /** * Possible data sets */ datasetType: string; /** * Possible object storage location types */ locationDetails: outputs.AiLanguage.ModelTestStrategyTestingDatasetLocationDetails; } interface ModelTestStrategyTestingDatasetLocationDetails { /** * Object storage bucket name */ bucket: string; /** * Possible object storage location types */ locationType: string; /** * Object storage namespace */ namespace: string; /** * Array of files which need to be processed in the bucket */ objectNames: string[]; } interface ModelTestStrategyValidationDataset { /** * Data Science Labelling Service OCID */ datasetId: string; /** * Possible data sets */ datasetType: string; /** * Possible object storage location types */ locationDetails: outputs.AiLanguage.ModelTestStrategyValidationDatasetLocationDetails; } interface ModelTestStrategyValidationDatasetLocationDetails { /** * Object storage bucket name */ bucket: string; /** * Possible object storage location types */ locationType: string; /** * Object storage namespace */ namespace: string; /** * Array of files which need to be processed in the bucket */ objectNames: string[]; } interface ModelTrainingDataset { /** * Data Science Labelling Service OCID */ datasetId: string; /** * Possible data sets */ datasetType: string; /** * Possible object storage location types */ locationDetails: outputs.AiLanguage.ModelTrainingDatasetLocationDetails; } interface ModelTrainingDatasetLocationDetails { /** * Object storage bucket name */ bucket: string; /** * Possible object storage location types */ locationType: string; /** * Object storage namespace */ namespace: string; /** * Array of files which need to be processed in the bucket * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ objectNames: string[]; } } export declare namespace AiVision { interface GetModelTestingDataset { /** * The name of the ObjectStorage bucket that contains the input data file. */ bucket: string; /** * The OCID of the Data Science Labeling Dataset. */ datasetId: string; /** * Type of the Dataset. */ datasetType: string; /** * The namespace name of the ObjectStorage bucket that contains the input data file. * > > > > > > > theirs */ namespaceName: string; /** * The object name of the input data file. */ object: string; } interface GetModelTrainingDataset { /** * The name of the ObjectStorage bucket that contains the input data file. */ bucket: string; /** * The OCID of the Data Science Labeling Dataset. */ datasetId: string; /** * Type of the Dataset. */ datasetType: string; /** * The namespace name of the ObjectStorage bucket that contains the input data file. * > > > > > > > theirs */ namespaceName: string; /** * The object name of the input data file. */ object: string; } interface GetModelValidationDataset { /** * The name of the ObjectStorage bucket that contains the input data file. */ bucket: string; /** * The OCID of the Data Science Labeling Dataset. */ datasetId: string; /** * Type of the Dataset. */ datasetType: string; /** * The namespace name of the ObjectStorage bucket that contains the input data file. * > > > > > > > theirs */ namespaceName: string; /** * The object name of the input data file. */ object: string; } interface GetModelsFilter { name: string; regex?: boolean; values: string[]; } interface GetModelsModelCollection { items: outputs.AiVision.GetModelsModelCollectionItem[]; } interface GetModelsModelCollectionItem { /** * The mean average precision of the trained model. */ averagePrecision: number; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The intersection over the union threshold used for calculating precision and recall. */ confidenceThreshold: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * An optional description of the model. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The filter to find the model with the given identifier. */ id: string; /** * 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. */ isQuickMode: boolean; /** * A message describing the current state in more detail, that can provide actionable information if training failed. */ lifecycleDetails: string; /** * The maximum model training duration in hours, expressed as a decimal fraction. */ maxTrainingDurationInHours: number; /** * The complete set of per-label metrics for successfully trained models. */ metrics: string; /** * What type of Vision model this is. */ modelType: string; /** * The version of the model. */ modelVersion: string; /** * The precision of the trained model. */ precision: number; /** * The ID of the project for which to list the objects. */ projectId: string; /** * Recall of the trained model. */ recall: number; /** * The filter to match models with the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` */ systemTags: { [key: string]: string; }; /** * The number of images set aside for evaluating model performance metrics after training. */ testImageCount: number; /** * The base entity which is the input for creating and training a model. */ testingDatasets: outputs.AiVision.GetModelsModelCollectionItemTestingDataset[]; /** * When the model was created, as an RFC3339 datetime string. */ timeCreated: string; /** * When the model was updated, as an RFC3339 datetime string. */ timeUpdated: string; /** * The number of images in the dataset used to train, validate, and test the model. */ totalImageCount: number; /** * The total hours actually used for model training. */ trainedDurationInHours: number; /** * The base entity which is the input for creating and training a model. */ trainingDatasets: outputs.AiVision.GetModelsModelCollectionItemTrainingDataset[]; /** * The base entity which is the input for creating and training a model. */ validationDatasets: outputs.AiVision.GetModelsModelCollectionItemValidationDataset[]; } interface GetModelsModelCollectionItemTestingDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; namespaceName: string; /** * The object name of the input data file. */ object: string; } interface GetModelsModelCollectionItemTrainingDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; namespaceName: string; /** * The object name of the input data file. */ object: string; } interface GetModelsModelCollectionItemValidationDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; namespaceName: string; /** * The object name of the input data file. */ object: string; } interface GetProjectsFilter { name: string; regex?: boolean; values: string[]; } interface GetProjectsProjectCollection { items: outputs.AiVision.GetProjectsProjectCollectionItem[]; } interface GetProjectsProjectCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * An optional description of the project. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The filter to find the project with the given identifier. */ id: string; /** * A message describing the current state in more detail, that can provide actionable information if creation failed. */ lifecycleDetails: string; /** * The filter to match projects with the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` */ systemTags: { [key: string]: string; }; /** * When the project was created, as an RFC3339 datetime string. */ timeCreated: string; /** * When the project was updated, as an RFC3339 datetime string. */ timeUpdated: string; } interface GetStreamGroupStreamOverlap { /** * List of streamSource OCIDs. */ overlappingStreams: string[]; } interface GetStreamGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetStreamGroupsStreamGroupCollection { items: outputs.AiVision.GetStreamGroupsStreamGroupCollectionItem[]; } interface GetStreamGroupsStreamGroupCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The filter to find the device with the given identifier. */ id: string; /** * Stream */ isEnabled: boolean; /** * The current state of the streamGroup. */ state: string; /** * List of streamSource OCIDs where the streamSource overlaps in field of view. */ streamOverlaps: outputs.AiVision.GetStreamGroupsStreamGroupCollectionItemStreamOverlap[]; /** * List of streamSource OCIDs associated with the stream group */ streamSourceIds: string[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` */ systemTags: { [key: string]: string; }; /** * When the streamGroup was created, as an RFC3339 datetime string. */ timeCreated: string; /** * When the streamGroup was updated, as an RFC3339 datetime string. */ timeUpdated: string; } interface GetStreamGroupsStreamGroupCollectionItemStreamOverlap { /** * List of streamSource OCIDs. */ overlappingStreams: string[]; } interface GetStreamJobFeature { /** * The feature of video analysis. Allowed values are: * * OBJECT_TRACKING: Object tracking feature(OT). * * FACE_DETECTION: Face detection feature(FD). */ featureType: string; /** * The maximum number of results to return. */ maxResults: number; /** * Whether or not return face landmarks. */ shouldReturnLandmarks: boolean; /** * List of details of what to track. */ trackingTypes: outputs.AiVision.GetStreamJobFeatureTrackingType[]; } interface GetStreamJobFeatureTrackingType { /** * compartment Id of biometric compartment. */ biometricStoreCompartmentId: string; /** * Which biometric store user wants to do face recognition */ biometricStoreId: string; /** * The detection model OCID. */ detectionModelId: string; /** * The maximum number of results to return. */ maxResults: number; /** * List of the objects to be tracked. */ objects: string[]; /** * Whether or not return face landmarks. */ shouldReturnLandmarks: boolean; /** * The tracking model OCID. */ trackingModelId: string; } interface GetStreamJobStreamOutputLocation { /** * The Object Storage bucket name. */ bucket: string; /** * The Object Storage namespace. */ namespace: string; /** * Object storage output location */ oboToken: string; /** * Type of device Allowed values are: * * OBJECT_STORAGE * * LIVEKIT_WEBRTC_AGENT */ outputLocationType: string; /** * The Object Storage folder name. */ prefix: string; } interface GetStreamJobsFilter { name: string; regex?: boolean; values: string[]; } interface GetStreamJobsStreamJobCollection { items: outputs.AiVision.GetStreamJobsStreamJobCollectionItem[]; } interface GetStreamJobsStreamJobCollectionItem { /** * participant id of agent where results need to be sent */ agentParticipantId: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * a list of document analysis features. */ features: outputs.AiVision.GetStreamJobsStreamJobCollectionItemFeature[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The filter to find the streamjob with the given identifier. */ id: string; /** * Additional details about current state of streamJob */ lifecycleDetails: string; /** * The filter to match projects with the given lifecycleState. */ state: string; /** * Details about a where results will be Sent */ streamOutputLocations: outputs.AiVision.GetStreamJobsStreamJobCollectionItemStreamOutputLocation[]; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the streamSource */ streamSourceId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` */ systemTags: { [key: string]: string; }; /** * When the streamJob was created, as an RFC3339 datetime string. */ timeCreated: string; /** * When the stream job was updated, as an RFC3339 datetime string. */ timeUpdated: string; } interface GetStreamJobsStreamJobCollectionItemFeature { /** * The feature of video analysis. Allowed values are: * * OBJECT_TRACKING: Object tracking feature(OT). * * FACE_DETECTION: Face detection feature(FD). */ featureType: string; /** * The maximum number of results to return. */ maxResults: number; /** * Whether or not return face landmarks. */ shouldReturnLandmarks: boolean; /** * List of details of what to track. */ trackingTypes: outputs.AiVision.GetStreamJobsStreamJobCollectionItemFeatureTrackingType[]; } interface GetStreamJobsStreamJobCollectionItemFeatureTrackingType { /** * compartment Id of biometric compartment. */ biometricStoreCompartmentId: string; /** * Which biometric store user wants to do face recognition */ biometricStoreId: string; /** * The detection model OCID. */ detectionModelId: string; /** * The maximum number of results to return. */ maxResults: number; /** * List of the objects to be tracked. */ objects: string[]; /** * Whether or not return face landmarks. */ shouldReturnLandmarks: boolean; /** * The tracking model OCID. */ trackingModelId: string; } interface GetStreamJobsStreamJobCollectionItemStreamOutputLocation { /** * The Object Storage bucket name. */ bucket: string; /** * The Object Storage namespace. */ namespace: string; /** * Object storage output location */ oboToken: string; /** * Type of device Allowed values are: * * OBJECT_STORAGE * * LIVEKIT_WEBRTC_AGENT */ outputLocationType: string; /** * The Object Storage folder name. */ prefix: string; } interface GetStreamSourceStreamSourceDetail { /** * url of camera */ cameraUrl: string; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of secret where credentials are stored in username:password format. */ secretId: string; /** * Type of source Allowed values are: * * RTSP */ sourceType: string; /** * Details about a stream Connection type */ streamNetworkAccessDetails: outputs.AiVision.GetStreamSourceStreamSourceDetailStreamNetworkAccessDetail[]; } interface GetStreamSourceStreamSourceDetailStreamNetworkAccessDetail { /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private Endpoint */ privateEndpointId: string; /** * Type of access Allowed values are: * * PRIVATE */ streamAccessType: string; } interface GetStreamSourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetStreamSourcesStreamSourceCollection { items: outputs.AiVision.GetStreamSourcesStreamSourceCollectionItem[]; } interface GetStreamSourcesStreamSourceCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The filter to find the device with the given identifier. */ id: string; /** * The filter to match projects with the given lifecycleState. */ state: string; /** * Details about a stream source */ streamSourceDetails: outputs.AiVision.GetStreamSourcesStreamSourceCollectionItemStreamSourceDetail[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` */ systemTags: { [key: string]: string; }; /** * When the streamSource was created, as an RFC3339 datetime string. */ timeCreated: string; /** * When the streamSource was updated, as an RFC3339 datetime string. */ timeUpdated: string; } interface GetStreamSourcesStreamSourceCollectionItemStreamSourceDetail { /** * url of camera */ cameraUrl: string; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of secret where credentials are stored in username:password format. */ secretId: string; /** * Type of source Allowed values are: * * RTSP */ sourceType: string; /** * Details about a stream Connection type */ streamNetworkAccessDetails: outputs.AiVision.GetStreamSourcesStreamSourceCollectionItemStreamSourceDetailStreamNetworkAccessDetail[]; } interface GetStreamSourcesStreamSourceCollectionItemStreamSourceDetailStreamNetworkAccessDetail { /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private Endpoint */ privateEndpointId: string; /** * Type of access Allowed values are: * * PRIVATE */ streamAccessType: string; } interface GetVisionPrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetVisionPrivateEndpointsVisionPrivateEndpointCollection { items: outputs.AiVision.GetVisionPrivateEndpointsVisionPrivateEndpointCollectionItem[]; } interface GetVisionPrivateEndpointsVisionPrivateEndpointCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * An optional description of the visionPrivateEndpoint. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The filter to find the device with the given identifier. */ id: string; /** * A message describing the current state in more detail, that can provide actionable information if creation failed. */ lifecycleDetails: string; /** * The filter to match projects with the given lifecycleState. */ state: string; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of subnet */ subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` */ systemTags: { [key: string]: string; }; /** * When the visionPrivateEndpoint was created, as an RFC3339 datetime string. */ timeCreated: string; /** * When the visionPrivateEndpoint was updated, as an RFC3339 datetime string. */ timeUpdated: string; } interface ModelTestingDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; namespaceName: string; /** * The object name of the input data file. */ object: string; } interface ModelTrainingDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; namespaceName: string; /** * The object name of the input data file. */ object: string; } interface ModelValidationDataset { /** * The name of the Object Storage bucket that contains the input data file. */ bucket: string; /** * OCID of the Data Labeling dataset. */ datasetId: string; /** * The dataset type, based on where it is stored. */ datasetType: string; namespaceName: string; /** * The object name of the input data file. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ object: string; } interface StreamGroupStreamOverlap { /** * (Updatable) List of streamSource OCIDs. */ overlappingStreams: string[]; } interface StreamJobFeature { /** * (Updatable) The feature of video analysis. Allowed values are: * * OBJECT_TRACKING: Object tracking feature(OT). * * FACE_DETECTION: Face detection feature(FD). */ featureType: string; /** * (Updatable) The maximum number of results to return. */ maxResults: number; /** * (Updatable) Whether or not return face landmarks. */ shouldReturnLandmarks: boolean; /** * (Updatable) List of details of what to track. */ trackingTypes: outputs.AiVision.StreamJobFeatureTrackingType[]; } interface StreamJobFeatureTrackingType { /** * (Updatable) compartment Id of biometric compartment. */ biometricStoreCompartmentId: string; /** * (Updatable) Which biometric store user wants to do face recognition */ biometricStoreId: string; /** * (Updatable) The detection model OCID. */ detectionModelId: string; /** * (Updatable) The maximum number of results to return. */ maxResults: number; /** * (Updatable) List of the objects to be tracked. */ objects: string[]; /** * (Updatable) Whether or not return face landmarks. */ shouldReturnLandmarks: boolean; /** * (Updatable) The tracking model OCID. */ trackingModelId: string; } interface StreamJobStreamOutputLocation { /** * (Updatable) The Object Storage bucket name. */ bucket: string; /** * (Updatable) The Object Storage namespace. */ namespace: string; /** * (Updatable) Object storage output location */ oboToken: string; /** * (Updatable) Type of device Allowed values are: * * OBJECT_STORAGE * * LIVEKIT_WEBRTC_AGENT */ outputLocationType: string; /** * (Updatable) The Object Storage folder name. */ prefix: string; } interface StreamSourceStreamSourceDetails { /** * (Updatable) url of camera */ cameraUrl: string; /** * (Updatable) [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of secret where credentials are stored in username:password format. */ secretId: string; /** * (Updatable) Type of source Allowed values are: * * RTSP */ sourceType: string; /** * (Updatable) Details about a stream Connection type */ streamNetworkAccessDetails: outputs.AiVision.StreamSourceStreamSourceDetailsStreamNetworkAccessDetails; } interface StreamSourceStreamSourceDetailsStreamNetworkAccessDetails { /** * (Updatable) [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private Endpoint */ privateEndpointId: string; /** * (Updatable) Type of access Allowed values are: * * PRIVATE * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ streamAccessType: string; } } export declare namespace Analytics { interface AnalyticsInstanceCapacity { /** * The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT */ capacityType: string; /** * (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 Analytics instance. */ capacityValue: number; } interface AnalyticsInstanceNetworkEndpointDetails { /** * The type of network endpoint. */ networkEndpointType: string; /** * Network Security Group OCIDs for the Analytics instance. */ networkSecurityGroupIds: string[]; /** * The subnet OCID for the private endpoint. */ subnetId: string; /** * The VCN OCID for the private endpoint. */ vcnId: string; /** * Source IP addresses or IP address ranges in ingress rules. */ whitelistedIps: string[]; /** * Oracle Cloud services that are allowed to access this Analytics instance. */ whitelistedServices: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ whitelistedVcns: outputs.Analytics.AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn[]; } interface AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn { /** * The Virtual Cloud Network OCID. */ id: string; /** * Source IP addresses or IP address ranges in ingress rules. */ whitelistedIps: string[]; } interface AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone { /** * (Updatable) Description of the private source DNS zone. */ description: string; /** * (Updatable) Private source DNS zone. For example: example-vcn.oraclevcn.com, corp.example.com. */ dnsZone: string; } interface AnalyticsInstancePrivateAccessChannelPrivateSourceScanHost { /** * (Updatable) Description of private source SCAN host zone. */ description: string; /** * (Updatable) Private source SCAN hostname. For example: db01-scan.corp.example.com, prd-db01-scan.mycompany.com. */ scanHostname: string; /** * (Updatable) Private source SCAN host port. This is the source port where the SCAN protocol connects (for example, 1521). */ scanPort: number; } interface AnalyticsInstanceResourceGroup { /** * Service instance capacity metadata (for example, OLPU count, number of users, and so on). */ capacity: number; /** * (Updatable) Optional description. */ description: string; /** * Meaningful name of resource group for end user */ displayName: string; /** * Unique identifier and name of resource group. Must be unique within the instance */ id: string; /** * Meaningful name of resource group for end user */ resourceName: string; } interface GetAnalyticsInstanceCapacity { /** * The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT */ capacityType: string; /** * 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 Analytics instance. */ capacityValue: number; } interface GetAnalyticsInstanceNetworkEndpointDetail { /** * The type of network endpoint. */ networkEndpointType: string; /** * Network Security Group OCIDs for the Analytics instance. */ networkSecurityGroupIds: string[]; /** * OCID of the customer subnet connected to the private access channel. */ subnetId: string; /** * OCID of the customer VCN peered with the private access channel. */ vcnId: string; /** * Source IP addresses or IP address ranges in ingress rules. */ whitelistedIps: string[]; /** * Oracle Cloud services that are allowed to access this Analytics instance. */ whitelistedServices: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ whitelistedVcns: outputs.Analytics.GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn[]; } interface GetAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn { /** * Unique identifier and name of resource group. Must be unique within the instance */ id: string; /** * Source IP addresses or IP address ranges in ingress rules. */ whitelistedIps: string[]; } interface GetAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone { /** * Description of private source SCAN host zone. */ description: string; /** * Private source DNS zone. For example: example-vcn.oraclevcn.com, corp.example.com. */ dnsZone: string; } interface GetAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost { /** * Description of private source SCAN host zone. */ description: string; /** * Private source SCAN hostname. For example: db01-scan.corp.example.com, prd-db01-scan.mycompany.com. */ scanHostname: string; /** * Private source SCAN host port. This is the source port where the SCAN protocol connects (for example, 1521). */ scanPort: number; } interface GetAnalyticsInstanceResourceGroup { /** * The capacity (in OCPU's) to be allocated for this resource. */ capacity: number; /** * Description of the vanity URL. */ description: string; /** * Meaningful name of resource group for end user */ displayName: string; /** * Unique identifier and name of resource group. Must be unique within the instance */ id: string; /** * Meaningful name of resource group for end user */ resourceName: string; } interface GetAnalyticsInstanceResourceGroupsFilter { /** * A filter to return only resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetAnalyticsInstanceResourceGroupsInstanceResourceGroup { /** * The OCID of the Analytics instance. */ analyticsInstanceId: string; /** * The capacity (in OCPU's) to be allocated for this resource. */ capacity: number; /** * Optional description of the resource group */ description: string; /** * Meaningful name of resource group for end user */ displayName: string; /** * Unique identifier and name of resource group. Must be unique within the instance */ id: string; /** * Meaningful name of resource group for end user */ resourceName: string; } interface GetAnalyticsInstancesAnalyticsInstance { adminUser: string; /** * The capacity (in OCPU's) to be allocated for this resource. */ capacities: outputs.Analytics.GetAnalyticsInstancesAnalyticsInstanceCapacity[]; /** * The OCID of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of the vanity URL. */ description: string; /** * Identity domain OCID. */ domainId: string; /** * Email address receiving notifications. */ emailNotification: string; /** * The feature set of an Analytics instance. */ featureBundle: string; /** * A filter to only return resources matching the feature set. Values are case-insensitive. */ featureSet: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier and name of resource group. Must be unique within the instance */ id: string; idcsAccessToken: string; /** * OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates that the default Oracle-managed encryption is used. */ kmsKeyId: string; /** * The license used for the service. */ licenseType: string; /** * A filter to return only resources that match the given name exactly. */ name: string; /** * Base representation of a network endpoint. */ networkEndpointDetails: outputs.Analytics.GetAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetail[]; /** * List of resource groups for this Analytics instance. The resource group id must be unique within the instance. */ resourceGroups: outputs.Analytics.GetAnalyticsInstancesAnalyticsInstanceResourceGroup[]; /** * URL of the Analytics instance. */ serviceUrl: string; /** * A filter to only return resources matching the lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.key": "value"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Analytics instance was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Analytics instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events don't affect it. */ timeUpdated: string; /** * The Analytics instance update cycle. */ updateChannel: string; } interface GetAnalyticsInstancesAnalyticsInstanceCapacity { /** * A filter to only return resources matching the capacity type enum. Values are case-insensitive. */ capacityType: string; /** * 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 Analytics instance. */ capacityValue: number; } interface GetAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetail { /** * The type of network endpoint. */ networkEndpointType: string; /** * Network Security Group OCIDs for the Analytics instance. */ networkSecurityGroupIds: string[]; /** * OCID of the customer subnet connected to the private access channel. */ subnetId: string; /** * OCID of the customer VCN peered with the private access channel. */ vcnId: string; /** * Source IP addresses or IP address ranges in ingress rules. */ whitelistedIps: string[]; /** * Oracle Cloud services that are allowed to access this Analytics instance. */ whitelistedServices: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ whitelistedVcns: outputs.Analytics.GetAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn[]; } interface GetAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn { /** * Unique identifier and name of resource group. Must be unique within the instance */ id: string; /** * Source IP addresses or IP address ranges in ingress rules. */ whitelistedIps: string[]; } interface GetAnalyticsInstancesAnalyticsInstanceResourceGroup { /** * The capacity (in OCPU's) to be allocated for this resource. */ capacity: number; /** * Description of the vanity URL. */ description: string; /** * Meaningful name of resource group for end user */ displayName: string; /** * Unique identifier and name of resource group. Must be unique within the instance */ id: string; /** * Meaningful name of resource group for end user */ resourceName: string; } interface GetAnalyticsInstancesFilter { /** * A filter to return only resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } } export declare namespace AnnouncementsService { interface AnnouncementSubscriptionFilterGroups { /** * 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. */ filters: outputs.AnnouncementsService.AnnouncementSubscriptionFilterGroupsFilter[]; /** * The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information. */ name: string; } interface AnnouncementSubscriptionFilterGroupsFilter { /** * 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. */ type: string; /** * The value of the filter. */ value: string; } interface AnnouncementSubscriptionsFilterGroupFilter { /** * (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. */ type: string; /** * (Updatable) The value of the filter. */ value: string; } interface GetAnnouncementSubscriptionFilterGroup { /** * 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. */ filters: outputs.AnnouncementsService.GetAnnouncementSubscriptionFilterGroupFilter[]; /** * The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information. */ name: string; } interface GetAnnouncementSubscriptionFilterGroupFilter { /** * 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. */ type: string; /** * The value of the filter. */ value: string; } interface GetAnnouncementSubscriptionsAnnouncementSubscriptionCollection { items: outputs.AnnouncementsService.GetAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItem[]; } interface GetAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItem { /** * The OCID of the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A description of the announcement subscription. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes. */ filterGroups: outputs.AnnouncementsService.GetAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroup[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the announcement subscription. */ id: string; /** * 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. */ lifecycleDetails: string; /** * The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. */ onsTopicId: string; /** * (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. */ preferredLanguage: string; /** * 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 */ preferredTimeZone: string; /** * A filter to return only announcement subscriptions that match the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time that the announcement subscription was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. */ timeCreated: string; /** * The date and time that the announcement subscription was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. */ timeUpdated: string; } interface GetAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroup { /** * 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. */ filters: outputs.AnnouncementsService.GetAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroupFilter[]; /** * The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information. */ name: string; } interface GetAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroupFilter { /** * 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. */ type: string; /** * The value of the filter. */ value: string; } interface GetAnnouncementSubscriptionsFilter { /** * The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information. */ name: string; regex?: boolean; values: string[]; } interface GetServicesFilter { name: string; regex?: boolean; values: string[]; } interface GetServicesServicesCollection { items: outputs.AnnouncementsService.GetServicesServicesCollectionItem[]; } interface GetServicesServicesCollectionItem { /** * Filter by comms manager name */ commsManagerName: string; /** * The list of realms where this service is not available to be used. */ excludedRealms: string[]; /** * ID of the service object. */ id: string; /** * A filter to return only services underlying a specific platform. */ platformType: string; /** * The list of previously used names for this service object. */ previousServiceNames: string[]; /** * Name of the service represented by this object. */ serviceName: string; /** * Short name of the team to whom this service object is related. */ shortName: string; /** * Current state of the service object. */ state: string; /** * Team name to which this service object is related. */ teamName: string; /** * The date and time when the service object was created. */ timeCreated: string; /** * The date and time when the service object was updated. */ timeUpdated: string; type: string; } } export declare namespace ApiGateway { interface ApiLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface ApiValidationResult { /** * Name of the validation. */ name: string; /** * Result of the validation. */ result: string; } interface CertificateLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DeploymentLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DeploymentSpecification { /** * (Updatable) Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging. */ loggingPolicies: outputs.ApiGateway.DeploymentSpecificationLoggingPolicies; /** * (Updatable) Global behavior applied to all requests received by the API. */ requestPolicies: outputs.ApiGateway.DeploymentSpecificationRequestPolicies; /** * (Updatable) A list of routes that this API exposes. */ routes: outputs.ApiGateway.DeploymentSpecificationRoute[]; } interface DeploymentSpecificationLoggingPolicies { /** * (Updatable) Configures the logging policies for the access logs of an API Deployment. */ accessLog: outputs.ApiGateway.DeploymentSpecificationLoggingPoliciesAccessLog; /** * (Updatable) Configures the logging policies for the execution logs of an API Deployment. */ executionLog: outputs.ApiGateway.DeploymentSpecificationLoggingPoliciesExecutionLog; } interface DeploymentSpecificationLoggingPoliciesAccessLog { /** * (Updatable) Enables pushing of access logs to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket. * * Oracle 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. * * Please 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. */ isEnabled: boolean; } interface DeploymentSpecificationLoggingPoliciesExecutionLog { /** * (Updatable) Enables pushing of execution logs to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket. * * Oracle 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. * * Please 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. */ isEnabled: boolean; /** * (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. */ logLevel: string; } interface DeploymentSpecificationRequestPolicies { /** * (Updatable) Information on how to authenticate incoming requests. */ authentication: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthentication; /** * (Updatable) Enable CORS (Cross-Origin-Resource-Sharing) request handling. */ cors: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesCors; /** * (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. */ dynamicAuthentication: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthentication; /** * (Updatable) Properties used to configure client mTLS verification when API Consumer makes connection to the gateway. */ mutualTls: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesMutualTls; /** * (Updatable) Limit the number of requests that should be handled for the specified window using a specfic key. */ rateLimiting: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesRateLimiting; /** * (Updatable) Usage plan policies for this deployment */ usagePlans: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesUsagePlans; } interface DeploymentSpecificationRequestPoliciesAuthentication { /** * (Updatable) The list of intended recipients for the token. */ audiences: string[]; /** * (Updatable) A list of keys from "parameters" attribute value whose values will be added to the cache key. */ cacheKeys: string[]; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * (Updatable) Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. */ isAnonymousAccessAllowed: boolean; /** * (Updatable) A list of parties that could have issued the token. */ issuers: string[]; /** * (Updatable) The maximum expected time difference between the system clocks of the token issuer and the API Gateway. */ maxClockSkewInSeconds: number; /** * (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]"}` */ parameters: { [key: string]: string; }; /** * (Updatable) A set of Public Keys that will be used to verify the JWT signature. */ publicKeys: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys; /** * (Updatable) The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. */ tokenAuthScheme: string; /** * (Updatable) The name of the header containing the authentication token. */ tokenHeader: string; /** * (Updatable) The name of the query parameter containing the authentication token. */ tokenQueryParam: string; /** * (Updatable) Type of the authentication policy to use. */ type: string; /** * (Updatable) Policy for defining behaviour on validation failure. */ validationFailurePolicy: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicy; /** * (Updatable) Authentication Policies for the Token Authentication types. */ validationPolicy: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicy; /** * (Updatable) A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim[]; } interface DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys { /** * (Updatable) Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * (Updatable) The set of static public keys. */ keys: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey[]; /** * (Updatable) The duration for which the JWKS should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * (Updatable) Type of the public key set. */ type: string; /** * (Updatable) The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey { /** * (Updatable) The algorithm intended for use with this key. */ alg: string; /** * (Updatable) The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * (Updatable) The format of the public key. */ format: string; /** * (Updatable) The content of the PEM-encoded public key. */ key: string; /** * (Updatable) The operations for which this key is to be used. */ keyOps: string[]; /** * (Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * (Updatable) The key type. */ kty: string; /** * (Updatable) The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * (Updatable) The intended use of the public key. */ use: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicy { /** * (Updatable) Client App Credential details. */ clientDetails: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyClientDetails; /** * (Updatable) The path to be used as fallback after OAuth2. */ fallbackRedirectPath: string; /** * (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. */ loginPath: string; /** * (Updatable) The path to be used as logout. */ logoutPath: string; /** * (Updatable) The duration for which the OAuth2 success token should be cached before it is fetched again. */ maxExpiryDurationInHours: number; /** * (Updatable) HTTP response code, can include context variables. */ responseCode: string; /** * (Updatable) A set of transformations to apply to HTTP headers that pass through the gateway. */ responseHeaderTransformations: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformations; /** * (Updatable) HTTP response message. */ responseMessage: string; /** * (Updatable) Response Type. */ responseType: string; /** * (Updatable) List of scopes. */ scopes: string[]; /** * (Updatable) Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicySourceUriDetails; /** * (Updatable) Type of the Validation failure Policy. */ type: string; /** * (Updatable) Defines whether or not to use cookies for OAuth2 intermediate steps. */ useCookiesForIntermediateSteps: boolean; /** * (Updatable) Defines whether or not to use cookies for session maintenance. */ useCookiesForSession: boolean; /** * (Updatable) Defines whether or not to support PKCE. */ usePkce: boolean; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyClientDetails { /** * (Updatable) Client ID for the OAuth2/OIDC app. */ clientId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * (Updatable) The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * (Updatable) To specify where the Client App details should be taken from. */ type: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformations { /** * (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. */ filterHeaders: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeaders; /** * (Updatable) Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeaders; /** * (Updatable) Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeaders; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem[]; /** * (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. */ type: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem { /** * (Updatable) The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem[]; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem { /** * (Updatable) The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * (Updatable) The new name of the header. This name must be unique across transformation policies. */ to: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem[]; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem { /** * (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. */ ifExists: string; /** * (Updatable) The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * (Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicySourceUriDetails { /** * (Updatable) Type of the Uri detail. */ type: string; /** * (Updatable) The discovery URI for the auth server. */ uri: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicy { /** * (Updatable) Additional JWT validation checks. */ additionalValidationPolicy: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicy; /** * (Updatable) Client App Credential details. */ clientDetails: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyClientDetails; /** * (Updatable) Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * (Updatable) The set of static public keys. */ keys: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyKey[]; /** * (Updatable) The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * (Updatable) Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicySourceUriDetails; /** * (Updatable) Type of the token validation policy. */ type: string; /** * (Updatable) The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicy { /** * (Updatable) The list of intended recipients for the token. */ audiences: string[]; /** * (Updatable) A list of parties that could have issued the token. */ issuers: string[]; /** * (Updatable) A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim[]; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim { /** * (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. */ isRequired: boolean; /** * (Updatable) Name of the claim. */ key: string; /** * (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. */ values: string[]; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyClientDetails { /** * (Updatable) Client ID for the OAuth2/OIDC app. */ clientId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * (Updatable) The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * (Updatable) To specify where the Client App details should be taken from. */ type: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyKey { /** * (Updatable) The algorithm intended for use with this key. */ alg: string; /** * (Updatable) The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * (Updatable) The format of the public key. */ format: string; /** * (Updatable) The content of the PEM-encoded public key. */ key: string; /** * (Updatable) The operations for which this key is to be used. */ keyOps: string[]; /** * (Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * (Updatable) The key type. */ kty: string; /** * (Updatable) The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * (Updatable) The intended use of the public key. */ use: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicySourceUriDetails { /** * (Updatable) Type of the Uri detail. */ type: string; /** * (Updatable) The discovery URI for the auth server. */ uri: string; } interface DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim { /** * (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. */ isRequired: boolean; /** * (Updatable) Name of the claim. */ key: string; /** * (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. */ values: string[]; } interface DeploymentSpecificationRequestPoliciesCors { /** * (Updatable) The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. */ allowedHeaders: string[]; /** * (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. */ allowedMethods: string[]; /** * (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. */ allowedOrigins: string[]; /** * (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. */ exposedHeaders: string[]; /** * (Updatable) Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. */ isAllowCredentialsEnabled: boolean; /** * (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. */ maxAgeInSeconds: number; } interface DeploymentSpecificationRequestPoliciesDynamicAuthentication { /** * (Updatable) List of authentication servers to choose from during dynamic authentication. */ authenticationServers: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServer[]; /** * (Updatable) The type of selector to use when dynamically routing and dynamically authenticating requests. */ selectionSource: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationSelectionSource; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServer { /** * (Updatable) Information on how to authenticate incoming requests. */ authenticationServerDetail: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetail; /** * (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. */ key: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerKey; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetail { /** * (Updatable) The list of intended recipients for the token. */ audiences: string[]; /** * A list of keys from "parameters" attribute value whose values will be added to the cache key. */ cacheKeys: string[]; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * (Updatable) Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. */ isAnonymousAccessAllowed: boolean; /** * (Updatable) A list of parties that could have issued the token. */ issuers: string[]; /** * (Updatable) The maximum expected time difference between the system clocks of the token issuer and the API Gateway. */ maxClockSkewInSeconds: number; /** * (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]"}` */ parameters: { [key: string]: string; }; /** * (Updatable) A set of Public Keys that will be used to verify the JWT signature. */ publicKeys: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeys; /** * (Updatable) The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. */ tokenAuthScheme: string; /** * (Updatable) The name of the header containing the authentication token. */ tokenHeader: string; /** * (Updatable) The name of the query parameter containing the authentication token. */ tokenQueryParam: string; /** * (Updatable) Type of the authentication policy to use. */ type: string; /** * (Updatable) Policy for defining behaviour on validation failure. */ validationFailurePolicy: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy; /** * (Updatable) Authentication Policies for the Token Authentication types. */ validationPolicy: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy; /** * (Updatable) A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim[]; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeys { /** * (Updatable) Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * (Updatable) The set of static public keys. */ keys: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeysKey[]; /** * (Updatable) The duration for which the JWKS should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * (Updatable) Type of the public key set. */ type: string; /** * (Updatable) The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeysKey { /** * (Updatable) The algorithm intended for use with this key. */ alg: string; /** * (Updatable) The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * (Updatable) The format of the public key. */ format: string; /** * (Updatable) The content of the PEM-encoded public key. */ key: string; /** * (Updatable) The operations for which this key is to be used. */ keyOps: string[]; /** * (Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * (Updatable) The key type. */ kty: string; /** * (Updatable) The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * (Updatable) The intended use of the public key. */ use: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy { /** * (Updatable) Client App Credential details. */ clientDetails: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetails; /** * (Updatable) The path to be used as fallback after OAuth2. */ fallbackRedirectPath: string; /** * (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. */ loginPath: string; /** * (Updatable) The path to be used as logout. */ logoutPath: string; /** * (Updatable) The duration for which the OAuth2 success token should be cached before it is fetched again. */ maxExpiryDurationInHours: number; /** * (Updatable) HTTP response code, can include context variables. */ responseCode: string; /** * (Updatable) A set of transformations to apply to HTTP headers that pass through the gateway. */ responseHeaderTransformations: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformations; /** * (Updatable) HTTP response message. */ responseMessage: string; /** * (Updatable) Response Type. */ responseType: string; /** * (Updatable) List of scopes. */ scopes: string[]; /** * (Updatable) Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetails; /** * (Updatable) Type of the Validation failure Policy. */ type: string; /** * (Updatable) Defines whether or not to use cookies for OAuth2 intermediate steps. */ useCookiesForIntermediateSteps: boolean; /** * (Updatable) Defines whether or not to use cookies for session maintenance. */ useCookiesForSession: boolean; /** * (Updatable) Defines whether or not to support PKCE. */ usePkce: boolean; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetails { /** * (Updatable) Client ID for the OAuth2/OIDC app. */ clientId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * (Updatable) The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * (Updatable) To specify where the Client App details should be taken from. */ type: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformations { /** * (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. */ filterHeaders: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeaders; /** * (Updatable) Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeaders; /** * (Updatable) Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeaders; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem[]; /** * (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. */ type: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem { /** * (Updatable) The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem[]; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem { /** * (Updatable) The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * (Updatable) The new name of the header. This name must be unique across transformation policies. */ to: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem[]; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem { /** * (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. */ ifExists: string; /** * (Updatable) The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * (Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetails { /** * (Updatable) Type of the Uri detail. */ type: string; /** * (Updatable) The discovery URI for the auth server. */ uri: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy { /** * (Updatable) Additional JWT validation checks. */ additionalValidationPolicy: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy; /** * (Updatable) Client App Credential details. */ clientDetails: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetails; /** * (Updatable) Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * (Updatable) The set of static public keys. */ keys: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey[]; /** * (Updatable) The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * (Updatable) Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetails; /** * (Updatable) Type of the token validation policy. */ type: string; /** * (Updatable) The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy { /** * (Updatable) The list of intended recipients for the token. */ audiences: string[]; /** * (Updatable) A list of parties that could have issued the token. */ issuers: string[]; /** * (Updatable) A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim[]; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim { /** * (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. */ isRequired: boolean; /** * (Updatable) Name of the claim. */ key: string; /** * (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. */ values: string[]; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetails { /** * (Updatable) Client ID for the OAuth2/OIDC app. */ clientId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * (Updatable) The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * (Updatable) To specify where the Client App details should be taken from. */ type: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey { /** * (Updatable) The algorithm intended for use with this key. */ alg: string; /** * (Updatable) The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * (Updatable) The format of the public key. */ format: string; /** * (Updatable) The content of the PEM-encoded public key. */ key: string; /** * (Updatable) The operations for which this key is to be used. */ keyOps: string[]; /** * (Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * (Updatable) The key type. */ kty: string; /** * (Updatable) The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * (Updatable) The intended use of the public key. */ use: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetails { /** * (Updatable) Type of the Uri detail. */ type: string; /** * (Updatable) The discovery URI for the auth server. */ uri: string; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim { /** * (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. */ isRequired: boolean; /** * (Updatable) Name of the claim. */ key: string; /** * (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. */ values: string[]; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerKey { /** * (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. */ expression: string; /** * (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. */ isDefault: boolean; /** * (Updatable) Name assigned to the branch. */ name: string; /** * (Updatable) Type of the selection key. */ type: string; /** * (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. */ values: string[]; } interface DeploymentSpecificationRequestPoliciesDynamicAuthenticationSelectionSource { /** * (Updatable) String describing the context variable used as selector. */ selector: string; /** * (Updatable) Type of the Selection source to use. */ type: string; } interface DeploymentSpecificationRequestPoliciesMutualTls { /** * (Updatable) Allowed list of CN or SAN which will be used for verification of certificate. */ allowedSans: string[]; /** * (Updatable) Determines whether to enable client verification when API Consumer makes connection to the gateway. */ isVerifiedCertificateRequired: boolean; } interface DeploymentSpecificationRequestPoliciesRateLimiting { /** * (Updatable) The maximum number of requests per second to allow. */ rateInRequestsPerSecond: number; /** * (Updatable) The key used to group requests together. */ rateKey: string; } interface DeploymentSpecificationRequestPoliciesUsagePlans { /** * (Updatable) A list of context variables specifying where API tokens may be located in a request. Example locations: * * "request.headers[token]" * * "request.query[token]" * * "request.auth[Token]" * * "request.path[TOKEN]" */ tokenLocations: string[]; } interface DeploymentSpecificationRoute { /** * (Updatable) The backend to forward requests to. */ backend: outputs.ApiGateway.DeploymentSpecificationRouteBackend; /** * (Updatable) Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging. */ loggingPolicies: outputs.ApiGateway.DeploymentSpecificationRouteLoggingPolicies; /** * (Updatable) A list of allowed methods on this route. */ methods: string[]; /** * (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. */ path: string; /** * (Updatable) Behavior applied to any requests received by the API on this route. */ requestPolicies: outputs.ApiGateway.DeploymentSpecificationRouteRequestPolicies; /** * (Updatable) Behavior applied to any responses sent by the API for requests on this route. */ responsePolicies: outputs.ApiGateway.DeploymentSpecificationRouteResponsePolicies; } interface DeploymentSpecificationRouteBackend { /** * (Updatable) A list of allowed post-logout URLs to which a request can be redirected after revoke access */ allowedPostLogoutUris: string[]; /** * (Updatable) The body of the stock response from the mock backend. */ body: string; /** * (Updatable) Defines a timeout for establishing a connection with a proxied server. */ connectTimeoutInSeconds: number; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * (Updatable) The headers of the stock response from the mock backend. */ headers: outputs.ApiGateway.DeploymentSpecificationRouteBackendHeader[]; /** * (Updatable) Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * (Updatable) Defines a state that should be shared on redirecting to postLogout URL. */ postLogoutState: string; /** * (Updatable) Defines a timeout for reading a response from the proxied server. */ readTimeoutInSeconds: number; /** * (Updatable) List of backends to chose from for Dynamic Routing. */ routingBackends: outputs.ApiGateway.DeploymentSpecificationRouteBackendRoutingBackend[]; /** * (Updatable) Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication. */ selectionSource: outputs.ApiGateway.DeploymentSpecificationRouteBackendSelectionSource; /** * (Updatable) Defines a timeout for transmitting a request to the proxied server. */ sendTimeoutInSeconds: number; /** * (Updatable) The status code of the stock response from the mock backend. */ status: number; /** * (Updatable) Type of the API backend. */ type: string; /** * (Updatable) The url of the HTTP Backend */ url: string; } interface DeploymentSpecificationRouteBackendHeader { /** * (Updatable) Name of the header. */ name: string; /** * (Updatable) Value of the header. */ value: string; } interface DeploymentSpecificationRouteBackendRoutingBackend { /** * (Updatable) The backend to forward requests to. */ backend: outputs.ApiGateway.DeploymentSpecificationRouteBackendRoutingBackendBackend; /** * (Updatable) Information around the values for selector of an authentication/ routing branch. */ key: outputs.ApiGateway.DeploymentSpecificationRouteBackendRoutingBackendKey; } interface DeploymentSpecificationRouteBackendRoutingBackendBackend { /** * The body of the stock response from the mock backend. */ body: string; /** * Defines a timeout for establishing a connection with a proxied server. */ connectTimeoutInSeconds: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * The List of Headers */ headers: outputs.ApiGateway.DeploymentSpecificationRouteBackendRoutingBackendBackendHeader[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * Defines a timeout for reading a response from the proxied server. */ readTimeoutInSeconds: number; /** * Defines a timeout for transmitting a request to the proxied server. */ sendTimeoutInSeconds: number; /** * The status code of the stock response from the mock backend. */ status: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The url of the HTTP Backend */ url: string; } interface DeploymentSpecificationRouteBackendRoutingBackendBackendHeader { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Value of the header. */ value: string; } interface DeploymentSpecificationRouteBackendRoutingBackendKey { /** * (Updatable) String describing the expression with wildcards. */ expression: string; /** * (Updatable) Information regarding whether this is the default branch. */ isDefault: boolean; /** * (Updatable) Name assigned to the branch. */ name: string; /** * (Updatable) Information regarding type of the selection key. */ type: string; /** * (Updatable) Information regarding the set of values of selector for which this branch should be selected. */ values: string[]; } interface DeploymentSpecificationRouteBackendSelectionSource { /** * (Updatable) String describing the context variable used as selector. */ selector: string; /** * (Updatable) Type of the Selection source to use. */ type: string; } interface DeploymentSpecificationRouteLoggingPolicies { /** * (Updatable) Configures the logging policies for the access logs of an API Deployment. */ accessLog: outputs.ApiGateway.DeploymentSpecificationRouteLoggingPoliciesAccessLog; /** * (Updatable) Configures the logging policies for the execution logs of an API Deployment. */ executionLog: outputs.ApiGateway.DeploymentSpecificationRouteLoggingPoliciesExecutionLog; } interface DeploymentSpecificationRouteLoggingPoliciesAccessLog { /** * (Updatable) Enables pushing of access logs to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket. * * Oracle 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. * * Please 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. */ isEnabled: boolean; } interface DeploymentSpecificationRouteLoggingPoliciesExecutionLog { /** * (Updatable) Enables pushing of execution logs to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket. * * Oracle 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. * * Please 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. */ isEnabled: boolean; /** * (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. */ logLevel: string; } interface DeploymentSpecificationRouteRequestPolicies { /** * (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. */ authorization: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesAuthorization; /** * (Updatable) Validate the payload body of the incoming API requests on a specific route. */ bodyValidation: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesBodyValidation; /** * (Updatable) Enable CORS (Cross-Origin-Resource-Sharing) request handling. */ cors: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesCors; /** * (Updatable) A set of transformations to apply to HTTP headers that pass through the gateway. */ headerTransformations: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformations; /** * (Updatable) Validate the HTTP headers on the incoming API requests on a specific route. */ headerValidations: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesHeaderValidations; /** * (Updatable) A set of transformations to apply to query parameters that pass through the gateway. */ queryParameterTransformations: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations; /** * (Updatable) Validate the URL query parameters on the incoming API requests on a specific route. */ queryParameterValidations: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations; /** * (Updatable) Base policy for Response Cache lookup. */ responseCacheLookup: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup; } interface DeploymentSpecificationRouteRequestPoliciesAuthorization { /** * (Updatable) A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive. */ allowedScopes: string[]; /** * (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. */ type: string; } interface DeploymentSpecificationRouteRequestPoliciesBodyValidation { /** * (Updatable) The content of the request body. */ contents: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesBodyValidationContent[]; /** * (Updatable) Determines if the request body is required in the request. */ required: boolean; /** * (Updatable) Validation behavior mode. * * In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. * * In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request will follow the normal path. * * `DISABLED` type turns the validation off. */ validationMode: string; } interface DeploymentSpecificationRouteRequestPoliciesBodyValidationContent { /** * (Updatable) The mediaType is a [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema * * mediaType ::= ( / ( "*" "/" "*" ) / ( type "/" "*" ) / ( type "/" subtype ) ) * * For requests that match multiple media types, only the most specific media type is applicable. e.g. `text/plain` overrides `text/*` */ mediaType: string; /** * (Updatable) Validation type defines the content validation method. * * Make the validation to first parse the body as the respective format. */ validationType: string; } interface DeploymentSpecificationRouteRequestPoliciesCors { /** * (Updatable) The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. */ allowedHeaders: string[]; /** * (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. */ allowedMethods: string[]; /** * (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. */ allowedOrigins: string[]; /** * (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. */ exposedHeaders: string[]; /** * (Updatable) Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. */ isAllowCredentialsEnabled: boolean; /** * (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. */ maxAgeInSeconds: number; } interface DeploymentSpecificationRouteRequestPoliciesHeaderTransformations { /** * (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. */ filterHeaders: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders; /** * (Updatable) Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders; /** * (Updatable) Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders; } interface DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem[]; /** * (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. */ type: string; } interface DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem { /** * (Updatable) The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItem[]; } interface DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItem { /** * (Updatable) The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * (Updatable) The new name of the header. This name must be unique across transformation policies. */ to: string; } interface DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItem[]; } interface DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItem { /** * (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. */ ifExists: string; /** * (Updatable) The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * (Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface DeploymentSpecificationRouteRequestPoliciesHeaderValidations { /** * (Updatable) The List of Headers */ headers: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeader[]; /** * (Updatable) Validation behavior mode. * * In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. * * In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request will follow the normal path. * * `DISABLED` type turns the validation off. */ validationMode: string; } interface DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeader { /** * (Updatable) Parameter name. */ name: string; /** * (Updatable) Determines if the header is required in the request. */ required: boolean; } interface DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations { /** * (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. */ filterQueryParameters: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters; /** * (Updatable) Rename parameters on the query string as they pass through the gateway. */ renameQueryParameters: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters; /** * (Updatable) Set parameters on the query string as they pass through the gateway. */ setQueryParameters: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters; } interface DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters { /** * (Updatable) The list of query parameters. */ items: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem[]; /** * (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. */ type: string; } interface DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem { /** * (Updatable) The case-sensitive name of the query parameter. */ name: string; } interface DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters { /** * (Updatable) The list of query parameters. */ items: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItem[]; } interface DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItem { /** * (Updatable) The original case-sensitive name of the query parameter. This name must be unique across transformation policies. */ from: string; /** * (Updatable) The new name of the query parameter. This name must be unique across transformation policies. */ to: string; } interface DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters { /** * (Updatable) The list of query parameters. */ items: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItem[]; } interface DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItem { /** * (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. */ ifExists: string; /** * (Updatable) The case-sensitive name of the query parameter. This name must be unique across transformation policies. */ name: string; /** * (Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations { /** * (Updatable) The List of Query Parameters */ parameters: outputs.ApiGateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameter[]; /** * (Updatable) Validation behavior mode. * * In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend. * * In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request will follow the normal path. * * `DISABLED` type turns the validation off. */ validationMode: string; } interface DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameter { /** * (Updatable) Parameter name. */ name: string; /** * (Updatable) Determines if the parameter is required in the request. */ required: boolean; } interface DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup { /** * (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. */ cacheKeyAdditions: string[]; /** * (Updatable) Whether this policy is currently enabled. */ isEnabled: boolean; /** * (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. * * When false, any request with an Authorization header will not be stored in the Response Cache. * * If using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check. */ isPrivateCachingEnabled: boolean; /** * (Updatable) Type of the Response Cache Store Policy. */ type: string; } interface DeploymentSpecificationRouteResponsePolicies { /** * (Updatable) A set of transformations to apply to HTTP headers that pass through the gateway. */ headerTransformations: outputs.ApiGateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformations; /** * (Updatable) Base policy for how a response from a backend is cached in the Response Cache. */ responseCacheStore: outputs.ApiGateway.DeploymentSpecificationRouteResponsePoliciesResponseCacheStore; } interface DeploymentSpecificationRouteResponsePoliciesHeaderTransformations { /** * (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. */ filterHeaders: outputs.ApiGateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders; /** * (Updatable) Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders; /** * (Updatable) Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders; } interface DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem[]; /** * (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. */ type: string; } interface DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem { /** * (Updatable) The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItem[]; } interface DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItem { /** * (Updatable) The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * (Updatable) The new name of the header. This name must be unique across transformation policies. */ to: string; } interface DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders { /** * (Updatable) The list of headers. */ items: outputs.ApiGateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItem[]; } interface DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItem { /** * (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. */ ifExists: string; /** * (Updatable) The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * (Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface DeploymentSpecificationRouteResponsePoliciesResponseCacheStore { /** * (Updatable) Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires. */ timeToLiveInSeconds: number; /** * (Updatable) Type of the Response Cache Store Policy. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface GatewayCaBundle { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ caBundleId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ certificateAuthorityId: string; /** * (Updatable) Type of the CA bundle */ type: string; } interface GatewayIpAddress { /** * An IP address. */ ipAddress: string; } interface GatewayIpv4addressConfiguration { /** * List of Reserved IP OCIDs created in VCN service. */ reservedIpIds: string[]; } interface GatewayIpv6addressConfiguration { /** * List of IPv6 addresses that will be assigned to the gateway during creation. */ addresses: string[]; /** * List of IPv6 prefixes from which to provision IPv6 addresses from. This is required if more than one prefix exists on the subnet. */ subnetCidrs: string[]; } interface GatewayLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GatewayResponseCacheDetails { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ authenticationSecretId: string; /** * (Updatable) The version number of the authentication secret to use. */ authenticationSecretVersionNumber: string; /** * (Updatable) Defines the timeout for establishing a connection with the Response Cache. */ connectTimeoutInMs: number; /** * (Updatable) Defines if the connection should be over SSL. */ isSslEnabled: boolean; /** * (Updatable) Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * (Updatable) Defines the timeout for reading data from the Response Cache. */ readTimeoutInMs: number; /** * (Updatable) Defines the timeout for transmitting data to the Response Cache. */ sendTimeoutInMs: number; /** * (Updatable) The set of cache store members to connect to. At present only a single server is supported. */ servers: outputs.ApiGateway.GatewayResponseCacheDetailsServer[]; /** * (Updatable) Type of the Response Cache. */ type: string; } interface GatewayResponseCacheDetailsServer { /** * (Updatable) Hostname or IP address (IPv4 only) where the cache store is running. */ host: string; /** * (Updatable) The port the cache store is exposed on. */ port: number; } interface GetApiDeploymentSpecificationLoggingPolicy { /** * Configures the logging policies for the access logs of an API Deployment. */ accessLogs: outputs.ApiGateway.GetApiDeploymentSpecificationLoggingPolicyAccessLog[]; /** * Configures the logging policies for the execution logs of an API Deployment. */ executionLogs: outputs.ApiGateway.GetApiDeploymentSpecificationLoggingPolicyExecutionLog[]; } interface GetApiDeploymentSpecificationLoggingPolicyAccessLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; } interface GetApiDeploymentSpecificationLoggingPolicyExecutionLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; /** * 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. */ logLevel: string; } interface GetApiDeploymentSpecificationRequestPolicy { /** * Information on how to authenticate incoming requests. */ authentications: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthentication[]; /** * Enable CORS (Cross-Origin-Resource-Sharing) request handling. */ cors: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyCor[]; /** * 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. */ dynamicAuthentications: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthentication[]; /** * Properties used to configure client mTLS verification when API Consumer makes connection to the gateway. */ mutualTls: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyMutualTl[]; /** * Limit the number of requests that should be handled for the specified window using a specfic key. */ rateLimitings: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyRateLimiting[]; /** * Usage plan policies for this deployment */ usagePlans: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyUsagePlan[]; } interface GetApiDeploymentSpecificationRequestPolicyAuthentication { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of keys from "parameters" attribute value whose values will be added to the cache key. */ cacheKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. */ isAnonymousAccessAllowed: boolean; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * The maximum expected time difference between the system clocks of the token issuer and the API Gateway. */ maxClockSkewInSeconds: number; /** * The List of Query Parameters */ parameters: { [key: string]: string; }; /** * A set of Public Keys that will be used to verify the JWT signature. */ publicKeys: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey[]; /** * The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. */ tokenAuthScheme: string; /** * The name of the header containing the authentication token. */ tokenHeader: string; /** * The name of the query parameter containing the authentication token. */ tokenQueryParam: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * Policy for defining behaviour on validation failure. */ validationFailurePolicies: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy[]; /** * Authentication Policies for the Token Authentication types. */ validationPolicies: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim[]; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey { /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy { /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail[]; /** * The path to be used as fallback after OAuth2. */ fallbackRedirectPath: string; /** * 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. */ loginPath: string; /** * The path to be used as logout. */ logoutPath: string; /** * The duration for which the OAuth2 success token should be cached before it is fetched again. */ maxExpiryDurationInHours: number; /** * HTTP response code, can include context variables. */ responseCode: string; /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ responseHeaderTransformations: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation[]; /** * HTTP response message. */ responseMessage: string; /** * Response Type. */ responseType: string; /** * List of scopes. */ scopes: string[]; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * Defines whether or not to use cookies for OAuth2 intermediate steps. */ useCookiesForIntermediateSteps: boolean; /** * Defines whether or not to use cookies for session maintenance. */ useCookiesForSession: boolean; /** * Defines whether or not to support PKCE. */ usePkce: boolean; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader[]; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem[]; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem[]; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy { /** * Additional JWT validation checks. */ additionalValidationPolicies: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy[]; /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim[]; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRequestPolicyCor { /** * The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. */ allowedHeaders: string[]; /** * 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. */ allowedMethods: string[]; /** * 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. */ allowedOrigins: string[]; /** * 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. */ exposedHeaders: string[]; /** * Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. */ isAllowCredentialsEnabled: boolean; /** * The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. */ maxAgeInSeconds: number; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthentication { /** * List of authentication servers to choose from during dynamic authentication. */ authenticationServers: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer[]; /** * Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication. */ selectionSources: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer { /** * Information on how to authenticate incoming requests. */ authenticationServerDetails: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail[]; /** * Information around the values for selector of an authentication/ routing branch. */ keys: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of keys from "parameters" attribute value whose values will be added to the cache key. */ cacheKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. */ isAnonymousAccessAllowed: boolean; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * The maximum expected time difference between the system clocks of the token issuer and the API Gateway. */ maxClockSkewInSeconds: number; /** * The List of Query Parameters */ parameters: { [key: string]: string; }; /** * A set of Public Keys that will be used to verify the JWT signature. */ publicKeys: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey[]; /** * The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. */ tokenAuthScheme: string; /** * The name of the header containing the authentication token. */ tokenHeader: string; /** * The name of the query parameter containing the authentication token. */ tokenQueryParam: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * Policy for defining behaviour on validation failure. */ validationFailurePolicies: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy[]; /** * Authentication Policies for the Token Authentication types. */ validationPolicies: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey { /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy { /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail[]; /** * The path to be used as fallback after OAuth2. */ fallbackRedirectPath: string; /** * 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. */ loginPath: string; /** * The path to be used as logout. */ logoutPath: string; /** * The duration for which the OAuth2 success token should be cached before it is fetched again. */ maxExpiryDurationInHours: number; /** * HTTP response code, can include context variables. */ responseCode: string; /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ responseHeaderTransformations: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation[]; /** * HTTP response message. */ responseMessage: string; /** * Response Type. */ responseType: string; /** * List of scopes. */ scopes: string[]; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * Defines whether or not to use cookies for OAuth2 intermediate steps. */ useCookiesForIntermediateSteps: boolean; /** * Defines whether or not to use cookies for session maintenance. */ useCookiesForSession: boolean; /** * Defines whether or not to support PKCE. */ usePkce: boolean; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy { /** * Additional JWT validation checks. */ additionalValidationPolicies: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy[]; /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey { /** * String describing the expression with wildcards. */ expression: string; /** * Information regarding whether this is the default branch. */ isDefault: boolean; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource { /** * String describing the context variable used as selector. */ selector: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRequestPolicyMutualTl { /** * Allowed list of CN or SAN which will be used for verification of certificate. */ allowedSans: string[]; /** * Determines whether to enable client verification when API Consumer makes connection to the gateway. */ isVerifiedCertificateRequired: boolean; } interface GetApiDeploymentSpecificationRequestPolicyRateLimiting { /** * The maximum number of requests per second to allow. */ rateInRequestsPerSecond: number; /** * The key used to group requests together. */ rateKey: string; } interface GetApiDeploymentSpecificationRequestPolicyUsagePlan { /** * A list of context variables specifying where API tokens may be located in a request. Example locations: * * "request.headers[token]" * * "request.query[token]" * * "request.auth[Token]" * * "request.path[TOKEN]" */ tokenLocations: string[]; } interface GetApiDeploymentSpecificationRoute { /** * The backend to forward requests to. */ backends: outputs.ApiGateway.GetApiDeploymentSpecificationRouteBackend[]; /** * Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging. */ loggingPolicies: outputs.ApiGateway.GetApiDeploymentSpecificationRouteLoggingPolicy[]; /** * A list of allowed methods on this route. */ methods: string[]; /** * 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. */ path: string; /** * Behavior applied to any requests received by the API on this route. */ requestPolicies: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicy[]; /** * Behavior applied to any responses sent by the API for requests on this route. */ responsePolicies: outputs.ApiGateway.GetApiDeploymentSpecificationRouteResponsePolicy[]; } interface GetApiDeploymentSpecificationRouteBackend { /** * A list of allowed post-logout URLs to which a request can be redirected after revoke access */ allowedPostLogoutUris: string[]; /** * The body of the stock response from the mock backend. */ body: string; /** * Defines a timeout for establishing a connection with a proxied server. */ connectTimeoutInSeconds: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * The List of Headers */ headers: outputs.ApiGateway.GetApiDeploymentSpecificationRouteBackendHeader[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * Defines a state that should be shared on redirecting to postLogout URL. */ postLogoutState: string; /** * Defines a timeout for reading a response from the proxied server. */ readTimeoutInSeconds: number; /** * List of backends to chose from for Dynamic Routing. */ routingBackends: outputs.ApiGateway.GetApiDeploymentSpecificationRouteBackendRoutingBackend[]; /** * Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication. */ selectionSources: outputs.ApiGateway.GetApiDeploymentSpecificationRouteBackendSelectionSource[]; /** * Defines a timeout for transmitting a request to the proxied server. */ sendTimeoutInSeconds: number; /** * The status code of the stock response from the mock backend. */ status: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The url of the HTTP Backend */ url: string; } interface GetApiDeploymentSpecificationRouteBackendHeader { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Value of the header. */ value: string; } interface GetApiDeploymentSpecificationRouteBackendRoutingBackend { /** * The backend to forward requests to. */ backends: outputs.ApiGateway.GetApiDeploymentSpecificationRouteBackendRoutingBackendBackend[]; /** * Information around the values for selector of an authentication/ routing branch. */ keys: outputs.ApiGateway.GetApiDeploymentSpecificationRouteBackendRoutingBackendKey[]; } interface GetApiDeploymentSpecificationRouteBackendRoutingBackendBackend { /** * The body of the stock response from the mock backend. */ body: string; /** * Defines a timeout for establishing a connection with a proxied server. */ connectTimeoutInSeconds: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * The List of Headers */ headers: outputs.ApiGateway.GetApiDeploymentSpecificationRouteBackendRoutingBackendBackendHeader[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * Defines a timeout for reading a response from the proxied server. */ readTimeoutInSeconds: number; /** * Defines a timeout for transmitting a request to the proxied server. */ sendTimeoutInSeconds: number; /** * The status code of the stock response from the mock backend. */ status: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The url of the HTTP Backend */ url: string; } interface GetApiDeploymentSpecificationRouteBackendRoutingBackendBackendHeader { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Value of the header. */ value: string; } interface GetApiDeploymentSpecificationRouteBackendRoutingBackendKey { /** * String describing the expression with wildcards. */ expression: string; /** * Information regarding whether this is the default branch. */ isDefault: boolean; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRouteBackendSelectionSource { /** * String describing the context variable used as selector. */ selector: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRouteLoggingPolicy { /** * Configures the logging policies for the access logs of an API Deployment. */ accessLogs: outputs.ApiGateway.GetApiDeploymentSpecificationRouteLoggingPolicyAccessLog[]; /** * Configures the logging policies for the execution logs of an API Deployment. */ executionLogs: outputs.ApiGateway.GetApiDeploymentSpecificationRouteLoggingPolicyExecutionLog[]; } interface GetApiDeploymentSpecificationRouteLoggingPolicyAccessLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; } interface GetApiDeploymentSpecificationRouteLoggingPolicyExecutionLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; /** * 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. */ logLevel: string; } interface GetApiDeploymentSpecificationRouteRequestPolicy { /** * 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. */ authorizations: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyAuthorization[]; /** * Validate the payload body of the incoming API requests on a specific route. */ bodyValidations: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyBodyValidation[]; /** * Enable CORS (Cross-Origin-Resource-Sharing) request handling. */ cors: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyCor[]; /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ headerTransformations: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation[]; /** * Validate the HTTP headers on the incoming API requests on a specific route. */ headerValidations: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidation[]; /** * A set of transformations to apply to query parameters that pass through the gateway. */ queryParameterTransformations: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation[]; /** * Validate the URL query parameters on the incoming API requests on a specific route. */ queryParameterValidations: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation[]; /** * Base policy for Response Cache lookup. */ responseCacheLookups: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup[]; } interface GetApiDeploymentSpecificationRouteRequestPolicyAuthorization { /** * A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive. */ allowedScopes: string[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyBodyValidation { /** * The content of the request body. */ contents: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent[]; /** * Determines if the parameter is required in the request. */ required: boolean; /** * Validation behavior mode. */ validationMode: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent { /** * The media type is a [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema */ mediaType: string; /** * Validation type defines the content validation method. */ validationType: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyCor { /** * The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. */ allowedHeaders: string[]; /** * 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. */ allowedMethods: string[]; /** * 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. */ allowedOrigins: string[]; /** * 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. */ exposedHeaders: string[]; /** * Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. */ isAllowCredentialsEnabled: boolean; /** * The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. */ maxAgeInSeconds: number; } interface GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader[]; } interface GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem[]; } interface GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem[]; } interface GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidation { /** * The List of Headers */ headers: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader[]; /** * Validation behavior mode. */ validationMode: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Determines if the parameter is required in the request. */ required: boolean; } interface GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation { /** * 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. */ filterQueryParameters: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter[]; /** * Rename parameters on the query string as they pass through the gateway. */ renameQueryParameters: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter[]; /** * Set parameters on the query string as they pass through the gateway. */ setQueryParameters: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter[]; } interface GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem[]; } interface GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem[]; } interface GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation { /** * The List of Query Parameters */ parameters: outputs.ApiGateway.GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter[]; /** * Validation behavior mode. */ validationMode: string; } interface GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Determines if the parameter is required in the request. */ required: boolean; } interface GetApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup { /** * 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. */ cacheKeyAdditions: string[]; /** * Whether this policy is currently enabled. */ isEnabled: boolean; /** * 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. */ isPrivateCachingEnabled: boolean; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRouteResponsePolicy { /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ headerTransformations: outputs.ApiGateway.GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation[]; /** * Base policy for how a response from a backend is cached in the Response Cache. */ responseCacheStores: outputs.ApiGateway.GetApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore[]; } interface GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader[]; } interface GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem[]; } interface GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem[]; } interface GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore { /** * Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires. */ timeToLiveInSeconds: number; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetApiLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetApiValidationResult { /** * Name of the validation. */ name: string; /** * Result of the validation. */ result: string; } interface GetApiValidationValidation { /** * Details of validation. */ details: outputs.ApiGateway.GetApiValidationValidationDetail[]; /** * Name of the validation. */ name: string; /** * Result of the validation. */ result: string; } interface GetApiValidationValidationDetail { /** * Description of the warning/error. */ msg: string; /** * Severity of the issue. */ severity: string; /** * Position of the issue in the specification file (line, column). */ srcs: outputs.ApiGateway.GetApiValidationValidationDetailSrc[]; } interface GetApiValidationValidationDetailSrc { items: any[]; } interface GetApisApiCollection { items: outputs.ApiGateway.GetApisApiCollectionItem[]; } interface GetApisApiCollectionItem { /** * The ocid of the compartment in which to list resources. */ compartmentId: string; content: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ id: string; isLockOverride: boolean; /** * 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: * * 'New' for just updated API Specifications * * 'Validating' for a document which is being validated. * * 'Valid' the document has been validated without any errors or warnings * * 'Warning' the document has been validated and contains warnings * * 'Error' the document has been validated and contains errors * * 'Failed' the document validation failed * * 'Canceled' the document validation was canceled */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.ApiGateway.GetApisApiCollectionItemLock[]; /** * Type of API Specification file. */ specificationType: string; /** * A filter to return only resources that match the given lifecycle state. Example: `ACTIVE` */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Status of each feature available from the API. */ validationResults: outputs.ApiGateway.GetApisApiCollectionItemValidationResult[]; } interface GetApisApiCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetApisApiCollectionItemValidationResult { /** * Name of the validation. */ name: string; /** * Result of the validation. */ result: string; } interface GetApisFilter { /** * Name of the validation. */ name: string; regex?: boolean; values: string[]; } interface GetCertificateLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetCertificatesCertificateCollection { items: outputs.ApiGateway.GetCertificatesCertificateCollectionItem[]; } interface GetCertificatesCertificateCollectionItem { /** * The data of the leaf certificate in pem format. */ certificate: string; /** * The ocid of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ id: string; /** * The intermediate certificate data associated with the certificate in pem format. */ intermediateCertificates: string; isLockOverride: boolean; /** * 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. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.ApiGateway.GetCertificatesCertificateCollectionItemLock[]; privateKey: string; /** * A filter to return only resources that match the given lifecycle state. Example: `ACTIVE` or `DELETED` */ state: string; /** * The entity to be secured by the certificate and additional host names. */ subjectNames: string[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The date and time the certificate will expire. */ timeNotValidAfter: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetCertificatesCertificateCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetCertificatesFilter { name: string; regex?: boolean; values: string[]; } interface GetDeploymentLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecification { /** * Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging. */ loggingPolicies: outputs.ApiGateway.GetDeploymentSpecificationLoggingPolicy[]; /** * Behavior applied to any requests received by the API on this route. */ requestPolicies: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicy[]; /** * A list of routes that this API exposes. */ routes: outputs.ApiGateway.GetDeploymentSpecificationRoute[]; } interface GetDeploymentSpecificationLoggingPolicy { /** * Configures the logging policies for the access logs of an API Deployment. */ accessLogs: outputs.ApiGateway.GetDeploymentSpecificationLoggingPolicyAccessLog[]; /** * Configures the logging policies for the execution logs of an API Deployment. */ executionLogs: outputs.ApiGateway.GetDeploymentSpecificationLoggingPolicyExecutionLog[]; } interface GetDeploymentSpecificationLoggingPolicyAccessLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; } interface GetDeploymentSpecificationLoggingPolicyExecutionLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; /** * 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. */ logLevel: string; } interface GetDeploymentSpecificationRequestPolicy { /** * Information on how to authenticate incoming requests. */ authentications: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthentication[]; /** * Enable CORS (Cross-Origin-Resource-Sharing) request handling. */ cors: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyCor[]; /** * 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. */ dynamicAuthentications: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthentication[]; /** * Properties used to configure client mTLS verification when API Consumer makes connection to the gateway. */ mutualTls: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyMutualTl[]; /** * Limit the number of requests that should be handled for the specified window using a specfic key. */ rateLimitings: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyRateLimiting[]; /** * Usage plan policies for this deployment */ usagePlans: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyUsagePlan[]; } interface GetDeploymentSpecificationRequestPolicyAuthentication { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of keys from "parameters" attribute value whose values will be added to the cache key. */ cacheKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. */ isAnonymousAccessAllowed: boolean; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * The maximum expected time difference between the system clocks of the token issuer and the API Gateway. */ maxClockSkewInSeconds: number; /** * The List of Query Parameters */ parameters: { [key: string]: string; }; /** * A set of Public Keys that will be used to verify the JWT signature. */ publicKeys: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey[]; /** * The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. */ tokenAuthScheme: string; /** * The name of the header containing the authentication token. */ tokenHeader: string; /** * The name of the query parameter containing the authentication token. */ tokenQueryParam: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * Policy for defining behaviour on validation failure. */ validationFailurePolicies: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy[]; /** * Authentication Policies for the Token Authentication types. */ validationPolicies: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim[]; } interface GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey { /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy { /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail[]; /** * The path to be used as fallback after OAuth2. */ fallbackRedirectPath: string; /** * 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. */ loginPath: string; /** * The path to be used as logout. */ logoutPath: string; /** * The duration for which the OAuth2 success token should be cached before it is fetched again. */ maxExpiryDurationInHours: number; /** * HTTP response code, can include context variables. */ responseCode: string; /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ responseHeaderTransformations: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation[]; /** * HTTP response message. */ responseMessage: string; /** * Response Type. */ responseType: string; /** * List of scopes. */ scopes: string[]; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * Defines whether or not to use cookies for OAuth2 intermediate steps. */ useCookiesForIntermediateSteps: boolean; /** * Defines whether or not to use cookies for session maintenance. */ useCookiesForSession: boolean; /** * Defines whether or not to support PKCE. */ usePkce: boolean; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader[]; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem[]; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem[]; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy { /** * Additional JWT validation checks. */ additionalValidationPolicies: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy[]; /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim[]; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRequestPolicyCor { /** * The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. */ allowedHeaders: string[]; /** * 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. */ allowedMethods: string[]; /** * 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. */ allowedOrigins: string[]; /** * 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. */ exposedHeaders: string[]; /** * Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. */ isAllowCredentialsEnabled: boolean; /** * The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. */ maxAgeInSeconds: number; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthentication { /** * List of authentication servers to choose from during dynamic authentication. */ authenticationServers: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer[]; /** * Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication. */ selectionSources: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer { /** * Information on how to authenticate incoming requests. */ authenticationServerDetails: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail[]; /** * Information around the values for selector of an authentication/ routing branch. */ keys: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of keys from "parameters" attribute value whose values will be added to the cache key. */ cacheKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. */ isAnonymousAccessAllowed: boolean; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * The maximum expected time difference between the system clocks of the token issuer and the API Gateway. */ maxClockSkewInSeconds: number; /** * The List of Query Parameters */ parameters: { [key: string]: string; }; /** * A set of Public Keys that will be used to verify the JWT signature. */ publicKeys: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey[]; /** * The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. */ tokenAuthScheme: string; /** * The name of the header containing the authentication token. */ tokenHeader: string; /** * The name of the query parameter containing the authentication token. */ tokenQueryParam: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * Policy for defining behaviour on validation failure. */ validationFailurePolicies: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy[]; /** * Authentication Policies for the Token Authentication types. */ validationPolicies: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey { /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy { /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail[]; /** * The path to be used as fallback after OAuth2. */ fallbackRedirectPath: string; /** * 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. */ loginPath: string; /** * The path to be used as logout. */ logoutPath: string; /** * The duration for which the OAuth2 success token should be cached before it is fetched again. */ maxExpiryDurationInHours: number; /** * HTTP response code, can include context variables. */ responseCode: string; /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ responseHeaderTransformations: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation[]; /** * HTTP response message. */ responseMessage: string; /** * Response Type. */ responseType: string; /** * List of scopes. */ scopes: string[]; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * Defines whether or not to use cookies for OAuth2 intermediate steps. */ useCookiesForIntermediateSteps: boolean; /** * Defines whether or not to use cookies for session maintenance. */ useCookiesForSession: boolean; /** * Defines whether or not to support PKCE. */ usePkce: boolean; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy { /** * Additional JWT validation checks. */ additionalValidationPolicies: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy[]; /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey { /** * String describing the expression with wildcards. */ expression: string; /** * Information regarding whether this is the default branch. */ isDefault: boolean; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource { /** * String describing the context variable used as selector. */ selector: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRequestPolicyMutualTl { /** * Allowed list of CN or SAN which will be used for verification of certificate. */ allowedSans: string[]; /** * Determines whether to enable client verification when API Consumer makes connection to the gateway. */ isVerifiedCertificateRequired: boolean; } interface GetDeploymentSpecificationRequestPolicyRateLimiting { /** * The maximum number of requests per second to allow. */ rateInRequestsPerSecond: number; /** * The key used to group requests together. */ rateKey: string; } interface GetDeploymentSpecificationRequestPolicyUsagePlan { /** * A list of context variables specifying where API tokens may be located in a request. Example locations: * * "request.headers[token]" * * "request.query[token]" * * "request.auth[Token]" * * "request.path[TOKEN]" */ tokenLocations: string[]; } interface GetDeploymentSpecificationRoute { /** * The backend to forward requests to. */ backends: outputs.ApiGateway.GetDeploymentSpecificationRouteBackend[]; /** * Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging. */ loggingPolicies: outputs.ApiGateway.GetDeploymentSpecificationRouteLoggingPolicy[]; /** * A list of allowed methods on this route. */ methods: string[]; /** * 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. */ path: string; /** * Behavior applied to any requests received by the API on this route. */ requestPolicies: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicy[]; /** * Behavior applied to any responses sent by the API for requests on this route. */ responsePolicies: outputs.ApiGateway.GetDeploymentSpecificationRouteResponsePolicy[]; } interface GetDeploymentSpecificationRouteBackend { /** * A list of allowed post-logout URLs to which a request can be redirected after revoke access */ allowedPostLogoutUris: string[]; /** * The body of the stock response from the mock backend. */ body: string; /** * Defines a timeout for establishing a connection with a proxied server. */ connectTimeoutInSeconds: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * The List of Headers */ headers: outputs.ApiGateway.GetDeploymentSpecificationRouteBackendHeader[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * Defines a state that should be shared on redirecting to postLogout URL. */ postLogoutState: string; /** * Defines a timeout for reading a response from the proxied server. */ readTimeoutInSeconds: number; /** * List of backends to chose from for Dynamic Routing. */ routingBackends: outputs.ApiGateway.GetDeploymentSpecificationRouteBackendRoutingBackend[]; /** * Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication. */ selectionSources: outputs.ApiGateway.GetDeploymentSpecificationRouteBackendSelectionSource[]; /** * Defines a timeout for transmitting a request to the proxied server. */ sendTimeoutInSeconds: number; /** * The status code of the stock response from the mock backend. */ status: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The url of the HTTP Backend */ url: string; } interface GetDeploymentSpecificationRouteBackendHeader { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Value of the header. */ value: string; } interface GetDeploymentSpecificationRouteBackendRoutingBackend { /** * The backend to forward requests to. */ backends: outputs.ApiGateway.GetDeploymentSpecificationRouteBackendRoutingBackendBackend[]; /** * Information around the values for selector of an authentication/ routing branch. */ keys: outputs.ApiGateway.GetDeploymentSpecificationRouteBackendRoutingBackendKey[]; } interface GetDeploymentSpecificationRouteBackendRoutingBackendBackend { /** * The body of the stock response from the mock backend. */ body: string; /** * Defines a timeout for establishing a connection with a proxied server. */ connectTimeoutInSeconds: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * The List of Headers */ headers: outputs.ApiGateway.GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * Defines a timeout for reading a response from the proxied server. */ readTimeoutInSeconds: number; /** * Defines a timeout for transmitting a request to the proxied server. */ sendTimeoutInSeconds: number; /** * The status code of the stock response from the mock backend. */ status: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The url of the HTTP Backend */ url: string; } interface GetDeploymentSpecificationRouteBackendRoutingBackendBackendHeader { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Value of the header. */ value: string; } interface GetDeploymentSpecificationRouteBackendRoutingBackendKey { /** * String describing the expression with wildcards. */ expression: string; /** * Information regarding whether this is the default branch. */ isDefault: boolean; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRouteBackendSelectionSource { /** * String describing the context variable used as selector. */ selector: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRouteLoggingPolicy { /** * Configures the logging policies for the access logs of an API Deployment. */ accessLogs: outputs.ApiGateway.GetDeploymentSpecificationRouteLoggingPolicyAccessLog[]; /** * Configures the logging policies for the execution logs of an API Deployment. */ executionLogs: outputs.ApiGateway.GetDeploymentSpecificationRouteLoggingPolicyExecutionLog[]; } interface GetDeploymentSpecificationRouteLoggingPolicyAccessLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; } interface GetDeploymentSpecificationRouteLoggingPolicyExecutionLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; /** * 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. */ logLevel: string; } interface GetDeploymentSpecificationRouteRequestPolicy { /** * 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. */ authorizations: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyAuthorization[]; /** * Validate the payload body of the incoming API requests on a specific route. */ bodyValidations: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyBodyValidation[]; /** * Enable CORS (Cross-Origin-Resource-Sharing) request handling. */ cors: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyCor[]; /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ headerTransformations: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation[]; /** * Validate the HTTP headers on the incoming API requests on a specific route. */ headerValidations: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyHeaderValidation[]; /** * A set of transformations to apply to query parameters that pass through the gateway. */ queryParameterTransformations: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation[]; /** * Validate the URL query parameters on the incoming API requests on a specific route. */ queryParameterValidations: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation[]; /** * Base policy for Response Cache lookup. */ responseCacheLookups: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup[]; } interface GetDeploymentSpecificationRouteRequestPolicyAuthorization { /** * A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive. */ allowedScopes: string[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRouteRequestPolicyBodyValidation { /** * The content of the request body. */ contents: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent[]; /** * Determines if the parameter is required in the request. */ required: boolean; /** * Validation behavior mode. */ validationMode: string; } interface GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent { /** * The media type is a [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema */ mediaType: string; /** * Validation type defines the content validation method. */ validationType: string; } interface GetDeploymentSpecificationRouteRequestPolicyCor { /** * The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. */ allowedHeaders: string[]; /** * 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. */ allowedMethods: string[]; /** * 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. */ allowedOrigins: string[]; /** * 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. */ exposedHeaders: string[]; /** * Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. */ isAllowCredentialsEnabled: boolean; /** * The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. */ maxAgeInSeconds: number; } interface GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader[]; } interface GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem[]; } interface GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem[]; } interface GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRouteRequestPolicyHeaderValidation { /** * The List of Headers */ headers: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader[]; /** * Validation behavior mode. */ validationMode: string; } interface GetDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Determines if the parameter is required in the request. */ required: boolean; } interface GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation { /** * 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. */ filterQueryParameters: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter[]; /** * Rename parameters on the query string as they pass through the gateway. */ renameQueryParameters: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter[]; /** * Set parameters on the query string as they pass through the gateway. */ setQueryParameters: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter[]; } interface GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem[]; } interface GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem[]; } interface GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation { /** * The List of Query Parameters */ parameters: outputs.ApiGateway.GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter[]; /** * Validation behavior mode. */ validationMode: string; } interface GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Determines if the parameter is required in the request. */ required: boolean; } interface GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup { /** * 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. */ cacheKeyAdditions: string[]; /** * Whether this policy is currently enabled. */ isEnabled: boolean; /** * 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. */ isPrivateCachingEnabled: boolean; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRouteResponsePolicy { /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ headerTransformations: outputs.ApiGateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformation[]; /** * Base policy for how a response from a backend is cached in the Response Cache. */ responseCacheStores: outputs.ApiGateway.GetDeploymentSpecificationRouteResponsePolicyResponseCacheStore[]; } interface GetDeploymentSpecificationRouteResponsePolicyHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader[]; } interface GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem[]; } interface GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem[]; } interface GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentSpecificationRouteResponsePolicyResponseCacheStore { /** * Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires. */ timeToLiveInSeconds: number; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollection { /** * The ocid of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; /** * The endpoint to access this deployment on the gateway. */ endpoint: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter deployments by the gateway ocid. */ gatewayId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ id: string; isLockOverride: boolean; /** * 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. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.ApiGateway.GetDeploymentsDeploymentCollectionLock[]; /** * 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). */ pathPrefix: string; /** * The logical configuration of the API exposed by a deployment. */ specifications: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecification[]; /** * A filter to return only resources that match the given lifecycle state. Example: `SUCCEEDED` */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetDeploymentsDeploymentCollectionLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecification { /** * Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging. */ loggingPolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationLoggingPolicy[]; /** * Behavior applied to any requests received by the API on this route. */ requestPolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicy[]; /** * A list of routes that this API exposes. */ routes: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRoute[]; } interface GetDeploymentsDeploymentCollectionSpecificationLoggingPolicy { /** * Configures the logging policies for the access logs of an API Deployment. */ accessLogs: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationLoggingPolicyAccessLog[]; /** * Configures the logging policies for the execution logs of an API Deployment. */ executionLogs: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationLoggingPolicyExecutionLog[]; } interface GetDeploymentsDeploymentCollectionSpecificationLoggingPolicyAccessLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; } interface GetDeploymentsDeploymentCollectionSpecificationLoggingPolicyExecutionLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; /** * 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. */ logLevel: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicy { /** * Information on how to authenticate incoming requests. */ authentications: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthentication[]; /** * Enable CORS (Cross-Origin-Resource-Sharing) request handling. */ cors: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyCor[]; /** * 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. */ dynamicAuthentications: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthentication[]; /** * Properties used to configure client mTLS verification when API Consumer makes connection to the gateway. */ mutualTls: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyMutualTl[]; /** * Limit the number of requests that should be handled for the specified window using a specfic key. */ rateLimitings: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyRateLimiting[]; /** * Usage plan policies for this deployment */ usagePlans: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyUsagePlan[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthentication { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of keys from "parameters" attribute value whose values will be added to the cache key. */ cacheKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. */ isAnonymousAccessAllowed: boolean; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * The maximum expected time difference between the system clocks of the token issuer and the API Gateway. */ maxClockSkewInSeconds: number; /** * The List of Query Parameters */ parameters: { [key: string]: string; }; /** * A set of Public Keys that will be used to verify the JWT signature. */ publicKeys: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKey[]; /** * The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. */ tokenAuthScheme: string; /** * The name of the header containing the authentication token. */ tokenHeader: string; /** * The name of the query parameter containing the authentication token. */ tokenQueryParam: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * Policy for defining behaviour on validation failure. */ validationFailurePolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicy[]; /** * Authentication Policies for the Token Authentication types. */ validationPolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicy[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationVerifyClaim[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKey { /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKeyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKeyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicy { /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail[]; /** * The path to be used as fallback after OAuth2. */ fallbackRedirectPath: string; /** * 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. */ loginPath: string; /** * The path to be used as logout. */ logoutPath: string; /** * The duration for which the OAuth2 success token should be cached before it is fetched again. */ maxExpiryDurationInHours: number; /** * HTTP response code, can include context variables. */ responseCode: string; /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ responseHeaderTransformations: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation[]; /** * HTTP response message. */ responseMessage: string; /** * Response Type. */ responseType: string; /** * List of scopes. */ scopes: string[]; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * Defines whether or not to use cookies for OAuth2 intermediate steps. */ useCookiesForIntermediateSteps: boolean; /** * Defines whether or not to use cookies for session maintenance. */ useCookiesForSession: boolean; /** * Defines whether or not to support PKCE. */ usePkce: boolean; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicy { /** * Additional JWT validation checks. */ additionalValidationPolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy[]; /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyCor { /** * The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. */ allowedHeaders: string[]; /** * 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. */ allowedMethods: string[]; /** * 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. */ allowedOrigins: string[]; /** * 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. */ exposedHeaders: string[]; /** * Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. */ isAllowCredentialsEnabled: boolean; /** * The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. */ maxAgeInSeconds: number; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthentication { /** * List of authentication servers to choose from during dynamic authentication. */ authenticationServers: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer[]; /** * Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication. */ selectionSources: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationSelectionSource[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer { /** * Information on how to authenticate incoming requests. */ authenticationServerDetails: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail[]; /** * Information around the values for selector of an authentication/ routing branch. */ keys: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of keys from "parameters" attribute value whose values will be added to the cache key. */ cacheKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization. */ isAnonymousAccessAllowed: boolean; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * The maximum expected time difference between the system clocks of the token issuer and the API Gateway. */ maxClockSkewInSeconds: number; /** * The List of Query Parameters */ parameters: { [key: string]: string; }; /** * A set of Public Keys that will be used to verify the JWT signature. */ publicKeys: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey[]; /** * The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified. */ tokenAuthScheme: string; /** * The name of the header containing the authentication token. */ tokenHeader: string; /** * The name of the query parameter containing the authentication token. */ tokenQueryParam: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * Policy for defining behaviour on validation failure. */ validationFailurePolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy[]; /** * Authentication Policies for the Token Authentication types. */ validationPolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey { /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy { /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail[]; /** * The path to be used as fallback after OAuth2. */ fallbackRedirectPath: string; /** * 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. */ loginPath: string; /** * The path to be used as logout. */ logoutPath: string; /** * The duration for which the OAuth2 success token should be cached before it is fetched again. */ maxExpiryDurationInHours: number; /** * HTTP response code, can include context variables. */ responseCode: string; /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ responseHeaderTransformations: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation[]; /** * HTTP response message. */ responseMessage: string; /** * Response Type. */ responseType: string; /** * List of scopes. */ scopes: string[]; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * Defines whether or not to use cookies for OAuth2 intermediate steps. */ useCookiesForIntermediateSteps: boolean; /** * Defines whether or not to use cookies for session maintenance. */ useCookiesForSession: boolean; /** * Defines whether or not to support PKCE. */ usePkce: boolean; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy { /** * Additional JWT validation checks. */ additionalValidationPolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy[]; /** * Client App Credential details. */ clientDetails: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * The set of static public keys. */ keys: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey[]; /** * The duration for which the introspect URL response should be cached before it is fetched again. */ maxCacheDurationInHours: number; /** * Auth endpoint details. */ sourceUriDetails: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail[]; /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy { /** * The list of intended recipients for the token. */ audiences: string[]; /** * A list of parties that could have issued the token. */ issuers: string[]; /** * A list of claims which should be validated to consider the token valid. */ verifyClaims: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail { /** * Client ID for the OAuth2/OIDC app. */ clientId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ clientSecretId: string; /** * The version number of the client secret to use. */ clientSecretVersionNumber: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey { /** * The algorithm intended for use with this key. */ alg: string; /** * The base64 url encoded exponent of the RSA public key represented by this key. */ e: string; /** * The format of the public key. */ format: string; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * The operations for which this key is to be used. */ keyOps: string[]; /** * A unique key ID. This key will be used to verify the signature of a JWT with matching "kid". */ kid: string; /** * The key type. */ kty: string; /** * The base64 url encoded modulus of the RSA public key represented by this key. */ n: string; /** * The intended use of the public key. */ use: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail { /** * Type of the Response Cache Store Policy. */ type: string; /** * The uri from which to retrieve the key. It must be accessible without authentication. */ uri: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim { /** * 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. */ isRequired: boolean; /** * Information around the values for selector of an authentication/ routing branch. */ key: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey { /** * String describing the expression with wildcards. */ expression: string; /** * Information regarding whether this is the default branch. */ isDefault: boolean; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationSelectionSource { /** * String describing the context variable used as selector. */ selector: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyMutualTl { /** * Allowed list of CN or SAN which will be used for verification of certificate. */ allowedSans: string[]; /** * Determines whether to enable client verification when API Consumer makes connection to the gateway. */ isVerifiedCertificateRequired: boolean; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyRateLimiting { /** * The maximum number of requests per second to allow. */ rateInRequestsPerSecond: number; /** * The key used to group requests together. */ rateKey: string; } interface GetDeploymentsDeploymentCollectionSpecificationRequestPolicyUsagePlan { /** * A list of context variables specifying where API tokens may be located in a request. Example locations: * * "request.headers[token]" * * "request.query[token]" * * "request.auth[Token]" * * "request.path[TOKEN]" */ tokenLocations: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRoute { /** * The backend to forward requests to. */ backends: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteBackend[]; /** * Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging. */ loggingPolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicy[]; /** * A list of allowed methods on this route. */ methods: string[]; /** * 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. */ path: string; /** * Behavior applied to any requests received by the API on this route. */ requestPolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicy[]; /** * Behavior applied to any responses sent by the API for requests on this route. */ responsePolicies: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicy[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteBackend { /** * A list of allowed post-logout URLs to which a request can be redirected after revoke access */ allowedPostLogoutUris: string[]; /** * The body of the stock response from the mock backend. */ body: string; /** * Defines a timeout for establishing a connection with a proxied server. */ connectTimeoutInSeconds: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * The List of Headers */ headers: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteBackendHeader[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * Defines a state that should be shared on redirecting to postLogout URL. */ postLogoutState: string; /** * Defines a timeout for reading a response from the proxied server. */ readTimeoutInSeconds: number; /** * List of backends to chose from for Dynamic Routing. */ routingBackends: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackend[]; /** * Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication. */ selectionSources: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteBackendSelectionSource[]; /** * Defines a timeout for transmitting a request to the proxied server. */ sendTimeoutInSeconds: number; /** * The status code of the stock response from the mock backend. */ status: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The url of the HTTP Backend */ url: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteBackendHeader { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Value of the header. */ value: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackend { /** * The backend to forward requests to. */ backends: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackend[]; /** * Information around the values for selector of an authentication/ routing branch. */ keys: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendKey[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackend { /** * The body of the stock response from the mock backend. */ body: string; /** * Defines a timeout for establishing a connection with a proxied server. */ connectTimeoutInSeconds: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource. */ functionId: string; /** * The List of Headers */ headers: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackendHeader[]; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * Defines a timeout for reading a response from the proxied server. */ readTimeoutInSeconds: number; /** * Defines a timeout for transmitting a request to the proxied server. */ sendTimeoutInSeconds: number; /** * The status code of the stock response from the mock backend. */ status: number; /** * Type of the Response Cache Store Policy. */ type: string; /** * The url of the HTTP Backend */ url: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackendHeader { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Value of the header. */ value: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendKey { /** * String describing the expression with wildcards. */ expression: string; /** * Information regarding whether this is the default branch. */ isDefault: boolean; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Type of the Response Cache Store Policy. */ type: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteBackendSelectionSource { /** * String describing the context variable used as selector. */ selector: string; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicy { /** * Configures the logging policies for the access logs of an API Deployment. */ accessLogs: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyAccessLog[]; /** * Configures the logging policies for the execution logs of an API Deployment. */ executionLogs: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyExecutionLog[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyAccessLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; } interface GetDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyExecutionLog { /** * Whether this policy is currently enabled. */ isEnabled: boolean; /** * 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. */ logLevel: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicy { /** * 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. */ authorizations: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyAuthorization[]; /** * Validate the payload body of the incoming API requests on a specific route. */ bodyValidations: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidation[]; /** * Enable CORS (Cross-Origin-Resource-Sharing) request handling. */ cors: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyCor[]; /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ headerTransformations: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformation[]; /** * Validate the HTTP headers on the incoming API requests on a specific route. */ headerValidations: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidation[]; /** * A set of transformations to apply to query parameters that pass through the gateway. */ queryParameterTransformations: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformation[]; /** * Validate the URL query parameters on the incoming API requests on a specific route. */ queryParameterValidations: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidation[]; /** * Base policy for Response Cache lookup. */ responseCacheLookups: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyResponseCacheLookup[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyAuthorization { /** * A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive. */ allowedScopes: string[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidation { /** * The content of the request body. */ contents: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidationContent[]; /** * Determines if the parameter is required in the request. */ required: boolean; /** * Validation behavior mode. */ validationMode: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidationContent { /** * The key is a [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema */ mediaType: string; /** * Validation type defines the content validation method. */ validationType: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyCor { /** * The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers. */ allowedHeaders: string[]; /** * 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. */ allowedMethods: string[]; /** * 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. */ allowedOrigins: string[]; /** * 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. */ exposedHeaders: string[]; /** * Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies. */ isAllowCredentialsEnabled: boolean; /** * The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0. */ maxAgeInSeconds: number; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeader[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidation { /** * The List of Headers */ headers: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidationHeader[]; /** * Validation behavior mode. */ validationMode: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidationHeader { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Determines if the parameter is required in the request. */ required: boolean; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformation { /** * 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. */ filterQueryParameters: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter[]; /** * Rename parameters on the query string as they pass through the gateway. */ renameQueryParameters: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter[]; /** * Set parameters on the query string as they pass through the gateway. */ setQueryParameters: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidation { /** * The List of Query Parameters */ parameters: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidationParameter[]; /** * Validation behavior mode. */ validationMode: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidationParameter { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * Determines if the parameter is required in the request. */ required: boolean; } interface GetDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyResponseCacheLookup { /** * 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. */ cacheKeyAdditions: string[]; /** * Whether this policy is currently enabled. */ isEnabled: boolean; /** * 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. */ isPrivateCachingEnabled: boolean; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicy { /** * A set of transformations to apply to HTTP headers that pass through the gateway. */ headerTransformations: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformation[]; /** * Base policy for how a response from a backend is cached in the Response Cache. */ responseCacheStores: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyResponseCacheStore[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformation { /** * 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. */ filterHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeader[]; /** * Rename HTTP headers as they pass through the gateway. */ renameHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeader[]; /** * Set HTTP headers as they pass through the gateway. */ setHeaders: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeader[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem[]; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem { /** * The original case-insensitive name of the header. This name must be unique across transformation policies. */ from: string; /** * The new name of the header. This name must be unique across transformation policies. */ to: string; } interface GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeader { /** * The list of headers. */ items: outputs.ApiGateway.GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem { /** * 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. */ ifExists: string; /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyResponseCacheStore { /** * Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires. */ timeToLiveInSeconds: number; /** * Type of the Response Cache Store Policy. */ type: string; } interface GetDeploymentsFilter { /** * The case-insensitive name of the header. This name must be unique across transformation policies. */ name: string; regex?: boolean; /** * A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters. */ values: string[]; } interface GetGatewayCaBundle { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ caBundleId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ certificateAuthorityId: string; /** * Type of the Response Cache. */ type: string; } interface GetGatewayIpAddress { /** * An IP address. */ ipAddress: string; } interface GetGatewayIpv4addressConfiguration { /** * List of Reserved IP OCIDs created in VCN service. */ reservedIpIds: string[]; } interface GetGatewayIpv6addressConfiguration { /** * List of IPv6 addresses that will be assigned to the gateway during creation. */ addresses: string[]; /** * List of IPv6 prefixes from which to provision IPv6 addresses from. This is required if more than one prefix exists on the subnet. */ subnetCidrs: string[]; } interface GetGatewayLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the Response Cache. */ type: string; } interface GetGatewayResponseCacheDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ authenticationSecretId: string; /** * The version number of the authentication secret to use. */ authenticationSecretVersionNumber: string; /** * Defines the timeout for establishing a connection with the Response Cache. */ connectTimeoutInMs: number; /** * Defines if the connection should be over SSL. */ isSslEnabled: boolean; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * Defines the timeout for reading data from the Response Cache. */ readTimeoutInMs: number; /** * Defines the timeout for transmitting data to the Response Cache. */ sendTimeoutInMs: number; /** * The set of cache store members to connect to. At present only a single server is supported. */ servers: outputs.ApiGateway.GetGatewayResponseCacheDetailServer[]; /** * Type of the Response Cache. */ type: string; } interface GetGatewayResponseCacheDetailServer { /** * Hostname or IP address (IPv4 only) where the cache store is running. */ host: string; /** * The port the cache store is exposed on. */ port: number; } interface GetGatewaysFilter { name: string; regex?: boolean; values: string[]; } interface GetGatewaysGatewayCollection { /** * An array of CA bundles that should be used on the Gateway for TLS validation. */ caBundles: outputs.ApiGateway.GetGatewaysGatewayCollectionCaBundle[]; /** * Filter gateways by the certificate ocid. */ certificateId: string; /** * The ocid of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; /** * 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` */ endpointType: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The hostname for APIs deployed on the gateway. */ hostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ id: string; /** * An array of IP addresses associated with the gateway. */ ipAddresses: outputs.ApiGateway.GetGatewaysGatewayCollectionIpAddress[]; /** * 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` */ ipMode: string; /** * IPv4 address configuration details that should be used when creating the gateway. */ ipv4addressConfigurations: outputs.ApiGateway.GetGatewaysGatewayCollectionIpv4addressConfiguration[]; /** * IPv6 address configuration details that should be used when creating the gateway. */ ipv6addressConfigurations: outputs.ApiGateway.GetGatewaysGatewayCollectionIpv6addressConfiguration[]; isLockOverride: boolean; /** * 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. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.ApiGateway.GetGatewaysGatewayCollectionLock[]; /** * An array of Network Security Groups OCIDs associated with this API Gateway. */ networkSecurityGroupIds: string[]; /** * Base Gateway response cache. */ responseCacheDetails: outputs.ApiGateway.GetGatewaysGatewayCollectionResponseCacheDetail[]; /** * A filter to return only resources that match the given lifecycle state. Example: `SUCCEEDED` */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created. */ subnetId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetGatewaysGatewayCollectionCaBundle { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ caBundleId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ certificateAuthorityId: string; /** * Type of the Response Cache. */ type: string; } interface GetGatewaysGatewayCollectionIpAddress { /** * An IP address. */ ipAddress: string; } interface GetGatewaysGatewayCollectionIpv4addressConfiguration { /** * List of Reserved IP OCIDs created in VCN service. */ reservedIpIds: string[]; } interface GetGatewaysGatewayCollectionIpv6addressConfiguration { /** * List of IPv6 addresses that will be assigned to the gateway during creation. */ addresses: string[]; /** * List of IPv6 prefixes from which to provision IPv6 addresses from. This is required if more than one prefix exists on the subnet. */ subnetCidrs: string[]; } interface GetGatewaysGatewayCollectionLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the Response Cache. */ type: string; } interface GetGatewaysGatewayCollectionResponseCacheDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource. */ authenticationSecretId: string; /** * The version number of the authentication secret to use. */ authenticationSecretVersionNumber: string; /** * Defines the timeout for establishing a connection with the Response Cache. */ connectTimeoutInMs: number; /** * Defines if the connection should be over SSL. */ isSslEnabled: boolean; /** * Defines whether or not to uphold SSL verification. */ isSslVerifyDisabled: boolean; /** * Defines the timeout for reading data from the Response Cache. */ readTimeoutInMs: number; /** * Defines the timeout for transmitting data to the Response Cache. */ sendTimeoutInMs: number; /** * The set of cache store members to connect to. At present only a single server is supported. */ servers: outputs.ApiGateway.GetGatewaysGatewayCollectionResponseCacheDetailServer[]; /** * Type of the Response Cache. */ type: string; } interface GetGatewaysGatewayCollectionResponseCacheDetailServer { /** * Hostname or IP address (IPv4 only) where the cache store is running. */ host: string; /** * The port the cache store is exposed on. */ port: number; } interface GetSubscriberClient { /** * The name of the client. Must be unique within a subscriber. */ name: string; /** * The token for the client. Must be unique within a tenancy. */ token: string; } interface GetSubscriberLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetSubscribersFilter { /** * The name of the client. Must be unique within a subscriber. */ name: string; regex?: boolean; values: string[]; } interface GetSubscribersSubscriberCollection { items: outputs.ApiGateway.GetSubscribersSubscriberCollectionItem[]; } interface GetSubscribersSubscriberCollectionItem { /** * The clients belonging to this subscriber. */ clients: outputs.ApiGateway.GetSubscribersSubscriberCollectionItemClient[]; /** * The ocid of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ id: string; isLockOverride: boolean; /** * 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. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.ApiGateway.GetSubscribersSubscriberCollectionItemLock[]; /** * A filter to return only resources that match the given lifecycle state. Example: `ACTIVE` */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * An array of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of usage plan resources. */ usagePlans: string[]; } interface GetSubscribersSubscriberCollectionItemClient { /** * The name of the client. Must be unique within a subscriber. */ name: string; /** * The token for the client. Must be unique within a tenancy. */ token: string; } interface GetSubscribersSubscriberCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetUsagePlanEntitlement { /** * A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. */ description: string; /** * An entitlement name, unique within a usage plan. */ name: string; /** * Quota policy for a usage plan. */ quotas: outputs.ApiGateway.GetUsagePlanEntitlementQuota[]; /** * Rate-limiting policy for a usage plan. */ rateLimits: outputs.ApiGateway.GetUsagePlanEntitlementRateLimit[]; /** * A collection of targeted deployments that the entitlement will be applied to. */ targets: outputs.ApiGateway.GetUsagePlanEntitlementTarget[]; } interface GetUsagePlanEntitlementQuota { /** * What the usage plan will do when a quota is breached: `REJECT` will allow no further requests `ALLOW` will continue to allow further requests */ operationOnBreach: string; /** * The policy that controls when quotas will reset. Example: `CALENDAR` */ resetPolicy: string; /** * The unit of time over which rate limits are calculated. Example: `SECOND` */ unit: string; /** * The number of requests that can be made per time period. */ value: number; } interface GetUsagePlanEntitlementRateLimit { /** * The unit of time over which rate limits are calculated. Example: `SECOND` */ unit: string; /** * The number of requests that can be made per time period. */ value: number; } interface GetUsagePlanEntitlementTarget { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a deployment resource. */ deploymentId: string; } interface GetUsagePlanLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetUsagePlansFilter { /** * An entitlement name, unique within a usage plan. */ name: string; regex?: boolean; values: string[]; } interface GetUsagePlansUsagePlanCollection { items: outputs.ApiGateway.GetUsagePlansUsagePlanCollectionItem[]; } interface GetUsagePlansUsagePlanCollectionItem { /** * The ocid of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; /** * A collection of entitlements currently assigned to the usage plan. */ entitlements: outputs.ApiGateway.GetUsagePlansUsagePlanCollectionItemEntitlement[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a usage plan resource. */ id: string; isLockOverride: boolean; /** * 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. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.ApiGateway.GetUsagePlansUsagePlanCollectionItemLock[]; /** * A filter to return only resources that match the given lifecycle state. Example: `ACTIVE` */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetUsagePlansUsagePlanCollectionItemEntitlement { /** * A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. */ description: string; /** * An entitlement name, unique within a usage plan. */ name: string; /** * Quota policy for a usage plan. */ quotas: outputs.ApiGateway.GetUsagePlansUsagePlanCollectionItemEntitlementQuota[]; /** * Rate-limiting policy for a usage plan. */ rateLimits: outputs.ApiGateway.GetUsagePlansUsagePlanCollectionItemEntitlementRateLimit[]; /** * A collection of targeted deployments that the entitlement will be applied to. */ targets: outputs.ApiGateway.GetUsagePlansUsagePlanCollectionItemEntitlementTarget[]; } interface GetUsagePlansUsagePlanCollectionItemEntitlementQuota { /** * What the usage plan will do when a quota is breached: `REJECT` will allow no further requests `ALLOW` will continue to allow further requests */ operationOnBreach: string; /** * The policy that controls when quotas will reset. Example: `CALENDAR` */ resetPolicy: string; /** * The unit of time over which rate limits are calculated. Example: `SECOND` */ unit: string; /** * The number of requests that can be made per time period. */ value: number; } interface GetUsagePlansUsagePlanCollectionItemEntitlementRateLimit { /** * The unit of time over which rate limits are calculated. Example: `SECOND` */ unit: string; /** * The number of requests that can be made per time period. */ value: number; } interface GetUsagePlansUsagePlanCollectionItemEntitlementTarget { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a deployment resource. */ deploymentId: string; } interface GetUsagePlansUsagePlanCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface SubscriberClient { /** * (Updatable) The name of the client. Must be unique within a subscriber. */ name: string; /** * (Updatable) The token for the client. Must be unique within a tenancy. */ token: string; } interface SubscriberLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface UsagePlanEntitlement { /** * (Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. */ description: string; /** * (Updatable) An entitlement name, unique within a usage plan. */ name: string; /** * (Updatable) Quota policy for a usage plan. */ quota: outputs.ApiGateway.UsagePlanEntitlementQuota; /** * (Updatable) Rate-limiting policy for a usage plan. */ rateLimit: outputs.ApiGateway.UsagePlanEntitlementRateLimit; /** * (Updatable) A collection of targeted deployments that the entitlement will be applied to. */ targets: outputs.ApiGateway.UsagePlanEntitlementTarget[]; } interface UsagePlanEntitlementQuota { /** * (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 */ operationOnBreach: string; /** * (Updatable) The policy that controls when quotas will reset. Example: `CALENDAR` */ resetPolicy: string; /** * (Updatable) The unit of time over which quotas are calculated. Example: `MINUTE` or `MONTH` */ unit: string; /** * (Updatable) The number of requests that can be made per time period. */ value: number; } interface UsagePlanEntitlementRateLimit { /** * (Updatable) The unit of time over which rate limits are calculated. Example: `SECOND` */ unit: string; /** * (Updatable) The number of requests that can be made per time period. */ value: number; } interface UsagePlanEntitlementTarget { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a deployment resource. */ deploymentId: string; } interface UsagePlanLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } } export declare namespace Apm { interface GetApmDomainsApmDomain { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The endpoint where the APM agents upload their observations and metrics. */ dataUploadEndpoint: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of the APM domain. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation. */ id: string; /** * Indicates if this is an Always Free resource. */ isFreeTier: boolean; /** * The OCID of the Log Analytics log group to which the data uploaded to this APM domain will be mapped to. */ logGroupId: string; /** * A filter to return only resources that match the given life-cycle state. */ state: string; /** * The time the APM domain was created, expressed in RFC 3339 timestamp format. */ timeCreated: string; /** * The time the APM domain was updated, expressed in RFC 3339 timestamp format. */ timeUpdated: string; } interface GetApmDomainsFilter { name: string; regex?: boolean; values: string[]; } interface GetDataKeysDataKey { /** * Name of the Data Key. The name uniquely identifies a Data Key within an APM domain. */ name: string; /** * Type of the Data Key. */ type: string; /** * Value of the Data Key. */ value: string; } interface GetDataKeysFilter { /** * Name of the Data Key. The name uniquely identifies a Data Key within an APM domain. */ name: string; regex?: boolean; values: string[]; } } export declare namespace ApmConfig { interface ConfigConfig { /** * (Updatable) Map of an agent configuration file. */ configMaps: outputs.ApmConfig.ConfigConfigConfigMap[]; } interface ConfigConfigConfigMap { /** * The Base64 encoded agent configuration file. */ body: string; /** * (Updatable) The MIME Content-Type that describes the content of the body field, for example, text/yaml or text/yaml; charset=utf-8 */ contentType: string; /** * (Updatable) An agent configuration file name. */ fileName: string; } interface ConfigDimension { /** * (Updatable) The name of the dimension. */ name: string; /** * (Updatable) The source to populate the dimension. This must not be specified. */ valueSource: string; } interface ConfigInUseBy { /** * (Updatable) The type of configuration item. */ configType: string; /** * (Updatable) The name by which a configuration entity is displayed to the end user. */ displayName: string; /** * 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. */ id: string; /** * A string that specifies the group that an OPTIONS item belongs to. */ optionsGroup: string; } interface ConfigMetric { /** * (Updatable) A description of the metric. */ description: string; /** * (Updatable) The name of the metric. This must be a known metric name. */ name: string; /** * (Updatable) The unit of the metric. */ unit: string; /** * (Updatable) This must not be set. */ valueSource: string; } interface ConfigOverrides { /** * (Updatable) */ overrideLists: outputs.ApmConfig.ConfigOverridesOverrideList[]; } interface ConfigOverridesOverrideList { /** * (Updatable) The string that defines the Agent Filter expression. */ agentFilter: string; /** * (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 */ overrideMap: { [key: string]: string; }; } interface ConfigRule { /** * (Updatable) The name by which a configuration entity is displayed to the end user. */ displayName: string; /** * (Updatable) The string that defines the Span Filter expression. */ filterText: string; /** * (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". */ isApplyToErrorSpans: boolean; /** * (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". */ isEnabled: boolean; /** * (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. */ priority: number; /** * (Updatable) The maximum response time in milliseconds that is considered "satisfactory" for the end user. */ satisfiedResponseTime: number; /** * (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". */ toleratingResponseTime: number; } interface GetConfigConfig { /** * Map of an agent configuration file. */ configMaps: outputs.ApmConfig.GetConfigConfigConfigMap[]; } interface GetConfigConfigConfigMap { /** * The Base64 encoded agent configuration file. */ body: string; /** * The MIME Content-Type that describes the content of the body field, for example, text/yaml or text/yaml; charset=utf-8 */ contentType: string; /** * An agent configuration file name. */ fileName: string; } interface GetConfigDimension { /** * The name of the metric. This must be a known metric name. */ name: string; /** * This must not be set. */ valueSource: string; } interface GetConfigInUseBy { /** * The type of configuration item. */ configType: string; /** * The name by which a configuration entity is displayed to the end user. */ displayName: string; /** * 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. */ id: string; /** * A string that specifies the group that an OPTIONS item belongs to. */ optionsGroup: string; } interface GetConfigMetric { /** * A description of the metric. */ description: string; /** * The name of the metric. This must be a known metric name. */ name: string; /** * The unit of the metric. */ unit: string; /** * This must not be set. */ valueSource: string; } interface GetConfigOverride { overrideLists: outputs.ApmConfig.GetConfigOverrideOverrideList[]; } interface GetConfigOverrideOverrideList { /** * The string that defines the Agent Filter expression. */ agentFilter: string; /** * 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 */ overrideMap: { [key: string]: string; }; } interface GetConfigRule { /** * The name by which a configuration entity is displayed to the end user. */ displayName: string; /** * The string that defines the Span Filter expression. */ filterText: string; /** * 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". */ isApplyToErrorSpans: boolean; /** * 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". */ isEnabled: boolean; /** * 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. */ priority: number; /** * The maximum response time in milliseconds that is considered "satisfactory" for the end user. */ satisfiedResponseTime: number; /** * 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". */ toleratingResponseTime: number; } interface GetConfigsConfigCollection { items: outputs.ApmConfig.GetConfigsConfigCollectionItem[]; } interface GetConfigsConfigCollectionItem { /** * The version of the referenced agent bundle. */ agentVersion: string; /** * The APM Domain ID the request is intended for. */ apmDomainId: string; /** * The directory owned by runAsUser. */ attachInstallDir: string; /** * A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, APDEX, AGENT and MACS_APM_EXTENSION. */ configType: string; /** * 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 `configMap`. To apply a different configuration in a subset of the agents, put this block anywhere in the body of the configuration and edit and {{ | default }} Example: com.oracle.apm.agent.tracer.enable.jfr = {{ isJfrEnabled | default false }} Then, in the configuration's overrides, specify a different value for along with the desired agent filter. Example: "agentFilter": "ApplicationType='Tomcat'" "overrideMap": { "isJfrEnabled": true } */ configs: outputs.ApmConfig.GetConfigsConfigCollectionItemConfig[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a user. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A description of the metric. */ description: string; /** * A list of dimensions for the metric. This variable should not be used. */ dimensions: outputs.ApmConfig.GetConfigsConfigCollectionItemDimension[]; /** * A filter to return resources that match the given display name. */ displayName: string; /** * For optimistic concurrency control. See `if-match`. */ etag: string; /** * 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. */ filterId: string; /** * The string that defines the Span Filter expression. */ filterText: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A string that specifies the group that an OPTIONS item belongs to. */ group: string; /** * 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. */ id: string; /** * The list of configuration items that reference the span filter. */ inUseBies: outputs.ApmConfig.GetConfigsConfigCollectionItemInUseBy[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent that will provision the APM Agent. */ managementAgentId: string; /** * 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. */ matchAgentsWithAttributeKeys: string[]; /** * 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. */ matchAgentsWithAttributeValue: string; /** * The list of metrics in this group. */ metrics: outputs.ApmConfig.GetConfigsConfigCollectionItemMetric[]; /** * The namespace to which the metrics are published. It must be one of several predefined namespaces. */ namespace: string; opcDryRun: string; /** * The options are stored here as JSON. */ options: string; /** * Agent configuration overrides that should apply to a subset of the agents associated with an Agent Config object. */ overrides: outputs.ApmConfig.GetConfigsConfigCollectionItemOverride[]; /** * Filter patterns used to discover active Java processes for provisioning the APM Agent. */ processFilters: string[]; rules: outputs.ApmConfig.GetConfigsConfigCollectionItemRule[]; /** * The OS user that should be used to discover Java processes. */ runAsUser: string; /** * 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. */ serviceName: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a user. */ updatedBy: string; } interface GetConfigsConfigCollectionItemConfig { /** * Map of an agent configuration file. */ configMaps: outputs.ApmConfig.GetConfigsConfigCollectionItemConfigConfigMap[]; } interface GetConfigsConfigCollectionItemConfigConfigMap { /** * The Base64 encoded agent configuration file. */ body: string; /** * The MIME Content-Type that describes the content of the body field, for example, text/yaml or text/yaml; charset=utf-8 */ contentType: string; /** * An agent configuration file name. */ fileName: string; } interface GetConfigsConfigCollectionItemDimension { /** * The name of the metric. This must be a known metric name. */ name: string; /** * This must not be set. */ valueSource: string; } interface GetConfigsConfigCollectionItemInUseBy { /** * A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, APDEX, AGENT and MACS_APM_EXTENSION. */ configType: string; /** * A filter to return resources that match the given display name. */ displayName: string; /** * 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. */ id: string; /** * A filter to return OPTIONS resources that match the given group. */ optionsGroup: string; } interface GetConfigsConfigCollectionItemMetric { /** * A description of the metric. */ description: string; /** * The name of the metric. This must be a known metric name. */ name: string; /** * The unit of the metric. */ unit: string; /** * This must not be set. */ valueSource: string; } interface GetConfigsConfigCollectionItemOverride { overrideLists: outputs.ApmConfig.GetConfigsConfigCollectionItemOverrideOverrideList[]; } interface GetConfigsConfigCollectionItemOverrideOverrideList { /** * The string that defines the Agent Filter expression. */ agentFilter: string; /** * 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 */ overrideMap: { [key: string]: string; }; } interface GetConfigsConfigCollectionItemRule { /** * A filter to return resources that match the given display name. */ displayName: string; /** * The string that defines the Span Filter expression. */ filterText: string; /** * 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". */ isApplyToErrorSpans: boolean; /** * 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". */ isEnabled: boolean; /** * 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. */ priority: number; /** * The maximum response time in milliseconds that is considered "satisfactory" for the end user. */ satisfiedResponseTime: number; /** * 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". */ toleratingResponseTime: number; } interface GetConfigsFilter { /** * The name of the metric. This must be a known metric name. */ name: string; regex?: boolean; values: string[]; } interface GetDataFilesFilter { /** * A filter to return resources that match the specified name. Supports regular expressions to filter data files. */ name: string; regex?: boolean; values: string[]; } interface GetDataFilesItem { /** * The type of the data file. */ apmType: string; md5: string; /** * Optional user-defined metadata key and value to search by. */ metadata: { [key: string]: string; }; /** * A filter to return resources that match the specified name. Supports regular expressions to filter data files. */ name: string; sizeInBytes: string; timeLastModified: string; } } export declare namespace ApmSynthetics { interface ConfigAvailabilityConfiguration { /** * (Updatable) Intervals with failed runs more than this value will be classified as UNAVAILABLE. */ maxAllowedFailuresPerInterval: number; /** * (Updatable) Intervals with runs less than this value will be classified as UNKNOWN and excluded from the availability calculations. */ minAllowedRunsPerInterval: number; } interface ConfigConfiguration { /** * (Updatable) Details for client certificate. */ clientCertificateDetails: outputs.ApmSynthetics.ConfigConfigurationClientCertificateDetails; /** * (Updatable) Type of configuration. */ configType: string; /** * (Updatable) Database connection string. */ connectionString: string; /** * (Updatable) Details for basic authentication. */ databaseAuthenticationDetails: outputs.ApmSynthetics.ConfigConfigurationDatabaseAuthenticationDetails; /** * (Updatable) Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type. */ databaseConnectionType: string; /** * (Updatable) Database role. */ databaseRole: string; /** * (Updatable) Database type. */ databaseType: string; /** * (Updatable) Details for database wallet. */ databaseWalletDetails: outputs.ApmSynthetics.ConfigConfigurationDatabaseWalletDetails; /** * (Updatable) Information about the DNS settings. */ dnsConfiguration: outputs.ApmSynthetics.ConfigConfigurationDnsConfiguration; /** * (Updatable) Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB. */ downloadSizeLimitInBytes: number; /** * (Updatable) Details for basic authentication. */ ftpBasicAuthenticationDetails: outputs.ApmSynthetics.ConfigConfigurationFtpBasicAuthenticationDetails; /** * (Updatable) FTP protocol type. */ ftpProtocol: string; /** * (Updatable) FTP monitor request type. */ ftpRequestType: string; /** * (Updatable) If enabled, Active mode will be used for the FTP connection. Not supported for SFTP protocol. */ isActiveMode: boolean; /** * (Updatable) If certificate validation is enabled, then the call will fail in case of certification errors. */ isCertificateValidationEnabled: boolean; /** * (Updatable) If disabled, auto snapshots are not collected. */ isDefaultSnapshotEnabled: boolean; /** * (Updatable) If isFailureRetried is enabled, then a failed call will be retried. */ isFailureRetried: boolean; /** * (Updatable) If isQueryRecursive is enabled, then queries will be sent recursively to the target server. */ isQueryRecursive: boolean; /** * (Updatable) If redirection is enabled, then redirects will be allowed while accessing target URL. */ isRedirectionEnabled: boolean; /** * (Updatable) Name of the server that will be used to perform DNS lookup. */ nameServer: string; /** * (Updatable) Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory. */ networkConfiguration: outputs.ApmSynthetics.ConfigConfigurationNetworkConfiguration; /** * (Updatable) Type of protocol. */ protocol: string; /** * (Updatable) SQL query to be executed. */ query: string; /** * (Updatable) DNS record type. */ recordType: string; /** * (Updatable) Details for request HTTP authentication. */ reqAuthenticationDetails: outputs.ApmSynthetics.ConfigConfigurationReqAuthenticationDetails; /** * (Updatable) Request HTTP authentication scheme. */ reqAuthenticationScheme: string; /** * (Updatable) List of request headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]` */ requestHeaders: outputs.ApmSynthetics.ConfigConfigurationRequestHeader[]; /** * (Updatable) Request HTTP method. */ requestMethod: string; /** * (Updatable) Request post body content. */ requestPostBody: string; /** * (Updatable) List of request query params. Example: `[{"paramName": "sortOrder", "paramValue": "asc"}]` */ requestQueryParams: outputs.ApmSynthetics.ConfigConfigurationRequestQueryParam[]; /** * (Updatable) File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB. */ uploadFileSizeInBytes: number; /** * (Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx. */ verifyResponseCodes: string[]; /** * (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. */ verifyResponseContent: string; /** * (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. */ verifyTexts: outputs.ApmSynthetics.ConfigConfigurationVerifyText[]; } interface ConfigConfigurationClientCertificateDetails { /** * (Updatable) Client certificate in PEM format. */ clientCertificate: outputs.ApmSynthetics.ConfigConfigurationClientCertificateDetailsClientCertificate; /** * (Updatable) The private key associated with the client certificate in PEM format. */ privateKey: outputs.ApmSynthetics.ConfigConfigurationClientCertificateDetailsPrivateKey; } interface ConfigConfigurationClientCertificateDetailsClientCertificate { /** * (Updatable) Content of the client certificate file. */ content: string; /** * (Updatable) Name of the certificate file. The name should not contain any confidential information. */ fileName: string; } interface ConfigConfigurationClientCertificateDetailsPrivateKey { /** * (Updatable) Content of the private key file. */ content: string; /** * (Updatable) Name of the private key file. */ fileName: string; } interface ConfigConfigurationDatabaseAuthenticationDetails { /** * (Updatable) Password. */ password: outputs.ApmSynthetics.ConfigConfigurationDatabaseAuthenticationDetailsPassword; /** * (Updatable) Username for authentication. */ username: string; } interface ConfigConfigurationDatabaseAuthenticationDetailsPassword { /** * (Updatable) Password. */ password: string; /** * (Updatable) Type of method to pass password. */ passwordType: string; /** * (Updatable) Vault secret OCID. */ vaultSecretId: string; } interface ConfigConfigurationDatabaseWalletDetails { /** * (Updatable) The database wallet configuration zip file. */ databaseWallet: string; /** * (Updatable) Service name of the database. */ serviceName: string; } interface ConfigConfigurationDnsConfiguration { /** * (Updatable) If isOverrideDns is true, then DNS settings will be overridden. */ isOverrideDns: boolean; /** * (Updatable) Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true. */ overrideDnsIp: string; } interface ConfigConfigurationFtpBasicAuthenticationDetails { /** * (Updatable) Password. */ password: outputs.ApmSynthetics.ConfigConfigurationFtpBasicAuthenticationDetailsPassword; /** * (Updatable) Username for authentication. */ username: string; } interface ConfigConfigurationFtpBasicAuthenticationDetailsPassword { /** * (Updatable) Password. */ password: string; /** * (Updatable) Type of method to pass password. */ passwordType: string; /** * (Updatable) Vault secret OCID. */ vaultSecretId: string; } interface ConfigConfigurationNetworkConfiguration { /** * (Updatable) Number of hops. */ numberOfHops: number; /** * (Updatable) Type of probe mode when TCP protocol is selected. */ probeMode: string; /** * (Updatable) Number of probes per hop. */ probePerHop: number; /** * (Updatable) Type of protocol. */ protocol: string; /** * (Updatable) Number of probe packets sent out simultaneously. */ transmissionRate: number; } interface ConfigConfigurationReqAuthenticationDetails { /** * (Updatable) List of authentication headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]` */ authHeaders: outputs.ApmSynthetics.ConfigConfigurationReqAuthenticationDetailsAuthHeader[]; /** * (Updatable) Request method. */ authRequestMethod: string; /** * (Updatable) Request post body. */ authRequestPostBody: string; /** * (Updatable) Authentication token. */ authToken: string; /** * (Updatable) URL to get authentication token. */ authUrl: string; /** * (Updatable) User name for authentication. */ authUserName: string; /** * (Updatable) User password for authentication. */ authUserPassword: string; /** * (Updatable) Request HTTP OAuth scheme. */ oauthScheme: string; } interface ConfigConfigurationReqAuthenticationDetailsAuthHeader { /** * (Updatable) Name of the header. */ headerName: string; /** * (Updatable) Value of the header. */ headerValue: string; } interface ConfigConfigurationRequestHeader { /** * (Updatable) Name of the header. */ headerName: string; /** * (Updatable) Value of the header. */ headerValue: string; } interface ConfigConfigurationRequestQueryParam { /** * (Updatable) Name of request query parameter. */ paramName: string; /** * (Updatable) Value of request query parameter. */ paramValue: string; } interface ConfigConfigurationVerifyText { /** * (Updatable) Verification text in the response. */ text: string; } interface ConfigMaintenanceWindowSchedule { /** * (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` */ timeEnded: string; /** * (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` */ timeStarted: string; } interface ConfigScriptParameter { /** * If parameter value is default or overwritten. */ isOverwritten: boolean; /** * Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API. */ isSecret: boolean; /** * Details of the script parameter that can be used to overwrite the parameter present in the script. */ monitorScriptParameters: outputs.ApmSynthetics.ConfigScriptParameterMonitorScriptParameter[]; /** * (Updatable) Name of the parameter. */ paramName: string; /** * (Updatable) Value of the parameter. */ paramValue: string; } interface ConfigScriptParameterMonitorScriptParameter { /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; } interface ConfigVantagePoint { /** * Unique name that can be edited. The name should not contain any confidential information. */ displayName: string; /** * Name of the vantage point. */ name: string; /** * List of workers running the assigned monitor. */ workerLists: string[]; } interface DedicatedVantagePointDvpStackDetails { /** * (Updatable) Stack [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point. */ dvpStackId: string; /** * (Updatable) Type of stack. */ dvpStackType: string; /** * (Updatable) Stream [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point. */ dvpStreamId: string; /** * (Updatable) Version of the dedicated vantage point. */ dvpVersion: string; } interface DedicatedVantagePointMonitorStatusCountMap { /** * Number of disabled monitors using the script. */ disabled: number; /** * Number of enabled monitors using the script. */ enabled: number; /** * Number of invalid monitors using the script. */ invalid: number; /** * Total number of monitors using the script. */ total: number; } interface GetDedicatedVantagePointDvpStackDetail { /** * Stack [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point. */ dvpStackId: string; /** * Type of stack. */ dvpStackType: string; /** * Stream [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point. */ dvpStreamId: string; /** * Version of the dedicated vantage point. */ dvpVersion: string; } interface GetDedicatedVantagePointMonitorStatusCountMap { /** * Number of disabled monitors using the script. */ disabled: number; /** * Number of enabled monitors using the script. */ enabled: number; /** * Number of invalid monitors using the script. */ invalid: number; /** * Total number of monitors using the script. */ total: number; } interface GetDedicatedVantagePointsDedicatedVantagePointCollection { items: outputs.ApmSynthetics.GetDedicatedVantagePointsDedicatedVantagePointCollectionItem[]; } interface GetDedicatedVantagePointsDedicatedVantagePointCollectionItem { /** * The APM domain ID the request is intended for. */ apmDomainId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name. */ displayName: string; /** * Details of a Dedicated Vantage Point (DVP) stack in Resource Manager. */ dvpStackDetails: outputs.ApmSynthetics.GetDedicatedVantagePointsDedicatedVantagePointCollectionItemDvpStackDetail[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated vantage point. */ id: string; /** * Details of the monitor count per state. Example: `{ "total" : 5, "enabled" : 3 , "disabled" : 2, "invalid" : 0 }` */ monitorStatusCountMaps: outputs.ApmSynthetics.GetDedicatedVantagePointsDedicatedVantagePointCollectionItemMonitorStatusCountMap[]; /** * A filter to return only the resources that match the entire name. */ name: string; /** * Name of the region. */ region: string; /** * A filter to return only the dedicated vantage points that match a given status. */ status: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; } interface GetDedicatedVantagePointsDedicatedVantagePointCollectionItemDvpStackDetail { /** * Stack [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point. */ dvpStackId: string; /** * Type of stack. */ dvpStackType: string; /** * Stream [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point. */ dvpStreamId: string; /** * Version of the dedicated vantage point. */ dvpVersion: string; } interface GetDedicatedVantagePointsDedicatedVantagePointCollectionItemMonitorStatusCountMap { /** * Number of disabled monitors using the script. */ disabled: number; /** * Number of enabled monitors using the script. */ enabled: number; /** * Number of invalid monitors using the script. */ invalid: number; /** * Total number of monitors using the script. */ total: number; } interface GetDedicatedVantagePointsFilter { /** * A filter to return only the resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetMonitorAvailabilityConfiguration { /** * 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. */ maxAllowedFailuresPerInterval: number; /** * 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. */ minAllowedRunsPerInterval: number; } interface GetMonitorConfiguration { /** * Details for client certificate. */ clientCertificateDetails: outputs.ApmSynthetics.GetMonitorConfigurationClientCertificateDetail[]; /** * Type of configuration. */ configType: string; /** * Database connection string. */ connectionString: string; /** * Details for basic authentication. */ databaseAuthenticationDetails: outputs.ApmSynthetics.GetMonitorConfigurationDatabaseAuthenticationDetail[]; /** * Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type. */ databaseConnectionType: string; /** * Database role. */ databaseRole: string; /** * Database type. */ databaseType: string; /** * Details for database wallet. */ databaseWalletDetails: outputs.ApmSynthetics.GetMonitorConfigurationDatabaseWalletDetail[]; /** * Information about the DNS settings. */ dnsConfigurations: outputs.ApmSynthetics.GetMonitorConfigurationDnsConfiguration[]; /** * Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB. */ downloadSizeLimitInBytes: number; /** * Details for basic authentication. */ ftpBasicAuthenticationDetails: outputs.ApmSynthetics.GetMonitorConfigurationFtpBasicAuthenticationDetail[]; /** * FTP protocol type. */ ftpProtocol: string; /** * FTP monitor request type. */ ftpRequestType: string; /** * If enabled, Active mode will be used for the FTP connection. Not supported for SFTP protocol. */ isActiveMode: boolean; /** * If certificate validation is enabled, then the call will fail in case of certification errors. */ isCertificateValidationEnabled: boolean; /** * If disabled, auto snapshots are not collected. */ isDefaultSnapshotEnabled: boolean; /** * If isFailureRetried is enabled, then a failed call will be retried. */ isFailureRetried: boolean; /** * If isQueryRecursive is enabled, then queries will be sent recursively to the target server. */ isQueryRecursive: boolean; /** * If redirection is enabled, then redirects will be allowed while accessing target URL. */ isRedirectionEnabled: boolean; /** * Name of the server that will be used to perform DNS lookup. */ nameServer: string; /** * Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory. */ networkConfigurations: outputs.ApmSynthetics.GetMonitorConfigurationNetworkConfiguration[]; /** * Type of protocol. */ protocol: string; /** * SQL query to be executed. */ query: string; /** * DNS record type. */ recordType: string; /** * Details for request HTTP authentication. */ reqAuthenticationDetails: outputs.ApmSynthetics.GetMonitorConfigurationReqAuthenticationDetail[]; /** * Request HTTP authentication scheme. */ reqAuthenticationScheme: string; /** * List of request headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]` */ requestHeaders: outputs.ApmSynthetics.GetMonitorConfigurationRequestHeader[]; /** * Request HTTP method. */ requestMethod: string; /** * Request post body content. */ requestPostBody: string; /** * List of request query params. Example: `[{"paramName": "sortOrder", "paramValue": "asc"}]` */ requestQueryParams: outputs.ApmSynthetics.GetMonitorConfigurationRequestQueryParam[]; /** * File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB. */ uploadFileSizeInBytes: number; /** * Expected HTTP response codes. For status code range, set values such as 2xx, 3xx. */ verifyResponseCodes: string[]; /** * Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure. */ verifyResponseContent: string; /** * 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. */ verifyTexts: outputs.ApmSynthetics.GetMonitorConfigurationVerifyText[]; } interface GetMonitorConfigurationClientCertificateDetail { /** * Client certificate in PEM format. */ clientCertificates: outputs.ApmSynthetics.GetMonitorConfigurationClientCertificateDetailClientCertificate[]; /** * The private key associated with the client certificate in PEM format. */ privateKeys: outputs.ApmSynthetics.GetMonitorConfigurationClientCertificateDetailPrivateKey[]; } interface GetMonitorConfigurationClientCertificateDetailClientCertificate { /** * Content of the private key file. */ content: string; /** * Name of the private key file. */ fileName: string; } interface GetMonitorConfigurationClientCertificateDetailPrivateKey { /** * Content of the private key file. */ content: string; /** * Name of the private key file. */ fileName: string; } interface GetMonitorConfigurationDatabaseAuthenticationDetail { /** * Password. */ passwords: outputs.ApmSynthetics.GetMonitorConfigurationDatabaseAuthenticationDetailPassword[]; /** * Username for authentication. */ username: string; } interface GetMonitorConfigurationDatabaseAuthenticationDetailPassword { /** * Password. */ password: string; /** * Type of method to pass password. */ passwordType: string; /** * Vault secret OCID. */ vaultSecretId: string; } interface GetMonitorConfigurationDatabaseWalletDetail { /** * The database wallet configuration zip file. */ databaseWallet: string; /** * Service name of the database. */ serviceName: string; } interface GetMonitorConfigurationDnsConfiguration { /** * If isOverrideDns is true, then DNS settings will be overridden. */ isOverrideDns: boolean; /** * Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true. */ overrideDnsIp: string; } interface GetMonitorConfigurationFtpBasicAuthenticationDetail { /** * Password. */ passwords: outputs.ApmSynthetics.GetMonitorConfigurationFtpBasicAuthenticationDetailPassword[]; /** * Username for authentication. */ username: string; } interface GetMonitorConfigurationFtpBasicAuthenticationDetailPassword { /** * Password. */ password: string; /** * Type of method to pass password. */ passwordType: string; /** * Vault secret OCID. */ vaultSecretId: string; } interface GetMonitorConfigurationNetworkConfiguration { /** * Number of hops. */ numberOfHops: number; /** * Type of probe mode when TCP protocol is selected. */ probeMode: string; /** * Number of probes per hop. */ probePerHop: number; /** * Type of protocol. */ protocol: string; /** * Number of probe packets sent out simultaneously. */ transmissionRate: number; } interface GetMonitorConfigurationReqAuthenticationDetail { /** * List of authentication headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]` */ authHeaders: outputs.ApmSynthetics.GetMonitorConfigurationReqAuthenticationDetailAuthHeader[]; /** * Request method. */ authRequestMethod: string; /** * Request post body. */ authRequestPostBody: string; /** * Authentication token. */ authToken: string; /** * URL to get authentication token. */ authUrl: string; /** * User name for authentication. */ authUserName: string; /** * User password for authentication. */ authUserPassword: string; /** * Request HTTP OAuth scheme. */ oauthScheme: string; } interface GetMonitorConfigurationReqAuthenticationDetailAuthHeader { /** * Name of the header. */ headerName: string; /** * Value of the header. */ headerValue: string; } interface GetMonitorConfigurationRequestHeader { /** * Name of the header. */ headerName: string; /** * Value of the header. */ headerValue: string; } interface GetMonitorConfigurationRequestQueryParam { /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; } interface GetMonitorConfigurationVerifyText { /** * Verification text in the response. */ text: string; } interface GetMonitorMaintenanceWindowSchedule { /** * 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` */ timeEnded: string; /** * 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` */ timeStarted: string; } interface GetMonitorScriptParameter { /** * If parameter value is default or overwritten. */ isOverwritten: boolean; /** * Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API. */ isSecret: boolean; /** * Details of the script parameter that can be used to overwrite the parameter present in the script. */ monitorScriptParameters: outputs.ApmSynthetics.GetMonitorScriptParameterMonitorScriptParameter[]; /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; } interface GetMonitorScriptParameterMonitorScriptParameter { /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; } interface GetMonitorVantagePoint { /** * Unique name that can be edited. The name should not contain any confidential information. */ displayName: string; /** * Name of the vantage point. */ name: string; /** * List of workers running the assigned monitor. */ workerLists: string[]; } interface GetMonitorsFilter { /** * Name of the vantage point. */ name: string; regex?: boolean; values: string[]; } interface GetMonitorsMonitorCollection { items: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItem[]; } interface GetMonitorsMonitorCollectionItem { /** * The APM domain ID the request is intended for. */ apmDomainId: string; /** * Monitor availability configuration details. */ availabilityConfigurations: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemAvailabilityConfiguration[]; /** * Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN). */ batchIntervalInSeconds: number; /** * Details of monitor configuration. */ configurations: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfiguration[]; /** * Content type of the script. */ contentType: string; /** * Name of the user that created the monitor. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitor. */ id: string; /** * If enabled, domain name will resolve to an IPv6 address. */ isIpv6: boolean; /** * If isRunNow is enabled, then the monitor will run immediately. */ isRunNow: boolean; /** * If runOnce is enabled, then the monitor will run once. */ isRunOnce: boolean; /** * Name of the user that recently updated the monitor. */ lastUpdatedBy: string; /** * Details required to schedule maintenance window. */ maintenanceWindowSchedules: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemMaintenanceWindowSchedule[]; /** * 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. */ monitorType: string; /** * 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. */ repeatIntervalInSeconds: number; /** * Scheduling policy to decide the distribution of monitor executions on vantage points. */ schedulingPolicy: string; /** * A filter to return only monitors using scriptId. */ scriptId: string; /** * Name of the script. */ scriptName: string; /** * List of script parameters. Example: `[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]` */ scriptParameters: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemScriptParameter[]; /** * A filter to return only monitors that match the status given. */ status: string; /** * 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. */ target: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; /** * 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. */ timeoutInSeconds: number; /** * Number of vantage points where monitor is running. */ vantagePointCount: number; /** * List of public, dedicated and onPremise vantage points where the monitor is running. */ vantagePoints: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemVantagePoint[]; } interface GetMonitorsMonitorCollectionItemAvailabilityConfiguration { /** * 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. */ maxAllowedFailuresPerInterval: number; /** * 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. */ minAllowedRunsPerInterval: number; } interface GetMonitorsMonitorCollectionItemConfiguration { /** * Details for client certificate. */ clientCertificateDetails: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetail[]; /** * Type of configuration. */ configType: string; /** * Database connection string. */ connectionString: string; /** * Details for basic authentication. */ databaseAuthenticationDetails: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail[]; /** * Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type. */ databaseConnectionType: string; /** * Database role. */ databaseRole: string; /** * Database type. */ databaseType: string; /** * Details for database wallet. */ databaseWalletDetails: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail[]; /** * Information about the DNS settings. */ dnsConfigurations: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration[]; /** * Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB. */ downloadSizeLimitInBytes: number; /** * Details for basic authentication. */ ftpBasicAuthenticationDetails: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail[]; /** * FTP protocol type. */ ftpProtocol: string; /** * FTP monitor request type. */ ftpRequestType: string; /** * If enabled, Active mode will be used for the FTP connection. Not supported for SFTP protocol. */ isActiveMode: boolean; /** * If certificate validation is enabled, then the call will fail in case of certification errors. */ isCertificateValidationEnabled: boolean; /** * If disabled, auto snapshots are not collected. */ isDefaultSnapshotEnabled: boolean; /** * If isFailureRetried is enabled, then a failed call will be retried. */ isFailureRetried: boolean; /** * If isQueryRecursive is enabled, then queries will be sent recursively to the target server. */ isQueryRecursive: boolean; /** * If redirection is enabled, then redirects will be allowed while accessing target URL. */ isRedirectionEnabled: boolean; /** * Name of the server that will be used to perform DNS lookup. */ nameServer: string; /** * Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory. */ networkConfigurations: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration[]; /** * Type of protocol. */ protocol: string; /** * SQL query to be executed. */ query: string; /** * DNS record type. */ recordType: string; /** * Details for request HTTP authentication. */ reqAuthenticationDetails: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail[]; /** * Request HTTP authentication scheme. */ reqAuthenticationScheme: string; /** * List of request headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]` */ requestHeaders: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationRequestHeader[]; /** * Request HTTP method. */ requestMethod: string; /** * Request post body content. */ requestPostBody: string; /** * List of request query params. Example: `[{"paramName": "sortOrder", "paramValue": "asc"}]` */ requestQueryParams: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam[]; /** * File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB. */ uploadFileSizeInBytes: number; /** * Expected HTTP response codes. For status code range, set values such as 2xx, 3xx. */ verifyResponseCodes: string[]; /** * Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure. */ verifyResponseContent: string; /** * 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. */ verifyTexts: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationVerifyText[]; } interface GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetail { /** * Client certificate in PEM format. */ clientCertificates: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate[]; /** * The private key associated with the client certificate in PEM format. */ privateKeys: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey[]; } interface GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate { /** * Content of the private key file. */ content: string; /** * Name of the private key file. */ fileName: string; } interface GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey { /** * Content of the private key file. */ content: string; /** * Name of the private key file. */ fileName: string; } interface GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail { /** * Password. */ passwords: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword[]; /** * Username for authentication. */ username: string; } interface GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword { /** * Password. */ password: string; /** * Type of method to pass password. */ passwordType: string; /** * Vault secret OCID. */ vaultSecretId: string; } interface GetMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail { /** * The database wallet configuration zip file. */ databaseWallet: string; /** * Service name of the database. */ serviceName: string; } interface GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration { /** * If isOverrideDns is true, then DNS settings will be overridden. */ isOverrideDns: boolean; /** * Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true. */ overrideDnsIp: string; } interface GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail { /** * Password. */ passwords: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword[]; /** * Username for authentication. */ username: string; } interface GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword { /** * Password. */ password: string; /** * Type of method to pass password. */ passwordType: string; /** * Vault secret OCID. */ vaultSecretId: string; } interface GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration { /** * Number of hops. */ numberOfHops: number; /** * Type of probe mode when TCP protocol is selected. */ probeMode: string; /** * Number of probes per hop. */ probePerHop: number; /** * Type of protocol. */ protocol: string; /** * Number of probe packets sent out simultaneously. */ transmissionRate: number; } interface GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail { /** * List of authentication headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]` */ authHeaders: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader[]; /** * Request method. */ authRequestMethod: string; /** * Request post body. */ authRequestPostBody: string; /** * Authentication token. */ authToken: string; /** * URL to get authentication token. */ authUrl: string; /** * User name for authentication. */ authUserName: string; /** * User password for authentication. */ authUserPassword: string; /** * Request HTTP OAuth scheme. */ oauthScheme: string; } interface GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader { /** * Name of the header. */ headerName: string; /** * Value of the header. */ headerValue: string; } interface GetMonitorsMonitorCollectionItemConfigurationRequestHeader { /** * Name of the header. */ headerName: string; /** * Value of the header. */ headerValue: string; } interface GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam { /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; } interface GetMonitorsMonitorCollectionItemConfigurationVerifyText { /** * Verification text in the response. */ text: string; } interface GetMonitorsMonitorCollectionItemMaintenanceWindowSchedule { /** * 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` */ timeEnded: string; /** * 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` */ timeStarted: string; } interface GetMonitorsMonitorCollectionItemScriptParameter { /** * If parameter value is default or overwritten. */ isOverwritten: boolean; /** * Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API. */ isSecret: boolean; /** * Details of the script parameter that can be used to overwrite the parameter present in the script. */ monitorScriptParameters: outputs.ApmSynthetics.GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter[]; /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; } interface GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter { /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; } interface GetMonitorsMonitorCollectionItemVantagePoint { /** * A filter to return only the resources that match the entire display name. */ displayName: string; /** * Name of the vantage point. */ name: string; /** * List of workers running the assigned monitor. */ workerLists: string[]; } interface GetOnPremiseVantagePointWorkerIdentityInfo { /** * Domain short id of the On-premise VP worker. */ apmShortId: string; /** * Collector endpoint of the On-premise VP worker. */ collectorEndPoint: string; /** * Domain region of the On-premise VP worker. */ regionName: string; } interface GetOnPremiseVantagePointWorkerMonitorList { /** * Unique name that can be edited. The name should not contain any confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitor. */ id: string; /** * If isRunNow is enabled, then the monitor will run immediately. */ isRunNow: boolean; /** * Type of monitor. */ monitorType: string; /** * 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` */ timeAssigned: string; } interface GetOnPremiseVantagePointWorkerVersionDetail { /** * Latest image version of the On-premise VP worker. */ latestVersion: string; /** * Minimum supported image version of the On-premise VP worker. */ minSupportedVersion: string; /** * Current image version of the On-premise VP worker. */ version: string; } interface GetOnPremiseVantagePointWorkersFilter { /** * A filter to return only the resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetOnPremiseVantagePointWorkersSummary { /** * Number of available workers in a specific On-premise vantage point. */ available: number; /** * List of available capabilities in a specific On-premise vantage point. */ availableCapabilities: outputs.ApmSynthetics.GetOnPremiseVantagePointWorkersSummaryAvailableCapability[]; /** * Number of disabled workers in a specific On-premise vantage point. */ disabled: number; /** * Minimum version among the workers in a specific On-premise vantage point. */ minVersion: string; /** * Total number of workers in a specific On-premise vantage point. */ total: number; /** * Number of occupied workers in a specific On-premise vantage point. */ used: number; } interface GetOnPremiseVantagePointWorkersSummaryAvailableCapability { /** * Capability of an On-premise vantage point worker. */ capability: string; /** * Count of available capability in a specific On-premise vantage point. */ onPremiseVantagePointCount: number; } interface GetOnPremiseVantagePointWorkersWorkerCollection { items: outputs.ApmSynthetics.GetOnPremiseVantagePointWorkersWorkerCollectionItem[]; } interface GetOnPremiseVantagePointWorkersWorkerCollectionItem { /** * The APM domain ID the request is intended for. */ apmDomainId: string; /** * Configuration details of the On-premise VP worker. */ configurationDetails: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Geographical information of the On-premise VP worker. */ geoInfo: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitor. */ id: string; /** * Domain details of the On-premise VP worker. */ identityInfos: outputs.ApmSynthetics.GetOnPremiseVantagePointWorkersWorkerCollectionItemIdentityInfo[]; /** * Monitors list assigned to the On-premise VP worker. */ monitorLists: outputs.ApmSynthetics.GetOnPremiseVantagePointWorkersWorkerCollectionItemMonitorList[]; /** * A filter to return only the resources that match the entire name. */ name: string; /** * The OCID of the On-premise vantage point. */ onPremiseVantagePointId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the On-premise vantage point. */ opvpId: string; /** * On-premise vantage point name. */ opvpName: string; /** * Priority of the On-premise VP worker to schedule monitors. */ priority: number; resourcePrincipalTokenPublicKey: string; /** * The runtime assigned id of the On-premise VP worker. */ runtimeId: string; /** * A filter to return only On-premise VP workers that match the status given. */ status: string; /** * 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` */ timeCreated: string; /** * 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` */ timeLastSyncUp: string; /** * 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` */ timeUpdated: string; /** * Current image version of the On-premise VP worker. */ version: string; /** * Image version details of the On-premise VP worker. */ versionDetails: outputs.ApmSynthetics.GetOnPremiseVantagePointWorkersWorkerCollectionItemVersionDetail[]; /** * Type of the On-premise VP worker. */ workerType: string; } interface GetOnPremiseVantagePointWorkersWorkerCollectionItemIdentityInfo { /** * Domain short id of the On-premise VP worker. */ apmShortId: string; /** * Collector endpoint of the On-premise VP worker. */ collectorEndPoint: string; /** * Domain region of the On-premise VP worker. */ regionName: string; } interface GetOnPremiseVantagePointWorkersWorkerCollectionItemMonitorList { /** * A filter to return only the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitor. */ id: string; /** * If isRunNow is enabled, then the monitor will run immediately. */ isRunNow: boolean; /** * Type of monitor. */ monitorType: string; /** * 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` */ timeAssigned: string; } interface GetOnPremiseVantagePointWorkersWorkerCollectionItemVersionDetail { /** * Latest image version of the On-premise VP worker. */ latestVersion: string; /** * Minimum supported image version of the On-premise VP worker. */ minSupportedVersion: string; /** * Current image version of the On-premise VP worker. */ version: string; } interface GetOnPremiseVantagePointsFilter { /** * A filter to return only the resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetOnPremiseVantagePointsOnPremiseVantagePointCollection { items: outputs.ApmSynthetics.GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItem[]; } interface GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItem { /** * The APM domain ID the request is intended for. */ apmDomainId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A short description about the On-premise vantage point. */ description: string; /** * A filter to return only the resources that match the entire display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the On-premise vantage point. */ id: string; /** * A filter to return only the resources that match the entire name. */ name: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; /** * Type of On-premise vantage point. */ type: string; /** * Details of the workers in a specific On-premise vantage point. */ workersSummaries: outputs.ApmSynthetics.GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary[]; } interface GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary { /** * Number of available workers in a specific On-premise vantage point. */ available: number; /** * List of available capabilities in a specific On-premise vantage point. */ availableCapabilities: outputs.ApmSynthetics.GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability[]; /** * Number of disabled workers in a specific On-premise vantage point. */ disabled: number; /** * Minimum version among the workers in a specific On-premise vantage point. */ minVersion: string; /** * Total number of workers in a specific On-premise vantage point. */ total: number; /** * Number of occupied workers in a specific On-premise vantage point. */ used: number; } interface GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability { /** * Capability of an On-premise vantage point worker. */ capability: string; /** * Count of available capability in a specific On-premise vantage point. */ onPremiseVantagePointCount: number; } interface GetResultResultDataSet { /** * Data content in byte format. Example: Zip or Screenshot. */ byteContent: string; /** * Name of the data. */ name: string; /** * Data content in string format. Example: HAR. */ stringContent: string; /** * 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` */ timestamp: string; } interface GetScriptMonitorStatusCountMap { /** * Number of disabled monitors using the script. */ disabled: number; /** * Number of enabled monitors using the script. */ enabled: number; /** * Number of invalid monitors using the script. */ invalid: number; /** * Total number of monitors using the script. */ total: number; } interface GetScriptParameter { /** * If parameter value is default or overwritten. */ isOverwritten: boolean; /** * If the parameter value is secret and should be kept confidential, then set isSecret to true. */ isSecret: boolean; /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; /** * 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. */ scriptParameters: outputs.ApmSynthetics.GetScriptParameterScriptParameter[]; } interface GetScriptParameterScriptParameter { /** * If the parameter value is secret and should be kept confidential, then set isSecret to true. */ isSecret: boolean; /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; } interface GetScriptsFilter { name: string; regex?: boolean; values: string[]; } interface GetScriptsScriptCollection { items: outputs.ApmSynthetics.GetScriptsScriptCollectionItem[]; } interface GetScriptsScriptCollectionItem { /** * The APM domain ID the request is intended for. */ apmDomainId: string; /** * 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: `param nameparam valueisParamValueSecret(true/false)`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `param name` With parameter name and value : `param nameparam value` 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. */ content: string; /** * File name of the uploaded script content. */ contentFileName: string; /** * Size of the script content. */ contentSizeInBytes: number; /** * A filter to return only resources that match the content type given. */ contentType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ id: string; /** * Details of the monitor count per state. Example: `{ "total" : 5, "enabled" : 3 , "disabled" : 2, "invalid" : 0 }` */ monitorStatusCountMaps: outputs.ApmSynthetics.GetScriptsScriptCollectionItemMonitorStatusCountMap[]; /** * List of script parameters. Example: `[{"scriptParameter": {"paramName": "userid", "paramValue":"testuser", "isSecret": false}, "isOverwritten": false}]` */ parameters: outputs.ApmSynthetics.GetScriptsScriptCollectionItemParameter[]; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; /** * The time the script was uploaded. */ timeUploaded: string; } interface GetScriptsScriptCollectionItemMonitorStatusCountMap { /** * Number of disabled monitors using the script. */ disabled: number; /** * Number of enabled monitors using the script. */ enabled: number; /** * Number of invalid monitors using the script. */ invalid: number; /** * Total number of monitors using the script. */ total: number; } interface GetScriptsScriptCollectionItemParameter { /** * If parameter value is default or overwritten. */ isOverwritten: boolean; /** * If the parameter value is secret and should be kept confidential, then set isSecret to true. */ isSecret: boolean; /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; /** * 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. */ scriptParameters: outputs.ApmSynthetics.GetScriptsScriptCollectionItemParameterScriptParameter[]; } interface GetScriptsScriptCollectionItemParameterScriptParameter { /** * If the parameter value is secret and should be kept confidential, then set isSecret to true. */ isSecret: boolean; /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; } interface GetVantagePointItem { /** * A filter to return only the resources that match the entire display name. */ displayName: string; /** * Geographic summary of a vantage point. */ geos: outputs.ApmSynthetics.GetVantagePointItemGeo[]; /** * A filter to return only the resources that match the entire name. */ name: string; } interface GetVantagePointItemGeo { /** * 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. */ adminDivCode: string; /** * Common English-language name for the city. */ cityName: string; /** * The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes. */ countryCode: string; /** * The common English-language name for the country. */ countryName: string; /** * Degrees north of the Equator. */ latitude: number; /** * Degrees east of the prime meridian. */ longitude: number; } interface GetVantagePointsFilter { /** * A filter to return only the resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetVantagePointsPublicVantagePointCollection { /** * List of PublicVantagePointSummary items. */ items: outputs.ApmSynthetics.GetVantagePointsPublicVantagePointCollectionItem[]; } interface GetVantagePointsPublicVantagePointCollectionItem { /** * A filter to return only the resources that match the entire display name. */ displayName: string; /** * Geographic summary of a vantage point. */ geos: outputs.ApmSynthetics.GetVantagePointsPublicVantagePointCollectionItemGeo[]; /** * A filter to return only the resources that match the entire name. */ name: string; } interface GetVantagePointsPublicVantagePointCollectionItemGeo { /** * 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. */ adminDivCode: string; /** * Common English-language name for the city. */ cityName: string; /** * The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes. */ countryCode: string; /** * The common English-language name for the country. */ countryName: string; /** * Degrees north of the equator. */ latitude: number; /** * Degrees east of the prime meridian. */ longitude: number; } interface OnPremiseVantagePointWorkerIdentityInfo { /** * Domain short id of the On-premise VP worker. */ apmShortId: string; /** * Collector endpoint of the On-premise VP worker. */ collectorEndPoint: string; /** * Domain region of the On-premise VP worker. */ regionName: string; } interface OnPremiseVantagePointWorkerMonitorList { /** * Unique name that can be edited. The name should not contain any confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitor. */ id: string; /** * If isRunNow is enabled, then the monitor will run immediately. */ isRunNow: boolean; /** * Type of monitor. */ monitorType: string; /** * 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` */ timeAssigned: string; } interface OnPremiseVantagePointWorkerVersionDetail { /** * Latest image version of the On-premise VP worker. */ latestVersion: string; /** * Minimum supported image version of the On-premise VP worker. */ minSupportedVersion: string; /** * Image version of the On-premise VP worker. */ version: string; } interface OnPremiseVantagePointWorkersSummary { /** * Number of available workers in a specific On-premise vantage point. */ available: number; /** * List of available capabilities in a specific On-premise vantage point. */ availableCapabilities: outputs.ApmSynthetics.OnPremiseVantagePointWorkersSummaryAvailableCapability[]; /** * Number of disabled workers in a specific On-premise vantage point. */ disabled: number; /** * Minimum version among the workers in a specific On-premise vantage point. */ minVersion: string; /** * Total number of workers in a specific On-premise vantage point. */ total: number; /** * Number of occupied workers in a specific On-premise vantage point. */ used: number; } interface OnPremiseVantagePointWorkersSummaryAvailableCapability { /** * Capability of an On-premise vantage point worker. */ capability: string; /** * Count of available capability in a specific On-premise vantage point. */ onPremiseVantagePointCount: number; } interface ScriptMonitorStatusCountMap { /** * Number of disabled monitors using the script. */ disabled: number; /** * Number of enabled monitors using the script. */ enabled: number; /** * Number of invalid monitors using the script. */ invalid: number; /** * Total number of monitors using the script. */ total: number; } interface ScriptParameter { /** * If parameter value is default or overwritten. */ isOverwritten: boolean; /** * (Updatable) If the parameter value is secret and should be kept confidential, then set isSecret to true. */ isSecret: boolean; /** * (Updatable) Name of the parameter. */ paramName: string; /** * (Updatable) Value of the parameter. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ paramValue: string; /** * 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. */ scriptParameters: outputs.ApmSynthetics.ScriptParameterScriptParameter[]; } interface ScriptParameterScriptParameter { /** * If the parameter value is secret and should be kept confidential, then set isSecret to true. */ isSecret: boolean; /** * Name of the parameter. */ paramName: string; /** * Value of the parameter. */ paramValue: string; } } export declare namespace ApmTraces { interface GetLogAttribute { /** * Key that specifies the attribute name. */ attributeName: string; /** * Value associated with the attribute key. */ attributeValue: string; } interface GetQueryQuickPicksFilter { name: string; regex?: boolean; values: string[]; } interface GetQueryQuickPicksQuickPick { /** * Quick Pick name for the query. */ quickPickName: string; /** * Query for the Quick Pick. */ quickPickQuery: string; } interface GetScheduledQueriesFilter { /** * Name of the Custom Metric. */ name: string; regex?: boolean; values: string[]; } interface GetScheduledQueriesScheduledQueryCollection { items: outputs.ApmTraces.GetScheduledQueriesScheduledQueryCollectionItem[]; } interface GetScheduledQueriesScheduledQueryCollectionItem { /** * The APM Domain ID for the intended request. */ apmDomainId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ id: string; opcDryRun: string; /** * Description for the scheduled query. */ scheduledQueryDescription: string; /** * Scheduled query instances. */ scheduledQueryInstances: string; /** * Maximum runtime for the scheduled query in seconds. */ scheduledQueryMaximumRuntimeInSeconds: string; /** * Name of the scheduled query. */ scheduledQueryName: string; /** * Next run for the scheduled query. */ scheduledQueryNextRunInMs: string; /** * Definition of the scheduled query processing configuration. */ scheduledQueryProcessingConfigurations: outputs.ApmTraces.GetScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfiguration[]; /** * Processing sub type of the scheduled query. */ scheduledQueryProcessingSubType: string; /** * Processing type of the scheduled query. */ scheduledQueryProcessingType: string; /** * Retention criteria for the scheduled query. */ scheduledQueryRetentionCriteria: string; /** * Retention period for the scheduled query in milliseconds. */ scheduledQueryRetentionPeriodInMs: string; /** * Schedule for the scheduled query. */ scheduledQuerySchedule: string; /** * Scheduled query to be run. */ scheduledQueryText: string; /** * The current lifecycle state of the Scheduled Query. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfiguration { /** * Definition of the Custom Metric. */ customMetrics: outputs.ApmTraces.GetScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationCustomMetric[]; /** * Definition of the object storage. */ objectStorages: outputs.ApmTraces.GetScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationObjectStorage[]; /** * Definition of the Stream. */ streamings: outputs.ApmTraces.GetScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationStreaming[]; } interface GetScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationCustomMetric { /** * 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. */ compartment: string; /** * Description of the Custom Metric. */ description: string; /** * Indicates whether anomaly Detection should be performed on the generated metric. */ isAnomalyDetectionEnabled: boolean; /** * 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. */ isMetricPublished: boolean; /** * Name of the Custom Metric. */ name: string; /** * Namespace in the Custom Metric. It defaults to `oracleApmCustom` if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace. */ namespace: string; /** * Resource Group of the Custom Metric. */ resourceGroup: string; /** * Unit in which the metric value is reported. For example 'ms'. */ unit: string; } interface GetScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationObjectStorage { /** * Bucket name in the object store. */ bucket: string; /** * Namespace in the object store. */ nameSpace: string; /** * Object name prefix in the object store. */ objectNamePrefix: string; } interface GetScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationStreaming { /** * Stream Id. */ streamId: string; } interface GetScheduledQueryScheduledQueryProcessingConfiguration { /** * Definition of the Custom Metric. */ customMetrics: outputs.ApmTraces.GetScheduledQueryScheduledQueryProcessingConfigurationCustomMetric[]; /** * Definition of the object storage. */ objectStorages: outputs.ApmTraces.GetScheduledQueryScheduledQueryProcessingConfigurationObjectStorage[]; /** * Definition of the Stream. */ streamings: outputs.ApmTraces.GetScheduledQueryScheduledQueryProcessingConfigurationStreaming[]; } interface GetScheduledQueryScheduledQueryProcessingConfigurationCustomMetric { /** * 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. */ compartment: string; /** * Description of the Custom Metric. */ description: string; /** * Indicates whether anomaly Detection should be performed on the generated metric. */ isAnomalyDetectionEnabled: boolean; /** * 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. */ isMetricPublished: boolean; /** * Name of the Custom Metric. */ name: string; /** * Namespace in the Custom Metric. It defaults to `oracleApmCustom` if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace. */ namespace: string; /** * Resource Group of the Custom Metric. */ resourceGroup: string; /** * Unit in which the metric value is reported. For example 'ms'. */ unit: string; } interface GetScheduledQueryScheduledQueryProcessingConfigurationObjectStorage { /** * Bucket name in the object store. */ bucket: string; /** * Namespace in the object store. */ nameSpace: string; /** * Object name prefix in the object store. */ objectNamePrefix: string; } interface GetScheduledQueryScheduledQueryProcessingConfigurationStreaming { /** * Stream Id. */ streamId: string; } interface GetTraceAggregatedSnapshotDataDetail { /** * Name of the property. */ key: string; /** * Value of the property. */ value: string; } interface GetTraceServiceSummary { /** * Number of spans with errors for serviceName in the trace. */ errorSpans: string; /** * Name associated with the service. */ spanServiceName: string; /** * Number of spans for serviceName in the trace. */ totalSpans: string; } interface GetTraceSnapshotDataTraceSnapshotDetail { /** * Name of the property. */ key: string; /** * Value of the property. */ value: string; } interface GetTraceSpan { /** * Total span duration in milliseconds. */ durationInMs: string; /** * Indicates if the span has an error. */ isError: boolean; /** * 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. */ key: string; /** * Kind associated with the span. */ kind: string; /** * List of logs associated with the span. */ logs: outputs.ApmTraces.GetTraceSpanLog[]; /** * Span name associated with the trace. This is usually the method or URI of the request. */ operationName: string; /** * Unique parent identifier for the span if one exists. For root spans this will be null. */ parentSpanKey: string; /** * Service name associated with the span. */ serviceName: string; /** * Source of span (spans, syn_spans). */ sourceName: string; /** * List of tags associated with the span. */ tags: outputs.ApmTraces.GetTraceSpanTag[]; /** * Span end time. Timestamp when the span was completed. */ timeEnded: string; /** * Span start time. Timestamp when the span was started. */ timeStarted: string; /** * Unique Application Performance Monitoring trace identifier (traceId). */ traceKey: string; } interface GetTraceSpanLog { /** * Name of the event for which the log is created. */ eventName: string; /** * List of logs associated with the span at the given timestamp. */ spanLogs: outputs.ApmTraces.GetTraceSpanLogSpanLog[]; /** * Timestamp at which the log is created. */ timeCreated: string; } interface GetTraceSpanLogSpanLog { /** * Key that specifies the log name. */ logKey: string; /** * Value associated with the log key. */ logValue: string; } interface GetTraceSpanSummary { /** * 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. */ errorSpanCount: number; /** * Boolean flag that indicates whether the trace has an error. */ isFault: boolean; /** * 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. */ key: string; /** * Time taken for the root span operation to complete in milliseconds. */ rootSpanDurationInMs: number; /** * 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. */ rootSpanOperationName: string; /** * Service associated with the trace. */ rootSpanServiceName: string; /** * A summary of the spans by service. */ serviceSummaries: outputs.ApmTraces.GetTraceSpanSummaryServiceSummary[]; /** * 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. */ spanCount: number; /** * Start time of the earliest span in the span collection. */ timeEarliestSpanStarted: string; /** * End time of the span that most recently ended in the span collection. */ timeLatestSpanEnded: string; /** * End time of the root span for the span collection. */ timeRootSpanEnded: string; /** * Start time of the root span for the span collection. */ timeRootSpanStarted: string; /** * Time between the start of the earliest span and the end of the most recent span in milliseconds. */ traceDurationInMs: number; /** * Error code of the trace. */ traceErrorCode: string; /** * Error type of the trace. */ traceErrorType: string; /** * 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. */ traceStatus: string; } interface GetTraceSpanSummaryServiceSummary { /** * Number of spans with errors for serviceName in the trace. */ errorSpans: string; /** * Name associated with the service. */ spanServiceName: string; /** * Number of spans for serviceName in the trace. */ totalSpans: string; } interface GetTraceSpanTag { /** * Key that specifies the tag name. */ tagName: string; /** * Value associated with the tag key. */ tagValue: string; } interface ScheduledQueryScheduledQueryProcessingConfiguration { /** * (Updatable) Definition of the Custom Metric. */ customMetric: outputs.ApmTraces.ScheduledQueryScheduledQueryProcessingConfigurationCustomMetric; /** * (Updatable) Definition of the object storage. */ objectStorage: outputs.ApmTraces.ScheduledQueryScheduledQueryProcessingConfigurationObjectStorage; /** * (Updatable) Definition of the Stream. */ streaming: outputs.ApmTraces.ScheduledQueryScheduledQueryProcessingConfigurationStreaming; } interface ScheduledQueryScheduledQueryProcessingConfigurationCustomMetric { /** * (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. */ compartment: string; /** * (Updatable) Description of the Custom Metric. */ description: string; /** * (Updatable) Indicates whether anomaly Detection should be performed on the generated metric. */ isAnomalyDetectionEnabled: boolean; /** * (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. */ isMetricPublished: boolean; /** * (Updatable) Name of the Custom Metric. */ name: string; /** * (Updatable) Namespace in the Custom Metric. It defaults to `oracleApmCustom` if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace. */ namespace: string; /** * (Updatable) Resource Group of the Custom Metric. */ resourceGroup: string; /** * (Updatable) Unit in which the metric value is reported. For example 'ms'. */ unit: string; } interface ScheduledQueryScheduledQueryProcessingConfigurationObjectStorage { /** * (Updatable) Bucket name in the object store. */ bucket: string; /** * (Updatable) Namespace in the object store. */ nameSpace: string; /** * (Updatable) Object name prefix in the object store. */ objectNamePrefix: string; } interface ScheduledQueryScheduledQueryProcessingConfigurationStreaming { /** * (Updatable) Stream Id. */ streamId: string; } } export declare namespace AppMgmtControl { interface GetMonitoredInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetMonitoredInstancesMonitoredInstanceCollection { items: outputs.AppMgmtControl.GetMonitoredInstancesMonitoredInstanceCollectionItem[]; } interface GetMonitoredInstancesMonitoredInstanceCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of monitored instance. */ instanceId: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * 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. */ managementAgentId: string; /** * Monitoring status. Can be either enabled or disabled. */ monitoringState: string; /** * The current state of the monitored instance. */ state: string; /** * The time the MonitoredInstance was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the MonitoredInstance was updated. An RFC3339 formatted datetime string */ timeUpdated: string; } } export declare namespace Artifacts { interface ContainerRepositoryReadme { /** * (Updatable) Readme content. Avoid entering confidential information. */ content: string; /** * (Updatable) Readme format. Supported formats are text/plain and text/markdown. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ format: string; } interface GetContainerImageLayer { /** * The sha256 digest of the image layer. */ digest: string; /** * The size of the layer in bytes. */ sizeInBytes: string; /** * The creation time of the version. */ timeCreated: string; } interface GetContainerImageVersion { /** * The OCID of the user or principal that pushed the version. */ createdBy: string; /** * The creation time of the version. */ timeCreated: string; /** * The version name. */ version: string; } interface GetContainerImagesContainerImageCollection { items: outputs.Artifacts.GetContainerImagesContainerImageCollectionItem[]; remainingItemsCount: number; } interface GetContainerImagesContainerImageCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The OCID of the user or principal that pushed the version. */ createdBy: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The sha256 digest of the image layer. */ digest: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image. Example: `ocid1.containerimage.oc1..exampleuniqueID` */ id: string; /** * Layers of which the image is composed, ordered by the layer digest. */ layers: outputs.Artifacts.GetContainerImagesContainerImageCollectionItemLayer[]; /** * The total size of the container image layers in bytes. */ layersSizeInBytes: string; /** * The size of the container image manifest in bytes. */ manifestSizeInBytes: number; /** * Total number of pulls. */ pullCount: string; /** * A filter to return container images only for the specified container repository OCID. */ repositoryId: string; /** * A filter to return container images or container image signatures that match the repository name. Example: `foo` or `foo*` */ repositoryName: string; /** * A filter to return only resources that match the given lifecycle state name exactly. */ state: string; /** * The system tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The creation time of the version. */ timeCreated: string; /** * An RFC 3339 timestamp indicating when the image was last pulled. */ timeLastPulled: string; /** * A filter to return container images that match the version. Example: `foo` or `foo*` */ version: string; /** * The versions associated with this image. */ versions: outputs.Artifacts.GetContainerImagesContainerImageCollectionItemVersion[]; } interface GetContainerImagesContainerImageCollectionItemLayer { /** * The sha256 digest of the image layer. */ digest: string; /** * The size of the layer in bytes. */ sizeInBytes: string; /** * The creation time of the version. */ timeCreated: string; } interface GetContainerImagesContainerImageCollectionItemVersion { /** * The OCID of the user or principal that pushed the version. */ createdBy: string; /** * The creation time of the version. */ timeCreated: string; /** * A filter to return container images that match the version. Example: `foo` or `foo*` */ version: string; } interface GetContainerImagesFilter { name: string; regex?: boolean; values: string[]; } interface GetContainerRepositoriesContainerRepositoryCollection { /** * Total number of images. */ imageCount: number; /** * List of container repositories. */ items: outputs.Artifacts.GetContainerRepositoriesContainerRepositoryCollectionItem[]; /** * Total number of layers. */ layerCount: number; /** * Total size of layers. */ layersSizeInBytes: string; /** * The number of remaining items. */ remainingItemsCount: number; /** * Total number of repositories. */ repositoryCount: number; } interface GetContainerRepositoriesContainerRepositoryCollectionItem { /** * Total storage size in GBs that will be charged. */ billableSizeInGbs: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The id of the user or principal that created the resource. */ createdBy: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository. Example: `ocid1.containerrepo.oc1..exampleuniqueID` */ id: string; /** * Total number of images. */ imageCount: number; /** * Whether the repository is immutable. Images cannot be overwritten in an immutable repository. */ isImmutable: boolean; /** * A filter to return resources that match the isPublic value. */ isPublic: boolean; /** * Total number of layers. */ layerCount: number; /** * Total size of layers. */ layersSizeInBytes: string; /** * The tenancy namespace used in the container repository path. */ namespace: string; /** * Container repository readme. */ readmes: outputs.Artifacts.GetContainerRepositoriesContainerRepositoryCollectionItemReadme[]; /** * A filter to return only resources that match the given lifecycle state name exactly. */ state: string; /** * The system tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * An RFC 3339 timestamp indicating when the repository was created. */ timeCreated: string; /** * An RFC 3339 timestamp indicating when an image was last pushed to the repository. */ timeLastPushed: string; } interface GetContainerRepositoriesContainerRepositoryCollectionItemReadme { /** * Readme content. Avoid entering confidential information. */ content: string; /** * Readme format. Supported formats are text/plain and text/markdown. */ format: string; } interface GetContainerRepositoriesFilter { name: string; regex?: boolean; values: string[]; } interface GetContainerRepositoryReadme { /** * Readme content. Avoid entering confidential information. */ content: string; /** * Readme format. Supported formats are text/plain and text/markdown. */ format: string; } interface GetContainerSignaturesContainerImageSignatureCollection { items: outputs.Artifacts.GetContainerSignaturesContainerImageSignatureCollectionItem[]; remainingItemsCount: number; } interface GetContainerSignaturesContainerImageSignatureCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The id of the user or principal that created the resource. */ createdBy: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image signature. Example: `ocid1.containerimagesignature.oc1..exampleuniqueID` */ id: string; /** * A filter to return a container image summary only for the specified container image OCID. */ imageId: string; /** * 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` */ kmsKeyId: string; /** * 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` */ kmsKeyVersionId: string; /** * The base64 encoded signature payload that was signed. */ message: string; /** * The signature of the message field using the kmsKeyId, the kmsKeyVersionId, and the signingAlgorithm. */ signature: string; /** * The algorithm to be used for signing. These are the only supported signing algorithms for container images. */ signingAlgorithm: string; /** * The current state of the container image signature. */ state: string; /** * The system tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * An RFC 3339 timestamp indicating when the image was created. */ timeCreated: string; } interface GetContainerSignaturesFilter { name: string; regex?: boolean; values: string[]; } interface GetGenericArtifactsFilter { name: string; regex?: boolean; values: string[]; } interface GetGenericArtifactsGenericArtifactCollection { items: outputs.Artifacts.GetGenericArtifactsGenericArtifactCollectionItem[]; } interface GetGenericArtifactsGenericArtifactCollectionItem { artifactId: string; /** * Filter results by a prefix for the `artifactPath` and and return artifacts that begin with the specified prefix in their path. */ artifactPath: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return the resources for the specified OCID. */ id: string; /** * A filter to return the artifacts only for the specified repository OCID. */ repositoryId: string; /** * Filter results by a specified SHA256 digest for the artifact. */ sha256: string; /** * The size of the artifact in bytes. */ sizeInBytes: string; /** * A filter to return only resources that match the given lifecycle state name exactly. */ state: string; /** * An RFC 3339 timestamp indicating when the repository was created. */ timeCreated: string; /** * Filter results by a prefix for `version` and return artifacts that that begin with the specified prefix in their version. */ version: string; } interface GetRepositoriesFilter { name: string; regex?: boolean; values: string[]; } interface GetRepositoriesRepositoryCollection { items: outputs.Artifacts.GetRepositoriesRepositoryCollectionItem[]; } interface GetRepositoriesRepositoryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The repository description. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return the resources for the specified OCID. */ id: string; /** * A filter to return resources that match the isImmutable value. */ isImmutable: boolean; /** * The repository's supported artifact type. */ repositoryType: string; /** * A filter to return only resources that match the given lifecycle state name exactly. */ state: string; /** * An RFC 3339 timestamp indicating when the repository was created. */ timeCreated: string; } } export declare namespace Audit { interface GetEventsAuditEvent { /** * 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/). */ cloudEventsVersion: string; /** * The content type of the data contained in `data`. Example: `application/json` */ contentType: string; /** * The payload of the event. Information within `data` comes from the resource emitting the event. */ datas: outputs.Audit.GetEventsAuditEventData[]; /** * The GUID of the event. */ eventId: string; /** * The time the event occurred, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-09-18T00:10:59.252Z` */ eventTime: string; /** * The type of event that happened. */ eventType: string; /** * 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` */ eventTypeVersion: string; /** * The source of the event. Example: `ComputeApi` */ source: string; } interface GetEventsAuditEventData { /** * A container object for attribues unique to the resource emitting the event. */ additionalDetails: { [key: string]: string; }; /** * The availability domain where the resource resides. */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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` */ compartmentName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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. */ eventGroupingId: string; /** * Name of the API operation that generated this event. Example: `GetInstance` */ eventName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A container object for identity attributes. */ identities: outputs.Audit.GetEventsAuditEventDataIdentity[]; /** * A container object for request attributes. */ requests: outputs.Audit.GetEventsAuditEventDataRequest[]; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or some other ID for the resource emitting the event. */ resourceId: string; /** * The name of the resource emitting the event. */ resourceName: string; /** * A container object for response attributes. */ responses: outputs.Audit.GetEventsAuditEventDataResponse[]; /** * A container object for state change attributes. */ stateChanges: outputs.Audit.GetEventsAuditEventDataStateChange[]; } interface GetEventsAuditEventDataIdentity { /** * The type of authentication used. Example: `natv` */ authType: string; /** * 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. */ callerId: string; /** * The name of the user or service. This value is the friendly name associated with `callerId`. */ callerName: string; /** * This value identifies any Console session associated with this request. */ consoleSessionId: string; /** * 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 (/). */ credentials: string; /** * The IP address of the source of the request. Example: `172.24.80.88` */ ipAddress: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the principal. */ principalId: string; /** * The name of the user or service. This value is the friendly name associated with `principalId`. Example: `ExampleName` */ principalName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenant. */ tenantId: string; /** * The user agent of the client that made the request. Example: `Jersey/2.23 (HttpUrlConnection 1.8.0_212)` */ userAgent: string; } interface GetEventsAuditEventDataRequest { /** * The HTTP method of the request. Example: `GET` */ action: string; /** * The headers of the response. */ headers: { [key: string]: string; }; /** * The opc-request-id of the request. */ id: string; /** * The parameters supplied by the caller during this operation. */ parameters: { [key: string]: string; }; /** * The full path of the API request. Example: `/20160918/instances/ocid1.instance.oc1.phx.` */ path: string; } interface GetEventsAuditEventDataResponse { /** * The headers of the response. */ headers: { [key: string]: string; }; /** * A friendly description of what happened during the operation. Use this for troubleshooting. */ message: string; /** * This value is included for backward compatibility with the Audit version 1 schema, where it contained metadata of interest from the response payload. */ payload: { [key: string]: string; }; /** * 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` */ responseTime: string; /** * The status code of the response. Example: `200` */ status: string; } interface GetEventsAuditEventDataStateChange { /** * 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 `previous`. */ current: { [key: string]: string; }; /** * 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 `current`. */ previous: { [key: string]: string; }; } interface GetEventsFilter { name: string; regex?: boolean; values: string[]; } } export declare namespace Autoscaling { interface AutoScalingConfigurationAutoScalingResources { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is managed by the autoscaling configuration. */ id: string; /** * The type of resource. */ type: string; } interface AutoScalingConfigurationPolicy { /** * The capacity requirements of the autoscaling policy. */ capacity: outputs.Autoscaling.AutoScalingConfigurationPolicyCapacity; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * An execution schedule for an autoscaling policy. */ executionSchedule: outputs.Autoscaling.AutoScalingConfigurationPolicyExecutionSchedule; /** * ID of the condition that is assigned after creation. */ id: string; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The type of autoscaling policy. */ policyType: string; /** * An action to run on a resource, such as stopping or starting an instance pool. */ resourceAction: outputs.Autoscaling.AutoScalingConfigurationPolicyResourceAction; rules: outputs.Autoscaling.AutoScalingConfigurationPolicyRule[]; /** * The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface AutoScalingConfigurationPolicyCapacity { /** * 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. * * For 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. */ initial: number; /** * For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out). * * For a schedule-based autoscaling policy, this value is not used. */ max: number; /** * For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in). * * For a schedule-based autoscaling policy, this value is not used. */ min: number; } interface AutoScalingConfigurationPolicyExecutionSchedule { /** * A cron expression that represents the time at which to execute the autoscaling policy. * * Cron expressions have this format: ` ` * * You can use special characters that are supported with the Quartz cron implementation. * * You must specify `0` as the value for seconds. * * Example: `0 15 10 ? * *` */ expression: string; /** * The time zone for the execution schedule. */ timezone: string; /** * The type of execution schedule. */ type: string; } interface AutoScalingConfigurationPolicyResourceAction { action: string; /** * The category of action to run on the resource. */ actionType: string; } interface AutoScalingConfigurationPolicyRule { /** * The action to take when autoscaling is triggered. */ action: outputs.Autoscaling.AutoScalingConfigurationPolicyRuleAction; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * ID of the condition that is assigned after creation. */ id: string; metric: outputs.Autoscaling.AutoScalingConfigurationPolicyRuleMetric; } interface AutoScalingConfigurationPolicyRuleAction { /** * The type of action to take. */ type: string; /** * To scale out (increase the number of instances), provide a positive value. To scale in (decrease the number of instances), provide a negative value. */ value: number; } interface AutoScalingConfigurationPolicyRuleMetric { /** * The OCID of the compartment containing the metrics. */ metricCompartmentId?: string; /** * Source of the metric data for creating the alarm used to trigger autoscaling actions. * * The following values are supported: * * `COMPUTE_AGENT`: CPU or memory metrics emitted by the Compute Instance Monitoring plugin. * * `CUSTOM_QUERY`: A custom Monitoring Query Language (MQL) expression. */ metricSource?: string; metricType?: string; /** * The namespace for the query. */ namespace?: string; /** * 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." * * The 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. */ pendingDuration?: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. * * Example of threshold alarm: * * *** * * CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 * * *** */ query?: string; /** * The resource group for the query. */ resourceGroup?: string; threshold?: outputs.Autoscaling.AutoScalingConfigurationPolicyRuleMetricThreshold; } interface AutoScalingConfigurationPolicyRuleMetricThreshold { /** * 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`). */ operator: string; /** * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: number; } interface GetAutoScalingConfigurationAutoScalingResource { /** * ID of the condition that is assigned after creation. */ id: string; /** * The type of action to take. */ type: string; } interface GetAutoScalingConfigurationPolicy { /** * The capacity requirements of the autoscaling policy. */ capacities: outputs.Autoscaling.GetAutoScalingConfigurationPolicyCapacity[]; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The schedule for executing the autoscaling policy. */ executionSchedules: outputs.Autoscaling.GetAutoScalingConfigurationPolicyExecutionSchedule[]; /** * ID of the condition that is assigned after creation. */ id: string; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The type of autoscaling policy. */ policyType: string; /** * An action to run on a resource, such as stopping or starting an instance pool. */ resourceActions: outputs.Autoscaling.GetAutoScalingConfigurationPolicyResourceAction[]; rules: outputs.Autoscaling.GetAutoScalingConfigurationPolicyRule[]; /** * The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetAutoScalingConfigurationPolicyCapacity { /** * 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. */ initial: number; /** * For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out). */ max: number; /** * For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in). */ min: number; } interface GetAutoScalingConfigurationPolicyExecutionSchedule { /** * A cron expression that represents the time at which to execute the autoscaling policy. */ expression: string; /** * The time zone for the execution schedule. */ timezone: string; /** * The type of action to take. */ type: string; } interface GetAutoScalingConfigurationPolicyResourceAction { /** * The action to take when autoscaling is triggered. */ action: string; /** * The category of action to run on the resource. */ actionType: string; } interface GetAutoScalingConfigurationPolicyRule { /** * The action to take when autoscaling is triggered. */ actions: outputs.Autoscaling.GetAutoScalingConfigurationPolicyRuleAction[]; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * ID of the condition that is assigned after creation. */ id: string; metrics: outputs.Autoscaling.GetAutoScalingConfigurationPolicyRuleMetric[]; } interface GetAutoScalingConfigurationPolicyRuleAction { /** * The type of action to take. */ type: string; value: number; } interface GetAutoScalingConfigurationPolicyRuleMetric { /** * The OCID of the compartment containing the metrics. */ metricCompartmentId: string; /** * Source of the metric data for creating the alarm used to trigger autoscaling actions. */ metricSource: string; /** * Metric type example: CPU_UTILIZATION, MEMORY_UTILIZATION */ metricType: string; /** * The namespace for the query. */ namespace: string; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The resource group for the query. */ resourceGroup: string; thresholds: outputs.Autoscaling.GetAutoScalingConfigurationPolicyRuleMetricThreshold[]; } interface GetAutoScalingConfigurationPolicyRuleMetricThreshold { /** * 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`). */ operator: string; value: number; } interface GetAutoScalingConfigurationsAutoScalingConfiguration { /** * A resource that is managed by an autoscaling configuration. The only supported type is "instancePool." */ autoScalingResources: outputs.Autoscaling.GetAutoScalingConfigurationsAutoScalingConfigurationAutoScalingResource[]; /** * 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. */ compartmentId: string; /** * 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. */ coolDownInSeconds: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * ID of the condition that is assigned after creation. */ id: string; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The maximum number of resources to scale out to. */ maxResourceCount: number; /** * The minimum number of resources to scale in to. */ minResourceCount: number; /** * Autoscaling policy definitions for the autoscaling configuration. An autoscaling policy defines the criteria that trigger autoscaling actions and the actions to take. */ policies: outputs.Autoscaling.GetAutoScalingConfigurationsAutoScalingConfigurationPolicy[]; /** * The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetAutoScalingConfigurationsAutoScalingConfigurationAutoScalingResource { /** * ID of the condition that is assigned after creation. */ id: string; /** * The type of action to take. */ type: string; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicy { /** * The capacity requirements of the autoscaling policy. */ capacities: outputs.Autoscaling.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyCapacity[]; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The schedule for executing the autoscaling policy. */ executionSchedules: outputs.Autoscaling.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyExecutionSchedule[]; /** * ID of the condition that is assigned after creation. */ id: string; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The type of autoscaling policy. */ policyType: string; /** * An action to run on a resource, such as stopping or starting an instance pool. */ resourceActions: outputs.Autoscaling.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyResourceAction[]; rules: outputs.Autoscaling.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRule[]; /** * The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyCapacity { /** * 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. */ initial: number; /** * For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out). */ max: number; /** * For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in). */ min: number; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyExecutionSchedule { /** * A cron expression that represents the time at which to execute the autoscaling policy. */ expression: string; /** * The time zone for the execution schedule. */ timezone: string; /** * The type of action to take. */ type: string; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyResourceAction { /** * The action to take when autoscaling is triggered. */ action: string; /** * The category of action to run on the resource. */ actionType: string; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRule { /** * The action to take when autoscaling is triggered. */ actions: outputs.Autoscaling.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleAction[]; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * ID of the condition that is assigned after creation. */ id: string; /** * Metric type example: CPU_UTILIZATION, MEMORY_UTILIZATION */ metrics: outputs.Autoscaling.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric[]; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleAction { /** * The type of action to take. */ type: string; value: number; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric { /** * The OCID of the compartment containing the metrics. */ metricCompartmentId: string; /** * Source of the metric data for creating the alarm used to trigger autoscaling actions. */ metricSource: string; metricType: string; /** * The namespace for the query. */ namespace: string; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The resource group for the query. */ resourceGroup: string; thresholds: outputs.Autoscaling.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold[]; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold { /** * 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`). */ operator: string; value: number; } interface GetAutoScalingConfigurationsFilter { name: string; regex?: boolean; values: string[]; } } export declare namespace Bastion { interface GetBastionsBastion { /** * The type of bastion. */ bastionType: string; /** * A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion. */ clientCidrBlockAllowLists: string[]; /** * The unique identifier (OCID) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Flag to enable FQDN and SOCKS5 Proxy Support. Example: `ENABLED`, `DISABLED` */ dnsProxyStatus: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The unique identifier (OCID) of the bastion, which can't be changed after creation. */ id: string; /** * A message describing the current state in more detail. */ lifecycleDetails: string; /** * The maximum amount of time that any session on the bastion can remain active. */ maxSessionTtlInSeconds: number; /** * The maximum number of active sessions allowed on the bastion. */ maxSessionsAllowed: number; /** * A filter to return only resources that match the entire name given. */ name: string; /** * The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to `standard` bastions. */ phoneBookEntry: string; /** * The private IP address of the created private endpoint. */ privateEndpointIpAddress: string; /** * 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"}` */ securityAttributes: { [key: string]: string; }; /** * The current state of the bastion. */ state: string; /** * A list of IP addresses of the hosts that the bastion has access to. Not applicable to `standard` bastions. */ staticJumpHostIpAddresses: string[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The unique identifier (OCID) of the subnet that the bastion connects to. */ targetSubnetId: string; /** * The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to. */ targetVcnId: string; /** * The time the bastion was created. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z` */ timeCreated: string; /** * The time the bastion was updated. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z` */ timeUpdated: string; } interface GetBastionsFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetSessionKeyDetail { /** * 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. */ publicKeyContent: string; } interface GetSessionTargetResourceDetail { /** * 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. */ sessionType: string; /** * The display name of the target Compute instance that the session connects to. */ targetResourceDisplayName: string; /** * The Fully Qualified Domain Name of the target resource that the session connects to. */ targetResourceFqdn: string; /** * The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to. */ targetResourceId: string; /** * The name of the user on the target resource operating system that the session uses for the connection. */ targetResourceOperatingSystemUserName: string; /** * The port number to connect to on the target resource. */ targetResourcePort: number; /** * The private IP address of the target resource that the session connects to. */ targetResourcePrivateIpAddress: string; } interface GetSessionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSessionsSession { /** * The unique identifier (OCID) of the bastion in which to list sessions. */ bastionId: string; /** * The name of the bastion that is hosting this session. */ bastionName: string; /** * The public key of the bastion host. You can use this to verify that you're connecting to the correct bastion. */ bastionPublicHostKeyInfo: string; /** * The username that the session uses to connect to the target resource. */ bastionUserName: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The unique identifier (OCID) of the session, which can't be changed after creation. */ id: string; /** * Public key details for a bastion session. */ keyDetails: outputs.Bastion.GetSessionsSessionKeyDetail[]; /** * The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format. */ keyType: string; /** * A message describing the current session state in more detail. */ lifecycleDetails: string; /** * The amount of time the session can remain active. */ sessionTtlInSeconds: number; /** * The connection message for the session. */ sshMetadata: { [key: string]: string; }; /** * The current state of the session. */ state: string; /** * Details about a bastion session's target resource. */ targetResourceDetails: outputs.Bastion.GetSessionsSessionTargetResourceDetail[]; /** * The time the session was created. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z` */ timeCreated: string; /** * The time the session was updated. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z` */ timeUpdated: string; } interface GetSessionsSessionKeyDetail { /** * 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. */ publicKeyContent: string; } interface GetSessionsSessionTargetResourceDetail { /** * 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. */ sessionType: string; /** * The display name of the target Compute instance that the session connects to. */ targetResourceDisplayName: string; /** * The Fully Qualified Domain Name of the target resource that the session connects to. */ targetResourceFqdn: string; /** * The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to. */ targetResourceId: string; /** * The name of the user on the target resource operating system that the session uses for the connection. */ targetResourceOperatingSystemUserName: string; /** * The port number to connect to on the target resource. */ targetResourcePort: number; /** * The private IP address of the target resource that the session connects to. */ targetResourcePrivateIpAddress: string; } interface SessionKeyDetails { /** * 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. */ publicKeyContent: string; } interface SessionTargetResourceDetails { /** * The session type. */ sessionType: string; /** * The display name of the target Compute instance that the session connects to. */ targetResourceDisplayName: string; /** * The Fully Qualified Domain Name of the target resource that the session connects to. */ targetResourceFqdn: string; /** * The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to. */ targetResourceId: string; /** * The name of the user on the target resource operating system that the session uses for the connection. */ targetResourceOperatingSystemUserName: string; /** * The port number to connect to on the target resource. */ targetResourcePort: number; /** * The private IP address of the target resource that the session connects to. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ targetResourcePrivateIpAddress: string; } } export declare namespace BigDataService { interface AutoScalingConfigurationPolicy { /** * (Updatable) Types of autoscale policies. Options are SCHEDULE-BASED or THRESHOLD-BASED. (Only THRESHOLD-BASED is supported in this release.) */ policyType: string; /** * (Updatable) The list of rules for autoscaling. If an action has multiple rules, the last rule in the array will be applied. */ rules: outputs.BigDataService.AutoScalingConfigurationPolicyRule[]; } interface AutoScalingConfigurationPolicyDetails { /** * The type of autoscaling action to take. */ actionType: string; /** * Type of autoscaling policy. */ policyType: string; /** * (Updatable) Configration for a metric based vertical scale-down policy. */ scaleDownConfig: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleDownConfig; /** * (Updatable) Configration for a metric based horizontal scale-in policy. */ scaleInConfig: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleInConfig; /** * (Updatable) Configration for a metric based horizontal scale-out policy. */ scaleOutConfig: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleOutConfig; /** * (Updatable) Configration for a metric based vertical scale-up policy. */ scaleUpConfig: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleUpConfig; /** * (Updatable) Details of a horizontal scaling schedule. */ scheduleDetails: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScheduleDetail[]; /** * (Updatable) The time zone of the execution schedule, in IANA time zone database name format */ timezone: string; /** * The type of autoscaling trigger. */ triggerType: string; } interface AutoScalingConfigurationPolicyDetailsScaleDownConfig { /** * (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. */ memoryStepSize: number; /** * (Updatable) Metric and threshold details for triggering an autoscale action. */ metric: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleDownConfigMetric; /** * (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. */ minMemoryPerNode: number; /** * (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. */ minOcpusPerNode: number; /** * (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. */ ocpuStepSize: number; } interface AutoScalingConfigurationPolicyDetailsScaleDownConfigMetric { /** * (Updatable) Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. */ metricType: string; /** * (Updatable) An autoscale action is triggered when a performance metric exceeds a threshold. */ threshold: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleDownConfigMetricThreshold; } interface AutoScalingConfigurationPolicyDetailsScaleDownConfigMetricThreshold { /** * (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. */ durationInMinutes: number; /** * (Updatable) The comparison operator to use. Options are greater than (GT) or less than (LT). */ operator: string; /** * (Updatable) Integer non-negative value. 0 < value < 100 */ value: number; } interface AutoScalingConfigurationPolicyDetailsScaleInConfig { /** * (Updatable) Metric and threshold details for triggering an autoscale action. */ metric: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleInConfigMetric; /** * (Updatable) This value is the minimum number of nodes the cluster can be scaled-in to. */ minNodeCount: number; /** * (Updatable) This value is the number of nodes to remove during a scale-in event. */ stepSize: number; } interface AutoScalingConfigurationPolicyDetailsScaleInConfigMetric { /** * (Updatable) Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. */ metricType: string; /** * (Updatable) An autoscale action is triggered when a performance metric exceeds a threshold. */ threshold: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleInConfigMetricThreshold; } interface AutoScalingConfigurationPolicyDetailsScaleInConfigMetricThreshold { /** * (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. */ durationInMinutes: number; /** * (Updatable) The comparison operator to use. Options are greater than (GT) or less than (LT). */ operator: string; /** * (Updatable) Integer non-negative value. 0 < value < 100 */ value: number; } interface AutoScalingConfigurationPolicyDetailsScaleOutConfig { /** * (Updatable) This value is the maximum number of nodes the cluster can be scaled-out to. */ maxNodeCount: number; /** * (Updatable) Metric and threshold details for triggering an autoscale action. */ metric: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleOutConfigMetric; /** * (Updatable) This value is the number of nodes to add during a scale-out event. */ stepSize: number; } interface AutoScalingConfigurationPolicyDetailsScaleOutConfigMetric { /** * (Updatable) Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. */ metricType: string; /** * (Updatable) An autoscale action is triggered when a performance metric exceeds a threshold. */ threshold: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleOutConfigMetricThreshold; } interface AutoScalingConfigurationPolicyDetailsScaleOutConfigMetricThreshold { /** * (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. */ durationInMinutes: number; /** * (Updatable) The comparison operator to use. Options are greater than (GT) or less than (LT). */ operator: string; /** * (Updatable) Integer non-negative value. 0 < value < 100 */ value: number; } interface AutoScalingConfigurationPolicyDetailsScaleUpConfig { /** * (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. */ maxMemoryPerNode: number; /** * (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. */ maxOcpusPerNode: number; /** * (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. */ memoryStepSize: number; /** * (Updatable) Metric and threshold details for triggering an autoscale action. */ metric: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleUpConfigMetric; /** * (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. */ ocpuStepSize: number; } interface AutoScalingConfigurationPolicyDetailsScaleUpConfigMetric { /** * (Updatable) Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. */ metricType: string; /** * (Updatable) An autoscale action is triggered when a performance metric exceeds a threshold. */ threshold: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScaleUpConfigMetricThreshold; } interface AutoScalingConfigurationPolicyDetailsScaleUpConfigMetricThreshold { /** * (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. */ durationInMinutes: number; /** * (Updatable) The comparison operator to use. Options are greater than (GT) or less than (LT). */ operator: string; /** * (Updatable) Integer non-negative value. 0 < value < 100 */ value: number; } interface AutoScalingConfigurationPolicyDetailsScheduleDetail { /** * (Updatable) The type of schedule. */ scheduleType: string; /** * (Updatable) Time of day and horizontal scaling configuration. */ timeAndHorizontalScalingConfigs: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndHorizontalScalingConfig[]; /** * (Updatable) Time of day and vertical scaling configuration */ timeAndVerticalScalingConfigs: outputs.BigDataService.AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndVerticalScalingConfig[]; } interface AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndHorizontalScalingConfig { /** * (Updatable) This value is the desired number of nodes in the cluster. */ targetNodeCount: number; /** * (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. */ timeRecurrence: string; } interface AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndVerticalScalingConfig { /** * (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. */ targetMemoryPerNode: number; /** * (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. */ targetOcpusPerNode: number; /** * (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. */ targetShape: string; /** * (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. */ timeRecurrence: string; } interface AutoScalingConfigurationPolicyRule { /** * (Updatable) The valid value are CHANGE_SHAPE_SCALE_UP or CHANGE_SHAPE_SCALE_DOWN. */ action: string; /** * (Updatable) Metric and threshold details for triggering an autoscale action. */ metric: outputs.BigDataService.AutoScalingConfigurationPolicyRuleMetric; } interface AutoScalingConfigurationPolicyRuleMetric { /** * (Updatable) Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. */ metricType: string; /** * (Updatable) An autoscale action is triggered when a performance metric exceeds a threshold. */ threshold: outputs.BigDataService.AutoScalingConfigurationPolicyRuleMetricThreshold; } interface AutoScalingConfigurationPolicyRuleMetricThreshold { /** * (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. */ durationInMinutes: number; /** * (Updatable) The comparison operator to use. Options are greater than (GT) or less than (LT). */ operator: string; /** * (Updatable) Integer non-negative value. 0 < value < 100 */ value: number; } interface BdsCapacityReportShapeAvailability { /** * Information about the capacity in each domain. */ domainLevelCapacityReports: outputs.BigDataService.BdsCapacityReportShapeAvailabilityDomainLevelCapacityReport[]; /** * The shape that you want to request a capacity report for. */ shape: string; /** * The shape configuration requested for the node. */ shapeConfig: outputs.BigDataService.BdsCapacityReportShapeAvailabilityShapeConfig; } interface BdsCapacityReportShapeAvailabilityDomainLevelCapacityReport { /** * The availability domain for the capacity report. */ availabilityDomain: string; /** * Information about the available capacity for a shape. */ capacityAvailabilities: outputs.BigDataService.BdsCapacityReportShapeAvailabilityDomainLevelCapacityReportCapacityAvailability[]; /** * Type of domain level for the capacity report. */ domainType: string; /** * The fault domain for the capacity report. */ faultDomain: string; } interface BdsCapacityReportShapeAvailabilityDomainLevelCapacityReportCapacityAvailability { /** * A flag denoting whether capacity is available. */ availabilityStatus: string; /** * The total number of new cluster nodes that can be created with the specified shape configuration. */ availableCount: string; } interface BdsCapacityReportShapeAvailabilityShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * 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. */ nvmes: number; /** * The total number of OCPUs available to the node. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ ocpus: number; } interface BdsInstanceBdsClusterVersionSummary { /** * BDS version to be used for cluster creation */ bdsVersion: string; /** * ODH version to be used for cluster creation */ odhVersion: string; } interface BdsInstanceCloudSqlDetail { /** * 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. */ blockVolumeSizeInGbs: string; /** * IP address of the node */ ipAddress: string; /** * Boolean flag specifying whether or not are Kerberos principals mapped to database users. */ isKerberosMappedToDatabaseUsers: boolean; /** * Details about Kerberos principals */ kerberosDetails: outputs.BigDataService.BdsInstanceCloudSqlDetailKerberosDetail[]; /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; /** * Shape of the node */ shape: string; } interface BdsInstanceCloudSqlDetailKerberosDetail { /** * Location of the keytab file */ keytabFile: string; /** * Name of the Kerberos principal */ principalName: string; } interface BdsInstanceClusterDetail { /** * The URL of Ambari */ ambariUrl: string; /** * Cloud SQL cell version. */ bdCellVersion: string; /** * BDA version installed in the cluster */ bdaVersion: string; /** * Big Data Manager version installed in the cluster. */ bdmVersion: string; /** * Big Data Service version installed in the cluster. */ bdsVersion: string; /** * The URL of Big Data Manager. */ bigDataManagerUrl: string; /** * The URL of Cloudera Manager */ clouderaManagerUrl: string; /** * Big Data SQL version. */ csqlCellVersion: string; /** * Cloud SQL query server database version. */ dbVersion: string; /** * The URL of the Hue server. */ hueServerUrl: string; /** * The URL of the Jupyterhub. */ jupyterHubUrl: string; /** * Version of the ODH (Oracle Distribution including Apache Hadoop) for the node. */ odhVersion: string; /** * BDS-assigned Operating System version for the node. */ osVersion: string; /** * The time the BDS instance was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the cluster was automatically or manually refreshed, shown as an RFC 3339 formatted datetime string. */ timeRefreshed: string; } interface BdsInstanceComputeOnlyWorkerNode { /** * 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. */ blockVolumeSizeInGbs?: string; /** * Number of nodes that forming the cluster */ numberOfNodes: number; /** * Shape of the node */ shape: string; shapeConfig?: outputs.BigDataService.BdsInstanceComputeOnlyWorkerNodeShapeConfig; /** * The OCID of the subnet in which the node should be created */ subnetId: string; } interface BdsInstanceComputeOnlyWorkerNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs?: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus?: number; } interface BdsInstanceEdgeNode { /** * 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. */ blockVolumeSizeInGbs?: string; /** * Number of nodes that forming the cluster */ numberOfNodes: number; /** * Shape of the node */ shape: string; shapeConfig: outputs.BigDataService.BdsInstanceEdgeNodeShapeConfig; /** * The OCID of the subnet in which the node should be created */ subnetId: string; } interface BdsInstanceEdgeNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs?: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus?: number; } interface BdsInstanceIdentityConfigurationIamUserSyncConfiguration { /** * whether to append POSIX attributes to IAM users */ isPosixAttributesAdditionRequired: boolean; /** * Lifecycle state of the UPST config */ state: string; /** * Time when this UPST config was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; } interface BdsInstanceIdentityConfigurationIamUserSyncConfigurationDetails { /** * (Updatable) whether posix attribute needs to be appended to users, required for updating IAM user sync configuration */ isPosixAttributesAdditionRequired: boolean; } interface BdsInstanceIdentityConfigurationUpstConfiguration { /** * The kerberos keytab content used for creating identity propagation trust config, in base64 format */ keytabContent: string; /** * Master Encryption key used for encrypting token exchange keytab. */ masterEncryptionKeyId: string; /** * (Updatable) The secretId for the clusterAdminPassword. */ secretId: string; /** * Lifecycle state of the UPST config */ state: string; /** * Time when this UPST config was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string. */ timeTokenExchangeKeytabLastRefreshed: string; /** * Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; /** * Token exchange kerberos Principal name in cluster */ tokenExchangePrincipalName: string; /** * The instance OCID of the node, which is the resource from which the node backup was acquired. */ vaultId: string; } interface BdsInstanceIdentityConfigurationUpstConfigurationDetails { /** * (Updatable) OCID of the master encryption key in vault for encrypting token exchange service principal keytab, required for activating UPST config */ masterEncryptionKeyId: string; /** * (Updatable) OCID of the vault to store token exchange service principal keyta, required for activating UPST config */ vaultId: string; } interface BdsInstanceKafkaBrokerNode { /** * 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. */ blockVolumeSizeInGbs?: string; numberOfKafkaNodes: number; /** * Shape of the node */ shape: string; /** * The shape configuration requested for the node. */ shapeConfig?: outputs.BigDataService.BdsInstanceKafkaBrokerNodeShapeConfig; /** * The OCID of the subnet in which the node should be created */ subnetId: string; } interface BdsInstanceKafkaBrokerNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes */ memoryInGbs?: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus?: number; } interface BdsInstanceMasterNode { /** * 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. */ blockVolumeSizeInGbs?: string; /** * The amount of master nodes should be created. */ numberOfNodes: number; /** * Shape of the node */ shape: string; /** * The shape configuration requested for the node. */ shapeConfig?: outputs.BigDataService.BdsInstanceMasterNodeShapeConfig; /** * The OCID of the subnet in which the node should be created */ subnetId: string; } interface BdsInstanceMasterNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes */ memoryInGbs?: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus?: number; } interface BdsInstanceNetworkConfig { /** * (Updatable) The CIDR IP address block of the VCN. */ cidrBlock: string; /** * (Updatable) A boolean flag whether to configure a NAT gateway. */ isNatGatewayRequired: boolean; } interface BdsInstanceNode { /** * The list of block volumes attached to a given node. */ attachedBlockVolumes: outputs.BigDataService.BdsInstanceNodeAttachedBlockVolume[]; /** * The name of the availability domain the node is running in */ availabilityDomain: string; /** * (Updatable) Name of the BDS instance */ displayName: string; /** * The name of the fault domain the node is running in */ faultDomain: string; /** * The fully-qualified hostname (FQDN) of the node */ hostname: string; /** * The OCID of the image from which the node was created */ imageId: string; /** * The OCID of the underlying compute instance */ instanceId: string; /** * IP address of the node */ ipAddress: string; /** * Indicates if the node requires a reboot to either reflect the latest os kernel or take actions for maintenance reboot. */ isRebootRequired: boolean; /** * The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null. */ localDisksTotalSizeInGbs: number; /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The Big Data Service cluster node type. */ nodeType: string; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; /** * Version of the ODH (Oracle Distribution including Apache Hadoop) for the node. */ odhVersion: string; /** * BDS-assigned Operating System version for the node. */ osVersion: string; /** * (Updatable) Shape of the node. */ shape: string; /** * The fingerprint of the SSH key used for node access */ sshFingerprint: string; /** * (Updatable) The target state for the Bds Instance. Could be set to `ACTIVE` or `INACTIVE`. */ state: string; /** * The OCID of the subnet in which the node will be created. */ subnetId: string; /** * The time the BDS instance was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. */ timeMaintenanceRebootDue: string; } interface BdsInstanceNodeAttachedBlockVolume { /** * The OCID of the volume attachment. */ volumeAttachmentId: string; /** * The size of the volume in GBs. */ volumeSizeInGbs: string; } interface BdsInstanceNodeBackupConfigurationLevelTypeDetails { /** * (Updatable) Type of level used to trigger the creation of a new node backup configuration or node replacement configuration. */ levelType: string; /** * (Updatable) Host name of the node to create backup configuration. */ nodeHostName: string; /** * (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. */ nodeType: string; } interface BdsInstanceNodeBackupLevelTypeDetails { /** * Type of level used to trigger the creation of a new node backup. */ levelType: string; /** * (Updatable) Host name of the node to create backup. */ nodeHostName: string; /** * (Updatable) Type of the node or nodes of the node backup which are going to be created. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ nodeType: string; } interface BdsInstanceNodeReplaceConfigurationLevelTypeDetails { /** * (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. */ levelType: string; /** * (Updatable) Host name of the node to create backup configuration. */ nodeHostName: string; /** * (Updatable) Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created. */ nodeType: string; } interface BdsInstanceOperationCertificateManagementsManagementHostCertDetail { /** * Certificate value in string format */ certificate: string; /** * Fully qualified domain name (FQDN) of the host */ hostName: string; /** * Private key of the provided certificate */ privateKey: string; } interface BdsInstanceOsPatchActionPatchingConfigs { /** * How many nodes to be patched in each iteration. */ batchSize: number; /** * Type of strategy used for detailed patching configuration */ patchingConfigStrategy: string; /** * 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. */ toleranceThresholdPerBatch: number; /** * 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. */ toleranceThresholdPerDomain: number; /** * The wait time between batches in seconds. */ waitTimeBetweenBatchInSeconds: number; /** * The wait time between AD/FD in seconds. */ waitTimeBetweenDomainInSeconds: number; } interface BdsInstancePatchActionPatchingConfig { /** * How many nodes to be patched in each iteration. */ batchSize: number; /** * Type of strategy used for detailed patching configuration */ patchingConfigStrategy: string; /** * 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. */ toleranceThresholdPerBatch: number; /** * 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. */ toleranceThresholdPerDomain: number; /** * The wait time between batches in seconds. */ waitTimeBetweenBatchInSeconds: number; /** * The wait time between AD/FD in seconds. */ waitTimeBetweenDomainInSeconds: number; } interface BdsInstanceStartClusterShapeConfig { nodeTypeShapeConfigs?: outputs.BigDataService.BdsInstanceStartClusterShapeConfigNodeTypeShapeConfig[]; } interface BdsInstanceStartClusterShapeConfigNodeTypeShapeConfig { /** * BDS instance node type */ nodeType?: string; /** * Shape of the node */ shape?: string; } interface BdsInstanceUtilNode { /** * 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. */ blockVolumeSizeInGbs?: string; /** * The amount of utility nodes should be created. */ numberOfNodes: number; /** * Shape of the node */ shape: string; /** * The shape configuration requested for the node. */ shapeConfig?: outputs.BigDataService.BdsInstanceUtilNodeShapeConfig; /** * The OCID of the subnet in which the node should be created */ subnetId: string; } interface BdsInstanceUtilNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes */ memoryInGbs?: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus?: number; } interface BdsInstanceWorkerNode { /** * 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. */ blockVolumeSizeInGbs?: string; /** * Number of nodes that forming the cluster */ numberOfNodes: number; /** * Shape of the node */ shape: string; shapeConfig?: outputs.BigDataService.BdsInstanceWorkerNodeShapeConfig; /** * The OCID of the subnet in which the node should be created */ subnetId: string; } interface BdsInstanceWorkerNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs?: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus?: number; } interface GetAutoScalingConfigurationPolicy { /** * Type of autoscaling policy. */ policyType: string; /** * The list of rules for autoscaling. If an action has multiple rules, the last rule in the array will be applied. */ rules: outputs.BigDataService.GetAutoScalingConfigurationPolicyRule[]; } interface GetAutoScalingConfigurationPolicyDetail { /** * The type of autoscaling action to take. */ actionType: string; /** * Type of autoscaling policy. */ policyType: string; /** * Configration for a metric based vertical scale-down policy. */ scaleDownConfigs: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleDownConfig[]; /** * Configration for a metric based horizontal scale-in policy. */ scaleInConfigs: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleInConfig[]; /** * Configration for a metric based horizontal scale-out policy. */ scaleOutConfigs: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleOutConfig[]; /** * Configration for a metric based vertical scale-up policy. */ scaleUpConfigs: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleUpConfig[]; /** * Details of a horizontal scaling schedule. */ scheduleDetails: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScheduleDetail[]; /** * The time zone of the execution schedule, in IANA time zone database name format */ timezone: string; /** * The type of autoscaling trigger. */ triggerType: string; } interface GetAutoScalingConfigurationPolicyDetailScaleDownConfig { /** * 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. */ memoryStepSize: number; /** * Metric and threshold details for triggering an autoscale action. */ metrics: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleDownConfigMetric[]; /** * 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. */ minMemoryPerNode: number; /** * 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. */ minOcpusPerNode: number; /** * 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. */ ocpuStepSize: number; } interface GetAutoScalingConfigurationPolicyDetailScaleDownConfigMetric { /** * Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. */ metricType: string; /** * An autoscale action is triggered when a performance metric exceeds a threshold. */ thresholds: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold[]; } interface GetAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold { /** * 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. */ durationInMinutes: number; /** * The comparison operator to use. Options are greater than (GT) or less than (LT). */ operator: string; /** * Integer non-negative value. 0 < value < 100 */ value: number; } interface GetAutoScalingConfigurationPolicyDetailScaleInConfig { /** * Metric and threshold details for triggering an autoscale action. */ metrics: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleInConfigMetric[]; /** * This value is the minimum number of nodes the cluster can be scaled-in to. */ minNodeCount: number; /** * This value is the number of nodes to add during a scale-out event. */ stepSize: number; } interface GetAutoScalingConfigurationPolicyDetailScaleInConfigMetric { /** * Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. */ metricType: string; /** * An autoscale action is triggered when a performance metric exceeds a threshold. */ thresholds: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold[]; } interface GetAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold { /** * 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. */ durationInMinutes: number; /** * The comparison operator to use. Options are greater than (GT) or less than (LT). */ operator: string; /** * Integer non-negative value. 0 < value < 100 */ value: number; } interface GetAutoScalingConfigurationPolicyDetailScaleOutConfig { /** * This value is the maximum number of nodes the cluster can be scaled-out to. */ maxNodeCount: number; /** * Metric and threshold details for triggering an autoscale action. */ metrics: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleOutConfigMetric[]; /** * This value is the number of nodes to add during a scale-out event. */ stepSize: number; } interface GetAutoScalingConfigurationPolicyDetailScaleOutConfigMetric { /** * Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. */ metricType: string; /** * An autoscale action is triggered when a performance metric exceeds a threshold. */ thresholds: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold[]; } interface GetAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold { /** * 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. */ durationInMinutes: number; /** * The comparison operator to use. Options are greater than (GT) or less than (LT). */ operator: string; /** * Integer non-negative value. 0 < value < 100 */ value: number; } interface GetAutoScalingConfigurationPolicyDetailScaleUpConfig { /** * 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. */ maxMemoryPerNode: number; /** * 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. */ maxOcpusPerNode: number; /** * 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. */ memoryStepSize: number; /** * Metric and threshold details for triggering an autoscale action. */ metrics: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleUpConfigMetric[]; /** * 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. */ ocpuStepSize: number; } interface GetAutoScalingConfigurationPolicyDetailScaleUpConfigMetric { /** * Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. */ metricType: string; /** * An autoscale action is triggered when a performance metric exceeds a threshold. */ thresholds: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold[]; } interface GetAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold { /** * 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. */ durationInMinutes: number; /** * The comparison operator to use. Options are greater than (GT) or less than (LT). */ operator: string; /** * Integer non-negative value. 0 < value < 100 */ value: number; } interface GetAutoScalingConfigurationPolicyDetailScheduleDetail { /** * The type of schedule. */ scheduleType: string; /** * Time of day and horizontal scaling configuration. */ timeAndHorizontalScalingConfigs: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig[]; /** * Time of day and vertical scaling configuration */ timeAndVerticalScalingConfigs: outputs.BigDataService.GetAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig[]; } interface GetAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig { /** * This value is the desired number of nodes in the cluster. */ targetNodeCount: number; /** * 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. */ timeRecurrence: string; } interface GetAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig { /** * 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. */ targetMemoryPerNode: number; /** * 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. */ targetOcpusPerNode: number; /** * 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. */ targetShape: string; /** * 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. */ timeRecurrence: string; } interface GetAutoScalingConfigurationPolicyRule { /** * The valid value are CHANGE_SHAPE_SCALE_UP or CHANGE_SHAPE_SCALE_DOWN. */ action: string; /** * Metric and threshold details for triggering an autoscale action. */ metrics: outputs.BigDataService.GetAutoScalingConfigurationPolicyRuleMetric[]; } interface GetAutoScalingConfigurationPolicyRuleMetric { /** * Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. */ metricType: string; /** * An autoscale action is triggered when a performance metric exceeds a threshold. */ thresholds: outputs.BigDataService.GetAutoScalingConfigurationPolicyRuleMetricThreshold[]; } interface GetAutoScalingConfigurationPolicyRuleMetricThreshold { /** * 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. */ durationInMinutes: number; /** * The comparison operator to use. Options are greater than (GT) or less than (LT). */ operator: string; /** * Integer non-negative value. 0 < value < 100 */ value: number; } interface GetAutoScalingConfigurationsAutoScalingConfiguration { bdsInstanceId: string; clusterAdminPassword: string; displayName: string; id: string; isEnabled: boolean; nodeType: string; policies: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicy[]; policyDetails: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetail[]; secretId: string; state: string; timeCreated: string; timeUpdated: string; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicy { policyType: string; rules: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRule[]; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetail { actionType: string; policyType: string; scaleDownConfigs: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfig[]; scaleInConfigs: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfig[]; scaleOutConfigs: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfig[]; scaleUpConfigs: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfig[]; scheduleDetails: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetail[]; timezone: string; triggerType: string; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfig { memoryStepSize: number; metrics: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetric[]; minMemoryPerNode: number; minOcpusPerNode: number; ocpuStepSize: number; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetric { metricType: string; thresholds: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold[]; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold { durationInMinutes: number; operator: string; value: number; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfig { metrics: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetric[]; minNodeCount: number; stepSize: number; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetric { metricType: string; thresholds: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold[]; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold { durationInMinutes: number; operator: string; value: number; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfig { maxNodeCount: number; metrics: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetric[]; stepSize: number; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetric { metricType: string; thresholds: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold[]; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold { durationInMinutes: number; operator: string; value: number; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfig { maxMemoryPerNode: number; maxOcpusPerNode: number; memoryStepSize: number; metrics: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetric[]; ocpuStepSize: number; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetric { metricType: string; thresholds: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold[]; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold { durationInMinutes: number; operator: string; value: number; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetail { scheduleType: string; timeAndHorizontalScalingConfigs: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig[]; timeAndVerticalScalingConfigs: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig[]; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig { targetNodeCount: number; timeRecurrence: string; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig { targetMemoryPerNode: number; targetOcpusPerNode: number; targetShape: string; timeRecurrence: string; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRule { action: string; metrics: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric[]; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric { metricType: string; thresholds: outputs.BigDataService.GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold[]; } interface GetAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold { durationInMinutes: number; operator: string; value: number; } interface GetAutoScalingConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsClusterVersionsBdsClusterVersion { /** * BDS version to be used for cluster creation */ bdsVersion: string; /** * ODH version to be used for cluster creation */ odhVersion: string; } interface GetBdsClusterVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceApiKeysBdsApiKey { /** * The OCID of the cluster. */ bdsInstanceId: string; /** * 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 . */ defaultRegion: string; /** * Identity domain OCID ,where user is present. For default domain ,this field will be optional. */ domainOcid: string; /** * The fingerprint that corresponds to the public API key requested. */ fingerprint: string; /** * Identifier of the user's API key. */ id: string; /** * User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed. */ keyAlias: string; passphrase: string; /** * 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. */ pemfilepath: string; /** * The current status of the API key. */ state: string; /** * The OCID of your tenancy. */ tenantId: string; /** * The time the API key was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * The user OCID for which this API key was created. */ userId: string; } interface GetBdsInstanceApiKeysFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceBdsCertificateConfigurationsBdsCertificateConfiguration { /** * The OCID of the cluster. */ bdsInstanceId: string; /** * 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. */ certificateAuthorityId: string; certificateType: string; clusterAdminPassword: string; /** * The OCID of the compartment of the certificate authority connecting to this certificate configuration. */ compartmentId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The ID of the BDS certificate configuration defined under BDS resources, not OCID. */ id: string; /** * If this BDS certificate configuration is a default configuration or not. There will be only one Default certificate configuration per BDS cluster. */ isDefaultConfiguration: boolean; isMissingNodesOnly: boolean; issueCertificateTrigger: string; renewCertificateTrigger: string; secretId: string; setDefaultTrigger: string; /** * The state of the BdsCertificateConfiguration. */ state: string; /** * The time when the BDS certificate configuration was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * The last time the BDS certificate configuration was used to generate or renew the certificate(s). */ timeLastRefreshedOrGenerated: string; /** * The time the BDS certificate configuration was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; /** * The type of the BDS certificate configuration, also the type of the BDS certificates which will be generated by the BDS certificate configuration. */ type: string; } interface GetBdsInstanceBdsCertificateConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceBdsClusterVersionSummary { /** * Big Data Service version installed in the cluster. */ bdsVersion: string; /** * Version of the ODH (Oracle Distribution including Apache Hadoop) for the node. */ odhVersion: string; } interface GetBdsInstanceCloudSqlDetail { /** * 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. */ blockVolumeSizeInGbs: string; /** * IP address of the node. */ ipAddress: string; /** * Boolean flag specifying whether or not Kerberos principals are mapped to database users. */ isKerberosMappedToDatabaseUsers: boolean; /** * Details about the Kerberos principals. */ kerberosDetails: outputs.BigDataService.GetBdsInstanceCloudSqlDetailKerberosDetail[]; /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; /** * Shape of the node. */ shape: string; } interface GetBdsInstanceCloudSqlDetailKerberosDetail { /** * Location of the keytab file */ keytabFile: string; /** * Name of the Kerberos principal. */ principalName: string; } interface GetBdsInstanceClusterDetail { /** * The URL of Ambari */ ambariUrl: string; /** * Cloud SQL cell version. */ bdCellVersion: string; /** * BDA version installed in the cluster */ bdaVersion: string; /** * Big Data Manager version installed in the cluster. */ bdmVersion: string; /** * Big Data Service version installed in the cluster. */ bdsVersion: string; /** * The URL of Big Data Manager. */ bigDataManagerUrl: string; /** * The URL of Cloudera Manager */ clouderaManagerUrl: string; /** * Big Data SQL version. */ csqlCellVersion: string; /** * Cloud SQL query server database version. */ dbVersion: string; /** * The URL of the Hue server. */ hueServerUrl: string; /** * The URL of the Jupyterhub. */ jupyterHubUrl: string; /** * Version of the ODH (Oracle Distribution including Apache Hadoop) for the node. */ odhVersion: string; /** * BDS-assigned Operating System version for the node. */ osVersion: string; /** * The time the cluster was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * The time the cluster was automatically or manually refreshed, shown as an RFC 3339 formatted datetime string. */ timeRefreshed: string; } interface GetBdsInstanceComputeOnlyWorkerNode { /** * 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. */ blockVolumeSizeInGbs: string; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstanceComputeOnlyWorkerNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstanceComputeOnlyWorkerNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstanceEdgeNode { /** * 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. */ blockVolumeSizeInGbs: string; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstanceEdgeNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstanceEdgeNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstanceGetOsPatchFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceGetOsPatchTargetPackage { /** * The package's name. */ packageName: string; /** * Package type based on package installation manager. */ packageType: string; /** * Related CVEs of the package update. */ relatedCvEs: string[]; /** * The target version of the package. */ targetVersion: string; /** * The action that current package will be executed on the cluster. */ updateType: string; } interface GetBdsInstanceIdentityConfigurationIamUserSyncConfiguration { /** * whether to append POSIX attributes to IAM users */ isPosixAttributesAdditionRequired: boolean; /** * Lifecycle state of the UPST config */ state: string; /** * Time when this UPST config was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; } interface GetBdsInstanceIdentityConfigurationIamUserSyncConfigurationDetail { /** * whether to append POSIX attributes to IAM users */ isPosixAttributesAdditionRequired: boolean; } interface GetBdsInstanceIdentityConfigurationUpstConfiguration { /** * The kerberos keytab content used for creating identity propagation trust config, in base64 format */ keytabContent: string; /** * Master Encryption key used for encrypting token exchange keytab. */ masterEncryptionKeyId: string; /** * Secret ID for token exchange keytab */ secretId: string; /** * Lifecycle state of the UPST config */ state: string; /** * Time when this UPST config was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string. */ timeTokenExchangeKeytabLastRefreshed: string; /** * Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; /** * Token exchange kerberos Principal name in cluster */ tokenExchangePrincipalName: string; /** * The instance OCID of the node, which is the resource from which the node backup was acquired. */ vaultId: string; } interface GetBdsInstanceIdentityConfigurationUpstConfigurationDetail { /** * Master Encryption key used for encrypting token exchange keytab. */ masterEncryptionKeyId: string; /** * The instance OCID of the node, which is the resource from which the node backup was acquired. */ vaultId: string; } interface GetBdsInstanceIdentityConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceIdentityConfigurationsIdentityConfiguration { activateIamUserSyncConfigurationTrigger: string; activateUpstConfigurationTrigger: string; /** * The OCID of the cluster. */ bdsInstanceId: string; clusterAdminPassword: string; /** * identity domain confidential application ID for the identity config */ confidentialApplicationId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; iamUserSyncConfigurationDetails: outputs.BigDataService.GetBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfigurationDetail[]; /** * Information about the IAM user sync configuration. */ iamUserSyncConfigurations: outputs.BigDataService.GetBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfiguration[]; /** * The id of the identity config */ id: string; /** * Identity domain to use for identity config */ identityDomainId: string; refreshConfidentialApplicationTrigger: string; refreshUpstTokenExchangeKeytabTrigger: string; /** * The state of the identity config */ state: string; /** * Time when this UPST config was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; upstConfigurationDetails: outputs.BigDataService.GetBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfigurationDetail[]; /** * Information about the UPST configuration. */ upstConfigurations: outputs.BigDataService.GetBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfiguration[]; } interface GetBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfiguration { /** * whether to append POSIX attributes to IAM users */ isPosixAttributesAdditionRequired: boolean; /** * The state of the identity config */ state: string; /** * Time when this UPST config was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; } interface GetBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfigurationDetail { /** * whether to append POSIX attributes to IAM users */ isPosixAttributesAdditionRequired: boolean; } interface GetBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfiguration { /** * The kerberos keytab content used for creating identity propagation trust config, in base64 format */ keytabContent: string; /** * Master Encryption key used for encrypting token exchange keytab. */ masterEncryptionKeyId: string; /** * Secret ID for token exchange keytab */ secretId: string; /** * The state of the identity config */ state: string; /** * Time when this UPST config was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string. */ timeTokenExchangeKeytabLastRefreshed: string; /** * Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; /** * Token exchange kerberos Principal name in cluster */ tokenExchangePrincipalName: string; /** * The instance OCID of the node, which is the resource from which the node backup was acquired. */ vaultId: string; } interface GetBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfigurationDetail { /** * Master Encryption key used for encrypting token exchange keytab. */ masterEncryptionKeyId: string; /** * The instance OCID of the node, which is the resource from which the node backup was acquired. */ vaultId: string; } interface GetBdsInstanceKafkaBrokerNode { /** * 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. */ blockVolumeSizeInGbs: string; numberOfKafkaNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstanceKafkaBrokerNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstanceKafkaBrokerNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstanceListOsPatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceListOsPatchesOsPatch { /** * The OCID of the cluster. */ bdsInstanceId: string; /** * Patch version of the os patch. */ osPatchVersion: string; /** * The time when the OS patch was released. */ releaseDate: string; } interface GetBdsInstanceMasterNode { /** * 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. */ blockVolumeSizeInGbs: string; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstanceMasterNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstanceMasterNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstanceMetastoreConfigsBdsMetastoreConfiguration { activateTrigger: number; /** * The ID of the API key that is associated with the external metastore in the metastore configuration */ bdsApiKeyId: string; bdsApiKeyPassphrase: string; /** * The OCID of the cluster. */ bdsInstanceId: string; clusterAdminPassword: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The ID of the metastore configuration */ id: string; /** * The OCID of the Data Catalog metastore in the metastore configuration */ metastoreId: string; /** * The type of the metastore in the metastore configuration */ metastoreType: string; /** * The lifecycle state of the metastore in the metastore configuration */ state: string; /** * The time when the configuration was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * The time when the configuration was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; } interface GetBdsInstanceMetastoreConfigsFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceNetworkConfig { /** * The CIDR IP address block of the VCN. */ cidrBlock: string; /** * A boolean flag whether to configure a NAT gateway. */ isNatGatewayRequired: boolean; } interface GetBdsInstanceNode { /** * The list of block volumes attached to a given node. */ attachedBlockVolumes: outputs.BigDataService.GetBdsInstanceNodeAttachedBlockVolume[]; /** * The name of the availability domain in which the node is running. */ availabilityDomain: string; /** * The name of the node. */ displayName: string; /** * The name of the fault domain in which the node is running. */ faultDomain: string; /** * The fully-qualified hostname (FQDN) of the node. */ hostname: string; /** * The OCID of the image from which the node was created. */ imageId: string; /** * The OCID of the underlying Oracle Cloud Infrastructure Compute instance. */ instanceId: string; /** * IP address of the node. */ ipAddress: string; /** * Indicates if the node requires a reboot to either reflect the latest os kernel or take actions for maintenance reboot. */ isRebootRequired: boolean; /** * The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null. */ localDisksTotalSizeInGbs: number; /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * Cluster node type. */ nodeType: string; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; /** * Version of the ODH (Oracle Distribution including Apache Hadoop) for the node. */ odhVersion: string; /** * BDS-assigned Operating System version for the node. */ osVersion: string; /** * Shape of the node. */ shape: string; /** * The fingerprint of the SSH key used for node access. */ sshFingerprint: string; /** * The state of the cluster. */ state: string; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; /** * The time the cluster was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. */ timeMaintenanceRebootDue: string; } interface GetBdsInstanceNodeAttachedBlockVolume { /** * The OCID of the volume attachment. */ volumeAttachmentId: string; /** * The size of the volume in GBs. */ volumeSizeInGbs: string; } interface GetBdsInstanceNodeBackupConfigurationLevelTypeDetail { /** * Type of level used to trigger the creation of a new node backup configuration or node replacement configuration. */ levelType: string; /** * Host name of the node to create backup configuration. */ nodeHostName: string; /** * Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created. */ nodeType: string; } interface GetBdsInstanceNodeBackupConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceNodeBackupConfigurationsNodeBackupConfiguration { /** * Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created. */ backupType: string; /** * The OCID of the cluster. */ bdsInstanceId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The id of the NodeBackupConfiguration defined under BDS resources, not OCID. */ id: string; /** * Details of the type of level used to trigger the creation of a new node backup configuration or node replacement configuration. */ levelTypeDetails: outputs.BigDataService.GetBdsInstanceNodeBackupConfigurationsNodeBackupConfigurationLevelTypeDetail[]; /** * Number of backup copies to retain. */ numberOfBackupsToRetain: number; /** * 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. */ schedule: string; /** * The state of the NodeBackupConfiguration configuration. */ state: string; /** * The time the NodeBackupConfiguration was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * The time the NodeBackupConfiguration was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; /** * The time zone of the execution schedule, in IANA time zone database name format */ timezone: string; } interface GetBdsInstanceNodeBackupConfigurationsNodeBackupConfigurationLevelTypeDetail { /** * Type of level used to trigger the creation of a new node backup configuration or node replacement configuration. */ levelType: string; /** * Host name of the node to create backup configuration. */ nodeHostName: string; /** * Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created. */ nodeType: string; } interface GetBdsInstanceNodeBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceNodeBackupsNodeBackup { /** * type based on how backup action was initiated. */ backupTriggerType: string; /** * Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created. */ backupType: string; /** * The display name belonged to the node backup. */ displayName: string; /** * The id of the node backup. */ id: string; /** * The ID of the nodeBackupConfiguration if the NodeBackup is automatically created by applying the configuration. */ nodeBackupConfigId: string; /** * The node host name belonged to a node that has a node backup. */ nodeHostName: string; /** * The instance OCID of the node, which is the resource from which the node backup was acquired. */ nodeInstanceId: string; /** * The state of the Node's Backup. */ state: string; /** * The time the cluster was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; } interface GetBdsInstanceNodeReplaceConfigurationLevelTypeDetail { /** * Type of level used to trigger the creation of a new node backup configuration or node replacement configuration. */ levelType: string; /** * Host name of the node to create backup configuration. */ nodeHostName: string; /** * Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created. */ nodeType: string; } interface GetBdsInstanceNodeReplaceConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceNodeReplaceConfigurationsNodeReplaceConfiguration { /** * The OCID of the cluster. */ bdsInstanceId: string; clusterAdminPassword: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * This value is the minimum period of time to wait for metric emission before triggering node replacement. The value is in minutes. */ durationInMinutes: number; /** * The id of the NodeReplaceConfiguration defined under BDS resources, not OCID. */ id: string; /** * Details of the type of level used to trigger the creation of a new node backup configuration or node replacement configuration. */ levelTypeDetails: outputs.BigDataService.GetBdsInstanceNodeReplaceConfigurationsNodeReplaceConfigurationLevelTypeDetail[]; /** * Type of compute instance health metric to use for node replacement */ metricType: string; /** * The secretId for the clusterAdminPassword. */ secretId: string; /** * The state of the NodeReplaceConfiguration. */ state: string; /** * The time the NodeReplaceConfiguration was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * The time the NodeReplaceConfiguration was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; } interface GetBdsInstanceNodeReplaceConfigurationsNodeReplaceConfigurationLevelTypeDetail { /** * Type of level used to trigger the creation of a new node backup configuration or node replacement configuration. */ levelType: string; /** * Host name of the node to create backup configuration. */ nodeHostName: string; /** * Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created. */ nodeType: string; } interface GetBdsInstancePatchHistoriesFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstancePatchHistoriesPatchHistory { /** * The type of a BDS patch history entity. */ patchType: string; /** * The status of the patch. */ state: string; /** * The time when the patch history was last updated. */ timeUpdated: string; /** * The version of the patch. */ version: string; } interface GetBdsInstancePatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstancePatchesPatch { /** * The time when the patch was released. */ timeReleased: string; /** * The version of the patch. */ version: string; } interface GetBdsInstanceResourcePrincipalConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceResourcePrincipalConfigurationsResourcePrincipalConfiguration { /** * The OCID of the cluster. */ bdsInstanceId: string; clusterAdminPassword: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; forceRefreshResourcePrincipalTrigger: number; /** * The id of the ResourcePrincipalConfiguration defined under BDS resources, not OCID. */ id: string; /** * The secretId for the clusterAdminPassword. */ secretId: string; /** * Life span in hours of each resource principal session token. */ sessionTokenLifeSpanDurationInHours: number; /** * The state of the ResourcePrincipalConfiguration. */ state: string; /** * The time the ResourcePrincipalConfiguration was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * the time the resource principal session token will expired, shown as an rfc 3339 formatted datetime string. */ timeTokenExpiry: string; /** * the time the resource principal session token was refreshed, shown as an rfc 3339 formatted datetime string. */ timeTokenRefreshed: string; /** * The time the ResourcePrincipalConfiguration was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; } interface GetBdsInstanceSoftwareUpdatesFilter { name: string; regex?: boolean; values: string[]; } interface GetBdsInstanceSoftwareUpdatesSoftwareUpdateCollection { items: outputs.BigDataService.GetBdsInstanceSoftwareUpdatesSoftwareUpdateCollectionItem[]; } interface GetBdsInstanceSoftwareUpdatesSoftwareUpdateCollectionItem { /** * Unique identifier of a given software update */ softwareUpdateKey: string; /** * type of current software update. * * Big Data Service's micro service. BDS version will be changed after upgrade. */ softwareUpdateType: string; /** * The version of the software update. */ softwareUpdateVersion: string; /** * The lifecycle state of the software update. */ state: string; /** * The due date for the software update. Big Data Service will be updated automatically after this date. */ timeDue: string; /** * The time when the software update was released. */ timeReleased: string; } interface GetBdsInstanceStartClusterShapeConfig { nodeTypeShapeConfigs: outputs.BigDataService.GetBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig[]; } interface GetBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig { /** * Cluster node type. */ nodeType: string; /** * Shape of the node. */ shape: string; } interface GetBdsInstanceUtilNode { /** * 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. */ blockVolumeSizeInGbs: string; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstanceUtilNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstanceUtilNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstanceWorkerNode { /** * 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. */ blockVolumeSizeInGbs: string; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstanceWorkerNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstanceWorkerNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstancesBdsInstance { /** * Cluster version details including bds and odh version information. */ bdsClusterVersionSummaries: outputs.BigDataService.GetBdsInstancesBdsInstanceBdsClusterVersionSummary[]; /** * pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed. */ bootstrapScriptUrl: string; /** * The information about added Cloud SQL capability */ cloudSqlDetails: outputs.BigDataService.GetBdsInstancesBdsInstanceCloudSqlDetail[]; clusterAdminPassword: string; /** * Specific info about a Hadoop cluster */ clusterDetails: outputs.BigDataService.GetBdsInstancesBdsInstanceClusterDetail[]; /** * Profile of the Big Data Service cluster. */ clusterProfile: string; clusterPublicKey: string; /** * Version of the Hadoop distribution. */ clusterVersion: string; /** * The OCID of the compartment. */ compartmentId: string; computeOnlyWorkerNodes: outputs.BigDataService.GetBdsInstancesBdsInstanceComputeOnlyWorkerNode[]; /** * The user who created the cluster. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; edgeNodes: outputs.BigDataService.GetBdsInstancesBdsInstanceEdgeNode[]; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. For example, `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Big Data Service resource. */ id: string; ignoreExistingNodesShapes: string[]; /** * Boolean flag specifying whether or not Cloud SQL should be configured. */ isCloudSqlConfigured: boolean; isForceRemoveEnabled: boolean; isForceStopJobs: boolean; /** * Boolean flag specifying whether or not the cluster is highly available (HA) */ isHighAvailability: boolean; /** * Boolean flag specifying whether or not Kafka should be configured. */ isKafkaConfigured: boolean; /** * Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations. */ isSecretReused: boolean; /** * Boolean flag specifying whether or not the cluster should be set up as secure. */ isSecure: boolean; kafkaBrokerNodes: outputs.BigDataService.GetBdsInstancesBdsInstanceKafkaBrokerNode[]; kerberosRealmName: string; /** * The OCID of the Key Management master encryption key. */ kmsKeyId: string; masterNodes: outputs.BigDataService.GetBdsInstancesBdsInstanceMasterNode[]; /** * Additional configuration of the user's network. */ networkConfigs: outputs.BigDataService.GetBdsInstancesBdsInstanceNetworkConfig[]; /** * The list of nodes in the cluster. */ nodes: outputs.BigDataService.GetBdsInstancesBdsInstanceNode[]; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Number of nodes that require a maintenance reboot */ numberOfNodesRequiringMaintenanceReboot: number; osPatchVersion: string; removeNode: string; removeNodes: string[]; /** * The secretId for the clusterAdminPassword. */ secretId: string; startClusterShapeConfigs: outputs.BigDataService.GetBdsInstancesBdsInstanceStartClusterShapeConfig[]; /** * The state of the cluster. */ state: string; /** * The time the cluster was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * The earliest time of certificate expiration date across the certificates of all current nodes under this cluster. */ timeEarliestCertificateExpiration: string; /** * The time the cluster was updated, shown as an RFC 3339 formatted datetime string. */ timeUpdated: string; utilNodes: outputs.BigDataService.GetBdsInstancesBdsInstanceUtilNode[]; workerNodes: outputs.BigDataService.GetBdsInstancesBdsInstanceWorkerNode[]; } interface GetBdsInstancesBdsInstanceBdsClusterVersionSummary { /** * Big Data Service version installed in the cluster. */ bdsVersion: string; /** * Version of the ODH (Oracle Distribution including Apache Hadoop) for the node. */ odhVersion: string; } interface GetBdsInstancesBdsInstanceCloudSqlDetail { /** * 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. */ blockVolumeSizeInGbs: string; /** * IP address of the node. */ ipAddress: string; /** * Boolean flag specifying whether or not Kerberos principals are mapped to database users. */ isKerberosMappedToDatabaseUsers: boolean; /** * Details about the Kerberos principals. */ kerberosDetails: outputs.BigDataService.GetBdsInstancesBdsInstanceCloudSqlDetailKerberosDetail[]; /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; /** * Shape of the node. */ shape: string; } interface GetBdsInstancesBdsInstanceCloudSqlDetailKerberosDetail { /** * Location of the keytab file */ keytabFile: string; /** * Name of the Kerberos principal. */ principalName: string; } interface GetBdsInstancesBdsInstanceClusterDetail { /** * The URL of Ambari */ ambariUrl: string; /** * Cloud SQL cell version. */ bdCellVersion: string; /** * BDA version installed in the cluster */ bdaVersion: string; /** * Big Data Manager version installed in the cluster. */ bdmVersion: string; /** * Big Data Service version installed in the cluster. */ bdsVersion: string; /** * The URL of Big Data Manager. */ bigDataManagerUrl: string; /** * The URL of Cloudera Manager */ clouderaManagerUrl: string; /** * Big Data SQL version. */ csqlCellVersion: string; /** * Cloud SQL query server database version. */ dbVersion: string; /** * The URL of the Hue server. */ hueServerUrl: string; /** * The URL of the Jupyterhub. */ jupyterHubUrl: string; /** * Version of the ODH (Oracle Distribution including Apache Hadoop) for the node. */ odhVersion: string; /** * BDS-assigned Operating System version for the node. */ osVersion: string; /** * The time the cluster was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * The time the cluster was automatically or manually refreshed, shown as an RFC 3339 formatted datetime string. */ timeRefreshed: string; } interface GetBdsInstancesBdsInstanceComputeOnlyWorkerNode { /** * 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. */ blockVolumeSizeInGbs: string; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstancesBdsInstanceComputeOnlyWorkerNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstancesBdsInstanceComputeOnlyWorkerNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstancesBdsInstanceEdgeNode { /** * 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. */ blockVolumeSizeInGbs: string; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstancesBdsInstanceEdgeNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstancesBdsInstanceEdgeNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstancesBdsInstanceKafkaBrokerNode { /** * 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. */ blockVolumeSizeInGbs: string; numberOfKafkaNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstancesBdsInstanceKafkaBrokerNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstancesBdsInstanceKafkaBrokerNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstancesBdsInstanceMasterNode { /** * 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. */ blockVolumeSizeInGbs: string; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstancesBdsInstanceMasterNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstancesBdsInstanceMasterNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstancesBdsInstanceNetworkConfig { /** * The CIDR IP address block of the VCN. */ cidrBlock: string; /** * A boolean flag whether to configure a NAT gateway. */ isNatGatewayRequired: boolean; } interface GetBdsInstancesBdsInstanceNode { /** * The list of block volumes attached to a given node. */ attachedBlockVolumes: outputs.BigDataService.GetBdsInstancesBdsInstanceNodeAttachedBlockVolume[]; /** * The name of the availability domain in which the node is running. */ availabilityDomain: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The name of the fault domain in which the node is running. */ faultDomain: string; /** * The fully-qualified hostname (FQDN) of the node. */ hostname: string; /** * The OCID of the image from which the node was created. */ imageId: string; /** * The OCID of the underlying Oracle Cloud Infrastructure Compute instance. */ instanceId: string; /** * IP address of the node. */ ipAddress: string; /** * Indicates if the node requires a reboot to either reflect the latest os kernel or take actions for maintenance reboot. */ isRebootRequired: boolean; /** * The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null. */ localDisksTotalSizeInGbs: number; /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * Cluster node type. */ nodeType: string; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; /** * Version of the ODH (Oracle Distribution including Apache Hadoop) for the node. */ odhVersion: string; /** * BDS-assigned Operating System version for the node. */ osVersion: string; /** * Shape of the node. */ shape: string; /** * The fingerprint of the SSH key used for node access. */ sshFingerprint: string; /** * The state of the cluster. */ state: string; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; /** * The time the cluster was created, shown as an RFC 3339 formatted datetime string. */ timeCreated: string; /** * The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. */ timeMaintenanceRebootDue: string; } interface GetBdsInstancesBdsInstanceNodeAttachedBlockVolume { /** * The OCID of the volume attachment. */ volumeAttachmentId: string; /** * The size of the volume in GBs. */ volumeSizeInGbs: string; } interface GetBdsInstancesBdsInstanceStartClusterShapeConfig { nodeTypeShapeConfigs: outputs.BigDataService.GetBdsInstancesBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig[]; } interface GetBdsInstancesBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig { /** * Cluster node type. */ nodeType: string; /** * Shape of the node. */ shape: string; } interface GetBdsInstancesBdsInstanceUtilNode { /** * 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. */ blockVolumeSizeInGbs: string; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstancesBdsInstanceUtilNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstancesBdsInstanceUtilNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstancesBdsInstanceWorkerNode { /** * 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. */ blockVolumeSizeInGbs: string; /** * The number of nodes that form the cluster. */ numberOfNodes: number; /** * Shape of the node. */ shape: string; shapeConfigs: outputs.BigDataService.GetBdsInstancesBdsInstanceWorkerNodeShapeConfig[]; /** * The OCID of the subnet in which the node is to be created. */ subnetId: string; } interface GetBdsInstancesBdsInstanceWorkerNodeShapeConfig { /** * The total amount of memory available to the node, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the node. */ ocpus: number; } interface GetBdsInstancesFilter { name: string; regex?: boolean; values: string[]; } } export declare namespace Blockchain { interface BlockchainPlatformComponentDetail { /** * List of OSNs */ osns: outputs.Blockchain.BlockchainPlatformComponentDetailOsn[]; /** * List of Peers */ peers: outputs.Blockchain.BlockchainPlatformComponentDetailPeer[]; } interface BlockchainPlatformComponentDetailOsn { /** * Availability Domain of peer */ ad: string; /** * OCPU allocation parameter */ ocpuAllocationParams: outputs.Blockchain.BlockchainPlatformComponentDetailOsnOcpuAllocationParam[]; /** * OSN identifier */ osnKey: string; /** * The current state of the Platform Instance. */ state: string; } interface BlockchainPlatformComponentDetailOsnOcpuAllocationParam { /** * Number of OCPU allocation */ ocpuAllocationNumber: number; } interface BlockchainPlatformComponentDetailPeer { /** * Availability Domain of peer */ ad: string; /** * peer alias */ alias: string; /** * Host name of VM */ host: string; /** * OCPU allocation parameter */ ocpuAllocationParams: outputs.Blockchain.BlockchainPlatformComponentDetailPeerOcpuAllocationParam[]; /** * peer identifier */ peerKey: string; /** * Peer role */ role: string; /** * The current state of the Platform Instance. */ state: string; } interface BlockchainPlatformComponentDetailPeerOcpuAllocationParam { /** * Number of OCPU allocation */ ocpuAllocationNumber: number; } interface BlockchainPlatformHostOcpuUtilizationInfo { /** * Host name of VM */ host: string; /** * Number of total OCPU capacity on the host */ ocpuCapacityNumber: number; /** * Number of OCPU utilized */ ocpuUtilizationNumber: number; } interface BlockchainPlatformReplicas { /** * Number of CA replicas */ caCount: number; /** * Number of console replicas */ consoleCount: number; /** * Number of REST proxy replicas */ proxyCount: number; } interface GetBlockchainPlatformComponentDetail { /** * List of OSNs */ osns: outputs.Blockchain.GetBlockchainPlatformComponentDetailOsn[]; /** * List of Peers */ peers: outputs.Blockchain.GetBlockchainPlatformComponentDetailPeer[]; } interface GetBlockchainPlatformComponentDetailOsn { /** * Availability Domain of peer */ ad: string; /** * OCPU allocation parameter */ ocpuAllocationParams: outputs.Blockchain.GetBlockchainPlatformComponentDetailOsnOcpuAllocationParam[]; /** * OSN identifier */ osnKey: string; /** * The current state of the Platform Instance. */ state: string; } interface GetBlockchainPlatformComponentDetailOsnOcpuAllocationParam { /** * Number of OCPU allocation */ ocpuAllocationNumber: number; } interface GetBlockchainPlatformComponentDetailPeer { /** * Availability Domain of peer */ ad: string; /** * peer alias */ alias: string; /** * Host name of VM */ host: string; /** * OCPU allocation parameter */ ocpuAllocationParams: outputs.Blockchain.GetBlockchainPlatformComponentDetailPeerOcpuAllocationParam[]; /** * peer identifier */ peerKey: string; /** * Peer role */ role: string; /** * The current state of the Platform Instance. */ state: string; } interface GetBlockchainPlatformComponentDetailPeerOcpuAllocationParam { /** * Number of OCPU allocation */ ocpuAllocationNumber: number; } interface GetBlockchainPlatformHostOcpuUtilizationInfo { /** * Host name of VM */ host: string; /** * Number of total OCPU capacity on the host */ ocpuCapacityNumber: number; /** * Number of OCPU utilized */ ocpuUtilizationNumber: number; } interface GetBlockchainPlatformPatchesBlockchainPlatformPatchCollection { /** * Collection of PatchSummary */ items: outputs.Blockchain.GetBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItem[]; } interface GetBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItem { /** * Collection of PatchSummary */ items: outputs.Blockchain.GetBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItemItem[]; } interface GetBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItemItem { /** * patch id */ id: string; /** * A URL for the patch specific documentation */ patchInfoUrl: string; /** * patch service version */ serviceVersion: string; /** * patch due date for customer initiated patching */ timePatchDue: string; } interface GetBlockchainPlatformPatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetBlockchainPlatformReplica { /** * Number of CA replicas */ caCount: number; /** * Number of console replicas */ consoleCount: number; /** * Number of REST proxy replicas */ proxyCount: number; } interface GetBlockchainPlatformsBlockchainPlatformCollection { items: outputs.Blockchain.GetBlockchainPlatformsBlockchainPlatformCollectionItem[]; } interface GetBlockchainPlatformsBlockchainPlatformCollectionItem { caCertArchiveText: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Blockchain Platform component details. */ componentDetails: outputs.Blockchain.GetBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetail[]; /** * 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 */ computeShape: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Platform Instance Description */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; federatedUserId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * List of OcpuUtilization for all hosts */ hostOcpuUtilizationInfos: outputs.Blockchain.GetBlockchainPlatformsBlockchainPlatformCollectionItemHostOcpuUtilizationInfo[]; /** * unique identifier that is immutable on creation */ id: string; idcsAccessToken: string; /** * Bring your own license */ isByol: boolean; /** * True for multi-AD blockchain plaforms, false for single-AD */ isMultiAd: boolean; /** * An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Type of Load Balancer shape - LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS. */ loadBalancerShape: string; /** * Role of platform - FOUNDER or PARTICIPANT */ platformRole: string; /** * Type of Platform shape - DEFAULT or CUSTOM */ platformShapeType: string; /** * Platform Version */ platformVersion: string; /** * Number of replicas of service components like Rest Proxy, CA and Console */ replicas: outputs.Blockchain.GetBlockchainPlatformsBlockchainPlatformCollectionItemReplica[]; /** * Service endpoint URL, valid post-provisioning */ serviceEndpoint: string; /** * The version of the Platform Instance. */ serviceVersion: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Storage size in TBs */ storageSizeInTbs: number; /** * Storage used in TBs */ storageUsedInTbs: number; /** * The time the the Platform Instance was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Platform Instance was updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * Number of total OCPUs allocated to the platform cluster */ totalOcpuCapacity: number; } interface GetBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetail { /** * List of OSNs */ osns: outputs.Blockchain.GetBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsn[]; /** * List of Peers */ peers: outputs.Blockchain.GetBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeer[]; } interface GetBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsn { /** * Availability Domain of peer */ ad: string; /** * OCPU allocation parameter */ ocpuAllocationParams: outputs.Blockchain.GetBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsnOcpuAllocationParam[]; /** * OSN identifier */ osnKey: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; } interface GetBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsnOcpuAllocationParam { /** * Number of OCPU allocation */ ocpuAllocationNumber: number; } interface GetBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeer { /** * Availability Domain of peer */ ad: string; /** * peer alias */ alias: string; /** * Host name of VM */ host: string; /** * OCPU allocation parameter */ ocpuAllocationParams: outputs.Blockchain.GetBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeerOcpuAllocationParam[]; /** * peer identifier */ peerKey: string; /** * Peer role */ role: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; } interface GetBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeerOcpuAllocationParam { /** * Number of OCPU allocation */ ocpuAllocationNumber: number; } interface GetBlockchainPlatformsBlockchainPlatformCollectionItemHostOcpuUtilizationInfo { /** * Host name of VM */ host: string; /** * Number of total OCPU capacity on the host */ ocpuCapacityNumber: number; /** * Number of OCPU utilized */ ocpuUtilizationNumber: number; } interface GetBlockchainPlatformsBlockchainPlatformCollectionItemReplica { /** * Number of CA replicas */ caCount: number; /** * Number of console replicas */ consoleCount: number; /** * Number of REST proxy replicas */ proxyCount: number; } interface GetBlockchainPlatformsFilter { name: string; regex?: boolean; values: string[]; } interface GetOsnOcpuAllocationParam { /** * Number of OCPU allocation */ ocpuAllocationNumber: number; } interface GetOsnsFilter { name: string; regex?: boolean; values: string[]; } interface GetOsnsOsnCollection { items: outputs.Blockchain.GetOsnsOsnCollectionItem[]; } interface GetOsnsOsnCollectionItem { /** * Availability Domain of OSN */ ad: string; /** * Unique service identifier. */ blockchainPlatformId: string; /** * OCPU allocation parameter */ ocpuAllocationParam: outputs.Blockchain.GetOsnsOsnCollectionItemOcpuAllocationParam; /** * OSN identifier */ osnKey: string; /** * The current state of the OSN. */ state: string; } interface GetOsnsOsnCollectionItemOcpuAllocationParam { /** * Number of OCPU allocation */ ocpuAllocationNumber: number; } interface GetPeerOcpuAllocationParam { /** * Number of OCPU allocation */ ocpuAllocationNumber: number; } interface GetPeersFilter { name: string; regex?: boolean; values: string[]; } interface GetPeersPeerCollection { items: outputs.Blockchain.GetPeersPeerCollectionItem[]; } interface GetPeersPeerCollectionItem { /** * Availability Domain of peer */ ad: string; /** * peer alias */ alias: string; /** * Unique service identifier. */ blockchainPlatformId: string; /** * Host on which the Peer exists */ host: string; /** * OCPU allocation parameter */ ocpuAllocationParam: outputs.Blockchain.GetPeersPeerCollectionItemOcpuAllocationParam; /** * peer identifier */ peerKey: string; /** * Peer role */ role: string; /** * The current state of the peer. */ state: string; } interface GetPeersPeerCollectionItemOcpuAllocationParam { /** * Number of OCPU allocation */ ocpuAllocationNumber: number; } interface OsnOcpuAllocationParam { /** * (Updatable) Number of OCPU allocation * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ ocpuAllocationNumber: number; } interface PeerOcpuAllocationParam { /** * (Updatable) Number of OCPU allocation */ ocpuAllocationNumber: number; } } export declare namespace Budget { interface CostAnomalyMonitorCostAlertSubscriptionMap { /** * (Updatable) The costAlertSubscription ocid which the cost monitor alert maps to. */ costAlertSubscriptionId: string; /** * (Updatable) The filter operator. Example: 'AND', 'OR'. */ operator: string; /** * (Updatable) The absolute threshold value. */ thresholdAbsoluteValue: number; /** * (Updatable) The relative percentage threshold value. */ thresholdRelativePercent: number; } interface GetAlertRulesAlertRule { /** * The unique budget OCID. */ budgetId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the alert rule. */ description: string; /** * A user-friendly name. This does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the alert rule. */ id: string; /** * The custom message that will be sent when the alert is triggered. */ message: string; /** * The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon. */ recipients: string; /** * The current state of the resource to filter by. */ state: string; /** * The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000. */ threshold: number; /** * The type of threshold. */ thresholdType: string; /** * The time when the budget was created. */ timeCreated: string; /** * The time when the budget was updated. */ timeUpdated: string; /** * 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). */ type: string; /** * The version of the alert rule. Starts from 1 and increments by 1. */ version: number; } interface GetAlertRulesFilter { name: string; regex?: boolean; values: string[]; } interface GetBudgetsBudget { /** * The actual spend in currency for the current budget cycle. */ actualSpend: number; /** * The total number of alert rules in the budget. */ alertRuleCount: number; /** * The amount of the budget, expressed in the currency of the customer's rate card. */ amount: number; /** * 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. */ budgetProcessingPeriodStartOffset: number; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the budget. */ description: string; /** * A user-friendly name. This does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; /** * 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. */ endDate: string; /** * The forecasted spend in currency by the end of the current budget cycle. */ forecastedSpend: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the budget. */ id: string; /** * The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE. */ processingPeriodType: string; /** * The reset period for the budget. */ resetPeriod: string; /** * 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. */ startDate: string; /** * The current state of the resource to filter by. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * 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. * * @deprecated The 'target_compartment_id' field has been deprecated. Please use 'targets' instead. */ targetCompartmentId: string; /** * The type of target to filter by: * * ALL - List all budgets * * COMPARTMENT - List all budgets with targetType == "COMPARTMENT" * * TAG - List all budgets with targetType == "TAG" */ targetType: string; /** * 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}". */ targets: string[]; /** * The time that the budget was created. */ timeCreated: string; /** * The time that the budget spend was last computed. */ timeSpendComputed: string; /** * The time that the budget was updated. */ timeUpdated: string; /** * The version of the budget. Starts from 1 and increments by 1. */ version: number; } interface GetBudgetsFilter { name: string; regex?: boolean; values: string[]; } interface GetCostAlertSubscriptionsCostAlertSubscriptionCollection { items: outputs.Budget.GetCostAlertSubscriptionsCostAlertSubscriptionCollectionItem[]; } interface GetCostAlertSubscriptionsCostAlertSubscriptionCollectionItem { /** * The notification channels string. */ channels: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * List of monitor identifiers */ costAnomalyMonitors: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the cost alert subscription. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Cost Alert Subscription. */ id: string; /** * Unique, non-changeable resource name. */ name: string; /** * The current state of the cost alert subscription. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The time that the cost alert subscription was created. */ timeCreated: string; /** * The time that the cost alert subscription was updated. */ timeUpdated: string; } interface GetCostAlertSubscriptionsFilter { /** * Unique, non-changeable resource name. */ name: string; regex?: boolean; values: string[]; } interface GetCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollection { /** * The list of CostAnomalyEvent Analytic summary. */ items: outputs.Budget.GetCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollectionItem[]; } interface GetCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollectionItem { /** * The average cost impact of the anomaly events in the given time period. */ averageCostImpact: number; /** * The average cost variance of the anomaly events in the given time period. */ averageCostVariance: number; /** * The number of cost anomaly events in the given time period. */ costAnomalyEventAnalyticCount: number; } interface GetCostAnomalyEventAnalyticsFilter { /** * Unique, non-changeable resource name. */ name: string; regex?: boolean; values: string[]; } interface GetCostAnomalyEventsCostAnomalyEventCollection { items: outputs.Budget.GetCostAnomalyEventsCostAnomalyEventCollectionItem[]; } interface GetCostAnomalyEventsCostAnomalyEventCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; costAnomalyEventId: string; /** * The name of the associated cost monitor. */ costAnomalyName: string; /** * cost impact (absolute) of the anomaly event. */ costImpact: number; /** * The OCID of the associated cost monitor. */ costMonitorId: string; /** * The name of the associated cost monitor. */ costMonitorName: string; /** * Type of cost monitor */ costMonitorType: string; /** * The cost variance percentage of the detected anomaly. */ costVariancePercentage: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The feedback response for the cost anomaly event. */ feedbackResponse: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Cost Anomaly Event. */ id: string; /** * The root cause details of the cost anomaly event. */ rootCauseDetail: string; /** * The current state of the cost anomaly event. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * 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. */ targetResourceFilter: string; /** * The event date of the anomaly event. */ timeAnomalyEventDate: string; /** * The created time of the cost anomaly event. */ timeCreated: string; /** * The updated time of the cost anomaly event. */ timeUpdated: string; } interface GetCostAnomalyEventsFilter { /** * Unique, non-changeable resource name. */ name: string; regex?: boolean; values: string[]; } interface GetCostAnomalyMonitorCostAlertSubscriptionMap { /** * The costAlertSubscription ocid which the cost monitor alert maps to. */ costAlertSubscriptionId: string; /** * The filter operator. Example: 'AND', 'OR'. */ operator: string; /** * The absolute threshold value. */ thresholdAbsoluteValue: number; /** * The relative percentage threshold value. */ thresholdRelativePercent: number; } interface GetCostAnomalyMonitorsCostAnomalyMonitorCollection { items: outputs.Budget.GetCostAnomalyMonitorsCostAnomalyMonitorCollectionItem[]; } interface GetCostAnomalyMonitorsCostAnomalyMonitorCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The mapping of cost monitor to alert subscription along with thresholds. */ costAlertSubscriptionMaps: outputs.Budget.GetCostAnomalyMonitorsCostAnomalyMonitorCollectionItemCostAlertSubscriptionMap[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the budget. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Cost Anomaly Monitor. */ id: string; /** * The current state details of the cost monitor. */ lifecycleDetails: string; /** * Unique, non-changeable resource name. */ name: string; /** * The current state of the cost monitor. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * 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. */ targetResourceFilter: string; /** * The time that the cost monitor was created. */ timeCreated: string; /** * The time that the cost monitor was last updated. */ timeUpdated: string; /** * Type of cost monitor */ type: string; } interface GetCostAnomalyMonitorsCostAnomalyMonitorCollectionItemCostAlertSubscriptionMap { /** * The costAlertSubscription ocid which the cost monitor alert maps to. */ costAlertSubscriptionId: string; /** * The filter operator. Example: 'AND', 'OR'. */ operator: string; /** * The absolute threshold value. */ thresholdAbsoluteValue: number; /** * The relative percentage threshold value. */ thresholdRelativePercent: number; } interface GetCostAnomalyMonitorsFilter { /** * Unique, non-changeable resource name. */ name: string; regex?: boolean; values: string[]; } } export declare namespace CapacityManagement { interface GetInternalNamespaceOccOverviewsFilter { name: string; regex?: boolean; values: string[]; } interface GetInternalNamespaceOccOverviewsOccOverviewCollection { /** * An array of overview summary. */ items: outputs.CapacityManagement.GetInternalNamespaceOccOverviewsOccOverviewCollectionItem[]; } interface GetInternalNamespaceOccOverviewsOccOverviewCollectionItem { /** * A raw json blob containing all the capacity requests corresponding to the resource name */ capacityRequestsBlob: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * The name of the month along with year for which this summary corresponds to. */ periodValue: string; /** * The name of the resource for which we have aggregated the value. */ resourceName: string; /** * The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration. */ totalAvailable: string; /** * 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. */ totalCancelled: string; /** * 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. */ totalDemanded: string; /** * The quantity of the resource which is rejected by Oracle. */ totalRejected: string; /** * 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. */ totalSupplied: string; /** * 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. */ totalUnfulfilled: string; /** * The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured. */ unit: string; /** * A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types */ workloadTypeBreakdownBlob: string; } interface GetInternalOccAvailabilityCatalogsFilter { name: string; regex?: boolean; values: string[]; } interface GetInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollection { /** * An array of availability catalogs. */ items: outputs.CapacityManagement.GetInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem[]; } interface GetInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem { /** * Filter the list of availability catalogs based on the catalog state. */ catalogState: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Text information about the availability catalog. */ description: string; /** * A filter to return only the resources that match the entire display name. The match is not case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the availability catalog to filter the list of availability catalogs. */ id: string; /** * 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. */ lifecycleDetails: string; /** * Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing. */ metadataDetails: outputs.CapacityManagement.GetInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail[]; /** * The namespace by which we would filter the list. */ namespace: string; /** * The customer group ocid by which we would filter the list. */ occCustomerGroupId: string; /** * The current lifecycle state of the customer group. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the availability catalog was created. */ timeCreated: string; /** * The time when the availability catalog was last updated. */ timeUpdated: string; } interface GetInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail { /** * The version for the format of the catalog file being uploaded. */ formatVersion: string; } interface GetInternalOccHandoverResourceBlockDetailsFilter { name: string; regex?: boolean; values: string[]; } interface GetInternalOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollection { /** * An array of details about an occ handover resource block. */ items: outputs.CapacityManagement.GetInternalOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem[]; } interface GetInternalOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem { /** * A map that contains additional details for a given handover resource. For example for compute namespace this includes host ocid, host serial etc. */ details: { [key: string]: string; }; /** * The OCID of the occResourceHandoverBlock. */ occResourceHandoverBlockId: string; } interface GetInternalOccHandoverResourceBlocksFilter { name: string; regex?: boolean; values: string[]; } interface GetInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollection { /** * An array of occ handover resource blocks. */ items: outputs.CapacityManagement.GetInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem[]; } interface GetInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem { /** * A list containing details about the capacity requests against which the resources were provisioned by oracle. */ associatedCapacityRequests: outputs.CapacityManagement.GetInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest[]; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * The date on which the resource was handed over to the customer. */ handoverDate: string; /** * A filter to return only the list of resources that match the name provided in this filter. */ handoverResourceName: string; /** * The OCID of the resource block. */ id: string; /** * The namespace enum value that needs to be passed as a required query parameter. */ namespace: string; /** * The customer group ocid by which we would filter the list. */ occCustomerGroupId: string; /** * Details like building, room and block where the resource was placed after provisioning in the datacenter. */ placementDetails: outputs.CapacityManagement.GetInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail[]; /** * The total quantity of the resource that was made available to the customer by Oracle. */ totalHandoverQuantity: string; } interface GetInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest { /** * The total quantity of the bare metal hardware that was made available corresponding to the capacity request ocid. */ handoverQuantity: string; /** * The OCID of the capacity request against which the resources were provisioned. */ occCapacityRequestId: string; } interface GetInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail { /** * The availability domain (AD) for which the resources were provisioned. */ availabilityDomain: string; /** * The block in the datacenter room where the resource was placed. */ block: string; /** * The datacenter building where the resource was placed. */ building: string; /** * The name of the region for which the resources were provisioned. */ region: string; /** * The name of the room in the dataacenter building where the resource was placed. */ room: string; /** * The type of workload to which these resources were provisioned. */ workloadType: string; } interface GetInternalOccmDemandSignalCatalogResourcesFilter { /** * A query parameter to filter the list of demand signal catalog resource based on the resource name. */ name: string; regex?: boolean; values: string[]; } interface GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollection { /** * An array of items containing detailed information about a resource's property dependecies. */ items: outputs.CapacityManagement.GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItem[]; } interface GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItem { /** * The name of the availability domain for which you want to request the Oracle Cloud Infrastructure resource. This is an optional parameter. */ availabilityDomain: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the demand signal catalog resource. */ id: string; /** * A query parameter to filter the list of demand signal catalog resource based on the resource name. */ name: string; /** * The name of the Oracle Cloud Infrastructure service in consideration for demand signal submission. For example: COMPUTE, NETWORK, GPU etc. */ namespace: string; /** * The customer group ocid by which we would filter the list. */ occCustomerGroupId: string; /** * The ocid of demand signal catalog id. */ occmDemandSignalCatalogId: string; /** * The name of region for which you want to request the Oracle Cloud Infrastructure resource. This is an optional parameter. */ region: string; /** * A list containing detailed information about a resource's properties. */ resourceProperties: outputs.CapacityManagement.GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourceProperty[]; /** * A list containing detailed information about a resource's property constraints. */ resourcePropertyConstraints: outputs.CapacityManagement.GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint[]; /** * The current lifecycle state of the demand signal catalog resource. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of the customer tenancy for which this resource will be available for the customer to order against. */ targetCompartmentId: string; /** * The time when the demand signal catalog resource was created. */ timeCreated: string; /** * The time when the demand signal catalog resource was last updated. */ timeUpdated: string; } interface GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourceProperty { /** * An array of items containing detailed information about a resource's property dependecies. */ items: outputs.CapacityManagement.GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem[]; } interface GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint { /** * An array of items containing detailed information about a resource's property dependecies. */ items: outputs.CapacityManagement.GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem[]; } interface GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem { /** * The name of demand signal resource's property constraint. */ constraintName: string; /** * The value of demand signal resource's property constraint. */ constraintValue: string; } interface GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem { /** * This will indicate if demand signal resource's property is editable. */ isEditable: boolean; /** * The maximum value of demand signal resource's property. This is an optional parameter. */ propertyMaxValue: string; /** * The minimum value of demand signal resource's property. This is an optional parameter. */ propertyMinValue: string; /** * The name of demand signal resource's property. */ propertyName: string; /** * Predefined options for demand signal resource's property. This is an optional parameter. */ propertyOptions: outputs.CapacityManagement.GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption[]; /** * Unit for demand signal resource's property. */ propertyUnit: string; /** * Default value of demand signal resource's property. */ propertyValue: string; } interface GetInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption { /** * key of a property option like memoryValue, ocpuValue. */ optionKey: string; /** * value of a property option like 64, 2 fastconnect etc. */ optionValue: string; } interface GetInternalOccmDemandSignalCatalogsFilter { name: string; regex?: boolean; values: string[]; } interface GetInternalOccmDemandSignalCatalogsOccmDemandSignalCatalogCollection { items: outputs.CapacityManagement.GetInternalOccmDemandSignalCatalogsOccmDemandSignalCatalogCollectionItem[]; } interface GetInternalOccmDemandSignalCatalogsOccmDemandSignalCatalogCollectionItem { /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * description of demand signal catalog. */ description: string; /** * A filter to return only the resources that match the entire display name. The match is not case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The ocid of demand signal catalog. */ id: string; /** * The customer group ocid by which we would filter the list. */ occCustomerGroupId: string; /** * The current lifecycle state of the resource. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the demand signal catalog was created. */ timeCreated: string; /** * The time when the demand signal catalog was last updated. */ timeUpdated: string; } interface GetInternalOccmDemandSignalDeliveriesFilter { name: string; regex?: boolean; values: string[]; } interface GetInternalOccmDemandSignalDeliveriesInternalOccmDemandSignalDeliveryCollection { items: outputs.CapacityManagement.GetInternalOccmDemandSignalDeliveriesInternalOccmDemandSignalDeliveryCollectionItem[]; } interface GetInternalOccmDemandSignalDeliveriesInternalOccmDemandSignalDeliveryCollectionItem { /** * The quantity of the resource that Oracle Cloud Infrastructure will supply to the customer. */ acceptedQuantity: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The OCID of the demand signal under which this delivery will be grouped. */ demandSignalId: string; /** * The OCID of the demand signal item corresponding to which this delivery is made. */ demandSignalItemId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A query parameter to filter the list of demand signals based on it's OCID. */ id: string; /** * This field could be used by Oracle Cloud Infrastructure to communicate the reason for accepting or declining the request. */ justification: string; /** * The enum values corresponding to the various states associated with the delivery resource. */ lifecycleDetails: string; /** * This field acts as a notes section for operators. */ notes: string; /** * The customer group ocid by which we would filter the list. */ occCustomerGroupId: string; /** * The current lifecycle state of the resource. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * 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. */ timeDelivered: string; } interface GetInternalOccmDemandSignalItemsFilter { name: string; regex?: boolean; values: string[]; } interface GetInternalOccmDemandSignalItemsInternalOccmDemandSignalItemCollection { /** * An array of items containing detailed information about different resource demanded as part of a demand signal. */ items: outputs.CapacityManagement.GetInternalOccmDemandSignalItemsInternalOccmDemandSignalItemCollectionItem[]; } interface GetInternalOccmDemandSignalItemsInternalOccmDemandSignalItemCollectionItem { /** * The name of the availability domain for which you want to request the Oracle Cloud Infrastructure resource. */ availabilityDomain: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The OCID of the corresponding demand signal catalog resource. */ demandSignalCatalogResourceId: string; /** * The OCID of the demand signal under which this item will be grouped. */ demandSignalId: string; /** * A query parameter to filter the list of demand signal details based on the namespace. */ demandSignalNamespace: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the demand signal resource request. */ id: string; /** * 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. */ notes: string; /** * The customer group ocid by which we would filter the list. */ occCustomerGroupId: string; /** * The quantity of the resource that you want to demand from Oracle Cloud Infrastructure or return to OCI. */ quantity: string; /** * The name of region for which you want to request the Oracle Cloud Infrastructure resource. */ region: string; /** * The type of request (DEMAND or RETURN) made against a particular demand signal item. */ requestType: string; /** * A query parameter to filter the list of demand signal details based on the resource name. */ resourceName: string; /** * A map of various properties associated with the Oracle Cloud Infrastructure resource. */ resourceProperties: { [key: string]: string; }; /** * The current lifecycle state of the demand signal item. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The ocid of the tenancy for which you want to request the Oracle Cloud Infrastructure resource for. This is an optional parameter. */ targetCompartmentId: string; /** * the date before which you would ideally like the Oracle Cloud Infrastructure resource to be delivered to you. */ timeNeededBefore: string; } interface GetInternalOccmDemandSignalsFilter { name: string; regex?: boolean; values: string[]; } interface GetInternalOccmDemandSignalsInternalOccmDemandSignalCollection { items: outputs.CapacityManagement.GetInternalOccmDemandSignalsInternalOccmDemandSignalCollectionItem[]; } interface GetInternalOccmDemandSignalsInternalOccmDemandSignalCollectionItem { /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A short description about the demand signal. */ description: string; /** * A filter to return only the resources that match the entire display name. The match is not case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A query parameter to filter the list of demand signals based on it's OCID. */ id: string; /** * A query parameter to filter the list of demand signals based on its state. */ lifecycleDetails: string; /** * The customer group ocid by which we would filter the list. */ occCustomerGroupId: string; occmDemandSignalId: string; /** * The current lifecycle state of the demand signal. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the demand signal was created. */ timeCreated: string; /** * The time when the demand signal was last updated. */ timeUpdated: string; } interface GetNamespaceOccOverviewsFilter { name: string; regex?: boolean; values: string[]; } interface GetNamespaceOccOverviewsOccOverviewCollection { /** * An array of overview summary. */ items: outputs.CapacityManagement.GetNamespaceOccOverviewsOccOverviewCollectionItem[]; } interface GetNamespaceOccOverviewsOccOverviewCollectionItem { /** * A raw json blob containing all the capacity requests corresponding to the resource name */ capacityRequestsBlob: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * The name of the month along with year for which this summary corresponds to. */ periodValue: string; /** * The name of the resource for which we have aggregated the value. */ resourceName: string; /** * The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration. */ totalAvailable: string; /** * 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. */ totalCancelled: string; /** * 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. */ totalDemanded: string; /** * The quantity of the resource which is rejected by Oracle. */ totalRejected: string; /** * 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. */ totalSupplied: string; /** * 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. */ totalUnfulfilled: string; /** * The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured. */ unit: string; /** * A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types */ workloadTypeBreakdownBlob: string; } interface GetOccAvailabilityCatalogDetail { /** * The quantity of resource currently available that the customer can request. */ availableQuantity: string; /** * The OCID of the availability catalog. */ catalogId: string; /** * The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled. */ dateExpectedCapacityHandover: string; /** * The date by which the customer must place the order to have their capacity requirements met by the customer handover date. */ dateFinalCustomerOrder: string; /** * The quantity of resource currently demanded by the customer. */ demandedQuantity: string; /** * The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on. */ namespace: string; /** * The name of the resource that the customer can request. */ resourceName: string; /** * The different types of resources against which customers can place capacity requests. */ resourceType: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The total quantity of resource that the customer can request. */ totalAvailableQuantity: string; /** * The unit in which the resource available is measured. */ unit: string; /** * The type of workload (Generic/ROW). */ workloadType: string; } interface GetOccAvailabilityCatalogMetadataDetail { /** * The version for the format of the catalog file being uploaded. */ formatVersion: string; } interface GetOccAvailabilityCatalogOccAvailabilitiesFilter { name: string; regex?: boolean; values: string[]; } interface GetOccAvailabilityCatalogOccAvailabilitiesOccAvailabilityCollection { /** * An array of capacity constraints. */ items: outputs.CapacityManagement.GetOccAvailabilityCatalogOccAvailabilitiesOccAvailabilityCollectionItem[]; } interface GetOccAvailabilityCatalogOccAvailabilitiesOccAvailabilityCollectionItem { /** * The quantity of resource currently available that the customer can request. */ availableQuantity: string; /** * The OCID of the availability catalog. */ catalogId: string; /** * The capacity handover date of the capacity constraint to filter the list of capacity constraints. */ dateExpectedCapacityHandover: string; /** * The date by which the customer must place the order to have their capacity requirements met by the customer handover date. */ dateFinalCustomerOrder: string; /** * The quantity of resource currently demanded by the customer. */ demandedQuantity: string; /** * The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on. */ namespace: string; /** * The name of the resource to filter the list of capacity constraints. */ resourceName: string; /** * Resource type using which the capacity constraints of an availability catalog can be filtered. */ resourceType: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The total quantity of resource that the customer can request. */ totalAvailableQuantity: string; /** * The unit in which the resource available is measured. */ unit: string; /** * Workload type using the resources in an availability catalog can be filtered. */ workloadType: string; } interface GetOccAvailabilityCatalogsFilter { name: string; regex?: boolean; values: string[]; } interface GetOccAvailabilityCatalogsOccAvailabilityCatalogCollection { items: outputs.CapacityManagement.GetOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem[]; } interface GetOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem { base64encodedCatalogDetails: string; /** * Filter the list of availability catalogs based on the catalog state. */ catalogState: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Text information about the availability catalog. */ description: string; /** * Details about capacity available for different resources in catalog. */ details: outputs.CapacityManagement.GetOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemDetail[]; /** * A filter to return only the resources that match the entire display name. The match is not case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the availability catalog to filter the list of availability catalogs. */ id: string; /** * 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. */ lifecycleDetails: string; /** * Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing. */ metadataDetails: outputs.CapacityManagement.GetOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail[]; /** * The namespace by which we would filter the list. */ namespace: string; /** * The customer group OCID to which the availability catalog belongs. */ occCustomerGroupId: string; /** * The current lifecycle state of the resource. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the availability catalog was created. */ timeCreated: string; /** * The time when the availability catalog was last updated. */ timeUpdated: string; } interface GetOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemDetail { /** * The quantity of resource currently available that the customer can request. */ availableQuantity: string; /** * The OCID of the availability catalog. */ catalogId: string; /** * The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled. */ dateExpectedCapacityHandover: string; /** * The date by which the customer must place the order to have their capacity requirements met by the customer handover date. */ dateFinalCustomerOrder: string; /** * The quantity of resource currently demanded by the customer. */ demandedQuantity: string; /** * The namespace by which we would filter the list. */ namespace: string; /** * The name of the resource that the customer can request. */ resourceName: string; /** * The different types of resources against which customers can place capacity requests. */ resourceType: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The total quantity of resource that the customer can request. */ totalAvailableQuantity: string; /** * The unit in which the resource available is measured. */ unit: string; /** * The type of workload (Generic/ROW). */ workloadType: string; } interface GetOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail { /** * The version for the format of the catalog file being uploaded. */ formatVersion: string; } interface GetOccCapacityRequestDetail { /** * The actual handed over quantity of resources at the time of request resolution. */ actualHandoverQuantity: string; /** * A list containing details about occHandoverResourceBlocks which were handed over for the corresponding resource name. */ associatedOccHandoverResourceBlockLists: outputs.CapacityManagement.GetOccCapacityRequestDetailAssociatedOccHandoverResourceBlockList[]; /** * The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests. */ availabilityDomain: string; /** * The date on which the actual handover quantity of resources is delivered. */ dateActualHandover: string; /** * The date on which the latest increment to supplied quantity of resources was delivered. */ dateExpectedHandover: string; /** * The number of compute server's with name required by the user. */ demandQuantity: string; /** * The incremental quantity of resources supplied as the provisioning is underway. */ expectedHandoverQuantity: string; /** * The name of the COMPUTE server shape for which the request is made. Do not use CAPACITY_CONSTRAINT as the resource name. */ resourceName: string; /** * The type of the resource against which the user wants to place a capacity request. */ resourceType: string; /** * The WorkloadType from where capacity request are to be transferred. */ sourceWorkloadType: string; /** * The type of the workload (Generic/ROW). */ workloadType: string; } interface GetOccCapacityRequestDetailAssociatedOccHandoverResourceBlockList { /** * The total quantity of the resource that was made available to the customer as part of this resource block */ handoverQuantity: string; /** * The OCID of the handed over resource block. */ occHandoverResourceBlockId: string; } interface GetOccCapacityRequestPatchOperation { from: string; operation: string; position: string; selectedItem: string; selection: string; value: { [key: string]: string; }; } interface GetOccCapacityRequestsFilter { name: string; regex?: boolean; values: string[]; } interface GetOccCapacityRequestsOccCapacityRequestCollection { items: outputs.CapacityManagement.GetOccCapacityRequestsOccCapacityRequestCollectionItem[]; } interface GetOccCapacityRequestsOccCapacityRequestCollectionItem { /** * The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests. */ availabilityDomain: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled. */ dateExpectedCapacityHandover: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Meaningful text about the capacity request. */ description: string; /** * A list of resources requested as part of this request */ details: outputs.CapacityManagement.GetOccCapacityRequestsOccCapacityRequestCollectionItemDetail[]; /** * A filter to return only the resources that match the entire display name. The match is not case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ id: string; /** * 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. */ lifecycleDetails: string; /** * The namespace by which we would filter the list. */ namespace: string; /** * A filter to return the list of capacity requests based on the OCID of the availability catalog against which they were created. */ occAvailabilityCatalogId: string; /** * The OCID of the customer group to which this customer belongs to. */ occCustomerGroupId: string; patchOperations: outputs.CapacityManagement.GetOccCapacityRequestsOccCapacityRequestCollectionItemPatchOperation[]; /** * The name of the region for which the capacity request was made. */ region: string; /** * The different states the capacity request goes through. */ requestState: string; /** * A filter to return only the resources that match the request type. The match is not case sensitive. */ requestType: string; /** * The current lifecycle state of the resource. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the capacity request was created. */ timeCreated: string; /** * The time when the capacity request was updated. */ timeUpdated: string; } interface GetOccCapacityRequestsOccCapacityRequestCollectionItemDetail { /** * The actual handed over quantity of resources at the time of request resolution. */ actualHandoverQuantity: string; /** * A list containing details about occHandoverResourceBlocks which were handed over for the corresponding resource name. */ associatedOccHandoverResourceBlockLists: outputs.CapacityManagement.GetOccCapacityRequestsOccCapacityRequestCollectionItemDetailAssociatedOccHandoverResourceBlockList[]; /** * The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests. */ availabilityDomain: string; /** * The date on which the actual handover quantity of resources is delivered. */ dateActualHandover: string; /** * The date on which the latest increment to supplied quantity of resources was delivered. */ dateExpectedHandover: string; /** * The number of compute server's with name required by the user. */ demandQuantity: string; /** * The incremental quantity of resources supplied as the provisioning is underway. */ expectedHandoverQuantity: string; /** * The name of the COMPUTE server shape for which the request is made. Do not use CAPACITY_CONSTRAINT as the resource name. */ resourceName: string; /** * The type of the resource against which the user wants to place a capacity request. */ resourceType: string; /** * The WorkloadType from where capacity request are to be transferred. */ sourceWorkloadType: string; /** * The type of the workload (Generic/ROW). */ workloadType: string; } interface GetOccCapacityRequestsOccCapacityRequestCollectionItemDetailAssociatedOccHandoverResourceBlockList { /** * The total quantity of the resource that was made available to the customer as part of this resource block */ handoverQuantity: string; /** * The OCID of the handed over resource block. */ occHandoverResourceBlockId: string; } interface GetOccCapacityRequestsOccCapacityRequestCollectionItemPatchOperation { from: string; operation: string; position: string; selectedItem: string; selection: string; value: { [key: string]: string; }; } interface GetOccCustomerGroupCustomersList { /** * The description about the customer group. */ description: string; /** * The display name of the customer group. */ displayName: string; /** * The OCID of the customer group. */ occCustomerGroupId: string; /** * To determine whether the customer group is enabled/disabled. */ status: string; /** * The OCID of the tenancy belonging to the customer. */ tenancyId: string; } interface GetOccCustomerGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetOccCustomerGroupsOccCustomerGroupCollection { items: outputs.CapacityManagement.GetOccCustomerGroupsOccCustomerGroupCollectionItem[]; } interface GetOccCustomerGroupsOccCustomerGroupCollectionItem { /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * A list containing all the customers that belong to this customer group */ customersLists: outputs.CapacityManagement.GetOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The description about the customer group. */ description: string; /** * A filter to return only the resources that match the entire display name. The match is not case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ id: string; /** * 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. */ lifecycleDetails: string; /** * The current lifecycle state of the resource. */ state: string; /** * A query filter to return the list result based on status. */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the customer group was created. */ timeCreated: string; /** * The time when the customer group was last updated. */ timeUpdated: string; } interface GetOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList { /** * The description about the customer group. */ description: string; /** * A filter to return only the resources that match the entire display name. The match is not case sensitive. */ displayName: string; /** * The OCID of the customer group. */ occCustomerGroupId: string; /** * A query filter to return the list result based on status. */ status: string; /** * The OCID of the tenancy belonging to the customer. */ tenancyId: string; } interface GetOccHandoverResourceBlockDetailsFilter { name: string; regex?: boolean; values: string[]; } interface GetOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollection { /** * An array of details about an occ handover resource block. */ items: outputs.CapacityManagement.GetOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem[]; } interface GetOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem { /** * A map that contains additional details for a given handover resource. For example for compute namespace this includes host ocid, host serial etc. */ details: { [key: string]: string; }; /** * The OCID of the occResourceHandoverBlock. */ occResourceHandoverBlockId: string; } interface GetOccHandoverResourceBlocksFilter { name: string; regex?: boolean; values: string[]; } interface GetOccHandoverResourceBlocksOccHandoverResourceBlockCollection { /** * An array of occ handover resource blocks. */ items: outputs.CapacityManagement.GetOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem[]; } interface GetOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem { /** * A list containing details about the capacity requests against which the resources were provisioned by oracle. */ associatedCapacityRequests: outputs.CapacityManagement.GetOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest[]; /** * The OCID of the compartment or tenancy in which resources are to be listed. */ compartmentId: string; /** * The date on which the resource was handed over to the customer. */ handoverDate: string; /** * A filter to return only the list of resources that match the name provided in this filter. */ handoverResourceName: string; /** * The OCID of the resource block. */ id: string; /** * The namespace by which we would filter the list. */ namespace: string; /** * The OCID of the customer group for which the resources were provisioned. */ occCustomerGroupId: string; /** * Details like building, room and block where the resource was placed after provisioning in the datacenter. */ placementDetails: outputs.CapacityManagement.GetOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail[]; /** * The total quantity of the resource that was made available to the customer by Oracle. */ totalHandoverQuantity: string; } interface GetOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest { /** * The total quantity of the bare metal hardware that was made available corresponding to the capacity request ocid. */ handoverQuantity: string; /** * The OCID of the capacity request against which the resources were provisioned. */ occCapacityRequestId: string; } interface GetOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail { /** * The availability domain (AD) for which the resources were provisioned. */ availabilityDomain: string; /** * The block in the datacenter room where the resource was placed. */ block: string; /** * The datacenter building where the resource was placed. */ building: string; /** * The name of the region for which the resources were provisioned. */ region: string; /** * The name of the room in the dataacenter building where the resource was placed. */ room: string; /** * The type of workload to which these resources were provisioned. */ workloadType: string; } interface GetOccmDemandSignalCatalogResourcesFilter { /** * A query parameter to filter the list of demand signal catalog resource based on the resource name. */ name: string; regex?: boolean; values: string[]; } interface GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollection { /** * An array of items containing detailed information about a resource's property dependecies. */ items: outputs.CapacityManagement.GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItem[]; } interface GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItem { /** * The name of the availability domain for which you want to request the Oracle Cloud Infrastructure resource. This is an optional parameter. */ availabilityDomain: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the demand signal catalog resource. */ id: string; /** * A query parameter to filter the list of demand signal catalog resource based on the resource name. */ name: string; /** * The name of the Oracle Cloud Infrastructure service in consideration for demand signal submission. For example: COMPUTE, NETWORK, GPU etc. */ namespace: string; /** * The name of region for which you want to request the Oracle Cloud Infrastructure resource. This is an optional parameter. */ region: string; /** * A list containing detailed information about a resource's properties. */ resourceProperties: outputs.CapacityManagement.GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourceProperty[]; /** * A list containing detailed information about a resource's property constraints. */ resourcePropertyConstraints: outputs.CapacityManagement.GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint[]; /** * The current lifecycles state of the demand signal catalog resource. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of the customer tenancy for which this resource will be available for the customer to order against. */ targetCompartmentId: string; /** * The time when the demand signal catalog resource was created. */ timeCreated: string; /** * The time when the demand signal catalog resource was last updated. */ timeUpdated: string; } interface GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourceProperty { /** * An array of items containing detailed information about a resource's property dependecies. */ items: outputs.CapacityManagement.GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem[]; } interface GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint { /** * An array of items containing detailed information about a resource's property dependecies. */ items: outputs.CapacityManagement.GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem[]; } interface GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem { /** * The name of demand signal resource's property constraint. */ constraintName: string; /** * The value of demand signal resource's property constraint. */ constraintValue: string; } interface GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem { /** * This will indicate if demand signal resource's property is editable. */ isEditable: boolean; /** * The maximum value of demand signal resource's property. This is an optional parameter. */ propertyMaxValue: string; /** * The minimum value of demand signal resource's property. This is an optional parameter. */ propertyMinValue: string; /** * The name of demand signal resource's property. */ propertyName: string; /** * Predefined options for demand signal resource's property. This is an optional parameter. */ propertyOptions: outputs.CapacityManagement.GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption[]; /** * Unit for demand signal resource's property. */ propertyUnit: string; /** * Default value of demand signal resource's property. */ propertyValue: string; } interface GetOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption { /** * key of a property option like memoryValue, ocpuValue. */ optionKey: string; /** * value of a property option like 64, 2 fastconnect etc. */ optionValue: string; } interface GetOccmDemandSignalDeliveriesFilter { name: string; regex?: boolean; values: string[]; } interface GetOccmDemandSignalDeliveriesOccmDemandSignalDeliveryCollection { /** * An array of items containing detailed information about demand signal delivery resources. */ items: outputs.CapacityManagement.GetOccmDemandSignalDeliveriesOccmDemandSignalDeliveryCollectionItem[]; } interface GetOccmDemandSignalDeliveriesOccmDemandSignalDeliveryCollectionItem { /** * The quantity of the resource that Oracle Cloud Infrastructure will supply to the customer. */ acceptedQuantity: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The OCID of the demand signal under which this delivery will be grouped. */ demandSignalId: string; /** * The OCID of the demand signal item corresponding to which this delivery is made. */ demandSignalItemId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A query parameter to filter the list of demand signals based on it's OCID. */ id: string; /** * This field could be used by Oracle Cloud Infrastructure to communicate the reason for accepting or declining the request. */ justification: string; /** * The enum values corresponding to the various states associated with the delivery resource. */ lifecycleDetails: string; /** * The current lifecycle state of the resource. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date on which the Oracle Cloud Infrastructure delivered the resource to the customers. */ timeDelivered: string; } interface GetOccmDemandSignalItemsFilter { name: string; regex?: boolean; values: string[]; } interface GetOccmDemandSignalItemsOccmDemandSignalItemCollection { items: outputs.CapacityManagement.GetOccmDemandSignalItemsOccmDemandSignalItemCollectionItem[]; } interface GetOccmDemandSignalItemsOccmDemandSignalItemCollectionItem { /** * The name of the availability domain for which you want to request the Oracle Cloud Infrastructure resource. */ availabilityDomain: string; /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The quantity of the resource that you want to demand from OCI. */ demandQuantity: string; /** * The OCID of the corresponding demand signal catalog resource. */ demandSignalCatalogResourceId: string; /** * The OCID of the demand signal under which this item will be grouped. */ demandSignalId: string; /** * A query parameter to filter the list of demand signal details based on the namespace. */ demandSignalNamespace: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the demand signal item. */ id: string; /** * 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. */ notes: string; /** * The name of region for which you want to request the Oracle Cloud Infrastructure resource. */ region: string; /** * The type of request (DEMAND or RETURN) made against a particular demand signal item. */ requestType: string; /** * A query parameter to filter the list of demand signal details based on the resource name. */ resourceName: string; /** * A map of various properties associated with the Oracle Cloud Infrastructure resource. */ resourceProperties: { [key: string]: string; }; /** * The current lifecycle state of the resource. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of the tenancy for which you want to request the Oracle Cloud Infrastructure resource for. This is an optional parameter. */ targetCompartmentId: string; /** * the date before which you would ideally like the Oracle Cloud Infrastructure resource to be delivered to you. */ timeNeededBefore: string; } interface GetOccmDemandSignalsFilter { name: string; regex?: boolean; values: string[]; } interface GetOccmDemandSignalsOccmDemandSignalCollection { items: outputs.CapacityManagement.GetOccmDemandSignalsOccmDemandSignalCollectionItem[]; } interface GetOccmDemandSignalsOccmDemandSignalCollectionItem { /** * The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Meaningful text about the demand signal. */ description: string; /** * A filter to return only the resources that match the entire display name. The match is not case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A query parameter to filter the list of demand signals based on it's OCID. */ id: string; /** * A query parameter to filter the list of demand signals based on its state. */ lifecycleDetails: string; /** * The current lifecycle state of the resource. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the demand signal was created. */ timeCreated: string; /** * The time when the demand signal was last updated. */ timeUpdated: string; } interface OccAvailabilityCatalogDetail { /** * The quantity of resource currently available that the customer can request. */ availableQuantity: string; /** * The OCID of the availability catalog. */ catalogId: string; /** * The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled. */ dateExpectedCapacityHandover: string; /** * The date by which the customer must place the order to have their capacity requirements met by the customer handover date. */ dateFinalCustomerOrder: string; /** * The quantity of resource currently demanded by the customer. */ demandedQuantity: string; /** * The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on. */ namespace: string; /** * The name of the resource that the customer can request. */ resourceName: string; /** * The different types of resources against which customers can place capacity requests. */ resourceType: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The total quantity of resource that the customer can request. */ totalAvailableQuantity: string; /** * The unit in which the resource available is measured. */ unit: string; /** * The type of workload (Generic/ROW). */ workloadType: string; } interface OccAvailabilityCatalogMetadataDetails { /** * The version for the format of the catalog file being uploaded. */ formatVersion: string; } interface OccCapacityRequestDetail { /** * The actual handed over quantity of resources at the time of request resolution. */ actualHandoverQuantity: string; /** * A list containing details about occHandoverResourceBlocks which were handed over for the corresponding resource name. */ associatedOccHandoverResourceBlockLists: outputs.CapacityManagement.OccCapacityRequestDetailAssociatedOccHandoverResourceBlockList[]; /** * The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests. */ availabilityDomain: string; /** * The date on which the actual handover quantity of resources is delivered. */ dateActualHandover: string; /** * The date on which the latest increment to supplied quantity of resources was delivered. */ dateExpectedHandover: string; /** * The number of compute server's with name required by the user. */ demandQuantity: string; /** * The incremental quantity of resources supplied as the provisioning is underway. */ expectedHandoverQuantity: string; /** * The name of the COMPUTE server shape for which the request is made. Do not use CAPACITY_CONSTRAINT as the resource name. */ resourceName: string; /** * The type of the resource against which the user wants to place a capacity request. */ resourceType: string; /** * The WorkloadType from where capacity request are to be transferred. */ sourceWorkloadType: string; /** * The type of the workload (Generic/ROW). */ workloadType: string; } interface OccCapacityRequestDetailAssociatedOccHandoverResourceBlockList { /** * The total quantity of the resource that was made available to the customer as part of this resource block */ handoverQuantity: string; /** * The OCID of the handed over resource block. */ occHandoverResourceBlockId: string; } interface OccCapacityRequestPatchOperation { /** * (Updatable) */ from: string; /** * (Updatable) The operation can be one of these values: `INSERT`, `INSERT_MULTIPLE`, `MERGE`, `MOVE`, `PROHIBIT`, `REMOVE`, `REPLACE`, `REQUIRE` */ operation: string; /** * (Updatable) */ position?: string; /** * (Updatable) */ selectedItem?: string; /** * (Updatable) */ selection: string; /** * (Updatable) */ value: { [key: string]: string; }; } interface OccCustomerGroupCustomersList { /** * The description about the customer group. */ description: string; /** * The display name for the customer. */ displayName: string; /** * The OCID of the customer group. */ occCustomerGroupId: string; /** * To determine whether the customer is enabled/disabled. */ status: string; /** * The OCID of the tenancy belonging to the customer. */ tenancyId: string; } } export declare namespace CertificatesManagement { interface CertificateAuthorityCertificateAuthorityConfig { actionDetails?: outputs.CertificatesManagement.CertificateAuthorityCertificateAuthorityConfigActionDetails; /** * (Updatable) The externally signed certificate (in PEM format) for the imported root CA. */ certificatePem: string; /** * (Updatable) The origin of the CA. */ configType: string; /** * The OCID of the private, external issuer CA. */ issuerCertificateAuthorityId?: string; /** * The algorithm used to sign public key certificates that the CA issues. */ signingAlgorithm: string; /** * The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate. */ subject: outputs.CertificatesManagement.CertificateAuthorityCertificateAuthorityConfigSubject; /** * (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. */ validity?: outputs.CertificatesManagement.CertificateAuthorityCertificateAuthorityConfigValidity; /** * (Updatable) The name of the CA version. When the value is not null, a name is unique across versions of a given CA. */ versionName?: string; } interface CertificateAuthorityCertificateAuthorityConfigActionDetails { actionType?: string; /** * (Updatable) The externally signed certificate (in PEM format) for the imported root CA. */ certificatePem?: string; } interface CertificateAuthorityCertificateAuthorityConfigSubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country?: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier?: string; /** * Domain component (RDN DC). */ domainComponent?: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier?: string; /** * Personal given name (RDN G or GN). */ givenName?: string; /** * Personal initials. */ initials?: string; /** * Locality (RDN L). */ localityName?: string; /** * Organization (RDN O). */ organization?: string; /** * Organizational unit (RDN OU). */ organizationalUnit?: string; /** * Subject pseudonym. */ pseudonym?: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber?: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName?: string; /** * Street address (RDN STREET). */ street?: string; /** * Personal surname (RDN SN). */ surname?: string; /** * Title (RDN T or TITLE). */ title?: string; /** * User ID (RDN UID). */ userId?: string; } interface CertificateAuthorityCertificateAuthorityConfigValidity { /** * (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` */ timeOfValidityNotAfter: string; /** * (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` */ timeOfValidityNotBefore?: string; } interface CertificateAuthorityCertificateAuthorityRule { /** * (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. */ certificateAuthorityMaxValidityDuration?: string; /** * (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. */ leafCertificateMaxValidityDuration?: string; /** * 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. */ nameConstraint: outputs.CertificatesManagement.CertificateAuthorityCertificateAuthorityRuleNameConstraint; /** * 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. */ pathLengthConstraint: number; /** * (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. */ ruleType: string; } interface CertificateAuthorityCertificateAuthorityRuleNameConstraint { /** * 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. */ excludedSubtrees: outputs.CertificatesManagement.CertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree[]; /** * A list that contains permitted namespaces. If you have a name constraint with no excluded namespaces, you must specify at least one permitted namespace. */ permittedSubtrees: outputs.CertificatesManagement.CertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree[]; } interface CertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree { /** * The type of name constraint. */ type: string; /** * Name restrictions for the corresponding type of name constraint. */ value: string; } interface CertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree { /** * The type of name constraint. */ type: string; /** * Name restrictions for the corresponding type of name constraint. */ value: string; } interface CertificateAuthorityCertificateRevocationListDetails { /** * (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. */ customFormattedUrls: string[]; /** * (Updatable) The details of the Object Storage bucket configured to store the certificate revocation list (CRL). */ objectStorageConfig: outputs.CertificatesManagement.CertificateAuthorityCertificateRevocationListDetailsObjectStorageConfig; } interface CertificateAuthorityCertificateRevocationListDetailsObjectStorageConfig { /** * (Updatable) The name of the bucket where the CRL is stored. */ objectStorageBucketName: string; /** * (Updatable) The tenancy of the bucket where the CRL is stored. */ objectStorageNamespace: string; /** * (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. */ objectStorageObjectNameFormat: string; } interface CertificateAuthorityCurrentVersion { /** * The OCID of the CA. */ certificateAuthorityId: string; /** * The version number of the issuing CA. */ issuerCaVersionNumber: string; /** * The current revocation status of the entity. */ revocationStatuses: outputs.CertificatesManagement.CertificateAuthorityCurrentVersionRevocationStatus[]; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * A list of rotation states for this CA version. */ stages: string[]; /** * 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` */ timeCreated: string; /** * 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` */ timeOfDeletion: string; /** * 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. */ validities: outputs.CertificatesManagement.CertificateAuthorityCurrentVersionValidity[]; /** * The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA. */ versionName: string; /** * The version number of the CA. */ versionNumber: string; } interface CertificateAuthorityCurrentVersionRevocationStatus { /** * The reason the certificate or certificate authority (CA) was revoked. */ revocationReason: string; /** * 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` */ timeOfRevocation: string; } interface CertificateAuthorityCurrentVersionValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface CertificateAuthoritySubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier: string; /** * Domain component (RDN DC). */ domainComponent: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier: string; /** * Personal given name (RDN G or GN). */ givenName: string; /** * Personal initials. */ initials: string; /** * Locality (RDN L). */ localityName: string; /** * Organization (RDN O). */ organization: string; /** * Organizational unit (RDN OU). */ organizationalUnit: string; /** * Subject pseudonym. */ pseudonym: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName: string; /** * Street address (RDN STREET). */ street: string; /** * Personal surname (RDN SN). */ surname: string; /** * Title (RDN T or TITLE). */ title: string; /** * User ID (RDN UID). */ userId: string; } interface CertificateCertificateConfig { /** * , `certificatePem`, `privateKeyPem`, `privateKeyPemPassphrase`, and `stage` can only be used when `config_type=IMPORTED`. */ certChainPem?: string; /** * (Updatable) The leaf certificate (in PEM format). */ certificatePem?: string; /** * The name of the profile used to create the certificate, which depends on the type of certificate you need. */ certificateProfileType?: string; /** * (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. */ configType: string; /** * (Updatable) The certificate signing request (in PEM format). */ csrPem?: string; /** * The OCID of the private CA. */ issuerCertificateAuthorityId?: string; /** * The algorithm to use to create key pairs. */ keyAlgorithm: string; /** * (Updatable) The private key (in PEM format). This value is sensitive. */ privateKeyPem?: string; /** * (Updatable) The passphrase for the encrypted private key in PEM format. This value is sensitive. */ privateKeyPemPassphrase?: string; /** * The algorithm to use to sign the public key certificate. */ signatureAlgorithm: string; /** * (Updatable) The rotation stage used for imported certificate version updates. Supported values are `CURRENT` and `PENDING`. Defaults to `CURRENT` when omitted. */ stage: string; /** * The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate. */ subject?: outputs.CertificatesManagement.CertificateCertificateConfigSubject; /** * A list of subject alternative names. */ subjectAlternativeNames?: outputs.CertificatesManagement.CertificateCertificateConfigSubjectAlternativeName[]; /** * (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. */ validity?: outputs.CertificatesManagement.CertificateCertificateConfigValidity; /** * (Updatable) A name for the certificate. When the value is not null, a name is unique across versions of a given certificate. */ versionName?: string; } interface CertificateCertificateConfigSubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country?: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier?: string; /** * Domain component (RDN DC). */ domainComponent?: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier?: string; /** * Personal given name (RDN G or GN). */ givenName?: string; /** * Personal initials. */ initials?: string; /** * Locality (RDN L). */ localityName?: string; /** * Organization (RDN O). */ organization?: string; /** * Organizational unit (RDN OU). */ organizationalUnit?: string; /** * Subject pseudonym. */ pseudonym?: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber?: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName?: string; /** * Street address (RDN STREET). */ street?: string; /** * Personal surname (RDN SN). */ surname?: string; /** * Title (RDN T or TITLE). */ title?: string; /** * User ID (RDN UID). */ userId?: string; } interface CertificateCertificateConfigSubjectAlternativeName { /** * The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported. */ type: string; /** * The subject alternative name. */ value: string; } interface CertificateCertificateConfigValidity { /** * (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` */ timeOfValidityNotAfter: string; /** * (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` */ timeOfValidityNotBefore?: string; } interface CertificateCertificateRevocationListDetail { /** * 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. */ customFormattedUrls: string[]; /** * The details of the Object Storage bucket configured to store the certificate revocation list (CRL). */ objectStorageConfigs: outputs.CertificatesManagement.CertificateCertificateRevocationListDetailObjectStorageConfig[]; } interface CertificateCertificateRevocationListDetailObjectStorageConfig { /** * The name of the bucket where the CRL is stored. */ objectStorageBucketName: string; /** * The tenancy of the bucket where the CRL is stored. */ objectStorageNamespace: string; /** * 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. */ objectStorageObjectNameFormat: string; } interface CertificateCertificateRule { /** * (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. */ advanceRenewalPeriod: string; /** * (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. */ renewalInterval: string; /** * (Updatable) The type of rule. */ ruleType: string; } interface CertificateCurrentVersion { /** * The OCID of the certificate. */ certificateId: string; /** * The version number of the issuing certificate authority (CA). */ issuerCaVersionNumber: string; /** * The current revocation status of the entity. */ revocationStatuses: outputs.CertificatesManagement.CertificateCurrentVersionRevocationStatus[]; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * A list of rotation states for this certificate version. */ stages: string[]; /** * A list of subject alternative names. */ subjectAlternativeNames: outputs.CertificatesManagement.CertificateCurrentVersionSubjectAlternativeName[]; /** * 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` */ timeCreated: string; /** * 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` */ timeOfDeletion: string; /** * 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. */ validities: outputs.CertificatesManagement.CertificateCurrentVersionValidity[]; /** * The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate. */ versionName: string; /** * The version number of the certificate. */ versionNumber: string; } interface CertificateCurrentVersionRevocationStatus { /** * The reason the certificate or certificate authority (CA) was revoked. */ revocationReason: string; /** * 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` */ timeOfRevocation: string; } interface CertificateCurrentVersionSubjectAlternativeName { /** * The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported. */ type: string; /** * The subject alternative name. */ value: string; } interface CertificateCurrentVersionValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface CertificateSubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier: string; /** * Domain component (RDN DC). */ domainComponent: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier: string; /** * Personal given name (RDN G or GN). */ givenName: string; /** * Personal initials. */ initials: string; /** * Locality (RDN L). */ localityName: string; /** * Organization (RDN O). */ organization: string; /** * Organizational unit (RDN OU). */ organizationalUnit: string; /** * Subject pseudonym. */ pseudonym: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName: string; /** * Street address (RDN STREET). */ street: string; /** * Personal surname (RDN SN). */ surname: string; /** * Title (RDN T or TITLE). */ title: string; /** * User ID (RDN UID). */ userId: string; } interface GetAssociationsAssociationCollection { items: outputs.CertificatesManagement.GetAssociationsAssociationCollectionItem[]; } interface GetAssociationsAssociationCollectionItem { /** * A filter that returns only resources that match the given OCID of an associated Oracle Cloud Infrastructure resource. */ associatedResourceId: string; /** * Type of associations to list. If the parameter is set to null, the service lists all types of associations. */ associationType: string; /** * A filter that returns only resources that match the given OCID of a certificate-related resource. */ certificatesResourceId: string; /** * A filter that returns only resources that match the given compartment OCID. */ compartmentId: string; /** * The OCID of the association. */ id: string; /** * A filter that returns only resources that match the specified name. */ name: string; /** * The current lifecycle state of the association. */ state: string; /** * 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` */ timeCreated: string; } interface GetAssociationsFilter { /** * A filter that returns only resources that match the specified name. */ name: string; regex?: boolean; values: string[]; } interface GetCaBundlesCaBundleCollection { items: outputs.CertificatesManagement.GetCaBundlesCaBundleCollectionItem[]; } interface GetCaBundlesCaBundleCollectionItem { caBundlePem: string; /** * A filter that returns only resources that match the given compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A brief description of the CA bundle. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the CA bundle. */ id: string; /** * Additional information about the current lifecycle state of the CA bundle. */ lifecycleDetails: string; /** * A filter that returns only resources that match the specified name. */ name: string; /** * A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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` */ timeCreated: string; } interface GetCaBundlesFilter { /** * A filter that returns only resources that match the specified name. */ name: string; regex?: boolean; values: string[]; } interface GetCertificateAuthoritiesCertificateAuthorityCollection { items: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItem[]; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItem { certificateAuthorityConfigs: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfig[]; /** * An optional list of rules that control how the CA is used and managed. */ certificateAuthorityRules: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRule[]; /** * The details of the certificate revocation list (CRL). */ certificateRevocationListDetails: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetail[]; /** * A filter that returns only resources that match the given compartment OCID. */ compartmentId: string; /** * The origin of the CA. */ configType: string; /** * The metadata details of the certificate authority (CA) version. This summary object does not contain the CA contents. */ currentVersions: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersion[]; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A brief description of the CA. */ description: string; /** * For externally managed CAs, a description of the externally managed key. Avoid entering confidential information. */ externalKeyDescription: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the CA. */ id: string; /** * The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. */ issuerCertificateAuthorityId: string; /** * The OCID of the Oracle Cloud Infrastructure Vault key used to encrypt the CA. */ kmsKeyId: string; /** * Additional information about the current CA lifecycle state. */ lifecycleDetails: string; /** * A filter that returns only resources that match the specified name. */ name: string; /** * The algorithm used to sign public key certificates that the CA issues. */ signingAlgorithm: string; /** * A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate. */ subjects: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemSubject[]; /** * 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` */ timeCreated: string; /** * 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` */ timeOfDeletion: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfig { actionDetails: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigActionDetail[]; certificatePem: string; /** * The origin of the CA. */ configType: string; /** * The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. */ issuerCertificateAuthorityId: string; /** * The algorithm used to sign public key certificates that the CA issues. */ signingAlgorithm: string; /** * The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate. */ subjects: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigSubject[]; /** * 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. */ validities: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigValidity[]; /** * The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA. */ versionName: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigActionDetail { actionType: string; certificatePem: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigSubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier: string; /** * Domain component (RDN DC). */ domainComponent: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier: string; /** * Personal given name (RDN G or GN). */ givenName: string; /** * Personal initials. */ initials: string; /** * Locality (RDN L). */ localityName: string; /** * Organization (RDN O). */ organization: string; /** * Organizational unit (RDN OU). */ organizationalUnit: string; /** * Subject pseudonym. */ pseudonym: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName: string; /** * Street address (RDN STREET). */ street: string; /** * Personal surname (RDN SN). */ surname: string; /** * Title (RDN T or TITLE). */ title: string; /** * User ID (RDN UID). */ userId: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRule { /** * 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. */ certificateAuthorityMaxValidityDuration: string; /** * 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. */ leafCertificateMaxValidityDuration: string; /** * 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. */ nameConstraints: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraint[]; /** * 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. */ pathLengthConstraint: number; /** * 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. */ ruleType: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraint { /** * 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. */ excludedSubtrees: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintExcludedSubtree[]; /** * A list that contains permitted namespaces. If you have a name constraint with no excluded namespaces, you must specify at least one permitted namespace. */ permittedSubtrees: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintPermittedSubtree[]; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintExcludedSubtree { /** * The type of name constraint. */ type: string; /** * Name restrictions for the corresponding type of name constraint. */ value: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintPermittedSubtree { /** * The type of name constraint. */ type: string; /** * Name restrictions for the corresponding type of name constraint. */ value: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetail { /** * 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. */ customFormattedUrls: string[]; /** * The details of the Object Storage bucket configured to store the certificate revocation list (CRL). */ objectStorageConfigs: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetailObjectStorageConfig[]; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetailObjectStorageConfig { /** * The name of the bucket where the CRL is stored. */ objectStorageBucketName: string; /** * The tenancy of the bucket where the CRL is stored. */ objectStorageNamespace: string; /** * 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. */ objectStorageObjectNameFormat: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersion { /** * The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. */ certificateAuthorityId: string; /** * The version number of the issuing CA. */ issuerCaVersionNumber: string; /** * The current revocation status of the entity. */ revocationStatuses: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionRevocationStatus[]; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * A list of rotation states for this CA version. */ stages: string[]; /** * 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` */ timeCreated: string; /** * 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` */ timeOfDeletion: string; /** * 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. */ validities: outputs.CertificatesManagement.GetCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionValidity[]; /** * The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA. */ versionName: string; /** * The version number of the CA. */ versionNumber: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionRevocationStatus { /** * The reason the certificate or certificate authority (CA) was revoked. */ revocationReason: string; /** * 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` */ timeOfRevocation: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificateAuthoritiesCertificateAuthorityCollectionItemSubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier: string; /** * Domain component (RDN DC). */ domainComponent: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier: string; /** * Personal given name (RDN G or GN). */ givenName: string; /** * Personal initials. */ initials: string; /** * Locality (RDN L). */ localityName: string; /** * Organization (RDN O). */ organization: string; /** * Organizational unit (RDN OU). */ organizationalUnit: string; /** * Subject pseudonym. */ pseudonym: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName: string; /** * Street address (RDN STREET). */ street: string; /** * Personal surname (RDN SN). */ surname: string; /** * Title (RDN T or TITLE). */ title: string; /** * User ID (RDN UID). */ userId: string; } interface GetCertificateAuthoritiesFilter { /** * A filter that returns only resources that match the specified name. */ name: string; regex?: boolean; values: string[]; } interface GetCertificateAuthorityCertificateAuthorityConfig { actionDetails: outputs.CertificatesManagement.GetCertificateAuthorityCertificateAuthorityConfigActionDetail[]; certificatePem: string; /** * The origin of the CA. */ configType: string; /** * The OCID of the parent CA that issued this CA. If this is the root CA, then this value is null. */ issuerCertificateAuthorityId: string; /** * The algorithm used to sign public key certificates that the CA issues. */ signingAlgorithm: string; /** * The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate. */ subjects: outputs.CertificatesManagement.GetCertificateAuthorityCertificateAuthorityConfigSubject[]; /** * 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. */ validities: outputs.CertificatesManagement.GetCertificateAuthorityCertificateAuthorityConfigValidity[]; /** * The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA. */ versionName: string; } interface GetCertificateAuthorityCertificateAuthorityConfigActionDetail { actionType: string; certificatePem: string; } interface GetCertificateAuthorityCertificateAuthorityConfigSubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier: string; /** * Domain component (RDN DC). */ domainComponent: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier: string; /** * Personal given name (RDN G or GN). */ givenName: string; /** * Personal initials. */ initials: string; /** * Locality (RDN L). */ localityName: string; /** * Organization (RDN O). */ organization: string; /** * Organizational unit (RDN OU). */ organizationalUnit: string; /** * Subject pseudonym. */ pseudonym: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName: string; /** * Street address (RDN STREET). */ street: string; /** * Personal surname (RDN SN). */ surname: string; /** * Title (RDN T or TITLE). */ title: string; /** * User ID (RDN UID). */ userId: string; } interface GetCertificateAuthorityCertificateAuthorityConfigValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificateAuthorityCertificateAuthorityRule { /** * 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. */ certificateAuthorityMaxValidityDuration: string; /** * 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. */ leafCertificateMaxValidityDuration: string; /** * 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. */ nameConstraints: outputs.CertificatesManagement.GetCertificateAuthorityCertificateAuthorityRuleNameConstraint[]; /** * 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. */ pathLengthConstraint: number; /** * 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. */ ruleType: string; } interface GetCertificateAuthorityCertificateAuthorityRuleNameConstraint { /** * 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. */ excludedSubtrees: outputs.CertificatesManagement.GetCertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree[]; /** * A list that contains permitted namespaces. If you have a name constraint with no excluded namespaces, you must specify at least one permitted namespace. */ permittedSubtrees: outputs.CertificatesManagement.GetCertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree[]; } interface GetCertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree { /** * The type of name constraint. */ type: string; /** * Name restrictions for the corresponding type of name constraint. */ value: string; } interface GetCertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree { /** * The type of name constraint. */ type: string; /** * Name restrictions for the corresponding type of name constraint. */ value: string; } interface GetCertificateAuthorityCertificateRevocationListDetail { /** * 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. */ customFormattedUrls: string[]; /** * The details of the Object Storage bucket configured to store the certificate revocation list (CRL). */ objectStorageConfigs: outputs.CertificatesManagement.GetCertificateAuthorityCertificateRevocationListDetailObjectStorageConfig[]; } interface GetCertificateAuthorityCertificateRevocationListDetailObjectStorageConfig { /** * The name of the bucket where the CRL is stored. */ objectStorageBucketName: string; /** * The tenancy of the bucket where the CRL is stored. */ objectStorageNamespace: string; /** * 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. */ objectStorageObjectNameFormat: string; } interface GetCertificateAuthorityCurrentVersion { /** * The OCID of the certificate authority (CA). */ certificateAuthorityId: string; /** * The version number of the issuing CA. */ issuerCaVersionNumber: string; /** * The current revocation status of the entity. */ revocationStatuses: outputs.CertificatesManagement.GetCertificateAuthorityCurrentVersionRevocationStatus[]; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * A list of rotation states for this CA version. */ stages: string[]; /** * 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` */ timeCreated: string; /** * 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` */ timeOfDeletion: string; /** * 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. */ validities: outputs.CertificatesManagement.GetCertificateAuthorityCurrentVersionValidity[]; /** * The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA. */ versionName: string; /** * The version number of the CA. */ versionNumber: string; } interface GetCertificateAuthorityCurrentVersionRevocationStatus { /** * The reason the certificate or certificate authority (CA) was revoked. */ revocationReason: string; /** * 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` */ timeOfRevocation: string; } interface GetCertificateAuthorityCurrentVersionValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificateAuthoritySubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier: string; /** * Domain component (RDN DC). */ domainComponent: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier: string; /** * Personal given name (RDN G or GN). */ givenName: string; /** * Personal initials. */ initials: string; /** * Locality (RDN L). */ localityName: string; /** * Organization (RDN O). */ organization: string; /** * Organizational unit (RDN OU). */ organizationalUnit: string; /** * Subject pseudonym. */ pseudonym: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName: string; /** * Street address (RDN STREET). */ street: string; /** * Personal surname (RDN SN). */ surname: string; /** * Title (RDN T or TITLE). */ title: string; /** * User ID (RDN UID). */ userId: string; } interface GetCertificateAuthorityVersionRevocationStatus { /** * The reason the certificate or certificate authority (CA) was revoked. */ revocationReason: string; /** * 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` */ timeOfRevocation: string; } interface GetCertificateAuthorityVersionSubjectAlternativeName { type: string; value: string; } interface GetCertificateAuthorityVersionValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificateAuthorityVersionsCertificateAuthorityVersionCollection { /** * A list of certificate authority version summary objects. */ items: outputs.CertificatesManagement.GetCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItem[]; } interface GetCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItem { /** * The OCID of the certificate authority (CA). */ certificateAuthorityId: string; /** * The version number of the issuing CA. */ issuerCaVersionNumber: string; /** * The current revocation status of the entity. */ revocationStatuses: outputs.CertificatesManagement.GetCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemRevocationStatus[]; /** * 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` */ serialNumber: string; /** * A list of rotation states for this CA version. */ stages: string[]; /** * 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` */ timeCreated: string; /** * 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` */ timeOfDeletion: string; /** * 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. */ validities: outputs.CertificatesManagement.GetCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemValidity[]; /** * The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA. */ versionName: string; /** * 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. */ versionNumber: string; } interface GetCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemRevocationStatus { /** * The reason the certificate or certificate authority (CA) was revoked. */ revocationReason: string; /** * 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` */ timeOfRevocation: string; } interface GetCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificateAuthorityVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetCertificateCertificateConfig { certChainPem: string; certificatePem: string; /** * The name of the profile used to create the certificate, which depends on the type of certificate you need. */ certificateProfileType: string; /** * 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. */ configType: string; csrPem: string; /** * The OCID of the certificate authority (CA) that issued the certificate. */ issuerCertificateAuthorityId: string; /** * The algorithm used to create key pairs. */ keyAlgorithm: string; privateKeyPem: string; privateKeyPemPassphrase: string; /** * The algorithm used to sign the public key certificate. */ signatureAlgorithm: string; stage: string; /** * A list of subject alternative names. */ subjectAlternativeNames: outputs.CertificatesManagement.GetCertificateCertificateConfigSubjectAlternativeName[]; /** * The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate. */ subjects: outputs.CertificatesManagement.GetCertificateCertificateConfigSubject[]; /** * 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. */ validities: outputs.CertificatesManagement.GetCertificateCertificateConfigValidity[]; /** * The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate. */ versionName: string; } interface GetCertificateCertificateConfigSubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier: string; /** * Domain component (RDN DC). */ domainComponent: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier: string; /** * Personal given name (RDN G or GN). */ givenName: string; /** * Personal initials. */ initials: string; /** * Locality (RDN L). */ localityName: string; /** * Organization (RDN O). */ organization: string; /** * Organizational unit (RDN OU). */ organizationalUnit: string; /** * Subject pseudonym. */ pseudonym: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName: string; /** * Street address (RDN STREET). */ street: string; /** * Personal surname (RDN SN). */ surname: string; /** * Title (RDN T or TITLE). */ title: string; /** * User ID (RDN UID). */ userId: string; } interface GetCertificateCertificateConfigSubjectAlternativeName { /** * The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported. */ type: string; /** * The subject alternative name. */ value: string; } interface GetCertificateCertificateConfigValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificateCertificateRevocationListDetail { /** * 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. */ customFormattedUrls: string[]; /** * The details of the Object Storage bucket configured to store the certificate revocation list (CRL). */ objectStorageConfigs: outputs.CertificatesManagement.GetCertificateCertificateRevocationListDetailObjectStorageConfig[]; } interface GetCertificateCertificateRevocationListDetailObjectStorageConfig { /** * The name of the bucket where the CRL is stored. */ objectStorageBucketName: string; /** * The tenancy of the bucket where the CRL is stored. */ objectStorageNamespace: string; /** * 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. */ objectStorageObjectNameFormat: string; } interface GetCertificateCertificateRule { /** * 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. */ advanceRenewalPeriod: string; /** * 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. */ renewalInterval: string; /** * The type of rule. */ ruleType: string; } interface GetCertificateCurrentVersion { /** * The OCID of the certificate. */ certificateId: string; /** * The version number of the issuing certificate authority (CA). */ issuerCaVersionNumber: string; /** * The current revocation status of the entity. */ revocationStatuses: outputs.CertificatesManagement.GetCertificateCurrentVersionRevocationStatus[]; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * A list of rotation states for this certificate version. */ stages: string[]; /** * A list of subject alternative names. */ subjectAlternativeNames: outputs.CertificatesManagement.GetCertificateCurrentVersionSubjectAlternativeName[]; /** * 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` */ timeCreated: string; /** * 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` */ timeOfDeletion: string; /** * 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. */ validities: outputs.CertificatesManagement.GetCertificateCurrentVersionValidity[]; /** * The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate. */ versionName: string; /** * The version number of the certificate. */ versionNumber: string; } interface GetCertificateCurrentVersionRevocationStatus { /** * The reason the certificate or certificate authority (CA) was revoked. */ revocationReason: string; /** * 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` */ timeOfRevocation: string; } interface GetCertificateCurrentVersionSubjectAlternativeName { /** * The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported. */ type: string; /** * The subject alternative name. */ value: string; } interface GetCertificateCurrentVersionValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificateSubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier: string; /** * Domain component (RDN DC). */ domainComponent: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier: string; /** * Personal given name (RDN G or GN). */ givenName: string; /** * Personal initials. */ initials: string; /** * Locality (RDN L). */ localityName: string; /** * Organization (RDN O). */ organization: string; /** * Organizational unit (RDN OU). */ organizationalUnit: string; /** * Subject pseudonym. */ pseudonym: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName: string; /** * Street address (RDN STREET). */ street: string; /** * Personal surname (RDN SN). */ surname: string; /** * Title (RDN T or TITLE). */ title: string; /** * User ID (RDN UID). */ userId: string; } interface GetCertificateVersionRevocationStatus { /** * The reason the certificate or certificate authority (CA) was revoked. */ revocationReason: string; /** * 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` */ timeOfRevocation: string; } interface GetCertificateVersionSubjectAlternativeName { /** * The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported. */ type: string; /** * The subject alternative name. */ value: string; } interface GetCertificateVersionValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificateVersionsCertificateVersionCollection { /** * A list of certificate version summary objects. */ items: outputs.CertificatesManagement.GetCertificateVersionsCertificateVersionCollectionItem[]; } interface GetCertificateVersionsCertificateVersionCollectionItem { /** * The OCID of the certificate. */ certificateId: string; /** * The version number of the issuing certificate authority (CA). */ issuerCaVersionNumber: string; /** * The current revocation status of the entity. */ revocationStatuses: outputs.CertificatesManagement.GetCertificateVersionsCertificateVersionCollectionItemRevocationStatus[]; /** * 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` */ serialNumber: string; /** * A list of rotation states for this certificate version. */ stages: string[]; /** * A list of subject alternative names. */ subjectAlternativeNames: outputs.CertificatesManagement.GetCertificateVersionsCertificateVersionCollectionItemSubjectAlternativeName[]; /** * 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` */ timeCreated: string; /** * 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` */ timeOfDeletion: string; /** * 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. */ validities: outputs.CertificatesManagement.GetCertificateVersionsCertificateVersionCollectionItemValidity[]; /** * The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate. */ versionName: string; /** * 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. */ versionNumber: string; } interface GetCertificateVersionsCertificateVersionCollectionItemRevocationStatus { /** * The reason the certificate or certificate authority (CA) was revoked. */ revocationReason: string; /** * 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` */ timeOfRevocation: string; } interface GetCertificateVersionsCertificateVersionCollectionItemSubjectAlternativeName { /** * The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported. */ type: string; /** * The subject alternative name. */ value: string; } interface GetCertificateVersionsCertificateVersionCollectionItemValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificateVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetCertificatesCertificateCollection { items: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItem[]; } interface GetCertificatesCertificateCollectionItem { certificateConfigs: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCertificateConfig[]; /** * The name of the profile used to create the certificate, which depends on the type of certificate you need. */ certificateProfileType: string; /** * The details of the certificate revocation list (CRL). */ certificateRevocationListDetails: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCertificateRevocationListDetail[]; /** * A list of rules that control how the certificate is used and managed. */ certificateRules: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCertificateRule[]; /** * A filter that returns only resources that match the given compartment OCID. */ compartmentId: string; /** * 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. */ configType: string; currentVersionNumber: string; /** * The details of the certificate version. This object does not contain the certificate contents. */ currentVersions: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCurrentVersion[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A brief description of the certificate. Avoid entering confidential information. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the certificate. */ id: string; /** * The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. */ issuerCertificateAuthorityId: string; /** * The algorithm used to create key pairs. */ keyAlgorithm: string; /** * Additional information about the current lifecycle state of the certificate. */ lifecycleDetails: string; /** * A filter that returns only resources that match the specified name. */ name: string; /** * The algorithm used to sign the public key certificate. */ signatureAlgorithm: string; /** * A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate. */ subjects: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemSubject[]; /** * 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` */ timeCreated: string; /** * 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` */ timeOfDeletion: string; } interface GetCertificatesCertificateCollectionItemCertificateConfig { certChainPem: string; certificatePem: string; /** * The name of the profile used to create the certificate, which depends on the type of certificate you need. */ certificateProfileType: string; /** * 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. */ configType: string; csrPem: string; /** * The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs. */ issuerCertificateAuthorityId: string; /** * The algorithm used to create key pairs. */ keyAlgorithm: string; privateKeyPem: string; privateKeyPemPassphrase: string; /** * The algorithm used to sign the public key certificate. */ signatureAlgorithm: string; stage: string; /** * A list of subject alternative names. */ subjectAlternativeNames: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCertificateConfigSubjectAlternativeName[]; /** * The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate. */ subjects: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCertificateConfigSubject[]; /** * 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. */ validities: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCertificateConfigValidity[]; /** * The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate. */ versionName: string; } interface GetCertificatesCertificateCollectionItemCertificateConfigSubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier: string; /** * Domain component (RDN DC). */ domainComponent: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier: string; /** * Personal given name (RDN G or GN). */ givenName: string; /** * Personal initials. */ initials: string; /** * Locality (RDN L). */ localityName: string; /** * Organization (RDN O). */ organization: string; /** * Organizational unit (RDN OU). */ organizationalUnit: string; /** * Subject pseudonym. */ pseudonym: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName: string; /** * Street address (RDN STREET). */ street: string; /** * Personal surname (RDN SN). */ surname: string; /** * Title (RDN T or TITLE). */ title: string; /** * User ID (RDN UID). */ userId: string; } interface GetCertificatesCertificateCollectionItemCertificateConfigSubjectAlternativeName { /** * The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported. */ type: string; /** * The subject alternative name. */ value: string; } interface GetCertificatesCertificateCollectionItemCertificateConfigValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificatesCertificateCollectionItemCertificateRevocationListDetail { /** * 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. */ customFormattedUrls: string[]; /** * The details of the Object Storage bucket configured to store the certificate revocation list (CRL). */ objectStorageConfigs: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCertificateRevocationListDetailObjectStorageConfig[]; } interface GetCertificatesCertificateCollectionItemCertificateRevocationListDetailObjectStorageConfig { /** * The name of the bucket where the CRL is stored. */ objectStorageBucketName: string; /** * The tenancy of the bucket where the CRL is stored. */ objectStorageNamespace: string; /** * 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. */ objectStorageObjectNameFormat: string; } interface GetCertificatesCertificateCollectionItemCertificateRule { /** * 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. */ advanceRenewalPeriod: string; /** * 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. */ renewalInterval: string; /** * The type of rule. */ ruleType: string; } interface GetCertificatesCertificateCollectionItemCurrentVersion { /** * The OCID of the certificate. If the parameter is set to null, the service lists all certificates. */ certificateId: string; /** * The version number of the issuing certificate authority (CA). */ issuerCaVersionNumber: string; /** * The current revocation status of the entity. */ revocationStatuses: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCurrentVersionRevocationStatus[]; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * A list of rotation states for this certificate version. */ stages: string[]; /** * A list of subject alternative names. */ subjectAlternativeNames: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCurrentVersionSubjectAlternativeName[]; /** * 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` */ timeCreated: string; /** * 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` */ timeOfDeletion: string; /** * 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. */ validities: outputs.CertificatesManagement.GetCertificatesCertificateCollectionItemCurrentVersionValidity[]; /** * The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate. */ versionName: string; /** * The version number of the certificate. */ versionNumber: string; } interface GetCertificatesCertificateCollectionItemCurrentVersionRevocationStatus { /** * The reason the certificate or certificate authority (CA) was revoked. */ revocationReason: string; /** * 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` */ timeOfRevocation: string; } interface GetCertificatesCertificateCollectionItemCurrentVersionSubjectAlternativeName { /** * The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported. */ type: string; /** * The subject alternative name. */ value: string; } interface GetCertificatesCertificateCollectionItemCurrentVersionValidity { /** * 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` */ timeOfValidityNotAfter: string; /** * 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` */ timeOfValidityNotBefore: string; } interface GetCertificatesCertificateCollectionItemSubject { /** * Common name or fully-qualified domain name (RDN CN). */ commonName: string; /** * Country name (RDN C). */ country: string; /** * Distinguished name qualifier(RDN DNQ). */ distinguishedNameQualifier: string; /** * Domain component (RDN DC). */ domainComponent: string; /** * Personal generational qualifier (for example, Sr., Jr. 3rd, or IV). */ generationQualifier: string; /** * Personal given name (RDN G or GN). */ givenName: string; /** * Personal initials. */ initials: string; /** * Locality (RDN L). */ localityName: string; /** * Organization (RDN O). */ organization: string; /** * Organizational unit (RDN OU). */ organizationalUnit: string; /** * Subject pseudonym. */ pseudonym: string; /** * Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER). */ serialNumber: string; /** * State or province name (RDN ST or S). */ stateOrProvinceName: string; /** * Street address (RDN STREET). */ street: string; /** * Personal surname (RDN SN). */ surname: string; /** * Title (RDN T or TITLE). */ title: string; /** * User ID (RDN UID). */ userId: string; } interface GetCertificatesFilter { /** * A filter that returns only resources that match the specified name. */ name: string; regex?: boolean; values: string[]; } } export declare namespace CloudBridge { interface AgentPluginList { /** * Agent identifier. */ agentId: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ lifecycleDetails: string; /** * Plugin identifier, which can be renamed. */ name: string; /** * Plugin version. */ pluginVersion: string; /** * The current state of the Agent. */ state: string; /** * The time when the Agent was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the Agent was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface AssetAttachedEbsVolumesCost { /** * (Updatable) Monthly costs for maintenance of this asset. */ amount: number; /** * (Updatable) Currency code */ currencyCode: string; } interface AssetAwsEbs { /** * (Updatable) Information about the volume attachments. */ attachments: outputs.CloudBridge.AssetAwsEbsAttachment[]; /** * (Updatable) The Availability Zone for the volume. */ availabilityZone: string; /** * (Updatable) The number of I/O operations per second. */ iops: number; /** * (Updatable) Indicates whether the volume is encrypted. */ isEncrypted: boolean; /** * (Updatable) Indicates whether Amazon EBS Multi-Attach is enabled. */ isMultiAttachEnabled: boolean; /** * (Updatable) The size of the volume, in GiBs. */ sizeInGiBs: number; /** * (Updatable) The volume state. */ status: string; /** * (Updatable) Any tags assigned to the volume. */ tags: outputs.CloudBridge.AssetAwsEbsTag[]; /** * (Updatable) The throughput that the volume supports, in MiB/s. */ throughput: number; /** * (Updatable) The ID of the volume. */ volumeKey: string; /** * (Updatable) The volume type. */ volumeType: string; } interface AssetAwsEbsAttachment { /** * (Updatable) The device name. */ device: string; /** * (Updatable) The ID of the instance. */ instanceKey: string; /** * (Updatable) Indicates whether the EBS volume is deleted on instance termination. */ isDeleteOnTermination: boolean; /** * (Updatable) The attachment state of the volume. */ status: string; /** * (Updatable) The ID of the volume. */ volumeKey: string; } interface AssetAwsEbsTag { /** * (Updatable) The key of the tag. */ key: string; /** * (Updatable) The value of the tag. */ value: string; } interface AssetAwsEc2 { /** * (Updatable) The architecture of the image. */ architecture: string; /** * (Updatable) Indicates if the elastic inference accelerators attached to an instance */ areElasticInferenceAcceleratorsPresent: boolean; /** * (Updatable) The boot mode of the instance. */ bootMode: string; /** * (Updatable) The ID of the Capacity Reservation. */ capacityReservationKey: string; /** * (Updatable) The ID of the AMI used to launch the instance. */ imageKey: string; /** * (Updatable) The ID of the instance. */ instanceKey: string; /** * (Updatable) Indicates whether this is a Spot Instance or a Scheduled Instance. */ instanceLifecycle: string; /** * (Updatable) The instance type. */ instanceType: string; /** * (Updatable) The public IPv4 address, or the Carrier IP address assigned to the instance. */ ipAddress: string; /** * (Updatable) The IPv6 address assigned to the instance. */ ipv6address: string; /** * (Updatable) Indicates whether the instance is enabled for AWS Nitro Enclaves. */ isEnclaveOptions: boolean; /** * (Updatable) Indicates whether the instance is enabled for hibernation. */ isHibernationOptions: boolean; /** * (Updatable) Indicates whether source/destination checking is enabled. */ isSourceDestCheck: boolean; /** * (Updatable) If the request is a Spot Instance request, this value will be true. */ isSpotInstance: boolean; /** * (Updatable) The kernel associated with this instance, if applicable. */ kernelKey: string; /** * (Updatable) The license configurations for the instance. */ licenses: string[]; /** * (Updatable) Provides information on the recovery and maintenance options of your instance. */ maintenanceOptions: string; /** * (Updatable) The monitoring for the instance. */ monitoring: string; /** * (Updatable) The network interfaces for the instance. */ networkInterfaces: outputs.CloudBridge.AssetAwsEc2NetworkInterface[]; /** * (Updatable) Describes the placement of an instance. */ placement: outputs.CloudBridge.AssetAwsEc2Placement; /** * (Updatable) (IPv4 only) The private DNS hostname name assigned to the instance. */ privateDnsName: string; /** * (Updatable) The private IPv4 address assigned to the instance. */ privateIpAddress: string; /** * (Updatable) The device name of the root device volume. */ rootDeviceName: string; /** * (Updatable) The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume. */ rootDeviceType: string; /** * (Updatable) The security groups for the instance. */ securityGroups: outputs.CloudBridge.AssetAwsEc2SecurityGroup[]; /** * (Updatable) Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. */ sriovNetSupport: string; /** * (Updatable) Describes the current state of an instance. */ state: outputs.CloudBridge.AssetAwsEc2State; /** * (Updatable) EC2-VPC The ID of the subnet in which the instance is running. */ subnetKey: string; /** * (Updatable) Any tags assigned to the instance. */ tags: outputs.CloudBridge.AssetAwsEc2Tag[]; /** * (Updatable) The time the instance was launched. */ timeLaunch: string; /** * (Updatable) If the instance is configured for NitroTPM support, the value is v2.0. */ tpmSupport: string; /** * (Updatable) The virtualization type of the instance. */ virtualizationType: string; /** * (Updatable) EC2-VPC The ID of the VPC in which the instance is running. */ vpcKey: string; } interface AssetAwsEc2NetworkInterface { /** * (Updatable) Describes association information for an Elastic IP address (IPv4). */ association: outputs.CloudBridge.AssetAwsEc2NetworkInterfaceAssociation; /** * (Updatable) Describes a network interface attachment. */ attachment: outputs.CloudBridge.AssetAwsEc2NetworkInterfaceAttachment; /** * (Updatable) The description. */ description: string; /** * (Updatable) The type of network interface. */ interfaceType: string; /** * (Updatable) The IPv4 delegated prefixes that are assigned to the network interface. */ ipv4prefixes: string[]; /** * (Updatable) The IPv6 addresses associated with the network interface. */ ipv6addresses: string[]; /** * (Updatable) The IPv6 delegated prefixes that are assigned to the network interface. */ ipv6prefixes: string[]; /** * (Updatable) Indicates whether source/destination checking is enabled. */ isSourceDestCheck: boolean; /** * (Updatable) The MAC address. */ macAddress: string; /** * (Updatable) The ID of the network interface. */ networkInterfaceKey: string; /** * (Updatable) The ID of the AWS account that created the network interface. */ ownerKey: string; /** * (Updatable) The private IPv4 addresses associated with the network interface. */ privateIpAddresses: outputs.CloudBridge.AssetAwsEc2NetworkInterfacePrivateIpAddress[]; /** * (Updatable) The security groups. */ securityGroups: outputs.CloudBridge.AssetAwsEc2NetworkInterfaceSecurityGroup[]; /** * (Updatable) The status of the network interface. */ status: string; /** * (Updatable) The ID of the subnet. */ subnetKey: string; } interface AssetAwsEc2NetworkInterfaceAssociation { /** * (Updatable) The carrier IP address associated with the network interface. */ carrierIp: string; /** * (Updatable) The customer-owned IP address associated with the network interface. */ customerOwnedIp: string; /** * (Updatable) The ID of the owner of the Elastic IP address. */ ipOwnerKey: string; /** * (Updatable) The public DNS name. */ publicDnsName: string; /** * (Updatable) The public IP address or Elastic IP address bound to the network interface. */ publicIp: string; } interface AssetAwsEc2NetworkInterfaceAttachment { /** * (Updatable) The ID of the network interface attachment. */ attachmentKey: string; /** * (Updatable) The index of the device on the instance for the network interface attachment. */ deviceIndex: number; /** * (Updatable) Indicates whether the network interface is deleted when the instance is terminated. */ isDeleteOnTermination: boolean; /** * (Updatable) The index of the network card. */ networkCardIndex: number; /** * (Updatable) The attachment state. */ status: string; /** * (Updatable) The timestamp when the attachment initiated. */ timeAttach: string; } interface AssetAwsEc2NetworkInterfacePrivateIpAddress { /** * (Updatable) Describes association information for an Elastic IP address (IPv4). */ association: outputs.CloudBridge.AssetAwsEc2NetworkInterfacePrivateIpAddressAssociation; /** * (Updatable) Indicates whether this IPv4 address is the primary private IP address of the network interface. */ isPrimary: boolean; /** * (Updatable) The private IPv4 DNS name. */ privateDnsName: string; /** * (Updatable) The private IPv4 address of the network interface. */ privateIpAddress: string; } interface AssetAwsEc2NetworkInterfacePrivateIpAddressAssociation { /** * (Updatable) The carrier IP address associated with the network interface. */ carrierIp: string; /** * (Updatable) The customer-owned IP address associated with the network interface. */ customerOwnedIp: string; /** * (Updatable) The ID of the owner of the Elastic IP address. */ ipOwnerKey: string; /** * (Updatable) The public DNS name. */ publicDnsName: string; /** * (Updatable) The public IP address or Elastic IP address bound to the network interface. */ publicIp: string; } interface AssetAwsEc2NetworkInterfaceSecurityGroup { /** * (Updatable) The ID of the security group. */ groupKey: string; /** * (Updatable) The name of the security group. */ groupName: string; } interface AssetAwsEc2Placement { /** * (Updatable) The affinity setting for the instance on the Dedicated Host. */ affinity: string; /** * (Updatable) The Availability Zone of the instance. */ availabilityZone: string; /** * (Updatable) The name of the placement group the instance is in. */ groupName: string; /** * (Updatable) The ID of the Dedicated Host on which the instance resides. */ hostKey: string; /** * (Updatable) The ARN of the host resource group in which to launch the instances. */ hostResourceGroupArn: string; /** * (Updatable) The number of the partition that the instance is in. */ partitionNumber: number; /** * (Updatable) Reserved for future use. */ spreadDomain: string; /** * (Updatable) The tenancy of the instance (if the instance is running in a VPC). */ tenancy: string; } interface AssetAwsEc2SecurityGroup { /** * (Updatable) The ID of the security group. */ groupKey: string; /** * (Updatable) The name of the security group. */ groupName: string; } interface AssetAwsEc2State { /** * (Updatable) The state of the instance as a 16-bit unsigned integer. */ code: number; /** * (Updatable) The current state of the instance. */ name: string; } interface AssetAwsEc2Tag { /** * (Updatable) The key of the tag. */ key: string; /** * (Updatable) The value of the tag. */ value: string; } interface AssetAwsEc2cost { /** * (Updatable) Monthly costs for maintenance of this asset. */ amount: number; /** * (Updatable) Currency code */ currencyCode: string; } interface AssetCompute { /** * (Updatable) Number of connected networks. */ connectedNetworks: number; /** * (Updatable) Number of CPUs. */ coresCount: number; /** * (Updatable) CPU model name. */ cpuModel: string; /** * (Updatable) Information about the asset. */ description: string; /** * (Updatable) Lists the set of disks belonging to the virtual machine. This list is unordered. */ disks: outputs.CloudBridge.AssetComputeDisk[]; /** * (Updatable) Number of disks. */ disksCount: number; /** * (Updatable) Fully Qualified DNS Name. */ dnsName: string; /** * (Updatable) Information about firmware type for this virtual machine. */ firmware: string; /** * (Updatable) List of GPU devices attached to a virtual machine. */ gpuDevices: outputs.CloudBridge.AssetComputeGpuDevice[]; /** * (Updatable) Number of GPU devices. */ gpuDevicesCount: number; /** * (Updatable) Guest state. */ guestState: string; /** * (Updatable) Hardware version. */ hardwareVersion: string; /** * (Updatable) Host name of the VM. */ hostName: string; /** * (Updatable) Whether Pmem is enabled. Decides if NVDIMMs are used as a permanent memory. */ isPmemEnabled: boolean; /** * (Updatable) Whether Trusted Platform Module (TPM) is enabled. */ isTpmEnabled: boolean; /** * (Updatable) Latency sensitivity. */ latencySensitivity: string; /** * (Updatable) Memory size in MBs. */ memoryInMbs: string; /** * (Updatable) List of network ethernet cards attached to a virtual machine. */ nics: outputs.CloudBridge.AssetComputeNic[]; /** * (Updatable) Number of network ethernet cards. */ nicsCount: number; /** * (Updatable) The asset's NVDIMM configuration. */ nvdimmController: outputs.CloudBridge.AssetComputeNvdimmController; /** * (Updatable) The properties of the NVDIMMs attached to a virtual machine. */ nvdimms: outputs.CloudBridge.AssetComputeNvdimm[]; /** * (Updatable) Operating system. */ operatingSystem: string; /** * (Updatable) Operating system version. */ operatingSystemVersion: string; /** * (Updatable) Pmem size in MBs. */ pmemInMbs: string; /** * (Updatable) The current power state of the virtual machine. */ powerState: string; /** * (Updatable) Primary IP address of the compute instance. */ primaryIp: string; /** * (Updatable) The assets SCSI controller. */ scsiController: outputs.CloudBridge.AssetComputeScsiController; /** * (Updatable) Provision storage size in MBs. */ storageProvisionedInMbs: string; /** * (Updatable) Number of threads per core. */ threadsPerCoreCount: number; } interface AssetComputeDisk { /** * (Updatable) Order of boot volumes. */ bootOrder: number; /** * (Updatable) Indicates that CBT (change disk tracking) is enabled for this virtual disk. */ isCbtEnabled: boolean; /** * (Updatable) Location of the boot/data volume. */ location: string; /** * (Updatable) Disk name. */ name: string; /** * (Updatable) The disk persistent mode. */ persistentMode: string; /** * (Updatable) The size of the volume in MBs. */ sizeInMbs: string; /** * (Updatable) Disk UUID for the virtual disk, if available. */ uuid: string; /** * (Updatable) Disk UUID LUN for the virtual disk, if available. */ uuidLun: string; } interface AssetComputeGpuDevice { /** * (Updatable) Number of GPU cores. */ coresCount: number; /** * (Updatable) GPU device description. */ description: string; /** * (Updatable) The manufacturer of GPU. */ manufacturer: string; /** * (Updatable) GPU memory size in MBs. */ memoryInMbs: string; /** * (Updatable) GPU device name. */ name: string; } interface AssetComputeNic { /** * (Updatable) List of IP addresses. */ ipAddresses: string[]; /** * (Updatable) Provides a label and summary information for the device. */ label: string; /** * (Updatable) Mac address of the VM. */ macAddress: string; /** * (Updatable) Mac address type. */ macAddressType: string; /** * (Updatable) Network name. */ networkName: string; /** * (Updatable) Switch name. */ switchName: string; } interface AssetComputeNvdimm { /** * (Updatable) Controller key. */ controllerKey: number; /** * (Updatable) Provides a label and summary information for the device. */ label: string; /** * (Updatable) The unit number of NVDIMM. */ unitNumber: number; } interface AssetComputeNvdimmController { /** * (Updatable) Bus number. */ busNumber: number; /** * (Updatable) Provides a label and summary information for the device. */ label: string; } interface AssetComputeScsiController { /** * (Updatable) Provides a label and summary information for the device. */ label: string; /** * (Updatable) Shared bus. */ sharedBus: string; /** * (Updatable) The unit number of the SCSI controller. */ unitNumber: number; } interface AssetSourceDiscoveryCredentials { /** * (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": "", "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": "", "secretAccessKey": "" }`. */ secretId: string; /** * (Updatable) Authentication type */ type: string; } interface AssetSourceReplicationCredentials { /** * (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": "", "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": "", "secretAccessKey": "" }`. */ secretId: string; /** * (Updatable) Authentication type */ type: string; } interface AssetVm { /** * (Updatable) Host name/IP address of VM on which the host is running. */ hypervisorHost: string; /** * (Updatable) Hypervisor vendor. */ hypervisorVendor: string; /** * (Updatable) Hypervisor version. */ hypervisorVersion: string; } interface AssetVmwareVcenter { /** * (Updatable) Data center name. */ dataCenter: string; /** * (Updatable) vCenter unique key. */ vcenterKey: string; /** * (Updatable) Dot-separated version string. */ vcenterVersion: string; } interface AssetVmwareVm { /** * (Updatable) Cluster name. */ cluster: string; /** * (Updatable) Customer fields. */ customerFields: string[]; /** * (Updatable) Customer defined tags. */ customerTags: outputs.CloudBridge.AssetVmwareVmCustomerTag[]; /** * (Updatable) Fault tolerance bandwidth. */ faultToleranceBandwidth: number; /** * (Updatable) Fault tolerance to secondary latency. */ faultToleranceSecondaryLatency: number; /** * (Updatable) Fault tolerance state. */ faultToleranceState: string; /** * (Updatable) vCenter-specific identifier of the virtual machine. */ instanceUuid: string; /** * (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. */ isDisksCbtEnabled: boolean; /** * (Updatable) Whether changed block tracking for this VM's disk is active. */ isDisksUuidEnabled: boolean; /** * (Updatable) Path directory of the asset. */ path: string; /** * (Updatable) VMware tools status. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vmwareToolsStatus: string; } interface AssetVmwareVmCustomerTag { /** * (Updatable) The tag description. */ description: string; /** * (Updatable) The tag name. */ name: string; } interface GetAgentDependenciesAgentDependencyCollection { items: outputs.CloudBridge.GetAgentDependenciesAgentDependencyCollectionItem[]; } interface GetAgentDependenciesAgentDependencyCollectionItem { /** * Object storage bucket where the Agent dependency is uploaded. */ bucket: string; /** * The checksum associated with the dependency object returned by Object Storage. */ checksum: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Name of the dependency type. This should match the whitelisted enum of dependency names. */ dependencyName: string; /** * Version of the Agent dependency. */ dependencyVersion: string; /** * Description about the Agent dependency. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The eTag associated with the dependency object returned by Object Storage. */ eTag: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation. */ id: string; /** * 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. */ lifecycleDetails: string; /** * Object storage namespace associated with the customer's tenancy. */ namespace: string; /** * Name of the dependency object uploaded by the customer. */ object: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time when the AgentDependency was created. An RFC3339 formatted datetime string. */ timeCreated: string; } interface GetAgentDependenciesFilter { name: string; regex?: boolean; values: string[]; } interface GetAgentPluginList { /** * Unique Agent identifier path parameter. */ agentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ lifecycleDetails: string; /** * Plugin identifier, which can be renamed. */ name: string; /** * Plugin version. */ pluginVersion: string; /** * The current state of the Agent. */ state: string; /** * The time when the Agent was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the Agent was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetAgentsAgentCollection { items: outputs.CloudBridge.GetAgentsAgentCollectionItem[]; } interface GetAgentsAgentCollectionItem { /** * Resource principal public key. */ agentPubKey: string; /** * Type of the Agent. */ agentType: string; /** * Agent identifier. */ agentVersion: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * A filter to return only resources that match the given environment ID. */ environmentId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The current heartbeat status of the Agent based on its timeLastSyncReceived value. */ heartBeatStatus: string; /** * Unique identifier that is immutable on creation. */ id: string; /** * 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. */ lifecycleDetails: string; /** * OS version. */ osVersion: string; /** * List of plugins associated with the agent. */ pluginLists: outputs.CloudBridge.GetAgentsAgentCollectionItemPluginList[]; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time when the Agent was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time since epoch for when the public key will expire. An RFC3339 formatted datetime string. */ timeExpireAgentKeyInMs: string; /** * The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string. */ timeLastSyncReceived: string; /** * The time when the Agent was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetAgentsAgentCollectionItemPluginList { /** * A filter to return only resources that match the given Agent ID. */ agentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ lifecycleDetails: string; /** * Plugin identifier, which can be renamed. */ name: string; /** * Plugin version. */ pluginVersion: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * The time when the Agent was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the Agent was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetAgentsFilter { /** * Plugin identifier, which can be renamed. */ name: string; regex?: boolean; values: string[]; } interface GetApplianceImageItem { /** * The checksum of the image file. */ checksum: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The URL from which the appliance image can be downloaded. */ downloadUrl: string; /** * The name of the appliance Image file. */ fileName: string; /** * The file format of the image file. */ format: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation. */ id: string; /** * The virtualization platform that the image file supports. */ platform: string; /** * The size of the image file in megabytes. */ sizeInMbs: string; /** * The current state of the appliance image. */ state: string; /** * The time when the appliance image was created.An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the appliance image was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The version of the image file. */ version: string; } interface GetApplianceImagesApplianceImageCollection { /** * List of appliance images. */ items: outputs.CloudBridge.GetApplianceImagesApplianceImageCollectionItem[]; } interface GetApplianceImagesApplianceImageCollectionItem { /** * The checksum of the image file. */ checksum: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The URL from which the appliance image can be downloaded. */ downloadUrl: string; /** * The name of the appliance Image file. */ fileName: string; /** * The file format of the image file. */ format: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation. */ id: string; /** * The virtualization platform that the image file supports. */ platform: string; /** * The size of the image file in megabytes. */ sizeInMbs: string; /** * The current state of the appliance image. */ state: string; /** * The time when the appliance image was created.An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the appliance image was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The version of the image file. */ version: string; } interface GetApplianceImagesFilter { name: string; regex?: boolean; values: string[]; } interface GetAssetAttachedEbsVolumesCost { amount: number; currencyCode: string; } interface GetAssetAwsEb { attachments: outputs.CloudBridge.GetAssetAwsEbAttachment[]; availabilityZone: string; iops: number; isEncrypted: boolean; isMultiAttachEnabled: boolean; sizeInGiBs: number; status: string; tags: outputs.CloudBridge.GetAssetAwsEbTag[]; throughput: number; volumeKey: string; volumeType: string; } interface GetAssetAwsEbAttachment { device: string; instanceKey: string; isDeleteOnTermination: boolean; status: string; volumeKey: string; } interface GetAssetAwsEbTag { key: string; value: string; } interface GetAssetAwsEc2 { architecture: string; areElasticInferenceAcceleratorsPresent: boolean; bootMode: string; capacityReservationKey: string; imageKey: string; instanceKey: string; instanceLifecycle: string; instanceType: string; ipAddress: string; ipv6address: string; isEnclaveOptions: boolean; isHibernationOptions: boolean; isSourceDestCheck: boolean; isSpotInstance: boolean; kernelKey: string; licenses: string[]; maintenanceOptions: string; monitoring: string; networkInterfaces: outputs.CloudBridge.GetAssetAwsEc2NetworkInterface[]; placements: outputs.CloudBridge.GetAssetAwsEc2Placement[]; privateDnsName: string; privateIpAddress: string; rootDeviceName: string; rootDeviceType: string; securityGroups: outputs.CloudBridge.GetAssetAwsEc2SecurityGroup[]; sriovNetSupport: string; /** * The current state of the asset. */ states: outputs.CloudBridge.GetAssetAwsEc2State[]; subnetKey: string; tags: outputs.CloudBridge.GetAssetAwsEc2Tag[]; timeLaunch: string; tpmSupport: string; virtualizationType: string; vpcKey: string; } interface GetAssetAwsEc2NetworkInterface { associations: outputs.CloudBridge.GetAssetAwsEc2NetworkInterfaceAssociation[]; attachments: outputs.CloudBridge.GetAssetAwsEc2NetworkInterfaceAttachment[]; /** * The tag description. */ description: string; interfaceType: string; ipv4prefixes: string[]; ipv6addresses: string[]; ipv6prefixes: string[]; isSourceDestCheck: boolean; /** * Mac address of the VM. */ macAddress: string; networkInterfaceKey: string; ownerKey: string; privateIpAddresses: outputs.CloudBridge.GetAssetAwsEc2NetworkInterfacePrivateIpAddress[]; securityGroups: outputs.CloudBridge.GetAssetAwsEc2NetworkInterfaceSecurityGroup[]; status: string; subnetKey: string; } interface GetAssetAwsEc2NetworkInterfaceAssociation { carrierIp: string; customerOwnedIp: string; ipOwnerKey: string; publicDnsName: string; publicIp: string; } interface GetAssetAwsEc2NetworkInterfaceAttachment { attachmentKey: string; deviceIndex: number; isDeleteOnTermination: boolean; networkCardIndex: number; status: string; timeAttach: string; } interface GetAssetAwsEc2NetworkInterfacePrivateIpAddress { associations: outputs.CloudBridge.GetAssetAwsEc2NetworkInterfacePrivateIpAddressAssociation[]; isPrimary: boolean; privateDnsName: string; privateIpAddress: string; } interface GetAssetAwsEc2NetworkInterfacePrivateIpAddressAssociation { carrierIp: string; customerOwnedIp: string; ipOwnerKey: string; publicDnsName: string; publicIp: string; } interface GetAssetAwsEc2NetworkInterfaceSecurityGroup { groupKey: string; groupName: string; } interface GetAssetAwsEc2Placement { affinity: string; availabilityZone: string; groupName: string; hostKey: string; hostResourceGroupArn: string; partitionNumber: number; spreadDomain: string; tenancy: string; } interface GetAssetAwsEc2SecurityGroup { groupKey: string; groupName: string; } interface GetAssetAwsEc2State { code: number; /** * The tag name. */ name: string; } interface GetAssetAwsEc2Tag { key: string; value: string; } interface GetAssetAwsEc2cost { amount: number; currencyCode: string; } interface GetAssetCompute { /** * Number of connected networks. */ connectedNetworks: number; /** * Number of GPU cores. */ coresCount: number; /** * CPU model name. */ cpuModel: string; /** * The tag description. */ description: string; /** * Lists the set of disks belonging to the virtual machine. This list is unordered. */ disks: outputs.CloudBridge.GetAssetComputeDisk[]; /** * Number of disks. */ disksCount: number; /** * Fully Qualified DNS Name. */ dnsName: string; /** * Information about firmware type for this virtual machine. */ firmware: string; /** * List of GPU devices attached to a virtual machine. */ gpuDevices: outputs.CloudBridge.GetAssetComputeGpuDevice[]; /** * Number of GPU devices. */ gpuDevicesCount: number; /** * Guest state. */ guestState: string; /** * Hardware version. */ hardwareVersion: string; /** * Host name of the VM. */ hostName: string; /** * Whether Pmem is enabled. Decides if NVDIMMs are used as a permanent memory. */ isPmemEnabled: boolean; /** * Whether Trusted Platform Module (TPM) is enabled. */ isTpmEnabled: boolean; /** * Latency sensitivity. */ latencySensitivity: string; /** * Memory size in MBs. */ memoryInMbs: string; /** * List of network ethernet cards attached to a virtual machine. */ nics: outputs.CloudBridge.GetAssetComputeNic[]; /** * Number of network ethernet cards. */ nicsCount: number; /** * The asset's NVDIMM configuration. */ nvdimmControllers: outputs.CloudBridge.GetAssetComputeNvdimmController[]; /** * The properties of the NVDIMMs attached to a virtual machine. */ nvdimms: outputs.CloudBridge.GetAssetComputeNvdimm[]; /** * Operating system. */ operatingSystem: string; /** * Operating system version. */ operatingSystemVersion: string; /** * Pmem size in MBs. */ pmemInMbs: string; /** * The current power state of the virtual machine. */ powerState: string; /** * Primary IP address of the compute instance. */ primaryIp: string; /** * The assets SCSI controller. */ scsiControllers: outputs.CloudBridge.GetAssetComputeScsiController[]; /** * Provision storage size in MBs. */ storageProvisionedInMbs: string; /** * Number of threads per core. */ threadsPerCoreCount: number; } interface GetAssetComputeDisk { /** * Order of boot volumes. */ bootOrder: number; isCbtEnabled: boolean; /** * Location of the boot/data volume. */ location: string; /** * The tag name. */ name: string; /** * The disk persistent mode. */ persistentMode: string; /** * The size of the volume in MBs. */ sizeInMbs: string; /** * Disk UUID for the virtual disk, if available. */ uuid: string; /** * Disk UUID LUN for the virtual disk, if available. */ uuidLun: string; } interface GetAssetComputeGpuDevice { /** * Number of GPU cores. */ coresCount: number; /** * The tag description. */ description: string; /** * The manufacturer of GPU. */ manufacturer: string; /** * Memory size in MBs. */ memoryInMbs: string; /** * The tag name. */ name: string; } interface GetAssetComputeNic { /** * List of IP addresses. */ ipAddresses: string[]; /** * Provides a label and summary information for the device. */ label: string; /** * Mac address of the VM. */ macAddress: string; /** * Mac address type. */ macAddressType: string; /** * Network name. */ networkName: string; /** * Switch name. */ switchName: string; } interface GetAssetComputeNvdimm { /** * Controller key. */ controllerKey: number; /** * Provides a label and summary information for the device. */ label: string; /** * The unit number of the SCSI controller. */ unitNumber: number; } interface GetAssetComputeNvdimmController { /** * Bus number. */ busNumber: number; /** * Provides a label and summary information for the device. */ label: string; } interface GetAssetComputeScsiController { /** * Provides a label and summary information for the device. */ label: string; /** * Shared bus. */ sharedBus: string; /** * The unit number of the SCSI controller. */ unitNumber: number; } interface GetAssetSourceDiscoveryCredential { /** * 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": "", "password": "" }`. */ secretId: string; /** * The type of asset source. Indicates external origin of the assets that are read by assigning this asset source. */ type: string; } interface GetAssetSourceReplicationCredential { /** * 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": "", "password": "" }`. */ secretId: string; /** * The type of asset source. Indicates external origin of the assets that are read by assigning this asset source. */ type: string; } interface GetAssetSourcesAssetSourceCollection { items: outputs.CloudBridge.GetAssetSourcesAssetSourceCollectionItem[]; } interface GetAssetSourcesAssetSourceCollectionItem { /** * Flag indicating whether historical metrics are collected for assets, originating from this asset source. */ areHistoricalMetricsCollected: boolean; /** * Flag indicating whether real-time metrics are collected for assets, originating from this asset source. */ areRealtimeMetricsCollected: boolean; /** * 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. */ assetsCompartmentId: string; awsAccountKey: string; awsRegion: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Credentials for an asset source. */ discoveryCredentials: outputs.CloudBridge.GetAssetSourcesAssetSourceCollectionItemDiscoveryCredential[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an attached discovery schedule. */ discoveryScheduleId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the environment. */ environmentId: string; /** * Specifies if this is the Source or Destination point for migration - different assets may be discovered depending on setting. */ environmentType: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the inventory that will contain created assets. */ inventoryId: string; isCostInformationCollected: boolean; /** * The detailed state of the asset source. */ lifecycleDetails: string; /** * Endpoint for OLVM asset discovery and replication in the form of ```https://:``` */ olvmEndpoint: string; /** * Credentials for an asset source. */ replicationCredentials: outputs.CloudBridge.GetAssetSourcesAssetSourceCollectionItemReplicationCredential[]; /** * The current state of the asset source. */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time when the asset source was created in the RFC3339 format. */ timeCreated: string; /** * The point in time that the asset source was last updated in the RFC3339 format. */ timeUpdated: string; /** * The type of asset source. Indicates external origin of the assets that are read by assigning this asset source. */ type: string; /** * Endpoint for VMware asset discovery and replication in the form of ```https://:/sdk``` */ vcenterEndpoint: string; } interface GetAssetSourcesAssetSourceCollectionItemDiscoveryCredential { /** * 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": "", "password": "" }`. */ secretId: string; /** * The type of asset source. Indicates external origin of the assets that are read by assigning this asset source. */ type: string; } interface GetAssetSourcesAssetSourceCollectionItemReplicationCredential { /** * 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": "", "password": "" }`. */ secretId: string; /** * The type of asset source. Indicates external origin of the assets that are read by assigning this asset source. */ type: string; } interface GetAssetSourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetAssetVm { /** * Host name/IP address of VM on which the host is running. */ hypervisorHost: string; /** * Hypervisor vendor. */ hypervisorVendor: string; /** * Hypervisor version. */ hypervisorVersion: string; } interface GetAssetVmwareVcenter { /** * Data center name. */ dataCenter: string; /** * vCenter unique key. */ vcenterKey: string; /** * Dot-separated version string. */ vcenterVersion: string; } interface GetAssetVmwareVm { /** * Cluster name. */ cluster: string; /** * Customer fields. */ customerFields: string[]; /** * Customer defined tags. */ customerTags: outputs.CloudBridge.GetAssetVmwareVmCustomerTag[]; /** * Fault tolerance bandwidth. */ faultToleranceBandwidth: number; /** * Fault tolerance to secondary latency. */ faultToleranceSecondaryLatency: number; /** * Fault tolerance state. */ faultToleranceState: string; /** * vCenter-specific identifier of the virtual machine. */ instanceUuid: string; /** * 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. */ isDisksCbtEnabled: boolean; /** * Whether changed block tracking for this VM's disk is active. */ isDisksUuidEnabled: boolean; /** * Path directory of the asset. */ path: string; /** * VMware tools status. */ vmwareToolsStatus: string; } interface GetAssetVmwareVmCustomerTag { /** * The tag description. */ description: string; /** * The tag name. */ name: string; } interface GetAssetsAssetCollection { items: outputs.CloudBridge.GetAssetsAssetCollectionItem[]; } interface GetAssetsAssetCollectionItem { /** * The name of the asset class. */ assetClassName: string; /** * The version of the asset class. */ assetClassVersion: string; /** * The details of the asset. */ assetDetails: string; /** * List of asset source OCID. */ assetSourceIds: string[]; /** * The type of asset. */ assetType: string; attachedEbsVolumesCosts: outputs.CloudBridge.GetAssetsAssetCollectionItemAttachedEbsVolumesCost[]; awsEbs: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEb[]; awsEc2costs: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2cost[]; awsEc2s: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Compute related properties. */ computes: outputs.CloudBridge.GetAssetsAssetCollectionItemCompute[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Specifies if this is the Source or Destination point for migration - different assets may be discovered depending on setting. */ environmentType: string; /** * External asset key. */ externalAssetKey: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Asset OCID that is immutable on creation. */ id: string; /** * Unique Inventory identifier. */ inventoryId: string; /** * Source key from where the assets originate. */ sourceKey: string; /** * A filter to return only assets whose lifecycleState matches the given lifecycleState. */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time when the asset was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the asset was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Virtual machine related properties. */ vms: outputs.CloudBridge.GetAssetsAssetCollectionItemVm[]; /** * VMware vCenter related properties. */ vmwareVcenters: outputs.CloudBridge.GetAssetsAssetCollectionItemVmwareVcenter[]; /** * VMware virtual machine related properties. */ vmwareVms: outputs.CloudBridge.GetAssetsAssetCollectionItemVmwareVm[]; } interface GetAssetsAssetCollectionItemAttachedEbsVolumesCost { amount: number; currencyCode: string; } interface GetAssetsAssetCollectionItemAwsEb { attachments: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEbAttachment[]; availabilityZone: string; iops: number; isEncrypted: boolean; isMultiAttachEnabled: boolean; sizeInGiBs: number; status: string; tags: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEbTag[]; throughput: number; volumeKey: string; volumeType: string; } interface GetAssetsAssetCollectionItemAwsEbAttachment { device: string; instanceKey: string; isDeleteOnTermination: boolean; status: string; volumeKey: string; } interface GetAssetsAssetCollectionItemAwsEbTag { key: string; value: string; } interface GetAssetsAssetCollectionItemAwsEc2 { architecture: string; areElasticInferenceAcceleratorsPresent: boolean; bootMode: string; capacityReservationKey: string; imageKey: string; instanceKey: string; instanceLifecycle: string; instanceType: string; ipAddress: string; ipv6address: string; isEnclaveOptions: boolean; isHibernationOptions: boolean; isSourceDestCheck: boolean; isSpotInstance: boolean; kernelKey: string; licenses: string[]; maintenanceOptions: string; monitoring: string; networkInterfaces: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2NetworkInterface[]; placements: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2Placement[]; privateDnsName: string; privateIpAddress: string; rootDeviceName: string; rootDeviceType: string; securityGroups: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2SecurityGroup[]; sriovNetSupport: string; /** * A filter to return only assets whose lifecycleState matches the given lifecycleState. */ states: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2State[]; subnetKey: string; tags: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2Tag[]; timeLaunch: string; tpmSupport: string; virtualizationType: string; vpcKey: string; } interface GetAssetsAssetCollectionItemAwsEc2NetworkInterface { associations: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2NetworkInterfaceAssociation[]; attachments: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2NetworkInterfaceAttachment[]; /** * The tag description. */ description: string; interfaceType: string; ipv4prefixes: string[]; ipv6addresses: string[]; ipv6prefixes: string[]; isSourceDestCheck: boolean; /** * Mac address of the VM. */ macAddress: string; networkInterfaceKey: string; ownerKey: string; privateIpAddresses: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddress[]; securityGroups: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2NetworkInterfaceSecurityGroup[]; status: string; subnetKey: string; } interface GetAssetsAssetCollectionItemAwsEc2NetworkInterfaceAssociation { carrierIp: string; customerOwnedIp: string; ipOwnerKey: string; publicDnsName: string; publicIp: string; } interface GetAssetsAssetCollectionItemAwsEc2NetworkInterfaceAttachment { attachmentKey: string; deviceIndex: number; isDeleteOnTermination: boolean; networkCardIndex: number; status: string; timeAttach: string; } interface GetAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddress { associations: outputs.CloudBridge.GetAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddressAssociation[]; isPrimary: boolean; privateDnsName: string; privateIpAddress: string; } interface GetAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddressAssociation { carrierIp: string; customerOwnedIp: string; ipOwnerKey: string; publicDnsName: string; publicIp: string; } interface GetAssetsAssetCollectionItemAwsEc2NetworkInterfaceSecurityGroup { groupKey: string; groupName: string; } interface GetAssetsAssetCollectionItemAwsEc2Placement { affinity: string; availabilityZone: string; groupName: string; hostKey: string; hostResourceGroupArn: string; partitionNumber: number; spreadDomain: string; tenancy: string; } interface GetAssetsAssetCollectionItemAwsEc2SecurityGroup { groupKey: string; groupName: string; } interface GetAssetsAssetCollectionItemAwsEc2State { code: number; /** * The tag name. */ name: string; } interface GetAssetsAssetCollectionItemAwsEc2Tag { key: string; value: string; } interface GetAssetsAssetCollectionItemAwsEc2cost { amount: number; currencyCode: string; } interface GetAssetsAssetCollectionItemCompute { /** * Number of connected networks. */ connectedNetworks: number; /** * Number of GPU cores. */ coresCount: number; /** * CPU model name. */ cpuModel: string; /** * The tag description. */ description: string; /** * Lists the set of disks belonging to the virtual machine. This list is unordered. */ disks: outputs.CloudBridge.GetAssetsAssetCollectionItemComputeDisk[]; /** * Number of disks. */ disksCount: number; /** * Fully Qualified DNS Name. */ dnsName: string; /** * Information about firmware type for this virtual machine. */ firmware: string; /** * List of GPU devices attached to a virtual machine. */ gpuDevices: outputs.CloudBridge.GetAssetsAssetCollectionItemComputeGpuDevice[]; /** * Number of GPU devices. */ gpuDevicesCount: number; /** * Guest state. */ guestState: string; /** * Hardware version. */ hardwareVersion: string; /** * Host name of the VM. */ hostName: string; /** * Whether Pmem is enabled. Decides if NVDIMMs are used as a permanent memory. */ isPmemEnabled: boolean; /** * Whether Trusted Platform Module (TPM) is enabled. */ isTpmEnabled: boolean; /** * Latency sensitivity. */ latencySensitivity: string; /** * Memory size in MBs. */ memoryInMbs: string; /** * List of network ethernet cards attached to a virtual machine. */ nics: outputs.CloudBridge.GetAssetsAssetCollectionItemComputeNic[]; /** * Number of network ethernet cards. */ nicsCount: number; /** * The asset's NVDIMM configuration. */ nvdimmControllers: outputs.CloudBridge.GetAssetsAssetCollectionItemComputeNvdimmController[]; /** * The properties of the NVDIMMs attached to a virtual machine. */ nvdimms: outputs.CloudBridge.GetAssetsAssetCollectionItemComputeNvdimm[]; /** * Operating system. */ operatingSystem: string; /** * Operating system version. */ operatingSystemVersion: string; /** * Pmem size in MBs. */ pmemInMbs: string; /** * The current power state of the virtual machine. */ powerState: string; /** * Primary IP address of the compute instance. */ primaryIp: string; /** * The assets SCSI controller. */ scsiControllers: outputs.CloudBridge.GetAssetsAssetCollectionItemComputeScsiController[]; /** * Provision storage size in MBs. */ storageProvisionedInMbs: string; /** * Number of threads per core. */ threadsPerCoreCount: number; } interface GetAssetsAssetCollectionItemComputeDisk { /** * Order of boot volumes. */ bootOrder: number; isCbtEnabled: boolean; /** * Location of the boot/data volume. */ location: string; /** * The tag name. */ name: string; /** * The disk persistent mode. */ persistentMode: string; /** * The size of the volume in MBs. */ sizeInMbs: string; /** * Disk UUID for the virtual disk, if available. */ uuid: string; /** * Disk UUID LUN for the virtual disk, if available. */ uuidLun: string; } interface GetAssetsAssetCollectionItemComputeGpuDevice { /** * Number of GPU cores. */ coresCount: number; /** * The tag description. */ description: string; /** * The manufacturer of GPU. */ manufacturer: string; /** * Memory size in MBs. */ memoryInMbs: string; /** * The tag name. */ name: string; } interface GetAssetsAssetCollectionItemComputeNic { /** * List of IP addresses. */ ipAddresses: string[]; /** * Provides a label and summary information for the device. */ label: string; /** * Mac address of the VM. */ macAddress: string; /** * Mac address type. */ macAddressType: string; /** * Network name. */ networkName: string; /** * Switch name. */ switchName: string; } interface GetAssetsAssetCollectionItemComputeNvdimm { /** * Controller key. */ controllerKey: number; /** * Provides a label and summary information for the device. */ label: string; /** * The unit number of the SCSI controller. */ unitNumber: number; } interface GetAssetsAssetCollectionItemComputeNvdimmController { /** * Bus number. */ busNumber: number; /** * Provides a label and summary information for the device. */ label: string; } interface GetAssetsAssetCollectionItemComputeScsiController { /** * Provides a label and summary information for the device. */ label: string; /** * Shared bus. */ sharedBus: string; /** * The unit number of the SCSI controller. */ unitNumber: number; } interface GetAssetsAssetCollectionItemVm { /** * Host name/IP address of VM on which the host is running. */ hypervisorHost: string; /** * Hypervisor vendor. */ hypervisorVendor: string; /** * Hypervisor version. */ hypervisorVersion: string; } interface GetAssetsAssetCollectionItemVmwareVcenter { /** * Data center name. */ dataCenter: string; /** * vCenter unique key. */ vcenterKey: string; /** * Dot-separated version string. */ vcenterVersion: string; } interface GetAssetsAssetCollectionItemVmwareVm { /** * Cluster name. */ cluster: string; /** * Customer fields. */ customerFields: string[]; /** * Customer defined tags. */ customerTags: outputs.CloudBridge.GetAssetsAssetCollectionItemVmwareVmCustomerTag[]; /** * Fault tolerance bandwidth. */ faultToleranceBandwidth: number; /** * Fault tolerance to secondary latency. */ faultToleranceSecondaryLatency: number; /** * Fault tolerance state. */ faultToleranceState: string; /** * vCenter-specific identifier of the virtual machine. */ instanceUuid: string; /** * 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. */ isDisksCbtEnabled: boolean; /** * Whether changed block tracking for this VM's disk is active. */ isDisksUuidEnabled: boolean; /** * Path directory of the asset. */ path: string; /** * VMware tools status. */ vmwareToolsStatus: string; } interface GetAssetsAssetCollectionItemVmwareVmCustomerTag { /** * The tag description. */ description: string; /** * The tag name. */ name: string; } interface GetAssetsFilter { /** * The tag name. */ name: string; regex?: boolean; values: string[]; } interface GetDiscoverySchedulesDiscoveryScheduleCollection { items: outputs.CloudBridge.GetDiscoverySchedulesDiscoveryScheduleCollectionItem[]; } interface GetDiscoverySchedulesDiscoveryScheduleCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Recurrence specification for the discovery schedule execution. */ executionRecurrences: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the discovery schedule. */ id: string; /** * The detailed state of the discovery schedule. */ lifecycleDetails: string; /** * The current state of the discovery schedule. */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time when the discovery schedule was created in RFC3339 format. */ timeCreated: string; /** * The time when the discovery schedule was last updated in RFC3339 format. */ timeUpdated: string; } interface GetDiscoverySchedulesFilter { name: string; regex?: boolean; values: string[]; } interface GetEnvironmentsEnvironmentCollection { items: outputs.CloudBridge.GetEnvironmentsEnvironmentCollectionItem[]; } interface GetEnvironmentsEnvironmentCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation. */ id: string; /** * 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. */ lifecycleDetails: string; /** * A filter to return only resources where their lifecycleState matches the given lifecycleState. */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time when the source environment was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the source environment was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetEnvironmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetInventoriesFilter { name: string; regex?: boolean; values: string[]; } interface GetInventoriesInventoryCollection { items: outputs.CloudBridge.GetInventoriesInventoryCollectionItem[]; } interface GetInventoriesInventoryCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Inventory display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Inventory OCID. */ id: string; /** * 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. */ lifecycleDetails: string; /** * A filter to return inventory if the lifecycleState matches the given lifecycleState. */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time when the inventory was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the inventory was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetSupportedCloudRegionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSupportedCloudRegionsSupportedCloudRegionCollection { items: outputs.CloudBridge.GetSupportedCloudRegionsSupportedCloudRegionCollectionItem[]; } interface GetSupportedCloudRegionsSupportedCloudRegionCollectionItem { assetSourceType: string; name: string; state: string; } } export declare namespace CloudGuard { interface AdhocQueryAdhocQueryDetails { /** * Target information in which adhoc query will be run */ adhocQueryResources: outputs.CloudGuard.AdhocQueryAdhocQueryDetailsAdhocQueryResource[]; /** * The adhoc query expression that is run */ query: string; } interface AdhocQueryAdhocQueryDetailsAdhocQueryResource { /** * Region in which adhoc query needs to be run */ region: string; /** * List of OCIDs on which query needs to be run */ resourceIds: string[]; /** * Type of resource */ resourceType: string; } interface AdhocQueryAdhocQueryRegionalDetail { /** * Expected number of instances on which query should run */ expectedCount: string; /** * Number of instances on which query expired */ expiredCount: string; /** * Number of instances on which query failed */ failedCount: string; /** * Region name */ region: string; /** * error message to show if adhoc query fails in a region */ regionalError: string; /** * adhoc query status of the region */ regionalStatus: string; /** * Number of instances on which query succeeded */ succeededCount: string; } interface CloudGuardDataSourceDataSourceDetails { /** * (Updatable) The additional entities count used for data source query */ additionalEntitiesCount: number; /** * (Updatable) Type of data source feed provider (LoggingQuery) */ dataSourceFeedProvider: string; /** * (Updatable) Description text for the query */ description: string; /** * (Updatable) Interval in minutes that query is run periodically. */ intervalInMinutes: number; /** * (Updatable) Interval in seconds which query is run periodically. */ intervalInSeconds: number; /** * (Updatable) Details for a logging query for a data source. */ loggingQueryDetails: outputs.CloudGuard.CloudGuardDataSourceDataSourceDetailsLoggingQueryDetails; /** * (Updatable) Type of logging query for data source (Sighting/Insight) */ loggingQueryType: string; /** * (Updatable) DEPRECATED - Operator used in data source */ operator: string; /** * (Updatable) The continuous query expression that is run periodically. */ query: string; /** * (Updatable) DEPRECATED - Start policy for continuous query */ queryStartTime: outputs.CloudGuard.CloudGuardDataSourceDataSourceDetailsQueryStartTime; /** * (Updatable) List of logging query regions */ regions: string[]; /** * (Updatable) Target information in which scheduled query will be run */ scheduledQueryScopeDetails: outputs.CloudGuard.CloudGuardDataSourceDataSourceDetailsScheduledQueryScopeDetail[]; /** * (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 */ threshold: number; } interface CloudGuardDataSourceDataSourceDetailsLoggingQueryDetails { /** * (Updatable) The key entities count used for data source query */ keyEntitiesCount: number; /** * (Updatable) Logging query type for data source */ loggingQueryType: string; } interface CloudGuardDataSourceDataSourceDetailsQueryStartTime { /** * (Updatable) Time when the query can start. If not specified it can start immediately */ queryStartTime: string; /** * (Updatable) Start policy delay timing */ startPolicyType: string; } interface CloudGuardDataSourceDataSourceDetailsScheduledQueryScopeDetail { /** * (Updatable) region on which scheduled query needs to be run */ region: string; /** * (Updatable) List of OCIDs on scheduled query needs to run */ resourceIds: string[]; /** * (Updatable) Type of resource */ resourceType: string; } interface CloudGuardDataSourceDataSourceDetectorMappingInfo { /** * ID of the detector recipe attached to the data source */ detectorRecipeId: string; /** * ID of the detector rule attached to the data source */ detectorRuleId: string; } interface CloudGuardDataSourceRegionStatusDetail { /** * Data source replication region */ region: string; /** * (Updatable) Enablement status of data source. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ status: string; } interface DataMaskRuleTargetSelected { /** * (Updatable) Kind of target selection to be used */ kind: string; /** * (Updatable) Types of targets * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ values: string[]; } interface DetectorRecipeDetectorRule { /** * List of responder rules that can be used to remediate this detector rule */ candidateResponderRules: outputs.CloudGuard.DetectorRecipeDetectorRuleCandidateResponderRule[]; /** * The ID of the attached data source */ dataSourceId: string; /** * (Updatable) Detector recipe description. * * Avoid entering confidential information. */ description: string; /** * (Updatable) Parameters to be updated for a detector rule within a detector recipe. */ details: outputs.CloudGuard.DetectorRecipeDetectorRuleDetails; /** * Detector for the rule */ detector: string; /** * (Updatable) Detector recipe rule ID */ detectorRuleId: string; /** * (Updatable) Detector recipe display name. * * Avoid entering confidential information. */ displayName: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.DetectorRecipeDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * Resource type of the configuration to which the rule is applied */ resourceType: string; /** * Detector rule type */ ruleTypes: outputs.CloudGuard.DetectorRecipeDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * The current lifecycle state of the resource */ state: string; /** * The date and time the detector recipe was created Format defined by RFC3339. */ timeCreated: string; /** * The date and time the detector recipe was last updated Format defined by RFC3339. */ timeUpdated: string; } interface DetectorRecipeDetectorRuleCandidateResponderRule { /** * (Updatable) Detector recipe display name. * * Avoid entering confidential information. */ displayName: string; /** * OCID for detector recipe */ id: string; /** * Is this the preferred state? */ isPreferred: boolean; } interface DetectorRecipeDetectorRuleDetails { /** * (Updatable) The base condition resource. */ condition: string; /** * (Updatable) List of detector rule configurations */ configurations: outputs.CloudGuard.DetectorRecipeDetectorRuleDetailsConfiguration[]; /** * (Updatable) The unique identifier of the attached data source */ dataSourceId: string; /** * (Updatable) Description for the detector rule */ description: string; /** * (Updatable) Data source entities mapping for a detector rule */ entitiesMappings: outputs.CloudGuard.DetectorRecipeDetectorRuleDetailsEntitiesMapping[]; /** * Can the rule be configured? */ isConfigurationAllowed: boolean; /** * (Updatable) Enablement status of the detector rule */ isEnabled: boolean; /** * (Updatable) User-defined labels for a detector rule */ labels: string[]; /** * (Updatable) Recommendation for the detector rule */ recommendation: string; /** * (Updatable) The risk level of the detector rule */ riskLevel: string; } interface DetectorRecipeDetectorRuleDetailsConfiguration { /** * (Updatable) Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.DetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty[]; /** * (Updatable) Map of possible values for configuration */ allowedValues: outputs.CloudGuard.DetectorRecipeDetectorRuleDetailsConfigurationAllowedValue[]; /** * (Updatable) Map property Value data type */ allowedValuesDataType: string; /** * (Updatable) Unique identifier of the configuration */ configKey: string; /** * (Updatable) Configuration data type */ dataType: string; /** * (Updatable) Configuration name */ name: string; /** * (Updatable) Configuration value */ value: string; /** * (Updatable) List of configuration values */ values: outputs.CloudGuard.DetectorRecipeDetectorRuleDetailsConfigurationValue[]; } interface DetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty { /** * (Updatable) Name for Additional Property, for example, "interpreter", "router" */ key: string; /** * (Updatable) Property Type */ propertyType: string; /** * (Updatable) Value for Property Name, for example, "generic", "cloudguard" */ value: string; } interface DetectorRecipeDetectorRuleDetailsConfigurationAllowedValue { /** * (Updatable) key */ key: string; /** * (Updatable) value */ value: string; } interface DetectorRecipeDetectorRuleDetailsConfigurationValue { /** * (Updatable) Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * (Updatable) Type of content in the managed list */ managedListType: string; /** * (Updatable) Configuration value */ value: string; } interface DetectorRecipeDetectorRuleDetailsEntitiesMapping { /** * (Updatable) Display name of the entity */ displayName: string; /** * (Updatable) Type of entity */ entityType: string; /** * (Updatable) The entity value mapped to a data source query */ queryField: string; } interface DetectorRecipeDetectorRuleEntitiesMapping { /** * (Updatable) Detector recipe display name. * * Avoid entering confidential information. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface DetectorRecipeDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ values: string[]; } interface DetectorRecipeEffectiveDetectorRule { /** * List of responder rules that can be used to remediate this detector rule */ candidateResponderRules: outputs.CloudGuard.DetectorRecipeEffectiveDetectorRuleCandidateResponderRule[]; /** * The ID of the attached data source */ dataSourceId: string; /** * (Updatable) Detector recipe description. * * Avoid entering confidential information. */ description: string; /** * Detailed information for a detector. */ details: outputs.CloudGuard.DetectorRecipeEffectiveDetectorRuleDetail[]; /** * Detector for the rule */ detector: string; /** * The unique identifier of the detector rule. */ detectorRuleId: string; /** * (Updatable) Detector recipe display name. * * Avoid entering confidential information. */ displayName: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.DetectorRecipeEffectiveDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * Resource type of the configuration to which the rule is applied */ resourceType: string; /** * Detector rule type */ ruleTypes: outputs.CloudGuard.DetectorRecipeEffectiveDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * The current lifecycle state of the resource */ state: string; /** * The date and time the detector recipe was created Format defined by RFC3339. */ timeCreated: string; /** * The date and time the detector recipe was last updated Format defined by RFC3339. */ timeUpdated: string; } interface DetectorRecipeEffectiveDetectorRuleCandidateResponderRule { /** * (Updatable) Detector recipe display name. * * Avoid entering confidential information. */ displayName: string; /** * OCID for detector recipe */ id: string; /** * Is this the preferred state? */ isPreferred: boolean; } interface DetectorRecipeEffectiveDetectorRuleDetail { /** * The base condition resource. */ condition: string; /** * List of detector rule configurations */ configurations: outputs.CloudGuard.DetectorRecipeEffectiveDetectorRuleDetailConfiguration[]; /** * The ID of the attached data source */ dataSourceId: string; /** * (Updatable) Detector recipe description. * * Avoid entering confidential information. */ description: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.DetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping[]; /** * Can the rule be configured? */ isConfigurationAllowed: boolean; /** * Enablement status for the rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * The risk level for the rule */ riskLevel: string; } interface DetectorRecipeEffectiveDetectorRuleDetailConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.DetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.DetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Detector rule type value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.DetectorRecipeEffectiveDetectorRuleDetailConfigurationValue[]; } interface DetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Detector rule type value */ value: string; } interface DetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ value: string; } interface DetectorRecipeEffectiveDetectorRuleDetailConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Detector rule type value */ value: string; } interface DetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping { /** * (Updatable) Detector recipe display name. * * Avoid entering confidential information. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface DetectorRecipeEffectiveDetectorRuleEntitiesMapping { /** * (Updatable) Detector recipe display name. * * Avoid entering confidential information. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface DetectorRecipeEffectiveDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ values: string[]; } interface GetAdhocQueriesAdhocQueryCollection { items: outputs.CloudGuard.GetAdhocQueriesAdhocQueryCollectionItem[]; } interface GetAdhocQueriesAdhocQueryCollectionItem { /** * Detailed information about the adhoc query. */ adhocQueryDetails: outputs.CloudGuard.GetAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetail[]; /** * Instance level status for each region */ adhocQueryRegionalDetails: outputs.CloudGuard.GetAdhocQueriesAdhocQueryCollectionItemAdhocQueryRegionalDetail[]; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Error message to show on UI in case of failure */ errorMessage: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID for the adhoc query */ id: string; /** * The current lifecycle state of the resource. */ state: string; /** * Status of the adhoc query */ status: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the adhoc query was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the adhoc query was updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetail { /** * Target information in which adhoc query will be run */ adhocQueryResources: outputs.CloudGuard.GetAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetailAdhocQueryResource[]; /** * The adhoc query expression that is run */ query: string; } interface GetAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetailAdhocQueryResource { /** * Region name */ region: string; /** * List of OCIDs on which query needs to be run */ resourceIds: string[]; /** * Type of resource */ resourceType: string; } interface GetAdhocQueriesAdhocQueryCollectionItemAdhocQueryRegionalDetail { /** * Expected number of instances on which query should run */ expectedCount: string; /** * Number of instances on which query expired */ expiredCount: string; /** * Number of instances on which query failed */ failedCount: string; /** * Region name */ region: string; /** * error message to show if adhoc query fails in a region */ regionalError: string; /** * adhoc query status of the region */ regionalStatus: string; /** * Number of instances on which query succeeded */ succeededCount: string; } interface GetAdhocQueriesFilter { name: string; regex?: boolean; values: string[]; } interface GetAdhocQueryAdhocQueryDetail { /** * Target information in which adhoc query will be run */ adhocQueryResources: outputs.CloudGuard.GetAdhocQueryAdhocQueryDetailAdhocQueryResource[]; /** * The adhoc query expression that is run */ query: string; } interface GetAdhocQueryAdhocQueryDetailAdhocQueryResource { /** * Region name */ region: string; /** * List of OCIDs on which query needs to be run */ resourceIds: string[]; /** * Type of resource */ resourceType: string; } interface GetAdhocQueryAdhocQueryRegionalDetail { /** * Expected number of instances on which query should run */ expectedCount: string; /** * Number of instances on which query expired */ expiredCount: string; /** * Number of instances on which query failed */ failedCount: string; /** * Region name */ region: string; /** * error message to show if adhoc query fails in a region */ regionalError: string; /** * adhoc query status of the region */ regionalStatus: string; /** * Number of instances on which query succeeded */ succeededCount: string; } interface GetDataMaskRuleTargetSelected { /** * Kind of target selection to be used */ kind: string; /** * Types of targets */ values: string[]; } interface GetDataMaskRulesDataMaskRuleCollection { items: outputs.CloudGuard.GetDataMaskRulesDataMaskRuleCollectionItem[]; } interface GetDataMaskRulesDataMaskRuleCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * List of data mask rule categories */ dataMaskCategories: string[]; /** * The status of the data mask rule */ dataMaskRuleStatus: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The data mask rule description */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID of the IAM group */ iamGroupId: string; /** * Unique identifier that can't be changed after creation */ id: string; /** * Additional details on the substate of the lifecycle state [DEPRECATE] */ lifecyleDetails: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId). */ targetSelecteds: outputs.CloudGuard.GetDataMaskRulesDataMaskRuleCollectionItemTargetSelected[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetDataMaskRulesDataMaskRuleCollectionItemTargetSelected { /** * Kind of target selection to be used */ kind: string; /** * Types of targets */ values: string[]; } interface GetDataMaskRulesFilter { name: string; regex?: boolean; /** * Types of targets */ values: string[]; } interface GetDataSourceDataSourceDetail { /** * The additional entities count used for data source query */ additionalEntitiesCount: number; /** * Possible type of dataSourceFeed Provider(LoggingQuery) */ dataSourceFeedProvider: string; /** * Description text for the query */ description: string; /** * Interval in minutes that query is run periodically. */ intervalInMinutes: number; /** * Interval in seconds which query is run periodically. */ intervalInSeconds: number; /** * Details for a logging query for a data source. */ loggingQueryDetails: outputs.CloudGuard.GetDataSourceDataSourceDetailLoggingQueryDetail[]; /** * Type of logging query for data source (Sighting/Insight) */ loggingQueryType: string; /** * DEPRECATED - Operator used in data source */ operator: string; /** * The continuous query expression that is run periodically. */ query: string; /** * Time when the query can start. If not specified it can start immediately */ queryStartTimes: outputs.CloudGuard.GetDataSourceDataSourceDetailQueryStartTime[]; /** * List of logging query regions */ regions: string[]; /** * Target information in which scheduled query will be run */ scheduledQueryScopeDetails: outputs.CloudGuard.GetDataSourceDataSourceDetailScheduledQueryScopeDetail[]; /** * 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 */ threshold: number; } interface GetDataSourceDataSourceDetailLoggingQueryDetail { /** * The key entities count used for data source query */ keyEntitiesCount: number; /** * Type of logging query for data source (Sighting/Insight) */ loggingQueryType: string; } interface GetDataSourceDataSourceDetailQueryStartTime { /** * Time when the query can start. If not specified it can start immediately */ queryStartTime: string; /** * Start policy delay timing */ startPolicyType: string; } interface GetDataSourceDataSourceDetailScheduledQueryScopeDetail { /** * Data source replication region */ region: string; /** * List of OCIDs on scheduled query needs to run */ resourceIds: string[]; /** * Type of resource */ resourceType: string; } interface GetDataSourceDataSourceDetectorMappingInfo { /** * ID of the detector recipe attached to the data source */ detectorRecipeId: string; /** * ID of the detector rule attached to the data source */ detectorRuleId: string; } interface GetDataSourceEventItem { /** * Data source event comments */ comments: string; /** * DataSource OCID */ dataSourceId: string; /** * Data source event date time */ eventDate: string; /** * Event info of a data source. */ eventInfos: outputs.CloudGuard.GetDataSourceEventItemEventInfo[]; /** * A filter to return only resource their region matches the given region. */ region: string; /** * Current data source event info status */ status: string; /** * Data source event created time */ timeCreated: string; } interface GetDataSourceEventItemEventInfo { /** * Possible type of dataSourceFeed Provider(LoggingQuery) */ dataSourceFeedProvider: string; logResult: string; observedValue: string; operator: string; triggerValue: string; } interface GetDataSourceEventsDataSourceEventCollection { /** * List of events related to a data source */ items: outputs.CloudGuard.GetDataSourceEventsDataSourceEventCollectionItem[]; } interface GetDataSourceEventsDataSourceEventCollectionItem { /** * Data source event comments */ comments: string; /** * Data source OCID. */ dataSourceId: string; /** * Data source event date and time */ eventDate: string; /** * This resource can have multiple subtypes, depending on the dataSourceFeedProvider value. For example, if dataSourceFeedProvider is LOGGINGQUERY, this resource will be of type LoggingEventInfo. */ eventInfos: outputs.CloudGuard.GetDataSourceEventsDataSourceEventCollectionItemEventInfo[]; /** * A filter to return only resource where their region matches the given region. */ region: string; /** * Current data source event info status */ status: string; /** * Data source event creation date and time */ timeCreated: string; } interface GetDataSourceEventsDataSourceEventCollectionItemEventInfo { /** * Possible type of dataSourceFeed Provider (LoggingQuery) */ dataSourceFeedProvider: string; /** * Log result details of DataSource for a Problem */ logResult: string; /** * Observed value of DataSource for a Problem */ observedValue: string; /** * Operator details of DataSource for a Problem */ operator: string; /** * Triggered value of DataSource for a Problem */ triggerValue: string; } interface GetDataSourceEventsFilter { name: string; regex?: boolean; values: string[]; } interface GetDataSourceRegionStatusDetail { /** * Data source replication region */ region: string; /** * Enablement status of the data source */ status: string; } interface GetDataSourcesDataSourceCollection { items: outputs.CloudGuard.GetDataSourcesDataSourceCollectionItem[]; } interface GetDataSourcesDataSourceCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Details specific to the data source type. */ dataSourceDetails: outputs.CloudGuard.GetDataSourcesDataSourceCollectionItemDataSourceDetail[]; /** * Information about the detector recipe and rule attached */ dataSourceDetectorMappingInfos: outputs.CloudGuard.GetDataSourcesDataSourceCollectionItemDataSourceDetectorMappingInfo[]; /** * A filter to return only resources when their feed provider matches the given feed provider (`DataSourceFeedProvider` resource). */ dataSourceFeedProvider: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID for the data source */ id: string; /** * Information about the region and status of query replication */ regionStatusDetails: outputs.CloudGuard.GetDataSourcesDataSourceCollectionItemRegionStatusDetail[]; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * Enablement status of the data source */ status: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Data source was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the data source was updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetDataSourcesDataSourceCollectionItemDataSourceDetail { /** * The additional entities count used for data source query */ additionalEntitiesCount: number; /** * A filter to return only resources when their feed provider matches the given feed provider (`DataSourceFeedProvider` resource). */ dataSourceFeedProvider: string; /** * Description text for the query */ description: string; /** * Interval in minutes that query is run periodically. */ intervalInMinutes: number; /** * Interval in seconds which query is run periodically. */ intervalInSeconds: number; /** * Details for a logging query for a data source. */ loggingQueryDetails: outputs.CloudGuard.GetDataSourcesDataSourceCollectionItemDataSourceDetailLoggingQueryDetail[]; /** * A filter to return only resources where their query type matches the given LoggingQueryType. */ loggingQueryType: string; /** * DEPRECATED - Operator used in data source */ operator: string; /** * The continuous query expression that is run periodically. */ query: string; /** * Time when the query can start. If not specified it can start immediately */ queryStartTimes: outputs.CloudGuard.GetDataSourcesDataSourceCollectionItemDataSourceDetailQueryStartTime[]; /** * List of logging query regions */ regions: string[]; /** * Target information in which scheduled query will be run */ scheduledQueryScopeDetails: outputs.CloudGuard.GetDataSourcesDataSourceCollectionItemDataSourceDetailScheduledQueryScopeDetail[]; /** * 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 */ threshold: number; } interface GetDataSourcesDataSourceCollectionItemDataSourceDetailLoggingQueryDetail { /** * The key entities count used for data source query */ keyEntitiesCount: number; /** * A filter to return only resources where their query type matches the given LoggingQueryType. */ loggingQueryType: string; } interface GetDataSourcesDataSourceCollectionItemDataSourceDetailQueryStartTime { /** * Time when the query can start. If not specified it can start immediately */ queryStartTime: string; /** * Start policy delay timing */ startPolicyType: string; } interface GetDataSourcesDataSourceCollectionItemDataSourceDetailScheduledQueryScopeDetail { /** * Data source replication region */ region: string; /** * List of OCIDs on scheduled query needs to run */ resourceIds: string[]; /** * Type of resource */ resourceType: string; } interface GetDataSourcesDataSourceCollectionItemDataSourceDetectorMappingInfo { /** * ID of the detector recipe attached to the data source */ detectorRecipeId: string; /** * ID of the detector rule attached to the data source */ detectorRuleId: string; } interface GetDataSourcesDataSourceCollectionItemRegionStatusDetail { /** * Data source replication region */ region: string; /** * Enablement status of the data source */ status: string; } interface GetDataSourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetDetectorRecipeDetectorRule { /** * List of responder rules that can be used to remediate this detector rule */ candidateResponderRules: outputs.CloudGuard.GetDetectorRecipeDetectorRuleCandidateResponderRule[]; /** * The ID of the attached data source */ dataSourceId: string; /** * Description for detector recipe detector rule */ description: string; /** * Detailed information for a detector. */ details: outputs.CloudGuard.GetDetectorRecipeDetectorRuleDetail[]; /** * Detector recipe for the rule */ detector: string; /** * The unique identifier of the detector rule. */ detectorRuleId: string; /** * Display name of the entity */ displayName: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.GetDetectorRecipeDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * Resource type of the configuration to which the rule is applied */ resourceType: string; /** * Detector rule type */ ruleTypes: outputs.CloudGuard.GetDetectorRecipeDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * The current lifecycle state of the resource */ state: string; /** * The date and time the detector recipe was created Format defined by RFC3339. */ timeCreated: string; /** * The date and time the detector recipe was last updated Format defined by RFC3339. */ timeUpdated: string; } interface GetDetectorRecipeDetectorRuleCandidateResponderRule { /** * Display name of the entity */ displayName: string; /** * OCID for detector recipe */ id: string; /** * Is this the preferred state? */ isPreferred: boolean; } interface GetDetectorRecipeDetectorRuleDetail { /** * The base condition resource. */ condition: string; /** * List of detector rule configurations */ configurations: outputs.CloudGuard.GetDetectorRecipeDetectorRuleDetailConfiguration[]; /** * The ID of the attached data source */ dataSourceId: string; /** * Description for detector recipe detector rule */ description: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.GetDetectorRecipeDetectorRuleDetailEntitiesMapping[]; /** * Can the rule be configured? */ isConfigurationAllowed: boolean; /** * Enablement status for the rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * The risk level for the rule */ riskLevel: string; } interface GetDetectorRecipeDetectorRuleDetailConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.GetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.GetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Detector rule type value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.GetDetectorRecipeDetectorRuleDetailConfigurationValue[]; } interface GetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipeDetectorRuleDetailConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipeDetectorRuleDetailEntitiesMapping { /** * Display name of the entity */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetDetectorRecipeDetectorRuleEntitiesMapping { /** * Display name of the entity */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetDetectorRecipeDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ values: string[]; } interface GetDetectorRecipeEffectiveDetectorRule { /** * List of responder rules that can be used to remediate this detector rule */ candidateResponderRules: outputs.CloudGuard.GetDetectorRecipeEffectiveDetectorRuleCandidateResponderRule[]; /** * The ID of the attached data source */ dataSourceId: string; /** * Description for detector recipe detector rule */ description: string; /** * Detailed information for a detector. */ details: outputs.CloudGuard.GetDetectorRecipeEffectiveDetectorRuleDetail[]; /** * Detector recipe for the rule */ detector: string; /** * The unique identifier of the detector rule. */ detectorRuleId: string; /** * Display name of the entity */ displayName: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.GetDetectorRecipeEffectiveDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * Resource type of the configuration to which the rule is applied */ resourceType: string; /** * Detector rule type */ ruleTypes: outputs.CloudGuard.GetDetectorRecipeEffectiveDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * The current lifecycle state of the resource */ state: string; /** * The date and time the detector recipe was created Format defined by RFC3339. */ timeCreated: string; /** * The date and time the detector recipe was last updated Format defined by RFC3339. */ timeUpdated: string; } interface GetDetectorRecipeEffectiveDetectorRuleCandidateResponderRule { /** * Display name of the entity */ displayName: string; /** * OCID for detector recipe */ id: string; /** * Is this the preferred state? */ isPreferred: boolean; } interface GetDetectorRecipeEffectiveDetectorRuleDetail { /** * The base condition resource. */ condition: string; /** * List of detector rule configurations */ configurations: outputs.CloudGuard.GetDetectorRecipeEffectiveDetectorRuleDetailConfiguration[]; /** * The ID of the attached data source */ dataSourceId: string; /** * Description for detector recipe detector rule */ description: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.GetDetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping[]; /** * Can the rule be configured? */ isConfigurationAllowed: boolean; /** * Enablement status for the rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * The risk level for the rule */ riskLevel: string; } interface GetDetectorRecipeEffectiveDetectorRuleDetailConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.GetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.GetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Detector rule type value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.GetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue[]; } interface GetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping { /** * Display name of the entity */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetDetectorRecipeEffectiveDetectorRuleEntitiesMapping { /** * Display name of the entity */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetDetectorRecipeEffectiveDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ values: string[]; } interface GetDetectorRecipesDetectorRecipeCollection { items: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItem[]; } interface GetDetectorRecipesDetectorRecipeCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description for detector recipe detector rule */ description: string; /** * Detector recipe for the rule */ detector: string; /** * Recipe type ( STANDARD, ENTERPRISE ) */ detectorRecipeType: string; /** * List of detector rules for the detector type for recipe - user input */ detectorRules: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * List of effective detector rules for the detector type for recipe after applying defaults */ effectiveDetectorRules: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID for detector recipe */ id: string; /** * Owner of detector recipe */ owner: string; /** * Recipe OCID of the source recipe to be cloned */ sourceDetectorRecipeId: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * List of target IDs to which the recipe is attached */ targetIds: string[]; /** * The date and time the detector recipe was created Format defined by RFC3339. */ timeCreated: string; /** * The date and time the detector recipe was last updated Format defined by RFC3339. */ timeUpdated: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemDetectorRule { /** * List of responder rules that can be used to remediate this detector rule */ candidateResponderRules: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule[]; /** * The ID of the attached data source */ dataSourceId: string; /** * Description for detector recipe detector rule */ description: string; /** * Detailed information for a detector. */ details: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail[]; /** * Detector recipe for the rule */ detector: string; /** * The unique identifier of the detector rule. */ detectorRuleId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * Resource type of the configuration to which the rule is applied */ resourceType: string; /** * Detector rule type */ ruleTypes: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * The date and time the detector recipe was created Format defined by RFC3339. */ timeCreated: string; /** * The date and time the detector recipe was last updated Format defined by RFC3339. */ timeUpdated: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * OCID for detector recipe */ id: string; /** * Is this the preferred state? */ isPreferred: boolean; } interface GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail { /** * The base condition resource. */ condition: string; /** * List of detector rule configurations */ configurations: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration[]; /** * The ID of the attached data source */ dataSourceId: string; /** * Description for detector recipe detector rule */ description: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping[]; /** * Can the rule be configured? */ isConfigurationAllowed: boolean; /** * Enablement status for the rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * The risk level for the rule */ riskLevel: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Detector rule type value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue[]; } interface GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ values: string[]; } interface GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule { /** * List of responder rules that can be used to remediate this detector rule */ candidateResponderRules: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule[]; /** * The ID of the attached data source */ dataSourceId: string; /** * Description for detector recipe detector rule */ description: string; /** * Detailed information for a detector. */ details: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail[]; /** * Detector recipe for the rule */ detector: string; /** * The unique identifier of the detector rule. */ detectorRuleId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * Resource type of the configuration to which the rule is applied */ resourceType: string; /** * Detector rule type */ ruleTypes: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * The date and time the detector recipe was created Format defined by RFC3339. */ timeCreated: string; /** * The date and time the detector recipe was last updated Format defined by RFC3339. */ timeUpdated: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * OCID for detector recipe */ id: string; /** * Is this the preferred state? */ isPreferred: boolean; } interface GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail { /** * The base condition resource. */ condition: string; /** * List of detector rule configurations */ configurations: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration[]; /** * The ID of the attached data source */ dataSourceId: string; /** * Description for detector recipe detector rule */ description: string; /** * Data source entities mapping for the detector rule */ entitiesMappings: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping[]; /** * Can the rule be configured? */ isConfigurationAllowed: boolean; /** * Enablement status for the rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * Recommendation for DetectorRecipeDetectorRule resource */ recommendation: string; /** * The risk level for the rule */ riskLevel: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Detector rule type value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue[]; } interface GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Detector rule type value */ value: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Detector rule type value */ values: string[]; } interface GetDetectorRecipesFilter { /** * Configuration name */ name: string; regex?: boolean; /** * List of configuration values */ values: string[]; } interface GetGuardTargetTargetDetail { /** * The name of the security zone to associate with this compartment. */ securityZoneDisplayName: string; /** * The OCID of the security zone to associate with this compartment */ securityZoneId: string; /** * Type of target */ targetResourceType: string; /** * The list of security zone recipes to associate with this compartment */ targetSecurityZoneRecipes: outputs.CloudGuard.GetGuardTargetTargetDetailTargetSecurityZoneRecipe[]; } interface GetGuardTargetTargetDetailTargetSecurityZoneRecipe { /** * Compartment OCID */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Responder rule description */ description: string; /** * Responder rule display name */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier of target responder recipe that can't be changed after creation */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Owner of target responder recipe */ owner: string; /** * The list of security policy IDs that are included in the recipe */ securityPolicies: string[]; /** * The current lifecycle state of the responder rule */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetTargetDetectorRecipe { /** * Compartment OCID */ compartmentId: string; /** * Responder rule description */ description: string; /** * Detector type for the rule */ detector: string; /** * Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based */ detectorRecipeId: string; /** * Recipe type ( STANDARD, ENTERPRISE ) */ detectorRecipeType: string; /** * List of detector rules for the detector recipe - user input */ detectorRules: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeDetectorRule[]; /** * Responder rule display name */ displayName: string; /** * List of currently enabled detector rules for the detector type for recipe after applying defaults */ effectiveDetectorRules: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeEffectiveDetectorRule[]; /** * Unique identifier of target responder recipe that can't be changed after creation */ id: string; /** * Owner of target responder recipe */ owner: string; /** * The current lifecycle state of the responder rule */ state: string; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetTargetDetectorRecipeDetectorRule { /** * The ID of the attached data source */ dataSourceId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeDetectorRuleDetail[]; /** * Detector type for the rule */ detector: string; /** * The unique identifier of the detector rule */ detectorRuleId: string; /** * Responder rule display name */ displayName: string; /** * Data source entities mapping for a detector rule */ entitiesMappings: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for TargetDetectorRecipeDetectorRule resource */ recommendation: string; /** * 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). */ resourceType: string; /** * Rule category type */ ruleTypes: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * The current lifecycle state of the responder rule */ state: string; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetTargetDetectorRecipeDetectorRuleDetail { /** * Condition group corresponding to each compartment */ conditionGroups: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeDetectorRuleDetailConditionGroup[]; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeDetectorRuleDetailConfiguration[]; /** * Configuration allowed or not */ isConfigurationAllowed: boolean; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * The risk level of the detector rule */ riskLevel: string; } interface GetGuardTargetTargetDetectorRecipeDetectorRuleDetailConditionGroup { /** * Compartment OCID */ compartmentId: string; /** * The base condition resource. */ condition: string; } interface GetGuardTargetTargetDetectorRecipeDetectorRuleDetailConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationValue[]; } interface GetGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Configuration value */ value: string; } interface GetGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ value: string; } interface GetGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Configuration value */ value: string; } interface GetGuardTargetTargetDetectorRecipeDetectorRuleEntitiesMapping { /** * Responder rule display name */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetGuardTargetTargetDetectorRecipeDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ values: string[]; } interface GetGuardTargetTargetDetectorRecipeEffectiveDetectorRule { /** * The ID of the attached data source */ dataSourceId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetail[]; /** * Detector type for the rule */ detector: string; /** * The unique identifier of the detector rule */ detectorRuleId: string; /** * Responder rule display name */ displayName: string; /** * Data source entities mapping for a detector rule */ entitiesMappings: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for TargetDetectorRecipeDetectorRule resource */ recommendation: string; /** * 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). */ resourceType: string; /** * Rule category type */ ruleTypes: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * The current lifecycle state of the responder rule */ state: string; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetail { /** * Condition group corresponding to each compartment */ conditionGroups: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup[]; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration[]; /** * Configuration allowed or not */ isConfigurationAllowed: boolean; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * The risk level of the detector rule */ riskLevel: string; } interface GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup { /** * Compartment OCID */ compartmentId: string; /** * The base condition resource. */ condition: string; } interface GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue[]; } interface GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Configuration value */ value: string; } interface GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ value: string; } interface GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Configuration value */ value: string; } interface GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping { /** * Responder rule display name */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetGuardTargetTargetDetectorRecipeEffectiveDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ values: string[]; } interface GetGuardTargetTargetResponderRecipe { /** * Compartment OCID */ compartmentId: string; /** * Responder rule description */ description: string; /** * Responder rule display name */ displayName: string; /** * List of currently enabled responder rules for the responder type for recipe after applying defaults */ effectiveResponderRules: outputs.CloudGuard.GetGuardTargetTargetResponderRecipeEffectiveResponderRule[]; /** * Unique identifier of target responder recipe that can't be changed after creation */ id: string; /** * Owner of target responder recipe */ owner: string; /** * Unique identifier for the Oracle-managed responder recipe from which this recipe was cloned */ responderRecipeId: string; /** * List of responder rules associated with the recipe - user input */ responderRules: outputs.CloudGuard.GetGuardTargetTargetResponderRecipeResponderRule[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetTargetResponderRecipeEffectiveResponderRule { /** * Compartment OCID */ compartmentId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetGuardTargetTargetResponderRecipeEffectiveResponderRuleDetail[]; /** * Responder rule display name */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * Unique identifier for the responder rule */ responderRuleId: string; /** * The current lifecycle state of the responder rule */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface GetGuardTargetTargetResponderRecipeEffectiveResponderRuleDetail { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetGuardTargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface GetGuardTargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface GetGuardTargetTargetResponderRecipeResponderRule { /** * Compartment OCID */ compartmentId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetGuardTargetTargetResponderRecipeResponderRuleDetail[]; /** * Responder rule display name */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * Unique identifier for the responder rule */ responderRuleId: string; /** * The current lifecycle state of the responder rule */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface GetGuardTargetTargetResponderRecipeResponderRuleDetail { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetGuardTargetTargetResponderRecipeResponderRuleDetailConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface GetGuardTargetTargetResponderRecipeResponderRuleDetailConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface GetGuardTargetsFilter { /** * Configuration name */ name: string; regex?: boolean; /** * List of configuration values */ values: string[]; } interface GetGuardTargetsTargetCollection { items: outputs.CloudGuard.GetGuardTargetsTargetCollectionItem[]; } interface GetGuardTargetsTargetCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Responder rule description */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier of target responder recipe that can't be changed after creation */ id: string; /** * List of inherited compartments */ inheritedByCompartments: string[]; /** * 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] */ lifecyleDetails: string; /** * Total number of recipes attached to target */ recipeCount: number; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * Details specific to the target type. */ targetDetails: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetail[]; /** * List of detector recipes attached to target */ targetDetectorRecipes: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipe[]; /** * Resource ID which the target uses to monitor */ targetResourceId: string; /** * Type of target */ targetResourceType: string; /** * List of responder recipes attached to target */ targetResponderRecipes: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetResponderRecipe[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetsTargetCollectionItemTargetDetail { /** * The name of the security zone to associate with this compartment. */ securityZoneDisplayName: string; /** * The OCID of the security zone to associate with this compartment */ securityZoneId: string; /** * Type of target */ targetResourceType: string; /** * The list of security zone recipes to associate with this compartment */ targetSecurityZoneRecipes: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetailTargetSecurityZoneRecipe[]; } interface GetGuardTargetsTargetCollectionItemTargetDetailTargetSecurityZoneRecipe { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Responder rule description */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier of target responder recipe that can't be changed after creation */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Owner of target responder recipe */ owner: string; /** * The list of security policy IDs that are included in the recipe */ securityPolicies: string[]; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipe { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Responder rule description */ description: string; /** * Detector type for the rule */ detector: string; /** * Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based */ detectorRecipeId: string; /** * Recipe type ( STANDARD, ENTERPRISE ) */ detectorRecipeType: string; /** * List of detector rules for the detector recipe - user input */ detectorRules: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRule[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * List of currently enabled detector rules for the detector type for recipe after applying defaults */ effectiveDetectorRules: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRule[]; /** * Unique identifier of target responder recipe that can't be changed after creation */ id: string; /** * Owner of target responder recipe */ owner: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRule { /** * The ID of the attached data source */ dataSourceId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetail[]; /** * Detector type for the rule */ detector: string; /** * The unique identifier of the detector rule */ detectorRuleId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Data source entities mapping for a detector rule */ entitiesMappings: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for TargetDetectorRecipeDetectorRule resource */ recommendation: string; /** * 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). */ resourceType: string; /** * Rule category type */ ruleTypes: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetail { /** * Condition group corresponding to each compartment */ conditionGroups: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConditionGroup[]; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfiguration[]; /** * Configuration allowed or not */ isConfigurationAllowed: boolean; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * The risk level of the detector rule */ riskLevel: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConditionGroup { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * The base condition resource. */ condition: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationValue[]; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Configuration value */ value: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ value: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Configuration value */ value: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleEntitiesMapping { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ values: string[]; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRule { /** * The ID of the attached data source */ dataSourceId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetail[]; /** * Detector type for the rule */ detector: string; /** * The unique identifier of the detector rule */ detectorRuleId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Data source entities mapping for a detector rule */ entitiesMappings: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for TargetDetectorRecipeDetectorRule resource */ recommendation: string; /** * 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). */ resourceType: string; /** * Rule category type */ ruleTypes: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetail { /** * Condition group corresponding to each compartment */ conditionGroups: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup[]; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration[]; /** * Configuration allowed or not */ isConfigurationAllowed: boolean; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * The risk level of the detector rule */ riskLevel: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * The base condition resource. */ condition: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue[]; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Configuration value */ value: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ value: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Configuration value */ value: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface GetGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ values: string[]; } interface GetGuardTargetsTargetCollectionItemTargetResponderRecipe { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Responder rule description */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * List of currently enabled responder rules for the responder type for recipe after applying defaults */ effectiveResponderRules: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRule[]; /** * Unique identifier of target responder recipe that can't be changed after creation */ id: string; /** * Owner of target responder recipe */ owner: string; /** * Unique identifier for the Oracle-managed responder recipe from which this recipe was cloned */ responderRecipeId: string; /** * List of responder rules associated with the recipe - user input */ responderRules: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRule[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRule { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetail[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * Unique identifier for the responder rule */ responderRuleId: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface GetGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetail { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetailConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface GetGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetailConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface GetGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRule { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetail[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * Unique identifier for the responder rule */ responderRuleId: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface GetGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetail { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetailConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface GetGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetailConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface GetManagedListsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedListsManagedListCollection { items: outputs.CloudGuard.GetManagedListsManagedListCollectionItem[]; } interface GetManagedListsManagedListCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Managed list description */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Provider of the managed list feed */ feedProvider: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Managed list type group */ group: string; /** * Unique identifier that can't be changed after creation */ id: string; /** * Is this list editable? */ isEditable: boolean; /** * 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] */ lifecyleDetails: string; /** * List of items in the managed list */ listItems: string[]; /** * The type of managed list. */ listType: string; /** * OCID of the source managed list */ sourceManagedListId: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the managed list was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the managed list was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetProblemEntitiesFilter { name: string; regex?: boolean; values: string[]; } interface GetProblemEntitiesProblemEntityCollection { /** * List of entity details related to a data source */ items: outputs.CloudGuard.GetProblemEntitiesProblemEntityCollectionItem[]; } interface GetProblemEntitiesProblemEntityCollectionItem { /** * List of entity details related to a data source */ entityDetails: outputs.CloudGuard.GetProblemEntitiesProblemEntityCollectionItemEntityDetail[]; /** * OCID of the problem. */ problemId: string; /** * Data source problem entities region */ regions: string[]; /** * Log result query URL for a data source query */ resultUrl: string; /** * Data source problem entities first detected time */ timeFirstDetected: string; /** * Data source problem entities last detected time */ timeLastDetected: string; } interface GetProblemEntitiesProblemEntityCollectionItemEntityDetail { /** * The display name of entity */ displayName: string; /** * Type of entity */ type: string; /** * The entity value */ value: string; } interface GetProblemEntityItem { /** * List of event related to a DataSource */ entityDetails: outputs.CloudGuard.GetProblemEntityItemEntityDetail[]; /** * OCId of the problem. */ problemId: string; /** * Data source problem entities region */ regions: string[]; /** * Log result query url for a data source query */ resultUrl: string; /** * Data source problem entities first detected time */ timeFirstDetected: string; /** * Data source problem entities last detected time */ timeLastDetected: string; } interface GetProblemEntityItemEntityDetail { /** * The display name of entity */ displayName: string; /** * Type of entity */ type: string; /** * The entity value */ value: string; } interface GetResponderRecipeEffectiveResponderRule { /** * Compartment OCID */ compartmentId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetResponderRecipeEffectiveResponderRuleDetail[]; /** * Responder rule display name */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * Unique identifier for the responder rule */ responderRuleId: string; /** * The current lifecycle state of the example */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the responder recipe was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the responder recipe was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface GetResponderRecipeEffectiveResponderRuleDetail { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetResponderRecipeEffectiveResponderRuleDetailConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface GetResponderRecipeEffectiveResponderRuleDetailConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface GetResponderRecipeResponderRule { /** * Compartment OCID */ compartmentId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetResponderRecipeResponderRuleDetail[]; /** * Responder rule display name */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * Unique identifier for the responder rule */ responderRuleId: string; /** * The current lifecycle state of the example */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the responder recipe was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the responder recipe was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface GetResponderRecipeResponderRuleDetail { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetResponderRecipeResponderRuleDetailConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface GetResponderRecipeResponderRuleDetailConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface GetResponderRecipesFilter { /** * Configuration name */ name: string; regex?: boolean; values: string[]; } interface GetResponderRecipesResponderRecipeCollection { items: outputs.CloudGuard.GetResponderRecipesResponderRecipeCollectionItem[]; } interface GetResponderRecipesResponderRecipeCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Responder rule description */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * List of currently enabled responder rules for the responder type, for recipe after applying defaults */ effectiveResponderRules: outputs.CloudGuard.GetResponderRecipesResponderRecipeCollectionItemEffectiveResponderRule[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier for the responder recip */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Owner of responder recipe */ owner: string; /** * List of responder rules associated with the recipe */ responderRules: outputs.CloudGuard.GetResponderRecipesResponderRecipeCollectionItemResponderRule[]; /** * The unique identifier of the source responder recipe */ sourceResponderRecipeId: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the responder recipe was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the responder recipe was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetResponderRecipesResponderRecipeCollectionItemEffectiveResponderRule { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetail[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * Unique identifier for the responder rule */ responderRuleId: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the responder recipe was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the responder recipe was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface GetResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetail { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetailConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface GetResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetailConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface GetResponderRecipesResponderRecipeCollectionItemResponderRule { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Responder rule description */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.GetResponderRecipesResponderRecipeCollectionItemResponderRuleDetail[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * Unique identifier for the responder rule */ responderRuleId: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the responder recipe was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the responder recipe was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface GetResponderRecipesResponderRecipeCollectionItemResponderRuleDetail { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.GetResponderRecipesResponderRecipeCollectionItemResponderRuleDetailConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface GetResponderRecipesResponderRecipeCollectionItemResponderRuleDetailConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface GetSavedQueriesFilter { name: string; regex?: boolean; values: string[]; } interface GetSavedQueriesSavedQueryCollection { items: outputs.CloudGuard.GetSavedQueriesSavedQueryCollectionItem[]; } interface GetSavedQueriesSavedQueryCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of the saved query */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID for the saved query */ id: string; /** * The saved query expression */ query: string; /** * The current lifecycle state of the resource */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the saved query was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the saved query was updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetSecurityPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityPoliciesSecurityPolicyCollection { items: outputs.CloudGuard.GetSecurityPoliciesSecurityPolicyCollectionItem[]; } interface GetSecurityPoliciesSecurityPolicyCollectionItem { /** * The category of the security policy */ category: string; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The security policy's description */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A shorter version of the security policy's name */ friendlyName: string; /** * The unique identifier of the security zone policy. (`SecurityPolicy`) */ id: string; /** * 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. */ lifecycleDetails: string; /** * The owner of the security policy */ owner: string; /** * The list of services that the security policy protects */ services: string[]; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * The time the security policy was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the security policy was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetSecurityRecipesFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityRecipesSecurityRecipeCollection { items: outputs.CloudGuard.GetSecurityRecipesSecurityRecipeCollectionItem[]; } interface GetSecurityRecipesSecurityRecipeCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The recipe's description */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The unique identifier of the security zone recipe. (`SecurityRecipe`) */ id: string; /** * 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. */ lifecycleDetails: string; /** * The owner of the recipe */ owner: string; /** * The list of security policy IDs that are included in the recipe */ securityPolicies: string[]; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * The time the recipe was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the recipe was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetSecurityZonesFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityZonesSecurityZoneCollection { items: outputs.CloudGuard.GetSecurityZonesSecurityZoneCollectionItem[]; } interface GetSecurityZonesSecurityZoneCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The security zone's description */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The unique identifier of the security zone (`SecurityZone` resource). */ id: string; /** * List of inherited compartments */ inheritedByCompartments: string[]; /** * Indicates if upon deletion of the security zone the comparment should inherit parent security zone */ isInheritanceAfterDeleteEnabled: boolean; /** * 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. */ lifecycleDetails: string; /** * The OCID of the recipe (`SecurityRecipe` resource) for the security zone */ securityZoneRecipeId: string; /** * The OCID of the target associated with the security zone */ securityZoneTargetId: string; /** * The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active. */ state: string; /** * The time the security zone was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the security zone was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetWlpAgentsFilter { name: string; regex?: boolean; values: string[]; } interface GetWlpAgentsWlpAgentCollection { items: outputs.CloudGuard.GetWlpAgentsWlpAgentCollectionItem[]; } interface GetWlpAgentsWlpAgentCollectionItem { /** * The version of the agent */ agentVersion: string; /** * The certificate ID returned by Oracle Cloud Infrastructure certificates service */ certificateId: string; /** * The updated certificate signing request */ certificateSignedRequest: string; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID for instance in which WlpAgent is installed */ hostId: string; /** * OCID for WlpAgent */ id: string; osInfo: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * TenantId of the host */ tenantId: string; /** * The date and time the WlpAgent was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the WlpAgent was updated. Format defined by RFC3339. */ timeUpdated: string; } interface ResponderRecipeEffectiveResponderRule { /** * (Updatable) Compartment OCID */ compartmentId: string; /** * (Updatable) Responder recipe description. * * Avoid entering confidential information. */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.ResponderRecipeEffectiveResponderRuleDetail[]; /** * (Updatable) Responder recipe display name. * * Avoid entering confidential information. */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * Unique identifier for the responder rule */ responderRuleId: string; /** * The current lifecycle state of the example */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the responder recipe was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the responder recipe was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface ResponderRecipeEffectiveResponderRuleDetail { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.ResponderRecipeEffectiveResponderRuleDetailConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface ResponderRecipeEffectiveResponderRuleDetailConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface ResponderRecipeResponderRule { /** * (Updatable) Compartment OCID */ compartmentId: string; /** * (Updatable) Responder recipe description. * * Avoid entering confidential information. */ description: string; /** * (Updatable) Parameters to be updated for a responder rule within a responder recipe. */ details: outputs.CloudGuard.ResponderRecipeResponderRuleDetails; /** * (Updatable) Responder recipe display name. * * Avoid entering confidential information. */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * (Updatable) Unique identifier for the responder rule */ responderRuleId: string; /** * The current lifecycle state of the example */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the responder recipe was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the responder recipe was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface ResponderRecipeResponderRuleDetails { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.ResponderRecipeResponderRuleDetailsConfiguration[]; /** * (Updatable) Enablement state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface ResponderRecipeResponderRuleDetailsConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface TargetTargetDetail { /** * The name of the security zone to associate with this compartment. */ securityZoneDisplayName: string; /** * The OCID of the security zone to associate with this compartment */ securityZoneId: string; /** * Type of resource that target support (COMPARTMENT/FACLOUD) */ targetResourceType: string; /** * The list of security zone recipes to associate with this compartment */ targetSecurityZoneRecipes: outputs.CloudGuard.TargetTargetDetailTargetSecurityZoneRecipe[]; } interface TargetTargetDetailTargetSecurityZoneRecipe { /** * Compartment OCID where the resource is created */ compartmentId: string; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The target description. * * Avoid entering confidential information. */ description: string; /** * (Updatable) Display name for the target. * * Avoid entering confidential information. */ displayName: string; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` * * Avoid entering confidential information. */ freeformTags: { [key: string]: string; }; /** * Unique identifier of target responder recipe that can't be changed after creation */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Owner of target responder recipe */ owner: string; /** * The list of security policy IDs that are included in the recipe */ securityPolicies: string[]; /** * (Updatable) The enablement state of the detector rule */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface TargetTargetDetectorRecipe { /** * Compartment OCID where the resource is created */ compartmentId: string; /** * The target description. * * Avoid entering confidential information. */ description: string; /** * Detector type for the rule */ detector: string; /** * Unique identifier for the target detector recipe */ detectorRecipeId: string; /** * Recipe type ( STANDARD, ENTERPRISE ) */ detectorRecipeType: string; /** * (Updatable) List of overrides to be applied to detector rules associated with the target */ detectorRules: outputs.CloudGuard.TargetTargetDetectorRecipeDetectorRule[]; /** * (Updatable) Display name for the target. * * Avoid entering confidential information. */ displayName: string; /** * List of currently enabled detector rules for the detector type for recipe after applying defaults */ effectiveDetectorRules: outputs.CloudGuard.TargetTargetDetectorRecipeEffectiveDetectorRule[]; /** * Unique identifier of target responder recipe that can't be changed after creation */ id: string; /** * Owner of target responder recipe */ owner: string; /** * (Updatable) The enablement state of the detector rule */ state: string; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface TargetTargetDetectorRecipeDetectorRule { /** * The ID of the attached data source */ dataSourceId: string; /** * The target description. * * Avoid entering confidential information. */ description: string; /** * (Updatable) Parameters to update detector rule configuration details in a detector recipe attached to a target. */ details: outputs.CloudGuard.TargetTargetDetectorRecipeDetectorRuleDetails; /** * Detector type for the rule */ detector: string; /** * (Updatable) Unique identifier for the detector rule */ detectorRuleId: string; /** * (Updatable) Display name for the target. * * Avoid entering confidential information. */ displayName: string; /** * Data source entities mapping for a detector rule */ entitiesMappings: outputs.CloudGuard.TargetTargetDetectorRecipeDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for TargetDetectorRecipeDetectorRule resource */ recommendation: string; /** * 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). */ resourceType: string; /** * Rule category type */ ruleTypes: outputs.CloudGuard.TargetTargetDetectorRecipeDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * (Updatable) The enablement state of the detector rule */ state: string; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface TargetTargetDetectorRecipeDetectorRuleDetails { /** * (Updatable) Condition group corresponding to each compartment */ conditionGroups: outputs.CloudGuard.TargetTargetDetectorRecipeDetectorRuleDetailsConditionGroup[]; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.TargetTargetDetectorRecipeDetectorRuleDetailsConfiguration[]; /** * Configuration allowed or not */ isConfigurationAllowed: boolean; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * The risk level of the detector rule */ riskLevel: string; } interface TargetTargetDetectorRecipeDetectorRuleDetailsConditionGroup { /** * (Updatable) Compartment OCID associated with condition */ compartmentId: string; /** * (Updatable) The base condition resource. */ condition: string; } interface TargetTargetDetectorRecipeDetectorRuleDetailsConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationValue[]; } interface TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Configuration value */ value: string; } interface TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ value: string; } interface TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Configuration value */ value: string; } interface TargetTargetDetectorRecipeDetectorRuleEntitiesMapping { /** * (Updatable) Display name for the target. * * Avoid entering confidential information. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface TargetTargetDetectorRecipeDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ values: string[]; } interface TargetTargetDetectorRecipeEffectiveDetectorRule { /** * The ID of the attached data source */ dataSourceId: string; /** * The target description. * * Avoid entering confidential information. */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.TargetTargetDetectorRecipeEffectiveDetectorRuleDetail[]; /** * Detector type for the rule */ detector: string; /** * The unique identifier of the detector rule */ detectorRuleId: string; /** * (Updatable) Display name for the target. * * Avoid entering confidential information. */ displayName: string; /** * Data source entities mapping for a detector rule */ entitiesMappings: outputs.CloudGuard.TargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping[]; /** * Is the rule cloneable? */ isCloneable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of managed list types related to this rule */ managedListTypes: string[]; /** * Recommendation for TargetDetectorRecipeDetectorRule resource */ recommendation: string; /** * 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). */ resourceType: string; /** * Rule category type */ ruleTypes: outputs.CloudGuard.TargetTargetDetectorRecipeEffectiveDetectorRuleRuleType[]; /** * Service type of the configuration to which the rule is applied */ serviceType: string; /** * (Updatable) The enablement state of the detector rule */ state: string; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface TargetTargetDetectorRecipeEffectiveDetectorRuleDetail { /** * Condition group corresponding to each compartment */ conditionGroups: outputs.CloudGuard.TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup[]; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration[]; /** * Configuration allowed or not */ isConfigurationAllowed: boolean; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * User-defined labels for a detector rule */ labels: string[]; /** * The risk level of the detector rule */ riskLevel: string; } interface TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup { /** * Compartment OCID where the resource is created */ compartmentId: string; /** * The base condition resource. */ condition: string; } interface TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration { /** * Map of additional property values for configuration */ additionalProperties: outputs.CloudGuard.TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty[]; /** * Map of possible values for configuration */ allowedValues: outputs.CloudGuard.TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue[]; /** * Map property Value data type */ allowedValuesDataType: string; /** * Unique identifier of the configuration */ configKey: string; /** * Configuration data type */ dataType: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; /** * List of configuration values */ values: outputs.CloudGuard.TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue[]; } interface TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty { /** * The unique identifier of the detector rule type */ key: string; /** * Property Type */ propertyType: string; /** * Configuration value */ value: string; } interface TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ value: string; } interface TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue { /** * Configuration list item type (CUSTOM or MANAGED) */ listType: string; /** * Type of content in the managed list */ managedListType: string; /** * Configuration value */ value: string; } interface TargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping { /** * (Updatable) Display name for the target. * * Avoid entering confidential information. */ displayName: string; /** * Type of entity */ entityType: string; /** * The entity value mapped to a data source query */ queryField: string; } interface TargetTargetDetectorRecipeEffectiveDetectorRuleRuleType { /** * The unique identifier of the detector rule type */ key: string; /** * Configuration value */ values: string[]; } interface TargetTargetResponderRecipe { /** * Compartment OCID where the resource is created */ compartmentId: string; /** * The target description. * * Avoid entering confidential information. */ description: string; /** * (Updatable) Display name for the target. * * Avoid entering confidential information. */ displayName: string; /** * List of currently enabled responder rules for the responder type for recipe after applying defaults */ effectiveResponderRules: outputs.CloudGuard.TargetTargetResponderRecipeEffectiveResponderRule[]; /** * Unique identifier of target responder recipe that can't be changed after creation */ id: string; /** * Owner of target responder recipe */ owner: string; /** * Unique identifier for responder recipe */ responderRecipeId: string; /** * (Updatable) List of overrides to be applied to responder rules associated with the target */ responderRules: outputs.CloudGuard.TargetTargetResponderRecipeResponderRule[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; } interface TargetTargetResponderRecipeEffectiveResponderRule { /** * Compartment OCID where the resource is created */ compartmentId: string; /** * The target description. * * Avoid entering confidential information. */ description: string; /** * Detailed information for a responder rule */ details: outputs.CloudGuard.TargetTargetResponderRecipeEffectiveResponderRuleDetail[]; /** * (Updatable) Display name for the target. * * Avoid entering confidential information. */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * Unique identifier for the responder rule */ responderRuleId: string; /** * (Updatable) The enablement state of the detector rule */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface TargetTargetResponderRecipeEffectiveResponderRuleDetail { /** * The base condition resource. */ condition: string; /** * List of responder rule configurations */ configurations: outputs.CloudGuard.TargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * Execution mode for the responder rule */ mode: string; } interface TargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration { /** * Unique identifier of the configuration */ configKey: string; /** * Configuration name */ name: string; /** * Configuration value */ value: string; } interface TargetTargetResponderRecipeResponderRule { /** * Compartment OCID where the resource is created */ compartmentId: string; /** * The target description. * * Avoid entering confidential information. */ description: string; /** * (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. */ details: outputs.CloudGuard.TargetTargetResponderRecipeResponderRuleDetails; /** * (Updatable) Display name for the target. * * Avoid entering confidential information. */ displayName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * List of policies */ policies: string[]; /** * (Updatable) Unique identifier for target detector recipe * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ responderRuleId: string; /** * (Updatable) The enablement state of the detector rule */ state: string; /** * Supported execution modes for the responder rule */ supportedModes: string[]; /** * The date and time the target was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the target was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Type of responder */ type: string; } interface TargetTargetResponderRecipeResponderRuleDetails { /** * (Updatable) The base condition resource. */ condition: string; /** * (Updatable) List of responder rule configurations */ configurations: outputs.CloudGuard.TargetTargetResponderRecipeResponderRuleDetailsConfiguration[]; /** * Enabled state for the responder rule */ isEnabled: boolean; /** * (Updatable) Execution mode for the responder rule */ mode: string; } interface TargetTargetResponderRecipeResponderRuleDetailsConfiguration { /** * (Updatable) Unique identifier of the configuration */ configKey: string; /** * (Updatable) Configuration name */ name: string; /** * (Updatable) Configuration value */ value: string; } } export declare namespace CloudMigrations { interface GetMigrationAssetReplicationLocationDetail { /** * Properties for each of the replication location types */ metadata: { [key: string]: string; }; /** * The type of replication location */ replicationLocationType: string; } interface GetMigrationAssetsFilter { name: string; regex?: boolean; values: string[]; } interface GetMigrationAssetsMigrationAssetCollection { items: outputs.CloudMigrations.GetMigrationAssetsMigrationAssetCollectionItem[]; } interface GetMigrationAssetsMigrationAssetCollectionItem { /** * Availability domain */ availabilityDomain: string; /** * Compartment Identifier */ compartmentId: string; /** * List of migration assets that depend on the asset. */ dependedOnBies: string[]; /** * Mapping of source disk id to destination disk details */ destinationDisks: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * Asset ID generated by mirgration service. It is used in the mirgration service pipeline. */ id: string; inventoryAssetId: string; /** * 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. */ lifecycleDetails: string; migrationAssetDependsOns: string[]; /** * Unique migration identifier */ migrationId: string; /** * List of notifications */ notifications: string[]; /** * The parent snapshot of the migration asset to be used by the replication task. */ parentSnapshot: string; /** * Replication compartment identifier */ replicationCompartmentId: string; /** * Replication location detail where the snapshots reside */ replicationLocationDetails: outputs.CloudMigrations.GetMigrationAssetsMigrationAssetCollectionItemReplicationLocationDetail[]; /** * Replication schedule identifier */ replicationScheduleId: string; /** * Name of snapshot bucket */ snapShotBucketName: string; /** * Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{"bar-key": "value"}` */ snapshots: { [key: string]: string; }; /** * OCID that is referenced to an asset for an inventory. */ sourceAssetId: string; /** * The current state of the migration asset. */ state: string; /** * Tenancy identifier */ tenancyId: string; /** * The time when the migration asset was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the migration asset was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The type of asset referenced for inventory. */ type: string; } interface GetMigrationAssetsMigrationAssetCollectionItemReplicationLocationDetail { /** * Properties for each of the replication location types */ metadata: { [key: string]: string; }; /** * The type of replication location */ replicationLocationType: string; } interface GetMigrationMigrationConfig { /** * The OCID of the subnet to use for replication */ subnetId: string; } interface GetMigrationPlanAvailableShapeItem { /** * The availability domain in which to list resources. */ availabilityDomain: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Description of the GPUs. */ gpuDescription: string; /** * Number of GPUs. */ gpus: number; /** * Description of local disks. */ localDiskDescription: string; /** * Number of local disks. */ localDisks: number; /** * Total size of local disks for shape. */ localDisksTotalSizeInGbs: number; /** * Maximum number of virtual network interfaces that can be attached. */ maxVnicAttachments: number; /** * Amount of memory for the shape. */ memoryInGbs: number; /** * Minimum CPUs required. */ minTotalBaselineOcpusRequired: number; /** * Shape bandwidth. */ networkingBandwidthInGbps: number; /** * Number of CPUs. */ ocpus: number; /** * Shape name and availability domain. Used for pagination. */ paginationToken: string; /** * Description of the processor. */ processorDescription: string; /** * Name of the shape. */ shape: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetMigrationPlanAvailableShapesAvailableShapesCollection { /** * Available shapes list. */ items: outputs.CloudMigrations.GetMigrationPlanAvailableShapesAvailableShapesCollectionItem[]; } interface GetMigrationPlanAvailableShapesAvailableShapesCollectionItem { /** * The availability domain in which to list resources. */ availabilityDomain: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Description of the GPUs. */ gpuDescription: string; /** * Number of GPUs. */ gpus: number; /** * Description of local disks. */ localDiskDescription: string; /** * Number of local disks. */ localDisks: number; /** * Total size of local disks for shape. */ localDisksTotalSizeInGbs: number; /** * Maximum number of virtual network interfaces that can be attached. */ maxVnicAttachments: number; /** * Amount of memory for the shape. */ memoryInGbs: number; /** * Minimum CPUs required. */ minTotalBaselineOcpusRequired: number; /** * Shape bandwidth. */ networkingBandwidthInGbps: number; /** * Number of CPUs. */ ocpus: number; /** * Shape name and availability domain. Used for pagination. */ paginationToken: string; /** * Description of the processor. */ processorDescription: string; /** * Name of the shape. */ shape: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetMigrationPlanAvailableShapesFilter { name: string; regex?: boolean; values: string[]; } interface GetMigrationPlanMigrationPlanStat { /** * Summary of costs to migrate. */ costToMigrates: outputs.CloudMigrations.GetMigrationPlanMigrationPlanStatCostToMigrate[]; /** * Current monthly compute and storage costs. */ currentMonthlyCosts: outputs.CloudMigrations.GetMigrationPlanMigrationPlanStatCurrentMonthlyCost[]; /** * The time when the migration plan was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Cost estimation description */ totalEstimatedCosts: outputs.CloudMigrations.GetMigrationPlanMigrationPlanStatTotalEstimatedCost[]; /** * The total count of VMs in migration */ vmCount: number; } interface GetMigrationPlanMigrationPlanStatCostToMigrate { /** * Number of assets used in this calculation. */ assetCount: number; /** * Currency code in the ISO format. */ currencyCode: string; /** * Data transfer costs from OCI. */ ociDataTransferCosts: number; /** * Data transfer costs from source cloud provider. */ sourceDataTransferCosts: number; } interface GetMigrationPlanMigrationPlanStatCurrentMonthlyCost { /** * Number of assets used in this calculation. */ assetCount: number; /** * Current monthly compute costs. */ computeAmount: number; /** * Currency code in the ISO format. */ currencyCode: string; /** * Current monthly storage costs. */ storageAmount: number; } interface GetMigrationPlanMigrationPlanStatTotalEstimatedCost { /** * Cost estimation for compute */ computes: outputs.CloudMigrations.GetMigrationPlanMigrationPlanStatTotalEstimatedCostCompute[]; /** * Currency code in the ISO format. */ currencyCode: string; /** * Cost estimation for the OS image. */ osImages: outputs.CloudMigrations.GetMigrationPlanMigrationPlanStatTotalEstimatedCostOsImage[]; /** * Cost estimation for storage */ storages: outputs.CloudMigrations.GetMigrationPlanMigrationPlanStatTotalEstimatedCostStorage[]; /** * Subscription ID */ subscriptionId: string; /** * Total estimation per month */ totalEstimationPerMonth: number; /** * Total estimation per month by subscription. */ totalEstimationPerMonthBySubscription: number; } interface GetMigrationPlanMigrationPlanStatTotalEstimatedCostCompute { /** * Total number of GPU */ gpuCount: number; /** * GPU per hour */ gpuPerHour: number; /** * GPU per hour by subscription */ gpuPerHourBySubscription: number; /** * Total usage of memory */ memoryAmountGb: number; /** * Gigabyte per hour */ memoryGbPerHour: number; /** * Gigabyte per hour by subscription */ memoryGbPerHourBySubscription: number; /** * Total number of OCPUs */ ocpuCount: number; /** * OCPU per hour */ ocpuPerHour: number; /** * OCPU per hour by subscription */ ocpuPerHourBySubscription: number; /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface GetMigrationPlanMigrationPlanStatTotalEstimatedCostOsImage { /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface GetMigrationPlanMigrationPlanStatTotalEstimatedCostStorage { /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; /** * Volume estimation */ volumes: outputs.CloudMigrations.GetMigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume[]; } interface GetMigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume { /** * Gigabyte storage capacity */ capacityGb: number; /** * Volume description */ description: string; /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; } interface GetMigrationPlanStrategy { /** * The real resource usage is multiplied to this number before making any recommendation. */ adjustmentMultiplier: number; /** * The current state of the migration plan. */ metricTimeWindow: string; /** * The current state of the migration plan. */ metricType: string; /** * Percentile value */ percentile: string; /** * The type of resource. */ resourceType: string; /** * The type of strategy used for migration. */ strategyType: string; } interface GetMigrationPlanTargetEnvironment { /** * Availability Domain of the VM configuration. */ availabilityDomain: string; /** * Inventory asset id of the olvm cluster */ clusterAssetId: string; /** * OCID of the dedicated VM configuration host. */ dedicatedVmHost: string; /** * Fault domain of the VM configuration. */ faultDomain: string; /** * Microsoft license for the VM configuration. */ msLicense: string; /** * OLVM OS type to inventory asset id of the template */ olvmTemplates: { [key: string]: string; }; /** * Preferred VM shape type provided by the customer. */ preferredShapeType: string; /** * OCID of the VM configuration subnet. */ subnet: string; /** * Target compartment identifier */ targetCompartmentId: string; /** * The type of target environment. */ targetEnvironmentType: string; /** * OCID of the VM configuration VCN. */ vcn: string; /** * Inventory asset Id of the vnic profile */ vnicProfileAssetId: string; } interface GetMigrationPlansFilter { name: string; regex?: boolean; values: string[]; } interface GetMigrationPlansMigrationPlanCollection { items: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItem[]; } interface GetMigrationPlansMigrationPlanCollectionItem { /** * Limits of the resources that are needed for migration. Example: {"BlockVolume": 2, "VCN": 1} */ calculatedLimits: { [key: string]: string; }; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The unique Oracle ID (OCID) that is immutable on creation. */ id: string; /** * 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. */ lifecycleDetails: string; /** * Unique migration identifier */ migrationId: string; /** * Status of the migration plan. */ migrationPlanStats: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStat[]; /** * OCID of the referenced ORM job. */ referenceToRmsStack: string; /** * Source migraiton plan ID to be cloned. */ sourceMigrationPlanId: string; /** * The current state of the migration plan. */ state: string; /** * List of strategies for the resources to be migrated. */ strategies: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItemStrategy[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * List of target environments. */ targetEnvironments: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItemTargetEnvironment[]; /** * The time when the migration plan was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the migration plan was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStat { /** * Summary of costs to migrate. */ costToMigrates: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCostToMigrate[]; /** * Current monthly compute and storage costs. */ currentMonthlyCosts: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCurrentMonthlyCost[]; /** * The time when the migration plan was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Cost estimation description */ totalEstimatedCosts: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCost[]; /** * The total count of VMs in migration */ vmCount: number; } interface GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCostToMigrate { /** * Number of assets used in this calculation. */ assetCount: number; /** * Currency code in the ISO format. */ currencyCode: string; /** * Data transfer costs from OCI. */ ociDataTransferCosts: number; /** * Data transfer costs from source cloud provider. */ sourceDataTransferCosts: number; } interface GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCurrentMonthlyCost { /** * Number of assets used in this calculation. */ assetCount: number; /** * Current monthly compute costs. */ computeAmount: number; /** * Currency code in the ISO format. */ currencyCode: string; /** * Current monthly storage costs. */ storageAmount: number; } interface GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCost { /** * Cost estimation for compute */ computes: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostCompute[]; /** * Currency code in the ISO format. */ currencyCode: string; /** * Cost estimation for the OS image. */ osImages: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostOsImage[]; /** * Cost estimation for storage */ storages: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorage[]; /** * Subscription ID */ subscriptionId: string; /** * Total estimation per month */ totalEstimationPerMonth: number; /** * Total estimation per month by subscription. */ totalEstimationPerMonthBySubscription: number; } interface GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostCompute { /** * Total number of GPU */ gpuCount: number; /** * GPU per hour */ gpuPerHour: number; /** * GPU per hour by subscription */ gpuPerHourBySubscription: number; /** * Total usage of memory */ memoryAmountGb: number; /** * Gigabyte per hour */ memoryGbPerHour: number; /** * Gigabyte per hour by subscription */ memoryGbPerHourBySubscription: number; /** * Total number of OCPUs */ ocpuCount: number; /** * OCPU per hour */ ocpuPerHour: number; /** * OCPU per hour by subscription */ ocpuPerHourBySubscription: number; /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostOsImage { /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorage { /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; /** * Volume estimation */ volumes: outputs.CloudMigrations.GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorageVolume[]; } interface GetMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorageVolume { /** * Gigabyte storage capacity */ capacityGb: number; /** * Volume description */ description: string; /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; } interface GetMigrationPlansMigrationPlanCollectionItemStrategy { /** * The real resource usage is multiplied to this number before making any recommendation. */ adjustmentMultiplier: number; /** * The current state of the migration plan. */ metricTimeWindow: string; /** * The current state of the migration plan. */ metricType: string; /** * Percentile value */ percentile: string; /** * The type of resource. */ resourceType: string; /** * The type of strategy used for migration. */ strategyType: string; } interface GetMigrationPlansMigrationPlanCollectionItemTargetEnvironment { /** * Availability Domain of the VM configuration. */ availabilityDomain: string; /** * Inventory asset id of the olvm cluster */ clusterAssetId: string; /** * OCID of the dedicated VM configuration host. */ dedicatedVmHost: string; /** * Fault domain of the VM configuration. */ faultDomain: string; /** * Microsoft license for the VM configuration. */ msLicense: string; /** * OLVM OS type to inventory asset id of the template */ olvmTemplates: { [key: string]: string; }; /** * Preferred VM shape type provided by the customer. */ preferredShapeType: string; /** * OCID of the VM configuration subnet. */ subnet: string; /** * Target compartment identifier */ targetCompartmentId: string; /** * The type of target environment. */ targetEnvironmentType: string; /** * OCID of the VM configuration VCN. */ vcn: string; /** * Inventory asset Id of the vnic profile */ vnicProfileAssetId: string; } interface GetMigrationsFilter { name: string; regex?: boolean; values: string[]; } interface GetMigrationsMigrationCollection { items: outputs.CloudMigrations.GetMigrationsMigrationCollectionItem[]; } interface GetMigrationsMigrationCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation */ id: string; /** * Indicates whether migration is marked as completed. */ isCompleted: boolean; /** * 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. */ lifecycleDetails: string; /** * Configuration for a Migration Project. */ migrationConfigs: outputs.CloudMigrations.GetMigrationsMigrationCollectionItemMigrationConfig[]; /** * Type of migration project (OCI/OLVM). This determines the target environment for the migration. */ migrationType: string; /** * Replication schedule identifier */ replicationScheduleId: string; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * A filter to return only resources where the resource's lifecycle state matches the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the migration project was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time when the migration project was updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetMigrationsMigrationCollectionItemMigrationConfig { /** * The OCID of the subnet to use for replication */ subnetId: string; } interface GetReplicationSchedulesFilter { name: string; regex?: boolean; values: string[]; } interface GetReplicationSchedulesReplicationScheduleCollection { items: outputs.CloudMigrations.GetReplicationSchedulesReplicationScheduleCollectionItem[]; } interface GetReplicationSchedulesReplicationScheduleCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * Recurrence specification for the replication schedule execution. */ executionRecurrences: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication schedule. */ id: string; /** * The detailed state of the replication schedule. */ lifecycleDetails: string; /** * The current state of the replication schedule. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the replication schedule was created in RFC3339 format. */ timeCreated: string; /** * The time when the replication schedule was last updated in RFC3339 format. */ timeUpdated: string; } interface GetTargetAssetCompatibilityMessage { /** * Detailed description of the compatibility issue. */ message: string; /** * 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). */ name: string; /** * Severity level of the compatibility issue. */ severity: string; } interface GetTargetAssetEstimatedCost { /** * Cost estimation for compute */ computes: outputs.CloudMigrations.GetTargetAssetEstimatedCostCompute[]; /** * Currency code in the ISO format. */ currencyCode: string; /** * Cost estimation for the OS image. */ osImages: outputs.CloudMigrations.GetTargetAssetEstimatedCostOsImage[]; /** * Cost estimation for storage */ storages: outputs.CloudMigrations.GetTargetAssetEstimatedCostStorage[]; /** * Subscription ID */ subscriptionId: string; /** * Total estimation per month */ totalEstimationPerMonth: number; /** * Total estimation per month by subscription. */ totalEstimationPerMonthBySubscription: number; } interface GetTargetAssetEstimatedCostCompute { /** * Total number of GPU */ gpuCount: number; /** * GPU per hour */ gpuPerHour: number; /** * GPU per hour by subscription */ gpuPerHourBySubscription: number; /** * Total usage of memory */ memoryAmountGb: number; /** * Gigabyte per hour */ memoryGbPerHour: number; /** * Gigabyte per hour by subscription */ memoryGbPerHourBySubscription: number; /** * Total number of OCPUs */ ocpuCount: number; /** * OCPU per hour */ ocpuPerHour: number; /** * OCPU per hour by subscription */ ocpuPerHourBySubscription: number; /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface GetTargetAssetEstimatedCostOsImage { /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface GetTargetAssetEstimatedCostStorage { /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; /** * Volume estimation */ volumes: outputs.CloudMigrations.GetTargetAssetEstimatedCostStorageVolume[]; } interface GetTargetAssetEstimatedCostStorageVolume { /** * Gigabyte storage capacity */ capacityGb: number; /** * Volume description */ description: string; /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; } interface GetTargetAssetMigrationAsset { /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compartment. */ compartmentId: string; /** * List of migration assets that depend on the asset. */ dependedOnBies: string[]; /** * List of migration assets that depends on the asset. */ dependsOns: string[]; /** * Mapping of source disk id to destination disk details */ destinationDisks: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Asset ID generated by mirgration service. It is used in the mirgration service pipeline. */ id: string; /** * 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. */ lifecycleDetails: string; /** * OCID of the associated migration. */ migrationId: string; /** * List of notifications */ notifications: string[]; /** * The parent snapshot of the migration asset to be used by the replication task. */ parentSnapshot: string; /** * Replication compartment identifier */ replicationCompartmentId: string; /** * Replication location detail where the snapshots reside */ replicationLocationDetails: outputs.CloudMigrations.GetTargetAssetMigrationAssetReplicationLocationDetail[]; /** * Replication schedule identifier */ replicationScheduleId: string; /** * Name of snapshot bucket */ snapShotBucketName: string; /** * Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{"bar-key": "value"}` */ snapshots: { [key: string]: string; }; /** * Key-value pair representing asset metadata keys and values scoped to a namespace. Example: `{"bar-key": "value"}` */ sourceAssetData: { [key: string]: string; }; /** * OCID that is referenced to an asset for an inventory. */ sourceAssetId: string; /** * The current state of the target asset. */ state: string; /** * Tenancy identifier */ tenancyId: string; /** * The time when the target asset was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the target asset was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetTargetAssetMigrationAssetReplicationLocationDetail { /** * Properties for each of the replication location types */ metadata: { [key: string]: string; }; /** * The type of replication location */ replicationLocationType: string; } interface GetTargetAssetRecommendedSpec { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.CloudMigrations.GetTargetAssetRecommendedSpecAgentConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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). */ capacityReservationId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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). */ createVnicDetails: outputs.CloudMigrations.GetTargetAssetRecommendedSpecCreateVnicDetail[]; /** * The OCID of the dedicated VM host. */ dedicatedVmHostId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * Optional mutable instance options */ instanceOptions: outputs.CloudMigrations.GetTargetAssetRecommendedSpecInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * 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. */ isPvEncryptionInTransitEnabled: boolean; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.CloudMigrations.GetTargetAssetRecommendedSpecPreemptibleInstanceConfig[]; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.CloudMigrations.GetTargetAssetRecommendedSpecShapeConfig[]; sourceDetails: outputs.CloudMigrations.GetTargetAssetRecommendedSpecSourceDetail[]; } interface GetTargetAssetRecommendedSpecAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * 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). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.CloudMigrations.GetTargetAssetRecommendedSpecAgentConfigPluginsConfig[]; } interface GetTargetAssetRecommendedSpecAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetTargetAssetRecommendedSpecCreateVnicDetail { /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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/). */ nsgIds: string[]; /** * 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). */ privateIp: string; /** * Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). */ skipSourceDestCheck: boolean; /** * 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. */ subnetId: string; /** * 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). */ vlanId: string; } interface GetTargetAssetRecommendedSpecInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetTargetAssetRecommendedSpecPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.CloudMigrations.GetTargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction[]; } interface GetTargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetTargetAssetRecommendedSpecShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * The total amount of memory in gigabytes that is available to the instance. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; } interface GetTargetAssetRecommendedSpecSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * The OCID of the key management key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetTargetAssetTestSpec { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.CloudMigrations.GetTargetAssetTestSpecAgentConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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). */ capacityReservationId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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). */ createVnicDetails: outputs.CloudMigrations.GetTargetAssetTestSpecCreateVnicDetail[]; /** * The OCID of the dedicated VM host. */ dedicatedVmHostId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * Optional mutable instance options */ instanceOptions: outputs.CloudMigrations.GetTargetAssetTestSpecInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * 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. */ isPvEncryptionInTransitEnabled: boolean; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.CloudMigrations.GetTargetAssetTestSpecPreemptibleInstanceConfig[]; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.CloudMigrations.GetTargetAssetTestSpecShapeConfig[]; sourceDetails: outputs.CloudMigrations.GetTargetAssetTestSpecSourceDetail[]; } interface GetTargetAssetTestSpecAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * 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). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.CloudMigrations.GetTargetAssetTestSpecAgentConfigPluginsConfig[]; } interface GetTargetAssetTestSpecAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetTargetAssetTestSpecCreateVnicDetail { /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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/). */ nsgIds: string[]; /** * 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). */ privateIp: string; /** * Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). */ skipSourceDestCheck: boolean; /** * 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. */ subnetId: string; /** * 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). */ vlanId: string; } interface GetTargetAssetTestSpecInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetTargetAssetTestSpecPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.CloudMigrations.GetTargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction[]; } interface GetTargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetTargetAssetTestSpecShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * The total amount of memory in gigabytes that is available to the instance. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; } interface GetTargetAssetTestSpecSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * The OCID of the key management key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetTargetAssetUserSpec { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.CloudMigrations.GetTargetAssetUserSpecAgentConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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). */ capacityReservationId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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). */ createVnicDetails: outputs.CloudMigrations.GetTargetAssetUserSpecCreateVnicDetail[]; /** * The OCID of the dedicated VM host. */ dedicatedVmHostId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * Optional mutable instance options */ instanceOptions: outputs.CloudMigrations.GetTargetAssetUserSpecInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * 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. */ isPvEncryptionInTransitEnabled: boolean; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.CloudMigrations.GetTargetAssetUserSpecPreemptibleInstanceConfig[]; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.CloudMigrations.GetTargetAssetUserSpecShapeConfig[]; sourceDetails: outputs.CloudMigrations.GetTargetAssetUserSpecSourceDetail[]; } interface GetTargetAssetUserSpecAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * 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). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.CloudMigrations.GetTargetAssetUserSpecAgentConfigPluginsConfig[]; } interface GetTargetAssetUserSpecAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetTargetAssetUserSpecCreateVnicDetail { /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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/). */ nsgIds: string[]; /** * 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). */ privateIp: string; /** * Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). */ skipSourceDestCheck: boolean; /** * 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. */ subnetId: string; /** * 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). */ vlanId: string; } interface GetTargetAssetUserSpecInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetTargetAssetUserSpecPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.CloudMigrations.GetTargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction[]; } interface GetTargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetTargetAssetUserSpecShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * The total amount of memory in gigabytes that is available to the instance. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; } interface GetTargetAssetUserSpecSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * The OCID of the key management key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetTargetAssetsFilter { /** * 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). */ name: string; regex?: boolean; values: string[]; } interface GetTargetAssetsTargetAssetCollection { items: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItem[]; } interface GetTargetAssetsTargetAssetCollectionItem { /** * Performance of the block volumes. */ blockVolumesPerformance: number; /** * The OCID of the compartment. */ compartmentId: string; /** * Messages about the compatibility issues. */ compatibilityMessages: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemCompatibilityMessage[]; /** * Created resource identifier */ createdResourceId: string; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * Cost estimation description */ estimatedCosts: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemEstimatedCost[]; /** * Asset ID generated by mirgration service. It is used in the mirgration service pipeline. */ id: string; /** * A boolean indicating whether the asset should be migrated. */ isExcludedFromExecution: boolean; /** * 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. */ lifecycleDetails: string; /** * Description of the migration asset. */ migrationAssets: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemMigrationAsset[]; /** * Unique migration plan identifier */ migrationPlanId: string; /** * Microsoft license for VM configuration. */ msLicense: string; /** * Preferred VM shape type that you provide. */ preferredShapeType: string; /** * Instance launch details. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance. */ recommendedSpecs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemRecommendedSpec[]; /** * The current state of the target asset. */ state: string; /** * Instance launch details. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance. */ testSpecs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemTestSpec[]; /** * The time when the assessment was done. An RFC3339 formatted datetime string. */ timeAssessed: string; /** * The time when the target asset was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the target asset was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; /** * Instance launch details. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance. */ userSpecs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemUserSpec[]; } interface GetTargetAssetsTargetAssetCollectionItemCompatibilityMessage { /** * Detailed description of the compatibility issue. */ message: string; /** * 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). */ name: string; /** * Severity level of the compatibility issue. */ severity: string; } interface GetTargetAssetsTargetAssetCollectionItemEstimatedCost { /** * Cost estimation for compute */ computes: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemEstimatedCostCompute[]; /** * Currency code in the ISO format. */ currencyCode: string; /** * Cost estimation for the OS image. */ osImages: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemEstimatedCostOsImage[]; /** * Cost estimation for storage */ storages: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemEstimatedCostStorage[]; /** * Subscription ID */ subscriptionId: string; /** * Total estimation per month */ totalEstimationPerMonth: number; /** * Total estimation per month by subscription. */ totalEstimationPerMonthBySubscription: number; } interface GetTargetAssetsTargetAssetCollectionItemEstimatedCostCompute { /** * Total number of GPU */ gpuCount: number; /** * GPU per hour */ gpuPerHour: number; /** * GPU per hour by subscription */ gpuPerHourBySubscription: number; /** * Total usage of memory */ memoryAmountGb: number; /** * Gigabyte per hour */ memoryGbPerHour: number; /** * Gigabyte per hour by subscription */ memoryGbPerHourBySubscription: number; /** * Total number of OCPUs */ ocpuCount: number; /** * OCPU per hour */ ocpuPerHour: number; /** * OCPU per hour by subscription */ ocpuPerHourBySubscription: number; /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface GetTargetAssetsTargetAssetCollectionItemEstimatedCostOsImage { /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface GetTargetAssetsTargetAssetCollectionItemEstimatedCostStorage { /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; /** * Volume estimation */ volumes: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemEstimatedCostStorageVolume[]; } interface GetTargetAssetsTargetAssetCollectionItemEstimatedCostStorageVolume { /** * Gigabyte storage capacity */ capacityGb: number; /** * Volume description */ description: string; /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; } interface GetTargetAssetsTargetAssetCollectionItemMigrationAsset { /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compartment. */ compartmentId: string; /** * List of migration assets that depend on the asset. */ dependedOnBies: string[]; /** * List of migration assets that depends on the asset. */ dependsOns: string[]; /** * Mapping of source disk id to destination disk details */ destinationDisks: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * Asset ID generated by mirgration service. It is used in the mirgration service pipeline. */ id: string; /** * 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. */ lifecycleDetails: string; /** * OCID of the associated migration. */ migrationId: string; /** * List of notifications */ notifications: string[]; /** * The parent snapshot of the migration asset to be used by the replication task. */ parentSnapshot: string; /** * Replication compartment identifier */ replicationCompartmentId: string; /** * Replication location detail where the snapshots reside */ replicationLocationDetails: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemMigrationAssetReplicationLocationDetail[]; /** * Replication schedule identifier */ replicationScheduleId: string; /** * Name of snapshot bucket */ snapShotBucketName: string; /** * Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{"bar-key": "value"}` */ snapshots: { [key: string]: string; }; /** * Key-value pair representing asset metadata keys and values scoped to a namespace. Example: `{"bar-key": "value"}` */ sourceAssetData: { [key: string]: string; }; /** * OCID that is referenced to an asset for an inventory. */ sourceAssetId: string; /** * The current state of the target asset. */ state: string; /** * Tenancy identifier */ tenancyId: string; /** * The time when the target asset was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the target asset was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetTargetAssetsTargetAssetCollectionItemMigrationAssetReplicationLocationDetail { /** * Properties for each of the replication location types */ metadata: { [key: string]: string; }; /** * The type of replication location */ replicationLocationType: string; } interface GetTargetAssetsTargetAssetCollectionItemRecommendedSpec { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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). */ capacityReservationId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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). */ createVnicDetails: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemRecommendedSpecCreateVnicDetail[]; /** * The OCID of the dedicated VM host. */ dedicatedVmHostId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * 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. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * Optional mutable instance options */ instanceOptions: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemRecommendedSpecInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * 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. */ isPvEncryptionInTransitEnabled: boolean; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfig[]; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemRecommendedSpecShapeConfig[]; sourceDetails: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemRecommendedSpecSourceDetail[]; } interface GetTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * 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). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfigPluginsConfig[]; } interface GetTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetTargetAssetsTargetAssetCollectionItemRecommendedSpecCreateVnicDetail { /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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/). */ nsgIds: string[]; /** * 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). */ privateIp: string; /** * Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). */ skipSourceDestCheck: boolean; /** * 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. */ subnetId: string; /** * 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). */ vlanId: string; } interface GetTargetAssetsTargetAssetCollectionItemRecommendedSpecInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfigPreemptionAction[]; } interface GetTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetTargetAssetsTargetAssetCollectionItemRecommendedSpecShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * The total amount of memory in gigabytes that is available to the instance. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; } interface GetTargetAssetsTargetAssetCollectionItemRecommendedSpecSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * The OCID of the key management key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetTargetAssetsTargetAssetCollectionItemTestSpec { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemTestSpecAgentConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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). */ capacityReservationId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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). */ createVnicDetails: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemTestSpecCreateVnicDetail[]; /** * The OCID of the dedicated VM host. */ dedicatedVmHostId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * 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. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * Optional mutable instance options */ instanceOptions: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemTestSpecInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * 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. */ isPvEncryptionInTransitEnabled: boolean; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfig[]; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemTestSpecShapeConfig[]; sourceDetails: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemTestSpecSourceDetail[]; } interface GetTargetAssetsTargetAssetCollectionItemTestSpecAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * 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). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemTestSpecAgentConfigPluginsConfig[]; } interface GetTargetAssetsTargetAssetCollectionItemTestSpecAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetTargetAssetsTargetAssetCollectionItemTestSpecCreateVnicDetail { /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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/). */ nsgIds: string[]; /** * 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). */ privateIp: string; /** * Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). */ skipSourceDestCheck: boolean; /** * 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. */ subnetId: string; /** * 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). */ vlanId: string; } interface GetTargetAssetsTargetAssetCollectionItemTestSpecInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfigPreemptionAction[]; } interface GetTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetTargetAssetsTargetAssetCollectionItemTestSpecShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * The total amount of memory in gigabytes that is available to the instance. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; } interface GetTargetAssetsTargetAssetCollectionItemTestSpecSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * The OCID of the key management key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetTargetAssetsTargetAssetCollectionItemUserSpec { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemUserSpecAgentConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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). */ capacityReservationId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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). */ createVnicDetails: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemUserSpecCreateVnicDetail[]; /** * The OCID of the dedicated VM host. */ dedicatedVmHostId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * 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. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * Optional mutable instance options */ instanceOptions: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemUserSpecInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * 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. */ isPvEncryptionInTransitEnabled: boolean; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfig[]; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemUserSpecShapeConfig[]; sourceDetails: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemUserSpecSourceDetail[]; } interface GetTargetAssetsTargetAssetCollectionItemUserSpecAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * 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). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemUserSpecAgentConfigPluginsConfig[]; } interface GetTargetAssetsTargetAssetCollectionItemUserSpecAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetTargetAssetsTargetAssetCollectionItemUserSpecCreateVnicDetail { /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire given display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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/). */ nsgIds: string[]; /** * 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). */ privateIp: string; /** * Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). */ skipSourceDestCheck: boolean; /** * 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. */ subnetId: string; /** * 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). */ vlanId: string; } interface GetTargetAssetsTargetAssetCollectionItemUserSpecInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.CloudMigrations.GetTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfigPreemptionAction[]; } interface GetTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetTargetAssetsTargetAssetCollectionItemUserSpecShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * The total amount of memory in gigabytes that is available to the instance. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; } interface GetTargetAssetsTargetAssetCollectionItemUserSpecSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * The OCID of the key management key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface MigrationAssetReplicationLocationDetail { /** * Properties for each of the replication location types */ metadata: { [key: string]: string; }; /** * The type of replication location */ replicationLocationType: string; } interface MigrationMigrationConfig { /** * (Updatable) The OCID of the subnet to use for replication */ subnetId: string; } interface MigrationPlanMigrationPlanStat { /** * Summary of costs to migrate. */ costToMigrates: outputs.CloudMigrations.MigrationPlanMigrationPlanStatCostToMigrate[]; /** * Current monthly compute and storage costs. */ currentMonthlyCosts: outputs.CloudMigrations.MigrationPlanMigrationPlanStatCurrentMonthlyCost[]; /** * The time when the migration plan was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Cost estimation description */ totalEstimatedCosts: outputs.CloudMigrations.MigrationPlanMigrationPlanStatTotalEstimatedCost[]; /** * The total count of VMs in migration */ vmCount: number; } interface MigrationPlanMigrationPlanStatCostToMigrate { /** * Number of assets used in this calculation. */ assetCount: number; /** * Currency code in the ISO format. */ currencyCode: string; /** * Data transfer costs from OCI. */ ociDataTransferCosts: number; /** * Data transfer costs from source cloud provider. */ sourceDataTransferCosts: number; } interface MigrationPlanMigrationPlanStatCurrentMonthlyCost { /** * Number of assets used in this calculation. */ assetCount: number; /** * Current monthly compute costs. */ computeAmount: number; /** * Currency code in the ISO format. */ currencyCode: string; /** * Current monthly storage costs. */ storageAmount: number; } interface MigrationPlanMigrationPlanStatTotalEstimatedCost { /** * Cost estimation for compute */ computes: outputs.CloudMigrations.MigrationPlanMigrationPlanStatTotalEstimatedCostCompute[]; /** * Currency code in the ISO format. */ currencyCode: string; /** * Cost estimation for the OS image. */ osImages: outputs.CloudMigrations.MigrationPlanMigrationPlanStatTotalEstimatedCostOsImage[]; /** * Cost estimation for storage */ storages: outputs.CloudMigrations.MigrationPlanMigrationPlanStatTotalEstimatedCostStorage[]; /** * Subscription ID */ subscriptionId: string; /** * Total estimation per month */ totalEstimationPerMonth: number; /** * Total estimation per month by subscription. */ totalEstimationPerMonthBySubscription: number; } interface MigrationPlanMigrationPlanStatTotalEstimatedCostCompute { /** * Total number of GPU */ gpuCount: number; /** * GPU per hour */ gpuPerHour: number; /** * GPU per hour by subscription */ gpuPerHourBySubscription: number; /** * Total usage of memory */ memoryAmountGb: number; /** * Gigabyte per hour */ memoryGbPerHour: number; /** * Gigabyte per hour by subscription */ memoryGbPerHourBySubscription: number; /** * Total number of OCPUs */ ocpuCount: number; /** * OCPU per hour */ ocpuPerHour: number; /** * OCPU per hour by subscription */ ocpuPerHourBySubscription: number; /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface MigrationPlanMigrationPlanStatTotalEstimatedCostOsImage { /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface MigrationPlanMigrationPlanStatTotalEstimatedCostStorage { /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; /** * Volume estimation */ volumes: outputs.CloudMigrations.MigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume[]; } interface MigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume { /** * Gigabyte storage capacity */ capacityGb: number; /** * Volume description */ description: string; /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; } interface MigrationPlanStrategy { /** * (Updatable) The real resource usage is multiplied to this number before making any recommendation. */ adjustmentMultiplier: number; /** * (Updatable) The current state of the migration plan. */ metricTimeWindow: string; /** * (Updatable) The current state of the migration plan. */ metricType: string; /** * (Updatable) Percentile value */ percentile: string; /** * (Updatable) The type of resource. */ resourceType: string; /** * (Updatable) The type of strategy used for migration. */ strategyType: string; } interface MigrationPlanTargetEnvironment { /** * (Updatable) Availability Domain of the VM configuration. */ availabilityDomain: string; /** * (Updatable) Inventory asset id of the olvm cluster */ clusterAssetId: string; /** * (Updatable) OCID of the dedicated VM configuration host. */ dedicatedVmHost: string; /** * (Updatable) Fault domain of the VM configuration. */ faultDomain: string; /** * (Updatable) Microsoft license for the VM configuration. */ msLicense: string; /** * (Updatable) OLVM OS type to inventory asset id of the template */ olvmTemplates: { [key: string]: string; }; /** * (Updatable) Preferred VM shape type provided by the customer. */ preferredShapeType: string; /** * (Updatable) OCID of the VM configuration subnet. */ subnet: string; /** * (Updatable) Target compartment identifier */ targetCompartmentId: string; /** * (Updatable) The type of target environment. */ targetEnvironmentType: string; /** * (Updatable) OCID of the VM configuration VCN. */ vcn: string; /** * (Updatable) Inventory asset Id of the vnic profile * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vnicProfileAssetId: string; } interface TargetAssetCompatibilityMessage { /** * Detailed description of the compatibility issue. */ message: string; /** * 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). */ name: string; /** * Severity level of the compatibility issue. */ severity: string; } interface TargetAssetEstimatedCost { /** * Cost estimation for compute */ computes: outputs.CloudMigrations.TargetAssetEstimatedCostCompute[]; /** * Currency code in the ISO format. */ currencyCode: string; /** * Cost estimation for the OS image. */ osImages: outputs.CloudMigrations.TargetAssetEstimatedCostOsImage[]; /** * Cost estimation for storage */ storages: outputs.CloudMigrations.TargetAssetEstimatedCostStorage[]; /** * Subscription ID */ subscriptionId: string; /** * Total estimation per month */ totalEstimationPerMonth: number; /** * Total estimation per month by subscription. */ totalEstimationPerMonthBySubscription: number; } interface TargetAssetEstimatedCostCompute { /** * Total number of GPU */ gpuCount: number; /** * GPU per hour */ gpuPerHour: number; /** * GPU per hour by subscription */ gpuPerHourBySubscription: number; /** * Total usage of memory */ memoryAmountGb: number; /** * Gigabyte per hour */ memoryGbPerHour: number; /** * Gigabyte per hour by subscription */ memoryGbPerHourBySubscription: number; /** * Total number of OCPUs */ ocpuCount: number; /** * OCPU per hour */ ocpuPerHour: number; /** * OCPU per hour by subscription */ ocpuPerHourBySubscription: number; /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface TargetAssetEstimatedCostOsImage { /** * Total price per hour */ totalPerHour: number; /** * Total price per hour by subscription */ totalPerHourBySubscription: number; } interface TargetAssetEstimatedCostStorage { /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; /** * Volume estimation */ volumes: outputs.CloudMigrations.TargetAssetEstimatedCostStorageVolume[]; } interface TargetAssetEstimatedCostStorageVolume { /** * Gigabyte storage capacity */ capacityGb: number; /** * Volume description */ description: string; /** * Gigabyte storage capacity per month. */ totalGbPerMonth: number; /** * Gigabyte storage capacity per month by subscription */ totalGbPerMonthBySubscription: number; } interface TargetAssetMigrationAsset { /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compartment. */ compartmentId: string; /** * List of migration assets that depend on the asset. */ dependedOnBies: string[]; /** * List of migration assets that depends on the asset. */ dependsOns: string[]; /** * Mapping of source disk id to destination disk details */ destinationDisks: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Asset ID generated by mirgration service. It is used in the mirgration service pipeline. */ id: string; /** * 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. */ lifecycleDetails: string; /** * OCID of the associated migration. */ migrationId: string; /** * List of notifications */ notifications: string[]; /** * The parent snapshot of the migration asset to be used by the replication task. */ parentSnapshot: string; /** * Replication compartment identifier */ replicationCompartmentId: string; /** * Replication location detail where the snapshots reside */ replicationLocationDetail: outputs.CloudMigrations.TargetAssetMigrationAssetReplicationLocationDetail; /** * Replication schedule identifier */ replicationScheduleId: string; /** * Name of snapshot bucket */ snapShotBucketName: string; /** * Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{"bar-key": "value"}` */ snapshots: { [key: string]: string; }; /** * Key-value pair representing asset metadata keys and values scoped to a namespace. Example: `{"bar-key": "value"}` */ sourceAssetData: { [key: string]: string; }; /** * OCID that is referenced to an asset for an inventory. */ sourceAssetId: string; /** * The current state of the target asset. */ state: string; /** * Tenancy identifier */ tenancyId: string; /** * The time when the target asset was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the target asset was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * (Updatable) The type of target asset. */ type: string; } interface TargetAssetMigrationAssetReplicationLocationDetail { /** * Properties for each of the replication location types */ metadata: { [key: string]: string; }; /** * The type of replication location */ replicationLocationType: string; } interface TargetAssetRecommendedSpec { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.CloudMigrations.TargetAssetRecommendedSpecAgentConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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). */ capacityReservationId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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). */ createVnicDetails: outputs.CloudMigrations.TargetAssetRecommendedSpecCreateVnicDetail[]; /** * The OCID of the dedicated VM host. */ dedicatedVmHostId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * Optional mutable instance options */ instanceOptions: outputs.CloudMigrations.TargetAssetRecommendedSpecInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * 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. */ isPvEncryptionInTransitEnabled: boolean; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.CloudMigrations.TargetAssetRecommendedSpecPreemptibleInstanceConfig[]; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.CloudMigrations.TargetAssetRecommendedSpecShapeConfig[]; /** * (Updatable) */ sourceDetails: outputs.CloudMigrations.TargetAssetRecommendedSpecSourceDetail[]; } interface TargetAssetRecommendedSpecAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * 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). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.CloudMigrations.TargetAssetRecommendedSpecAgentConfigPluginsConfig[]; } interface TargetAssetRecommendedSpecAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface TargetAssetRecommendedSpecCreateVnicDetail { /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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/). */ nsgIds: string[]; /** * 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). */ privateIp: string; /** * Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). */ skipSourceDestCheck: boolean; /** * 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. */ subnetId: string; /** * 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). */ vlanId: string; } interface TargetAssetRecommendedSpecInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface TargetAssetRecommendedSpecPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.CloudMigrations.TargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction[]; } interface TargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * (Updatable) The type of target asset. */ type: string; } interface TargetAssetRecommendedSpecShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * The total amount of memory in gigabytes that is available to the instance. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; } interface TargetAssetRecommendedSpecSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * The OCID of the key management key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface TargetAssetTestSpec { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.CloudMigrations.TargetAssetTestSpecAgentConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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). */ capacityReservationId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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). */ createVnicDetails: outputs.CloudMigrations.TargetAssetTestSpecCreateVnicDetail[]; /** * The OCID of the dedicated VM host. */ dedicatedVmHostId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * Optional mutable instance options */ instanceOptions: outputs.CloudMigrations.TargetAssetTestSpecInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * 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. */ isPvEncryptionInTransitEnabled: boolean; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.CloudMigrations.TargetAssetTestSpecPreemptibleInstanceConfig[]; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.CloudMigrations.TargetAssetTestSpecShapeConfig[]; /** * (Updatable) */ sourceDetails: outputs.CloudMigrations.TargetAssetTestSpecSourceDetail[]; } interface TargetAssetTestSpecAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * 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). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.CloudMigrations.TargetAssetTestSpecAgentConfigPluginsConfig[]; } interface TargetAssetTestSpecAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface TargetAssetTestSpecCreateVnicDetail { /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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/). */ nsgIds: string[]; /** * 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). */ privateIp: string; /** * Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). */ skipSourceDestCheck: boolean; /** * 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. */ subnetId: string; /** * 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). */ vlanId: string; } interface TargetAssetTestSpecInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface TargetAssetTestSpecPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.CloudMigrations.TargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction[]; } interface TargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * (Updatable) The type of target asset. */ type: string; } interface TargetAssetTestSpecShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * The total amount of memory in gigabytes that is available to the instance. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; } interface TargetAssetTestSpecSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * The OCID of the key management key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface TargetAssetUserSpec { /** * (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfig: outputs.CloudMigrations.TargetAssetUserSpecAgentConfig; /** * (Updatable) The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * (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). */ capacityReservationId: string; /** * (Updatable) The OCID of the compartment. */ compartmentId: string; /** * (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). */ createVnicDetails: outputs.CloudMigrations.TargetAssetUserSpecCreateVnicDetails; /** * (Updatable) The OCID of the dedicated VM host. */ dedicatedVmHostId: string; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * (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. * * If you do not specify the fault domain, the system selects one for you. * * To 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. * * Example: `FAULT-DOMAIN-1` */ faultDomain: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * (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. */ hostnameLabel: string; /** * (Updatable) Optional mutable instance options */ instanceOptions: outputs.CloudMigrations.TargetAssetUserSpecInstanceOptions; /** * (Updatable) This is an advanced option. * * 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. * * If 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. * * By 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. * * If 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. * * For 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). * * For more information about iPXE, see http://ipxe.org. */ ipxeScript: string; /** * (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. */ isPvEncryptionInTransitEnabled: boolean; /** * (Updatable) Configuration options for preemptible instances. */ preemptibleInstanceConfig: outputs.CloudMigrations.TargetAssetUserSpecPreemptibleInstanceConfig; /** * (Updatable) The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources 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). */ shape: string; /** * (Updatable) The shape configuration requested for the instance. * * If 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 `shape` that you specify. * * Each shape only supports certain configurable values. If the values that you provide are not valid for the specified `shape`, an error is returned. */ shapeConfig: outputs.CloudMigrations.TargetAssetUserSpecShapeConfig; /** * (Updatable) */ sourceDetails: outputs.CloudMigrations.TargetAssetUserSpecSourceDetails; } interface TargetAssetUserSpecAgentConfig { /** * (Updatable) Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. * * 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). */ areAllPluginsDisabled: boolean; /** * (Updatable) Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled). * * These are the management plugins: OS Management Service Agent and Compute instance run command. * * The management plugins are controlled by this parameter and the per-plugin configuration in the `pluginsConfig` object. * * If `isManagementDisabled` is true, all the management plugins are disabled, regardless of the per-plugin configuration. * * 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. */ isManagementDisabled: boolean; /** * (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). * * These are the monitoring plugins: Compute instance monitoring and Custom logs monitoring. * * The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object. * * If `isMonitoringDisabled` is true, all the monitoring plugins are disabled, regardless of the per-plugin configuration. * * 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. */ isMonitoringDisabled: boolean; /** * (Updatable) The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.CloudMigrations.TargetAssetUserSpecAgentConfigPluginsConfig[]; } interface TargetAssetUserSpecAgentConfigPluginsConfig { /** * (Updatable) Whether the plugin should be enabled or disabled. * * To enable the monitoring and management plugins, the `isMonitoringDisabled` and `isManagementDisabled` attributes must also be set to false. */ desiredState: string; /** * (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). */ name: string; } interface TargetAssetUserSpecCreateVnicDetails { /** * (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. * * If you specify a `hostnameLabel`, then `assignPrivateDnsRecord` must be set to true. */ assignPrivateDnsRecord: boolean; /** * (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. * * **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). * * **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). * * Example: `false` * * If you specify a `vlanId`, then `assignPublicIp` must be set to false. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan). */ assignPublicIp: boolean; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * (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). * * For more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm). * * When 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. * * Example: `bminstance-1` * * If 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). */ hostnameLabel: string; /** * (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/). * * If 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). */ nsgIds: string[]; /** * (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). * * If you specify a `vlanId`, the `privateIp` cannot be specified. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan). * * Example: `10.0.3.3` */ privateIp: string; /** * (Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). * * If 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). * * Example: `true` */ skipSourceDestCheck: boolean; /** * (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. * * If 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. */ subnetId: string; /** * (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). * * Provide a `vlanId` instead of a `subnetId`. If you provide both `vlanId` and `subnetId`, the request fails. */ vlanId: string; } interface TargetAssetUserSpecInstanceOptions { /** * (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. */ areLegacyImdsEndpointsDisabled: boolean; } interface TargetAssetUserSpecPreemptibleInstanceConfig { /** * (Updatable) The action to run when the preemptible instance is interrupted for eviction. */ preemptionAction: outputs.CloudMigrations.TargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction; } interface TargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction { /** * (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. */ preserveBootVolume: boolean; /** * (Updatable) The type of action to run when the instance is interrupted for eviction. */ type: string; } interface TargetAssetUserSpecShapeConfig { /** * (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`. * * The following values are supported: * * `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. * * `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. * * `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance. */ baselineOcpuUtilization: string; /** * (Updatable) The total amount of memory in gigabytes that is available to the instance. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs available to the instance. */ ocpus: number; } interface TargetAssetUserSpecSourceDetails { /** * (Updatable) The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * (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). */ bootVolumeSizeInGbs: string; /** * (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. * * Allowed values: */ bootVolumeVpusPerGb: string; /** * (Updatable) The OCID of the image used to boot the instance. */ imageId: string; /** * (Updatable) The OCID of the key management key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * (Updatable) The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ sourceType: string; } } export declare namespace ClusterPlacementGroups { interface ClusterPlacementGroupCapabilities { /** * The supported resources. */ items: outputs.ClusterPlacementGroups.ClusterPlacementGroupCapabilitiesItem[]; } interface ClusterPlacementGroupCapabilitiesItem { /** * Additional details describing the selected capability. */ additionalDetails: outputs.ClusterPlacementGroups.ClusterPlacementGroupCapabilitiesItemAdditionalDetails; /** * The type of resource. */ name: string; /** * The service that the resource is part of. */ service: string; } interface ClusterPlacementGroupCapabilitiesItemAdditionalDetails { /** * The number of instances or size of the resource. */ clusterPlacementGroupCount: number; /** * The amount of memory (in GBs) needed in the instance. */ memoryInGbs: number; /** * The number of NVMe drives to use for storage. */ nvmes: number; /** * The number of OCPUs needed in the instance. */ ocpus: number; /** * Additional details about what service provides the capability. For example, `COMPUTE` means that the Oracle Cloud Infrastructure Compute service provides the selected capability. */ serviceType: string; } interface ClusterPlacementGroupPlacementInstruction { /** * The type of placement instruction. */ type: string; /** * The value of the token designated for placement of the cluster placement group upon creation. */ value: string; } interface GetClusterPlacementGroupCapability { /** * The supported resources. */ items: outputs.ClusterPlacementGroups.GetClusterPlacementGroupCapabilityItem[]; } interface GetClusterPlacementGroupCapabilityItem { /** * Additional details describing the selected capability. */ additionalDetails: outputs.ClusterPlacementGroups.GetClusterPlacementGroupCapabilityItemAdditionalDetail[]; /** * 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. */ name: string; /** * The service that the resource is part of. */ service: string; } interface GetClusterPlacementGroupCapabilityItemAdditionalDetail { /** * The number of instances or size of the resource. */ clusterPlacementGroupCount: number; /** * The amount of memory (in GBs) needed in the instance. */ memoryInGbs: number; /** * The number of NVMe drives to use for storage. */ nvmes: number; /** * The number of OCPUs needed in the instance. */ ocpus: number; /** * Additional details about what service provides the capability. For example, `COMPUTE` means that the Oracle Cloud Infrastructure Compute service provides the selected capability. */ serviceType: string; } interface GetClusterPlacementGroupPlacementInstruction { /** * The type of placement instruction. */ type: string; /** * The value of the token designated for placement of the cluster placement group upon creation. */ value: string; } interface GetClusterPlacementGroupsClusterPlacementGroupCollection { /** * The supported resources. */ items: outputs.ClusterPlacementGroups.GetClusterPlacementGroupsClusterPlacementGroupCollectionItem[]; } interface GetClusterPlacementGroupsClusterPlacementGroupCollectionItem { /** * The availability domain of the cluster placement group. */ availabilityDomain: string; /** * A list of resources that you can create in a cluster placement group. */ capabilities: outputs.ClusterPlacementGroups.GetClusterPlacementGroupsClusterPlacementGroupCollectionItemCapability[]; /** * The type of cluster placement group. */ clusterPlacementGroupType: string; /** * A filter to return only the resources that match the specified compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A description of the cluster placement group. */ description: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only the resources that match the specified unique cluster placement group identifier. */ id: string; /** * 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. */ lifecycleDetails: string; /** * A filter to return only the resources that match the entire display name specified. */ name: string; opcDryRun: boolean; /** * Details that inform cluster placement group provisioning. */ placementInstructions: outputs.ClusterPlacementGroups.GetClusterPlacementGroupsClusterPlacementGroupCollectionItemPlacementInstruction[]; /** * A filter to return only the resources that match the specified lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the cluster placement group was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. */ timeCreated: string; /** * The time the cluster placement group was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. */ timeUpdated: string; } interface GetClusterPlacementGroupsClusterPlacementGroupCollectionItemCapability { /** * The supported resources. */ items: outputs.ClusterPlacementGroups.GetClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItem[]; } interface GetClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItem { /** * Additional details describing the selected capability. */ additionalDetails: outputs.ClusterPlacementGroups.GetClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItemAdditionalDetail[]; /** * A filter to return only the resources that match the entire display name specified. */ name: string; /** * The service that the resource is part of. */ service: string; } interface GetClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItemAdditionalDetail { /** * The number of instances or size of the resource. */ clusterPlacementGroupCount: number; /** * The amount of memory (in GBs) needed in the instance. */ memoryInGbs: number; /** * The number of NVMe drives to use for storage. */ nvmes: number; /** * The number of OCPUs needed in the instance. */ ocpus: number; /** * Additional details about what service provides the capability. For example, `COMPUTE` means that the Oracle Cloud Infrastructure Compute service provides the selected capability. */ serviceType: string; } interface GetClusterPlacementGroupsClusterPlacementGroupCollectionItemPlacementInstruction { /** * The type of placement instruction. */ type: string; /** * The value of the token designated for placement of the cluster placement group upon creation. */ value: string; } interface GetClusterPlacementGroupsFilter { /** * A filter to return only the resources that match the entire display name specified. */ name: string; regex?: boolean; values: string[]; } } export declare namespace ComputeCloud { interface AtCustomerCccInfrastructureInfrastructureInventory { /** * The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for capacity storage. */ capacityStorageTrayCount: number; /** * 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. */ computeNodeCount: number; /** * The number of management nodes that are available and in active use on the Compute Cloud@Customer infrastructure rack. */ managementNodeCount: number; /** * The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for performance storage. */ performanceStorageTrayCount: number; /** * The serial number of the Compute Cloud@Customer infrastructure rack. */ serialNumber: string; } interface AtCustomerCccInfrastructureInfrastructureNetworkConfiguration { /** * The domain name system (DNS) addresses that the Compute Cloud@Customer infrastructure uses for the data center network. */ dnsIps: string[]; /** * Dynamic routing information for the Compute Cloud@Customer infrastructure. */ infrastructureRoutingDynamics: outputs.ComputeCloud.AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic[]; /** * Static routing information for a rack. */ infrastructureRoutingStatics: outputs.ComputeCloud.AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic[]; /** * Information about the management nodes that are provisioned in the Compute Cloud@Customer infrastructure. */ managementNodes: outputs.ComputeCloud.AtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode[]; /** * The hostname corresponding to the virtual IP (VIP) address of the management nodes. */ mgmtVipHostname: string; /** * The IP address used as the virtual IP (VIP) address of the management nodes. */ mgmtVipIp: string; /** * Addresses of the network spine switches. */ spineIps: string[]; /** * 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. */ spineVip: string; /** * Domain name to be used as the base domain for the internal network and by public facing services. */ uplinkDomain: string; /** * Uplink gateway in the datacenter network that the Compute Cloud@Customer connects to. */ uplinkGatewayIp: string; /** * Netmask of the subnet that the Compute Cloud@Customer infrastructure is connected to. */ uplinkNetmask: string; /** * 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. */ uplinkPortCount: number; /** * The port forward error correction (FEC) setting for the uplink port on the Compute Cloud@Customer infrastructure. */ uplinkPortForwardErrorCorrection: string; /** * Uplink port speed defined in gigabytes per second. All uplink ports must have identical speed. */ uplinkPortSpeedInGbps: number; /** * The virtual local area network (VLAN) maximum transmission unit (MTU) size for the uplink ports. */ uplinkVlanMtu: number; } interface AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic { /** * The topology in use for the Border Gateway Protocol (BGP) configuration. */ bgpTopology: string; /** * The Oracle Autonomous System Number (ASN) to control routing and exchange information within the dynamic routing configuration. */ oracleAsn: number; /** * The list of peer devices in the dynamic routing configuration. */ peerInformations: outputs.ComputeCloud.AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation[]; } interface AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation { /** * The Autonomous System Number (ASN) of the peer network. */ asn: number; /** * Address of the management node. */ ip: string; } interface AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic { /** * The uplink Hot Standby Router Protocol (HSRP) group value for the switch in the Compute Cloud@Customer infrastructure. */ uplinkHsrpGroup: number; /** * The virtual local area network (VLAN) identifier used to connect to the uplink (only access mode is supported). */ uplinkVlan: number; } interface AtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode { /** * Hostname for interface to the management node. */ hostname: string; /** * Address of the management node. */ ip: string; } interface AtCustomerCccInfrastructureUpgradeInformation { /** * The current version of software installed on the Compute Cloud@Customer infrastructure. */ currentVersion: string; /** * Indication that the Compute Cloud@Customer infrastructure is in the process of an upgrade or an upgrade activity (such as preloading upgrade images). */ isActive: boolean; /** * 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. */ scheduledUpgradeDuration: string; /** * Compute Cloud@Customer infrastructure next upgrade time. The rack might have performance impacts during this time. */ timeOfScheduledUpgrade: string; } interface AtCustomerCccUpgradeScheduleEvent { /** * (Updatable) A description of the Compute Cloud@Customer upgrade schedule time block. */ description: string; /** * Generated name associated with the event. */ name: string; /** * (Updatable) The duration of this block of time. The duration must be specified and be of the ISO-8601 format for durations. */ scheduleEventDuration: string; /** * (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. */ scheduleEventRecurrences: string; /** * (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. */ timeStart: string; } interface GetAtCustomerCccInfrastructureInfrastructureInventory { /** * The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for capacity storage. */ capacityStorageTrayCount: number; /** * 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. */ computeNodeCount: number; /** * The number of management nodes that are available and in active use on the Compute Cloud@Customer infrastructure rack. */ managementNodeCount: number; /** * The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for performance storage. */ performanceStorageTrayCount: number; /** * The serial number of the Compute Cloud@Customer infrastructure rack. */ serialNumber: string; } interface GetAtCustomerCccInfrastructureInfrastructureNetworkConfiguration { /** * The domain name system (DNS) addresses that the Compute Cloud@Customer infrastructure uses for the data center network. */ dnsIps: string[]; /** * Dynamic routing information for the Compute Cloud@Customer infrastructure. */ infrastructureRoutingDynamics: outputs.ComputeCloud.GetAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic[]; /** * Static routing information for a rack. */ infrastructureRoutingStatics: outputs.ComputeCloud.GetAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic[]; /** * Information about the management nodes that are provisioned in the Compute Cloud@Customer infrastructure. */ managementNodes: outputs.ComputeCloud.GetAtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode[]; /** * The hostname corresponding to the virtual IP (VIP) address of the management nodes. */ mgmtVipHostname: string; /** * The IP address used as the virtual IP (VIP) address of the management nodes. */ mgmtVipIp: string; /** * Addresses of the network spine switches. */ spineIps: string[]; /** * 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. */ spineVip: string; /** * Domain name to be used as the base domain for the internal network and by public facing services. */ uplinkDomain: string; /** * Uplink gateway in the datacenter network that the Compute Cloud@Customer connects to. */ uplinkGatewayIp: string; /** * Netmask of the subnet that the Compute Cloud@Customer infrastructure is connected to. */ uplinkNetmask: string; /** * 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. */ uplinkPortCount: number; /** * The port forward error correction (FEC) setting for the uplink port on the Compute Cloud@Customer infrastructure. */ uplinkPortForwardErrorCorrection: string; /** * Uplink port speed defined in gigabytes per second. All uplink ports must have identical speed. */ uplinkPortSpeedInGbps: number; /** * The virtual local area network (VLAN) maximum transmission unit (MTU) size for the uplink ports. */ uplinkVlanMtu: number; } interface GetAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic { /** * The topology in use for the Border Gateway Protocol (BGP) configuration. */ bgpTopology: string; /** * The Oracle Autonomous System Number (ASN) to control routing and exchange information within the dynamic routing configuration. */ oracleAsn: number; /** * The list of peer devices in the dynamic routing configuration. */ peerInformations: outputs.ComputeCloud.GetAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation[]; } interface GetAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation { /** * The Autonomous System Number (ASN) of the peer network. */ asn: number; /** * Address of the management node. */ ip: string; } interface GetAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic { /** * The uplink Hot Standby Router Protocol (HSRP) group value for the switch in the Compute Cloud@Customer infrastructure. */ uplinkHsrpGroup: number; /** * The virtual local area network (VLAN) identifier used to connect to the uplink (only access mode is supported). */ uplinkVlan: number; } interface GetAtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode { /** * Hostname for interface to the management node. */ hostname: string; /** * Address of the management node. */ ip: string; } interface GetAtCustomerCccInfrastructureUpgradeInformation { /** * The current version of software installed on the Compute Cloud@Customer infrastructure. */ currentVersion: string; /** * Indication that the Compute Cloud@Customer infrastructure is in the process of an upgrade or an upgrade activity (such as preloading upgrade images). */ isActive: boolean; /** * 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. */ scheduledUpgradeDuration: string; /** * Compute Cloud@Customer infrastructure next upgrade time. The rack might have performance impacts during this time. */ timeOfScheduledUpgrade: string; } interface GetAtCustomerCccInfrastructuresCccInfrastructureCollection { items: outputs.ComputeCloud.GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItem[]; } interface GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItem { /** * Schedule used for upgrades. If no schedule is associated with the infrastructure, it can be updated at any time. */ cccUpgradeScheduleId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * A message describing the current connection state in more detail. */ connectionDetails: string; /** * 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. */ connectionState: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A mutable client-meaningful text description of the Compute Cloud@Customer infrastructure. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The Compute Cloud@Customer infrastructure [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This cannot be changed once created. */ id: string; /** * 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. */ infrastructureInventories: outputs.ComputeCloud.GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureInventory[]; /** * 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. */ infrastructureNetworkConfigurations: outputs.ComputeCloud.GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfiguration[]; /** * 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. */ lifecycleDetails: string; /** * 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. */ provisioningFingerprint: string; /** * 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). */ provisioningPin: string; /** * 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. */ shortName: string; /** * A filter used to return only resources that match the given lifecycleState. */ state: string; /** * [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. */ subnetId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Compute Cloud@Customer infrastructure creation date and time, using an RFC3339 formatted datetime string. */ timeCreated: string; /** * Compute Cloud@Customer infrastructure updated date and time, using an RFC3339 formatted datetime string. */ timeUpdated: string; /** * Upgrade information that relates to a Compute Cloud@Customer infrastructure. This information cannot be updated. */ upgradeInformations: outputs.ComputeCloud.GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemUpgradeInformation[]; } interface GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureInventory { /** * The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for capacity storage. */ capacityStorageTrayCount: number; /** * 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. */ computeNodeCount: number; /** * The number of management nodes that are available and in active use on the Compute Cloud@Customer infrastructure rack. */ managementNodeCount: number; /** * The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for performance storage. */ performanceStorageTrayCount: number; /** * The serial number of the Compute Cloud@Customer infrastructure rack. */ serialNumber: string; } interface GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfiguration { /** * The domain name system (DNS) addresses that the Compute Cloud@Customer infrastructure uses for the data center network. */ dnsIps: string[]; /** * Dynamic routing information for the Compute Cloud@Customer infrastructure. */ infrastructureRoutingDynamics: outputs.ComputeCloud.GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamic[]; /** * Static routing information for a rack. */ infrastructureRoutingStatics: outputs.ComputeCloud.GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingStatic[]; /** * Information about the management nodes that are provisioned in the Compute Cloud@Customer infrastructure. */ managementNodes: outputs.ComputeCloud.GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationManagementNode[]; /** * The hostname corresponding to the virtual IP (VIP) address of the management nodes. */ mgmtVipHostname: string; /** * The IP address used as the virtual IP (VIP) address of the management nodes. */ mgmtVipIp: string; /** * Addresses of the network spine switches. */ spineIps: string[]; /** * 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. */ spineVip: string; /** * Domain name to be used as the base domain for the internal network and by public facing services. */ uplinkDomain: string; /** * Uplink gateway in the datacenter network that the Compute Cloud@Customer connects to. */ uplinkGatewayIp: string; /** * Netmask of the subnet that the Compute Cloud@Customer infrastructure is connected to. */ uplinkNetmask: string; /** * 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. */ uplinkPortCount: number; /** * The port forward error correction (FEC) setting for the uplink port on the Compute Cloud@Customer infrastructure. */ uplinkPortForwardErrorCorrection: string; /** * Uplink port speed defined in gigabytes per second. All uplink ports must have identical speed. */ uplinkPortSpeedInGbps: number; /** * The virtual local area network (VLAN) maximum transmission unit (MTU) size for the uplink ports. */ uplinkVlanMtu: number; } interface GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamic { /** * The topology in use for the Border Gateway Protocol (BGP) configuration. */ bgpTopology: string; /** * The Oracle Autonomous System Number (ASN) to control routing and exchange information within the dynamic routing configuration. */ oracleAsn: number; /** * The list of peer devices in the dynamic routing configuration. */ peerInformations: outputs.ComputeCloud.GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation[]; } interface GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation { /** * The Autonomous System Number (ASN) of the peer network. */ asn: number; /** * Address of the management node. */ ip: string; } interface GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingStatic { /** * The uplink Hot Standby Router Protocol (HSRP) group value for the switch in the Compute Cloud@Customer infrastructure. */ uplinkHsrpGroup: number; /** * The virtual local area network (VLAN) identifier used to connect to the uplink (only access mode is supported). */ uplinkVlan: number; } interface GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationManagementNode { /** * Hostname for interface to the management node. */ hostname: string; /** * Address of the management node. */ ip: string; } interface GetAtCustomerCccInfrastructuresCccInfrastructureCollectionItemUpgradeInformation { /** * The current version of software installed on the Compute Cloud@Customer infrastructure. */ currentVersion: string; /** * Indication that the Compute Cloud@Customer infrastructure is in the process of an upgrade or an upgrade activity (such as preloading upgrade images). */ isActive: boolean; /** * 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. */ scheduledUpgradeDuration: string; /** * Compute Cloud@Customer infrastructure next upgrade time. The rack might have performance impacts during this time. */ timeOfScheduledUpgrade: string; } interface GetAtCustomerCccInfrastructuresFilter { name: string; regex?: boolean; values: string[]; } interface GetAtCustomerCccUpgradeScheduleEvent { /** * A description of the Compute Cloud@Customer upgrade schedule time block. */ description: string; /** * Generated name associated with the event. */ name: string; /** * The duration of this block of time. The duration must be specified and be of the ISO-8601 format for durations. */ scheduleEventDuration: string; /** * 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. */ scheduleEventRecurrences: string; /** * 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. */ timeStart: string; } interface GetAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollection { items: outputs.ComputeCloud.GetAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItem[]; } interface GetAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A description of the Compute Cloud@Customer upgrade schedule time block. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * List of preferred times for Compute Cloud@Customer infrastructures associated with this schedule to be upgraded. */ events: outputs.ComputeCloud.GetAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItemEvent[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Upgrade schedule [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This cannot be changed once created. */ id: string; /** * List of Compute Cloud@Customer infrastructure [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that are using this upgrade schedule. */ infrastructureIds: string[]; /** * 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. */ lifecycleDetails: string; /** * A filter to return resources only when their lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the upgrade schedule was created, using an RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the upgrade schedule was updated, using an RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItemEvent { /** * A description of the Compute Cloud@Customer upgrade schedule time block. */ description: string; /** * Generated name associated with the event. */ name: string; /** * The duration of this block of time. The duration must be specified and be of the ISO-8601 format for durations. */ scheduleEventDuration: string; /** * 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. */ scheduleEventRecurrences: string; /** * 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. */ timeStart: string; } interface GetAtCustomerCccUpgradeSchedulesFilter { /** * Generated name associated with the event. */ name: string; regex?: boolean; values: string[]; } } export declare namespace ComputeInstanceAgent { interface GetInstanceAgentPluginsFilter { /** * The plugin name. */ name: string; regex?: boolean; values: string[]; } interface GetInstanceAgentPluginsInstanceAgentPlugin { /** * An optional message from the plugin. */ message: string; /** * The plugin name. */ name: string; /** * The plugin status. */ status: string; /** * The last updated time of the plugin, in UTC. */ timeLastUpdatedUtc: string; } interface GetInstanceAvailablePluginAvailablePlugin { /** * Whether the plugin is enabled or disabled by default. */ isEnabledByDefault: boolean; /** * Whether the plugin is supported. */ isSupported: boolean; /** * The plugin name. */ name: string; /** * A brief description of the plugin's functionality. */ summary: string; } interface GetInstanceAvailablePluginFilter { /** * The plugin name. */ name: string; regex?: boolean; values: string[]; } } export declare namespace ContainerEngine { interface AddonAddonError { /** * 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). */ code: string; /** * A human-readable error string of the upstream error. */ message: string; /** * The status of the HTTP response encountered in the upstream error. */ status: string; } interface AddonConfiguration { /** * (Updatable) configuration key name */ key: string; /** * (Updatable) configuration value name */ value: string; } interface ClusterClusterPodNetworkOption { /** * The CNI used by the node pools of this cluster */ cniType: string; } interface ClusterEndpoint { /** * The IPv6 networking Kubernetes API server endpoint. */ ipv6endpoint: string; /** * The non-native networking Kubernetes API server endpoint. */ kubernetes: string; /** * The private native networking Kubernetes API server endpoint. */ privateEndpoint: string; /** * The public native networking Kubernetes API server endpoint, if one was requested. */ publicEndpoint: string; /** * The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint' */ vcnHostnameEndpoint: string; } interface ClusterEndpointConfig { /** * 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. */ isPublicIpEnabled: boolean; /** * 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/). */ nsgIds?: string[]; /** * [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. */ securityAttributes: { [key: string]: string; }; /** * The OCID of the regional subnet in which to place the Cluster endpoint. */ subnetId: string; } interface ClusterImagePolicyConfig { /** * (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. */ isPolicyEnabled: boolean; /** * (Updatable) A list of KMS key details. */ keyDetails: outputs.ContainerEngine.ClusterImagePolicyConfigKeyDetail[]; } interface ClusterImagePolicyConfigKeyDetail { /** * (Updatable) The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source. */ kmsKeyId: string; } interface ClusterMetadata { /** * The user who created the cluster. */ createdByUserId: string; /** * The OCID of the work request which created the cluster. */ createdByWorkRequestId: string; /** * The user who deleted the cluster. */ deletedByUserId: string; /** * The OCID of the work request which deleted the cluster. */ deletedByWorkRequestId: string; /** * The time the cluster was created. */ timeCreated: string; /** * The time until which the cluster credential is valid. */ timeCredentialExpiration: string; /** * The time the cluster was deleted. */ timeDeleted: string; /** * The time the cluster was updated. */ timeUpdated: string; /** * The user who updated the cluster. */ updatedByUserId: string; /** * The OCID of the work request which updated the cluster. */ updatedByWorkRequestId: string; } interface ClusterOptions { /** * Configurable cluster add-ons */ addOns: outputs.ContainerEngine.ClusterOptionsAddOns; /** * (Updatable) Configurable cluster admission controllers */ admissionControllerOptions: outputs.ContainerEngine.ClusterOptionsAdmissionControllerOptions; /** * 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). */ ipFamilies: string[]; /** * Network configuration for Kubernetes. */ kubernetesNetworkConfig: outputs.ContainerEngine.ClusterOptionsKubernetesNetworkConfig; /** * (Updatable) The property that define the status of the OIDC Discovery feature for a cluster. */ openIdConnectDiscovery: outputs.ContainerEngine.ClusterOptionsOpenIdConnectDiscovery; /** * (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). */ openIdConnectTokenAuthenticationConfig: outputs.ContainerEngine.ClusterOptionsOpenIdConnectTokenAuthenticationConfig; /** * (Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC) */ persistentVolumeConfig: outputs.ContainerEngine.ClusterOptionsPersistentVolumeConfig; /** * (Updatable) Configuration to be applied to load balancers created by Kubernetes services */ serviceLbConfig: outputs.ContainerEngine.ClusterOptionsServiceLbConfig; /** * The OCIDs of the subnets used for Kubernetes services load balancers. */ serviceLbSubnetIds: string[]; } interface ClusterOptionsAddOns { /** * Whether or not to enable the Kubernetes Dashboard add-on. */ isKubernetesDashboardEnabled: boolean; /** * Whether or not to enable the Tiller add-on. */ isTillerEnabled: boolean; } interface ClusterOptionsAdmissionControllerOptions { /** * (Updatable) Whether or not to enable the Pod Security Policy admission controller. */ isPodSecurityPolicyEnabled: boolean; } interface ClusterOptionsKubernetesNetworkConfig { /** * 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. */ podsCidr: string; /** * 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. */ servicesCidr: string; } interface ClusterOptionsOpenIdConnectDiscovery { /** * (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. */ isOpenIdConnectDiscoveryEnabled: boolean; } interface ClusterOptionsOpenIdConnectTokenAuthenticationConfig { /** * (Updatable) A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate. */ caCertificate?: string; /** * (Updatable) A client id that all tokens must be issued for. */ clientId?: string; /** * (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) */ configurationFile?: string; /** * (Updatable) JWT claim to use as the user's group. If the claim is present it must be an array of strings. */ groupsClaim?: string; /** * (Updatable) Prefix prepended to group claims to prevent clashes with existing names (such as system:groups). */ groupsPrefix?: string; /** * (Updatable) Whether the cluster has OIDC Auth Config enabled. Defaults to false. */ isOpenIdConnectAuthEnabled: boolean; /** * (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. */ issuerUrl?: string; /** * (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. */ requiredClaims?: outputs.ContainerEngine.ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim[]; /** * (Updatable) The signing algorithms accepted. Default is ["RS256"]. */ signingAlgorithms?: string[]; /** * (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. */ usernameClaim?: string; /** * (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. */ usernamePrefix?: string; } interface ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim { /** * (Updatable) The key of the pair. */ key?: string; /** * (Updatable) The value of the pair. */ value?: string; } interface ClusterOptionsPersistentVolumeConfig { /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (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"}` */ freeformTags: { [key: string]: string; }; } interface ClusterOptionsServiceLbConfig { /** * (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/). */ backendNsgIds: string[]; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (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"}` */ freeformTags: { [key: string]: string; }; } interface ContainerInstanceContainer { /** * A list of string arguments for a container's ENTRYPOINT process. * * Many 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. * * The total size of all arguments combined must be 64 KB or smaller. */ arguments: string[]; /** * The availability domain where the container instance runs. */ availabilityDomain: string; /** * 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. */ commands: string[]; /** * (Updatable) The compartment OCID. */ compartmentId: string; /** * The OCID of the container. */ containerId: string; containerInstanceId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. */ definedTags: { [key: string]: string; }; /** * 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. */ displayName: string; /** * 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. * * The total size of all environment variables combined, name and values, must be 64 KB or smaller. */ environmentVariables: { [key: string]: string; }; exitCode: number; /** * The fault domain where the container instance runs. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ healthChecks: outputs.ContainerEngine.ContainerInstanceContainerHealthCheck[]; /** * 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. * * If no registry is provided, will default the registry to public docker hub `docker.io/library`. * * The registry used for container image must be reachable over the Container Instance's VNIC. */ imageUrl: string; /** * Determines if the container will have access to the container instance resource principal. * * This 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. */ isResourcePrincipalDisabled: boolean; /** * A message that describes the current state of the container in more detail. Can be used to provide actionable information. */ lifecycleDetails: string; /** * The size and amount of resources available to the container. */ resourceConfig: outputs.ContainerEngine.ContainerInstanceContainerResourceConfig; /** * Security context for container. */ securityContext: outputs.ContainerEngine.ContainerInstanceContainerSecurityContext; /** * (Updatable) The target state for the Container Instance. Could be set to `ACTIVE` or `INACTIVE`. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`. */ systemTags: { [key: string]: string; }; /** * The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; timeTerminated: string; /** * The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; /** * List of the volume mounts. */ volumeMounts: outputs.ContainerEngine.ContainerInstanceContainerVolumeMount[]; /** * The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used. */ workingDirectory: string; } interface ContainerInstanceContainerHealthCheck { /** * 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. */ failureAction: string; /** * Number of consecutive failures at which we consider the check failed. */ failureThreshold: number; /** * Container health check HTTP headers. */ headers: outputs.ContainerEngine.ContainerInstanceContainerHealthCheckHeader[]; /** * Container health check type. */ healthCheckType: string; /** * The initial delay in seconds before start checking container health status. */ initialDelayInSeconds: number; /** * Number of seconds between two consecutive runs for checking container health. */ intervalInSeconds: number; /** * Health check name. */ name: string; /** * Container health check HTTP path. */ path: string; /** * Container health check HTTP port. */ port: number; status: string; statusDetails: string; /** * Number of consecutive successes at which we consider the check succeeded again after it was in failure state. */ successThreshold: number; /** * Length of waiting time in seconds before marking health check failed. */ timeoutInSeconds: number; } interface ContainerInstanceContainerHealthCheckHeader { /** * Container HTTP header Key. */ name: string; /** * Container HTTP header value. */ value: string; } interface ContainerInstanceContainerResourceConfig { /** * The maximum amount of memory that can be consumed by the container's process. * * If you do not set a value, then the process may use all available memory on the instance. */ memoryLimitInGbs: number; /** * The maximum amount of CPUs that can be consumed by the container's process. * * If you do not set a value, then the process can use all available CPU resources on the instance. * * CPU 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. * * A 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. */ vcpusLimit: number; } interface ContainerInstanceContainerSecurityContext { /** * Linux Container capabilities to configure capabilities of container. */ capabilities: outputs.ContainerEngine.ContainerInstanceContainerSecurityContextCapabilities; /** * 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. */ isNonRootUserCheckEnabled: boolean; /** * Determines if the container will have a read-only root file system. Default value is false. */ isRootFileSystemReadonly: boolean; /** * The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided. */ runAsGroup: number; /** * 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. */ runAsUser: number; /** * The type of security context */ securityContextType: string; } interface ContainerInstanceContainerSecurityContextCapabilities { /** * A list of additional configurable container capabilities. */ addCapabilities: string[]; /** * A list of container capabilities that can be dropped. */ dropCapabilities: string[]; } interface ContainerInstanceContainerVolumeMount { /** * Whether the volume was mounted in read-only mode. By default, the volume is not read-only. */ isReadOnly: boolean; /** * The volume access path. */ mountPath: string; /** * 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 */ partition: number; /** * A subpath inside the referenced volume. */ subPath: string; /** * The name of the volume. Avoid entering confidential information. */ volumeName: string; } interface ContainerInstanceDnsConfig { /** * 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. */ nameservers: string[]; /** * 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"]. */ options: string[]; /** * Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios. */ searches: string[]; } interface ContainerInstanceImagePullSecret { /** * The password which should be used with the registry for authentication. The value is expected in base64 format. */ password: string; /** * The registry endpoint of the container image. */ registryEndpoint: string; /** * The OCID of the secret for registry credentials. */ secretId: string; /** * The type of ImagePullSecret. */ secretType: string; /** * The username which should be used with the registry for authentication. The value is expected in base64 format. */ username: string; } interface ContainerInstanceSecurityContext { /** * 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. */ fsGroup: number; /** * 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. */ fsGroupChangePolicy: string; /** * The type of security context */ securityContextType: string; } interface ContainerInstanceShapeConfig { /** * The total amount of memory available to the container instance (GB). */ memoryInGbs: number; /** * The networking bandwidth available to the container instance, in gigabits per second. */ networkingBandwidthInGbps: number; /** * The total number of OCPUs available to the container instance. */ ocpus: number; /** * A short description of the container instance's processor (CPU). */ processorDescription: string; } interface ContainerInstanceVnic { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. */ definedTags: { [key: string]: string; }; /** * A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The hostname for the VNIC's primary private IP. Used for DNS. */ hostnameLabel: string; /** * Whether the VNIC should be assigned a public IP address. */ isPublicIpAssigned: boolean; /** * A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. */ nsgIds: string[]; /** * A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. */ privateIp: string; /** * Whether the source/destination check is disabled on the VNIC. */ skipSourceDestCheck: boolean; /** * The OCID of the subnet to create the VNIC in. */ subnetId: string; /** * The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network. */ vnicId: string; } interface ContainerInstanceVolume { /** * The volume type of the empty directory, can be either File Storage or Memory. */ backingStore: string; /** * 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. */ configs: outputs.ContainerEngine.ContainerInstanceVolumeConfig[]; /** * 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. */ export: outputs.ContainerEngine.ContainerInstanceVolumeExport; /** * Specifications for the mount command to mount the Oracle Cloud Infrastructure File Storage Service (FSS) File System to Containers. */ mountCommand: outputs.ContainerEngine.ContainerInstanceVolumeMountCommand; /** * 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. */ mountTarget: outputs.ContainerEngine.ContainerInstanceVolumeMountTarget; /** * The name of the volume. This must be unique within a single container instance. */ name: string; /** * Security options for Oracle Cloud Infrastructure FSS File System. */ security: outputs.ContainerEngine.ContainerInstanceVolumeSecurity; /** * 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. */ subnetId: string; /** * The type of volume. */ volumeType: string; } interface ContainerInstanceVolumeConfig { /** * 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. */ data: string; /** * The name of the file. The fileName should be unique across the volume. */ fileName: string; /** * (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. */ path: string; } interface ContainerInstanceVolumeExport { /** * The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Export. */ id: string; /** * 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. */ ociFssExportType: string; } interface ContainerInstanceVolumeMountCommand { /** * List of mount options to be used in the mount command. The order of this array will be maintained while preparing the mount command. */ mountOptions: outputs.ContainerEngine.ContainerInstanceVolumeMountCommandMountOption[]; } interface ContainerInstanceVolumeMountCommandMountOption { /** * 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. */ option: string; /** * The value of the mount option. */ value: string; } interface ContainerInstanceVolumeMountTarget { /** * The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target. */ id: string; /** * 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. */ ociFssMountTargetType: string; } interface ContainerInstanceVolumeSecurity { /** * NFS authentication type to be used. Currently, only auth type SYS is supported. */ auth: string; /** * 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. */ isEncryptedInTransit: boolean; } interface GetAddonAddonError { /** * 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). */ code: string; /** * A human-readable error string of the upstream error. */ message: string; /** * The status of the HTTP response encountered in the upstream error. */ status: string; } interface GetAddonConfiguration { /** * configuration key name */ key: string; /** * configuration value name */ value: string; } interface GetAddonOptionsAddonOption { /** * Addon group info, a namespace concept that groups addons with similar functionalities. */ addonGroup: string; /** * Addon definition schema version to validate addon. */ addonSchemaVersion: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Information about the addon version. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Is it an essential addon for cluster operation or not. */ isEssential: boolean; /** * Name of the addon and it would be unique. */ name: string; /** * The life cycle state of the addon. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the work request was created. */ timeCreated: string; /** * The resources this work request affects. */ versions: outputs.ContainerEngine.GetAddonOptionsAddonOptionVersion[]; } interface GetAddonOptionsAddonOptionVersion { /** * Addon version configuration details. */ configurations: outputs.ContainerEngine.GetAddonOptionsAddonOptionVersionConfiguration[]; /** * Information about the addon version. */ description: string; /** * The range of kubernetes versions an addon can be configured. */ kubernetesVersionFilters: outputs.ContainerEngine.GetAddonOptionsAddonOptionVersionKubernetesVersionFilter[]; /** * 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. */ status: string; /** * Version number, need be comparable within an addon. */ versionNumber: string; } interface GetAddonOptionsAddonOptionVersionConfiguration { /** * Information about the addon version. */ description: string; /** * Display name of addon version. */ displayName: string; /** * If the the configuration is required or not. */ isRequired: boolean; /** * Addon configuration key */ key: string; /** * Addon configuration value */ value: string; } interface GetAddonOptionsAddonOptionVersionKubernetesVersionFilter { /** * The exact version of kubernetes that are compatible. */ exactKubernetesVersions: string[]; /** * The latest kubernetes version. */ maximumVersion: string; /** * The earliest kubernetes version. */ minimalVersion: string; } interface GetAddonOptionsFilter { /** * Name of the addon and it would be unique. */ name: string; regex?: boolean; values: string[]; } interface GetAddonsAddon { /** * The error info of the addon. */ addonErrors: outputs.ContainerEngine.GetAddonsAddonAddonError[]; /** * The name of the addon. */ addonName: string; /** * The OCID of the cluster. */ clusterId: string; /** * Addon configuration details. */ configurations: outputs.ContainerEngine.GetAddonsAddonConfiguration[]; /** * current installed version of the addon */ currentInstalledVersion: string; overrideExisting?: boolean; removeAddonResourcesOnDelete: boolean; /** * The state of the addon. */ state: string; /** * The time the cluster was created. */ timeCreated: string; /** * selected addon version, or null indicates autoUpdate */ version?: string; } interface GetAddonsAddonAddonError { /** * 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). */ code: string; /** * A human-readable error string of the upstream error. */ message: string; /** * The status of the HTTP response encountered in the upstream error. */ status: string; } interface GetAddonsAddonConfiguration { /** * configuration key name */ key: string; /** * configuration value name */ value: string; } interface GetAddonsFilter { name: string; regex?: boolean; values: string[]; } interface GetClusterClusterPodNetworkOption { /** * The CNI used by the node pools of this cluster */ cniType: string; } interface GetClusterEndpoint { /** * The IPv6 networking Kubernetes API server endpoint. */ ipv6endpoint: string; /** * The non-native networking Kubernetes API server endpoint. */ kubernetes: string; /** * The private native networking Kubernetes API server endpoint. */ privateEndpoint: string; /** * The public native networking Kubernetes API server endpoint, if one was requested. */ publicEndpoint: string; /** * The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint' */ vcnHostnameEndpoint: string; } interface GetClusterEndpointConfig { /** * 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. */ isPublicIpEnabled: boolean; /** * 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/). */ nsgIds: string[]; /** * [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. */ securityAttributes: { [key: string]: string; }; /** * The OCID of the regional subnet in which to place the Cluster endpoint. */ subnetId: string; } interface GetClusterImagePolicyConfig { /** * Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime. */ isPolicyEnabled: boolean; /** * A list of KMS key details. */ keyDetails: outputs.ContainerEngine.GetClusterImagePolicyConfigKeyDetail[]; } interface GetClusterImagePolicyConfigKeyDetail { /** * The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. */ kmsKeyId: string; } interface GetClusterMetadata { /** * The user who created the cluster. */ createdByUserId: string; /** * The OCID of the work request which created the cluster. */ createdByWorkRequestId: string; /** * The user who deleted the cluster. */ deletedByUserId: string; /** * The OCID of the work request which deleted the cluster. */ deletedByWorkRequestId: string; /** * The time the cluster was created. */ timeCreated: string; /** * The time until which the cluster credential is valid. */ timeCredentialExpiration: string; /** * The time the cluster was deleted. */ timeDeleted: string; /** * The time the cluster was updated. */ timeUpdated: string; /** * The user who updated the cluster. */ updatedByUserId: string; /** * The OCID of the work request which updated the cluster. */ updatedByWorkRequestId: string; } interface GetClusterOption { /** * Configurable cluster add-ons */ addOns: outputs.ContainerEngine.GetClusterOptionAddOn[]; /** * Configurable cluster admission controllers */ admissionControllerOptions: outputs.ContainerEngine.GetClusterOptionAdmissionControllerOption[]; /** * 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). */ ipFamilies: string[]; /** * Network configuration for Kubernetes. */ kubernetesNetworkConfigs: outputs.ContainerEngine.GetClusterOptionKubernetesNetworkConfig[]; /** * The property that define the status of the OIDC Discovery feature for a cluster. */ openIdConnectDiscoveries: outputs.ContainerEngine.GetClusterOptionOpenIdConnectDiscovery[]; /** * 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). */ openIdConnectTokenAuthenticationConfigs: outputs.ContainerEngine.GetClusterOptionOpenIdConnectTokenAuthenticationConfig[]; /** * Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC) */ persistentVolumeConfigs: outputs.ContainerEngine.GetClusterOptionPersistentVolumeConfig[]; /** * Configuration to be applied to load balancers created by Kubernetes services */ serviceLbConfigs: outputs.ContainerEngine.GetClusterOptionServiceLbConfig[]; /** * The OCIDs of the subnets used for Kubernetes services load balancers. */ serviceLbSubnetIds: string[]; } interface GetClusterOptionAddOn { /** * Whether or not to enable the Kubernetes Dashboard add-on. */ isKubernetesDashboardEnabled: boolean; /** * Whether or not to enable the Tiller add-on. */ isTillerEnabled: boolean; } interface GetClusterOptionAdmissionControllerOption { /** * Whether or not to enable the Pod Security Policy admission controller. */ isPodSecurityPolicyEnabled: boolean; } interface GetClusterOptionClusterPodNetworkOption { /** * The CNI used by the node pools of this cluster */ cniType: string; } interface GetClusterOptionKubernetesNetworkConfig { /** * 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. */ podsCidr: string; /** * 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. */ servicesCidr: string; } interface GetClusterOptionOpenIdConnectDiscovery { /** * Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint. */ isOpenIdConnectDiscoveryEnabled: boolean; } interface GetClusterOptionOpenIdConnectTokenAuthenticationConfig { /** * A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate. */ caCertificate: string; /** * A client id that all tokens must be issued for. */ clientId: string; /** * 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) */ configurationFile: string; /** * JWT claim to use as the user's group. If the claim is present it must be an array of strings. */ groupsClaim: string; /** * Prefix prepended to group claims to prevent clashes with existing names (such as system:groups). */ groupsPrefix: string; /** * Whether the cluster has OIDC Auth Config enabled. Defaults to false. */ isOpenIdConnectAuthEnabled: boolean; /** * 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. */ issuerUrl: string; /** * 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. */ requiredClaims: outputs.ContainerEngine.GetClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim[]; /** * The signing algorithms accepted. Default is ["RS256"]. */ signingAlgorithms: string[]; /** * 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. */ usernameClaim: string; /** * 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. */ usernamePrefix: string; } interface GetClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim { /** * The key of the pair. */ key: string; /** * The value of the pair. */ value: string; } interface GetClusterOptionPersistentVolumeConfig { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; } interface GetClusterOptionServiceLbConfig { /** * 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/). */ backendNsgIds: string[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; } interface GetClusterWorkloadMappingsFilter { name: string; regex?: boolean; values: string[]; } interface GetClusterWorkloadMappingsWorkloadMapping { /** * The OCID of the cluster. */ clusterId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The ocid of the workloadMapping. */ id: string; /** * The OCID of the mapped customer compartment. */ mappedCompartmentId: string; /** * The OCID of the mapped customer tenancy. */ mappedTenancyId: string; /** * The namespace of the workloadMapping. */ namespace: string; /** * The state of the workloadMapping. */ state: string; /** * The time the cluster was created. */ timeCreated: string; } interface GetClustersCluster { /** * Available Kubernetes versions to which the clusters masters may be upgraded. */ availableKubernetesUpgrades: string[]; /** * Available CNIs and network options for existing and new node pools of the cluster */ clusterPodNetworkOptions: outputs.ContainerEngine.GetClustersClusterClusterPodNetworkOption[]; /** * The OCID of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The network configuration for access to the Cluster control plane. */ endpointConfigs: outputs.ContainerEngine.GetClustersClusterEndpointConfig[]; /** * Endpoints served up by the cluster masters. */ endpoints: outputs.ContainerEngine.GetClustersClusterEndpoint[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the cluster. */ id: string; /** * The image verification policy for signature validation. */ imagePolicyConfigs: outputs.ContainerEngine.GetClustersClusterImagePolicyConfig[]; /** * The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. */ kmsKeyId: string; /** * The version of Kubernetes running on the cluster masters. */ kubernetesVersion: string; /** * Details about the state of the cluster masters. */ lifecycleDetails: string; /** * Metadata about the cluster. */ metadatas: outputs.ContainerEngine.GetClustersClusterMetadata[]; /** * The name to filter on. */ name: string; /** * The cluster-specific OpenID Connect Discovery endpoint */ openIdConnectDiscoveryEndpoint: string; /** * The cluster-specific OpenID Connect Discovery Key to derive the DiscoveryEndpoint */ openIdConnectDiscoveryKey: string; /** * Optional attributes for the cluster. */ options: outputs.ContainerEngine.GetClustersClusterOption[]; /** * A cluster lifecycle state to filter on. Can have multiple parameters of this name. */ state: string; /** * 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) */ type: string; /** * The OCID of the virtual cloud network (VCN) in which the cluster exists. */ vcnId: string; } interface GetClustersClusterClusterPodNetworkOption { /** * The CNI used by the node pools of this cluster */ cniType: string; } interface GetClustersClusterEndpoint { /** * The IPv6 networking Kubernetes API server endpoint. */ ipv6endpoint: string; /** * The non-native networking Kubernetes API server endpoint. */ kubernetes: string; /** * The private native networking Kubernetes API server endpoint. */ privateEndpoint: string; /** * The public native networking Kubernetes API server endpoint, if one was requested. */ publicEndpoint: string; /** * The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint' */ vcnHostnameEndpoint: string; } interface GetClustersClusterEndpointConfig { /** * 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. */ isPublicIpEnabled: boolean; /** * 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/). */ nsgIds: string[]; /** * [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. */ securityAttributes: { [key: string]: string; }; /** * The OCID of the regional subnet in which to place the Cluster endpoint. */ subnetId: string; } interface GetClustersClusterImagePolicyConfig { /** * Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime. */ isPolicyEnabled: boolean; /** * A list of KMS key details. */ keyDetails: outputs.ContainerEngine.GetClustersClusterImagePolicyConfigKeyDetail[]; } interface GetClustersClusterImagePolicyConfigKeyDetail { /** * The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption. */ kmsKeyId: string; } interface GetClustersClusterMetadata { /** * The user who created the cluster. */ createdByUserId: string; /** * The OCID of the work request which created the cluster. */ createdByWorkRequestId: string; /** * The user who deleted the cluster. */ deletedByUserId: string; /** * The OCID of the work request which deleted the cluster. */ deletedByWorkRequestId: string; /** * The time the cluster was created. */ timeCreated: string; /** * The time until which the cluster credential is valid. */ timeCredentialExpiration: string; /** * The time the cluster was deleted. */ timeDeleted: string; /** * The time the cluster was updated. */ timeUpdated: string; /** * The user who updated the cluster. */ updatedByUserId: string; /** * The OCID of the work request which updated the cluster. */ updatedByWorkRequestId: string; } interface GetClustersClusterOption { /** * Configurable cluster add-ons */ addOns: outputs.ContainerEngine.GetClustersClusterOptionAddOn[]; /** * Configurable cluster admission controllers */ admissionControllerOptions: outputs.ContainerEngine.GetClustersClusterOptionAdmissionControllerOption[]; /** * 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). */ ipFamilies: string[]; /** * Network configuration for Kubernetes. */ kubernetesNetworkConfigs: outputs.ContainerEngine.GetClustersClusterOptionKubernetesNetworkConfig[]; /** * The property that define the status of the OIDC Discovery feature for a cluster. */ openIdConnectDiscoveries: outputs.ContainerEngine.GetClustersClusterOptionOpenIdConnectDiscovery[]; /** * 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). */ openIdConnectTokenAuthenticationConfigs: outputs.ContainerEngine.GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfig[]; /** * Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC) */ persistentVolumeConfigs: outputs.ContainerEngine.GetClustersClusterOptionPersistentVolumeConfig[]; /** * Configuration to be applied to load balancers created by Kubernetes services */ serviceLbConfigs: outputs.ContainerEngine.GetClustersClusterOptionServiceLbConfig[]; /** * The OCIDs of the subnets used for Kubernetes services load balancers. */ serviceLbSubnetIds: string[]; } interface GetClustersClusterOptionAddOn { /** * Whether or not to enable the Kubernetes Dashboard add-on. */ isKubernetesDashboardEnabled: boolean; /** * Whether or not to enable the Tiller add-on. */ isTillerEnabled: boolean; } interface GetClustersClusterOptionAdmissionControllerOption { /** * Whether or not to enable the Pod Security Policy admission controller. */ isPodSecurityPolicyEnabled: boolean; } interface GetClustersClusterOptionKubernetesNetworkConfig { /** * 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. */ podsCidr: string; /** * 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. */ servicesCidr: string; } interface GetClustersClusterOptionOpenIdConnectDiscovery { /** * Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint. */ isOpenIdConnectDiscoveryEnabled: boolean; } interface GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfig { /** * A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate. */ caCertificate: string; /** * A client id that all tokens must be issued for. */ clientId: string; /** * 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) */ configurationFile: string; /** * JWT claim to use as the user's group. If the claim is present it must be an array of strings. */ groupsClaim: string; /** * Prefix prepended to group claims to prevent clashes with existing names (such as system:groups). */ groupsPrefix: string; /** * Whether the cluster has OIDC Auth Config enabled. Defaults to false. */ isOpenIdConnectAuthEnabled: boolean; /** * 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. */ issuerUrl: string; /** * 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. */ requiredClaims: outputs.ContainerEngine.GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim[]; /** * The signing algorithms accepted. Default is ["RS256"]. */ signingAlgorithms: string[]; /** * 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. */ usernameClaim: string; /** * 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. */ usernamePrefix: string; } interface GetClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim { /** * The key of the pair. */ key: string; /** * The value of the pair. */ value: string; } interface GetClustersClusterOptionPersistentVolumeConfig { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; } interface GetClustersClusterOptionServiceLbConfig { /** * 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/). */ backendNsgIds: string[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; } interface GetClustersFilter { /** * The name to filter on. */ name: string; regex?: boolean; values: string[]; } interface GetNodePoolInitialNodeLabel { /** * The key of the pair. */ key: string; /** * The value of the pair. */ value: string; } interface GetNodePoolNode { /** * The name of the availability domain in which this node is placed. */ availabilityDomain: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * An error that may be associated with the node. */ errors: outputs.ContainerEngine.GetNodePoolNodeError[]; /** * The fault domain of this node. */ faultDomain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the compute instance backing this node. */ id: string; /** * The version of Kubernetes this node is running. */ kubernetesVersion: string; /** * Details about the state of the node. */ lifecycleDetails: string; /** * The name of the node. */ name: string; /** * The OCID of the node pool. */ nodePoolId: string; /** * The private IP address of this node. */ privateIp: string; /** * The public IP address of this node. */ publicIp: string; /** * The state of the nodepool. */ state: string; /** * the ocid of the subnet to create the vnic in */ subnetId: string; } interface GetNodePoolNodeConfigDetail { /** * The OCID of the Compute Cluster to be associated with the worker node instance. */ computeClusterId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ isPvEncryptionInTransitEnabled: boolean; /** * The OCID of the Key Management Service key assigned to the boot volume. */ kmsKeyId: string; /** * The CNI related configuration of pods in the node pool. */ nodePoolPodNetworkOptionDetails: outputs.ContainerEngine.GetNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail[]; /** * A list of the OCIDs of the network security groups (NSGs) to add the VNIC to */ nsgIds: string[]; /** * The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node. */ placementConfigs: outputs.ContainerEngine.GetNodePoolNodeConfigDetailPlacementConfig[]; /** * The number of nodes in the node pool. */ size: number; } interface GetNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail { /** * The CNI plugin used by this node pool */ cniType: string; /** * 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 */ maxPodsPerNode: number; /** * 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/). */ podNsgIds: string[]; /** * The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs */ podSubnetIds: string[]; } interface GetNodePoolNodeConfigDetailPlacementConfig { /** * The name of the availability domain in which this node is placed. */ availabilityDomain: string; /** * The OCID of the compute capacity reservation in which to place the compute instance. */ capacityReservationId: string; /** * A list of fault domains in which to place nodes. */ faultDomains: string[]; /** * The OCID of the Host Group to be associated with the worker node instance. */ hostGroupId: string; /** * Configuration options for preemptible nodes. */ preemptibleNodeConfigs: outputs.ContainerEngine.GetNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig[]; /** * the ocid of the subnet to create the vnic in */ subnetId: string; } interface GetNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig { /** * The action to run when the preemptible node is interrupted for eviction. */ preemptionActions: outputs.ContainerEngine.GetNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction[]; } interface GetNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction { /** * 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. */ isPreserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetNodePoolNodeError { /** * 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). */ code: string; /** * A human-readable error string of the upstream error. */ message: string; /** * The status of the HTTP response encountered in the upstream error. */ status: string; } interface GetNodePoolNodeEvictionNodePoolSetting { /** * 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 */ evictionGraceDuration: string; /** * If the node action should be performed if not all the pods can be evicted in the grace period */ isForceActionAfterGraceDuration: boolean; /** * If the underlying compute instance should be deleted if you cannot evict all the pods in grace period */ isForceDeleteAfterGraceDuration: boolean; } interface GetNodePoolNodePoolCyclingDetail { /** * An ordered list of cycle modes that should be performed on the OKE nodes. */ cycleModes: string[]; /** * If cycling operation should be performed on the nodes in the node pool. */ isNodeCyclingEnabled: boolean; /** * 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% */ maximumSurge: string; /** * 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% */ maximumUnavailable: string; } interface GetNodePoolNodeShapeConfig { /** * The total amount of memory available to each node, in gigabytes. */ memoryInGbs: number; /** * 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. */ ocpus: number; } interface GetNodePoolNodeSource { /** * The OCID of the image used to boot the node. */ imageId: string; /** * The user-friendly name of the entity corresponding to the OCID. */ sourceName: string; /** * The source type for the node. Use `IMAGE` when specifying an OCID of an image. */ sourceType: string; } interface GetNodePoolNodeSourceDetail { /** * 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. */ bootVolumeSizeInGbs: string; /** * The OCID of the image used to boot the node. */ imageId: string; /** * The source type for the node. Use `IMAGE` when specifying an OCID of an image. */ sourceType: string; } interface GetNodePoolOptionSource { /** * The OCID of the image. */ imageId: string; /** * The user-friendly name of the entity corresponding to the OCID. */ sourceName: string; /** * The source type of this option. `IMAGE` means the OCID is of an image. */ sourceType: string; } interface GetNodePoolPrimaryVnic { /** * [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. */ securityAttributes: { [key: string]: string; }; } interface GetNodePoolSecondaryVnic { /** * The properties of the secondary vnics */ createVnicDetails: outputs.ContainerEngine.GetNodePoolSecondaryVnicCreateVnicDetail[]; /** * Display name for vnic attachment */ displayName: string; /** * Which physical network interface card (NIC) the VNIC will use */ nicIndex: number; } interface GetNodePoolSecondaryVnicCreateVnicDetail { /** * The application resource that corresponds to this secondary vnic. Used to map pods to this specific vnic for scheduling */ applicationResources: string[]; /** * Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet */ assignIpv6ip: boolean; /** * Whether the VNIC should be assigned a public IP address */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Display name for vnic attachment */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The number of ip addresses to attach to secondary vnic */ ipCount: number; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.ContainerEngine.GetNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; /** * A list of the OCIDs of the network security groups (NSGs) to add the VNIC to */ nsgIds: string[]; /** * [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. */ securityAttributes: { [key: string]: string; }; /** * Whether the source/destination check is disabled on the VNIC */ skipSourceDestCheck: boolean; /** * the ocid of the subnet to create the vnic in */ subnetId: string; } interface GetNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix */ ipv6address: string; /** * The IPv6 prefix allocated to the subnet */ ipv6subnetCidr: string; } interface GetNodePoolsFilter { /** * The name to filter on. */ name: string; regex?: boolean; values: string[]; } interface GetNodePoolsNodePool { /** * The OCID of the cluster. */ clusterId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the node pool. */ id: string; /** * A list of key/value pairs to add to nodes after they join the Kubernetes cluster. */ initialNodeLabels: outputs.ContainerEngine.GetNodePoolsNodePoolInitialNodeLabel[]; /** * The version of Kubernetes running on the nodes in the node pool. */ kubernetesVersion: string; /** * Details about the state of the nodepool. */ lifecycleDetails: string; /** * The name to filter on. */ name: string; /** * Emulation type for the physical network interface card (NIC) for nodes */ networkLaunchType: string; /** * The configuration of nodes in the node pool. */ nodeConfigDetails: outputs.ContainerEngine.GetNodePoolsNodePoolNodeConfigDetail[]; /** * Node Eviction Details configuration */ nodeEvictionNodePoolSettings: outputs.ContainerEngine.GetNodePoolsNodePoolNodeEvictionNodePoolSetting[]; /** * Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool. * * @deprecated 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. */ nodeImageId: string; /** * Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool. * * @deprecated 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. */ nodeImageName: string; nodeMetadata: { [key: string]: string; }; /** * Node Pool Cycling Details */ nodePoolCyclingDetails: outputs.ContainerEngine.GetNodePoolsNodePoolNodePoolCyclingDetail[]; nodePoolId: string; /** * The name of the node shape of the nodes in the node pool. */ nodeShape: string; /** * The shape configuration of the nodes. */ nodeShapeConfigs: outputs.ContainerEngine.GetNodePoolsNodePoolNodeShapeConfig[]; /** * Source running on the nodes in the node pool. */ nodeSourceDetails: outputs.ContainerEngine.GetNodePoolsNodePoolNodeSourceDetail[]; /** * Deprecated. see `nodeSourceDetails`. Source running on the nodes in the node pool. */ nodeSources: outputs.ContainerEngine.GetNodePoolsNodePoolNodeSource[]; nodes: outputs.ContainerEngine.GetNodePoolsNodePoolNode[]; /** * Details for node's primary VNIC */ primaryVnics: outputs.ContainerEngine.GetNodePoolsNodePoolPrimaryVnic[]; /** * The number of nodes in each subnet. */ quantityPerSubnet: number; /** * A list of secondary vnics to attach to nodes */ secondaryVnics: outputs.ContainerEngine.GetNodePoolsNodePoolSecondaryVnic[]; /** * The SSH public key on each node in the node pool on launch. */ sshPublicKey: string; /** * A list of nodepool lifecycle states on which to filter on, matching any of the list items (OR logic). eg. [ACTIVE, DELETING] */ state: string; /** * The OCIDs of the subnets in which to place nodes for this node pool. */ subnetIds: string[]; } interface GetNodePoolsNodePoolInitialNodeLabel { /** * The key of the pair. */ key: string; /** * The value of the pair. */ value: string; } interface GetNodePoolsNodePoolNode { /** * The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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"}` */ definedTags: { [key: string]: string; }; errors: outputs.ContainerEngine.GetNodePoolsNodePoolNodeError[]; faultDomain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the node pool. */ id: string; /** * The version of Kubernetes running on the nodes in the node pool. */ kubernetesVersion: string; /** * Details about the state of the nodepool. */ lifecycleDetails: string; /** * The name to filter on. */ name: string; nodePoolId: string; privateIp: string; publicIp: string; /** * A list of nodepool lifecycle states on which to filter on, matching any of the list items (OR logic). eg. [ACTIVE, DELETING] */ state: string; /** * the ocid of the subnet to create the vnic in */ subnetId: string; } interface GetNodePoolsNodePoolNodeConfigDetail { /** * The OCID of the Compute Cluster to be associated with the worker node instance. */ computeClusterId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ isPvEncryptionInTransitEnabled: boolean; /** * The OCID of the Key Management Service key assigned to the boot volume. */ kmsKeyId: string; /** * The CNI related configuration of pods in the node pool. */ nodePoolPodNetworkOptionDetails: outputs.ContainerEngine.GetNodePoolsNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail[]; /** * A list of the OCIDs of the network security groups (NSGs) to add the VNIC to */ nsgIds: string[]; /** * The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node. */ placementConfigs: outputs.ContainerEngine.GetNodePoolsNodePoolNodeConfigDetailPlacementConfig[]; /** * The number of nodes in the node pool. */ size: number; } interface GetNodePoolsNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail { /** * The CNI plugin used by this node pool */ cniType: string; /** * 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 */ maxPodsPerNode: number; /** * 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/). */ podNsgIds: string[]; /** * The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs */ podSubnetIds: string[]; } interface GetNodePoolsNodePoolNodeConfigDetailPlacementConfig { /** * The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compute capacity reservation in which to place the compute instance. */ capacityReservationId: string; /** * A list of fault domains in which to place nodes. */ faultDomains: string[]; /** * The OCID of the Host Group to be associated with the worker node instance. */ hostGroupId: string; /** * Configuration options for preemptible nodes. */ preemptibleNodeConfigs: outputs.ContainerEngine.GetNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig[]; /** * the ocid of the subnet to create the vnic in */ subnetId: string; } interface GetNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig { /** * The action to run when the preemptible node is interrupted for eviction. */ preemptionActions: outputs.ContainerEngine.GetNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction[]; } interface GetNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction { /** * 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. */ isPreserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetNodePoolsNodePoolNodeError { code: string; message: string; status: string; } interface GetNodePoolsNodePoolNodeEvictionNodePoolSetting { /** * 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 */ evictionGraceDuration: string; /** * If the node action should be performed if not all the pods can be evicted in the grace period */ isForceActionAfterGraceDuration: boolean; /** * If the underlying compute instance should be deleted if you cannot evict all the pods in grace period */ isForceDeleteAfterGraceDuration: boolean; } interface GetNodePoolsNodePoolNodePoolCyclingDetail { /** * An ordered list of cycle modes that should be performed on the OKE nodes. */ cycleModes: string[]; /** * If cycling operation should be performed on the nodes in the node pool. */ isNodeCyclingEnabled: boolean; /** * 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% */ maximumSurge: string; /** * 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% */ maximumUnavailable: string; } interface GetNodePoolsNodePoolNodeShapeConfig { /** * The total amount of memory available to each node, in gigabytes. */ memoryInGbs: number; /** * 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. */ ocpus: number; } interface GetNodePoolsNodePoolNodeSource { /** * The OCID of the image used to boot the node. */ imageId: string; /** * The user-friendly name of the entity corresponding to the OCID. */ sourceName: string; /** * The source type for the node. Use `IMAGE` when specifying an OCID of an image. */ sourceType: string; } interface GetNodePoolsNodePoolNodeSourceDetail { /** * 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. */ bootVolumeSizeInGbs: string; /** * The OCID of the image used to boot the node. */ imageId: string; /** * The source type for the node. Use `IMAGE` when specifying an OCID of an image. */ sourceType: string; } interface GetNodePoolsNodePoolPrimaryVnic { /** * [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. */ securityAttributes: { [key: string]: string; }; } interface GetNodePoolsNodePoolSecondaryVnic { /** * The properties of the secondary vnics */ createVnicDetails: outputs.ContainerEngine.GetNodePoolsNodePoolSecondaryVnicCreateVnicDetail[]; /** * Display name for vnic attachment */ displayName: string; /** * Which physical network interface card (NIC) the VNIC will use */ nicIndex: number; } interface GetNodePoolsNodePoolSecondaryVnicCreateVnicDetail { /** * The application resource that corresponds to this secondary vnic. Used to map pods to this specific vnic for scheduling */ applicationResources: string[]; /** * Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet */ assignIpv6ip: boolean; /** * Whether the VNIC should be assigned a public IP address */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Display name for vnic attachment */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The number of ip addresses to attach to secondary vnic */ ipCount: number; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.ContainerEngine.GetNodePoolsNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; /** * A list of the OCIDs of the network security groups (NSGs) to add the VNIC to */ nsgIds: string[]; /** * [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. */ securityAttributes: { [key: string]: string; }; /** * Whether the source/destination check is disabled on the VNIC */ skipSourceDestCheck: boolean; /** * the ocid of the subnet to create the vnic in */ subnetId: string; } interface GetNodePoolsNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix */ ipv6address: string; /** * The IPv6 prefix allocated to the subnet */ ipv6subnetCidr: string; } interface GetPodShapesFilter { /** * The name to filter on. */ name: string; regex?: boolean; values: string[]; } interface GetPodShapesPodShape { /** * ShapeMemoryOptions. */ memoryOptions: outputs.ContainerEngine.GetPodShapesPodShapeMemoryOption[]; /** * The name to filter on. */ name: string; /** * ShapeNetworkBandwidthOptions. */ networkBandwidthOptions: outputs.ContainerEngine.GetPodShapesPodShapeNetworkBandwidthOption[]; /** * Options for OCPU shape. */ ocpuOptions: outputs.ContainerEngine.GetPodShapesPodShapeOcpuOption[]; /** * A short description of the VM's processor (CPU). */ processorDescription: string; } interface GetPodShapesPodShapeMemoryOption { /** * The default amount of memory per OCPU available for this shape, in gigabytes. */ defaultPerOcpuInGbs: number; /** * The maximum amount of memory, in gigabytes. */ maxInGbs: number; /** * The maximum amount of memory per OCPU available for this shape, in gigabytes. */ maxPerOcpuInGbs: number; /** * The minimum amount of memory, in gigabytes. */ minInGbs: number; /** * The minimum amount of memory per OCPU available for this shape, in gigabytes. */ minPerOcpuInGbs: number; } interface GetPodShapesPodShapeNetworkBandwidthOption { /** * The default amount of networking bandwidth per OCPU, in gigabits per second. */ defaultPerOcpuInGbps: number; /** * The maximum amount of networking bandwidth, in gigabits per second. */ maxInGbps: number; /** * The minimum amount of networking bandwidth, in gigabits per second. */ minInGbps: number; } interface GetPodShapesPodShapeOcpuOption { /** * The maximum number of OCPUs. */ max: number; /** * The minimum number of OCPUs. */ min: number; } interface GetVirtualNodePoolInitialVirtualNodeLabel { /** * The key of the pair. */ key: string; /** * The value of the pair. */ value: string; } interface GetVirtualNodePoolPlacementConfiguration { /** * The availability domain in which to place virtual nodes. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The fault domain of this virtual node. */ faultDomains: string[]; /** * The private regional subnet where pods' VNIC will be placed. */ subnetId: string; } interface GetVirtualNodePoolPodConfiguration { /** * List of network security group IDs applied to the Pod VNIC. */ nsgIds: string[]; /** * Shape of the pods. */ shape: string; /** * The private regional subnet where pods' VNIC will be placed. */ subnetId: string; } interface GetVirtualNodePoolTaint { /** * The effect of the pair. */ effect: string; /** * The key of the pair. */ key: string; /** * The value of the pair. */ value: string; } interface GetVirtualNodePoolVirtualNodePoolCyclingDetail { /** * If virtual nodes in the virtual nodepool will be cycled to have new changes. */ isVirtualNodeCyclingEnabled: boolean; /** * 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% */ maximumSurge: string; /** * 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% */ maximumUnavailable: string; } interface GetVirtualNodePoolVirtualNodeTag { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; } interface GetVirtualNodePoolsFilter { /** * The name to filter on. */ name: string; regex?: boolean; values: string[]; } interface GetVirtualNodePoolsVirtualNodePool { /** * The OCID of the cluster. */ clusterId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Display name of the virtual node pool. This is a non-unique value. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the virtual node pool. */ id: string; /** * Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources. */ initialVirtualNodeLabels: outputs.ContainerEngine.GetVirtualNodePoolsVirtualNodePoolInitialVirtualNodeLabel[]; /** * The version of Kubernetes running on the nodes in the node pool. */ kubernetesVersion: string; /** * Details about the state of the Virtual Node Pool. */ lifecycleDetails: string; /** * List of network security group IDs applied to the Pod VNIC. */ nsgIds: string[]; /** * 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 */ placementConfigurations: outputs.ContainerEngine.GetVirtualNodePoolsVirtualNodePoolPlacementConfiguration[]; /** * The pod configuration for pods run on virtual nodes of this virtual node pool. */ podConfigurations: outputs.ContainerEngine.GetVirtualNodePoolsVirtualNodePoolPodConfiguration[]; /** * The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed. */ size: number; /** * A virtual node pool lifecycle state to filter on. Can have multiple parameters of this name. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A taint is a collection of . These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling. */ taints: outputs.ContainerEngine.GetVirtualNodePoolsVirtualNodePoolTaint[]; /** * The time the virtual node pool was created. */ timeCreated: string; /** * The time the virtual node pool was updated. */ timeUpdated: string; /** * Virtual Node Pool Cycling Details */ virtualNodePoolCyclingDetails: outputs.ContainerEngine.GetVirtualNodePoolsVirtualNodePoolVirtualNodePoolCyclingDetail[]; virtualNodePoolId: string; /** * The tags associated to the virtual nodes in this virtual node pool. */ virtualNodeTags: outputs.ContainerEngine.GetVirtualNodePoolsVirtualNodePoolVirtualNodeTag[]; } interface GetVirtualNodePoolsVirtualNodePoolInitialVirtualNodeLabel { /** * The key of the pair. */ key: string; /** * The value of the pair. */ value: string; } interface GetVirtualNodePoolsVirtualNodePoolPlacementConfiguration { /** * The availability domain in which to place virtual nodes. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The fault domain of this virtual node. */ faultDomains: string[]; /** * The private regional subnet where pods' VNIC will be placed. */ subnetId: string; } interface GetVirtualNodePoolsVirtualNodePoolPodConfiguration { /** * List of network security group IDs applied to the Pod VNIC. */ nsgIds: string[]; /** * Shape of the pods. */ shape: string; /** * The private regional subnet where pods' VNIC will be placed. */ subnetId: string; } interface GetVirtualNodePoolsVirtualNodePoolTaint { /** * The effect of the pair. */ effect: string; /** * The key of the pair. */ key: string; /** * The value of the pair. */ value: string; } interface GetVirtualNodePoolsVirtualNodePoolVirtualNodePoolCyclingDetail { /** * If virtual nodes in the virtual nodepool will be cycled to have new changes. */ isVirtualNodeCyclingEnabled: boolean; /** * 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% */ maximumSurge: string; /** * 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% */ maximumUnavailable: string; } interface GetVirtualNodePoolsVirtualNodePoolVirtualNodeTag { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; } interface GetWorkRequestErrorsFilter { name: string; regex?: boolean; values: string[]; } interface GetWorkRequestErrorsWorkRequestError { /** * 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). */ code: string; /** * A human-readable error string. */ message: string; /** * The date and time the error occurred. */ timestamp: string; } interface GetWorkRequestLogEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetWorkRequestLogEntriesWorkRequestLogEntry { /** * The description of an action that occurred. */ message: string; /** * The date and time the log entry occurred. */ timestamp: string; } interface GetWorkRequestsFilter { name: string; regex?: boolean; values: string[]; } interface GetWorkRequestsWorkRequest { /** * The OCID of the compartment. */ compartmentId: string; /** * The OCID of the work request. */ id: string; /** * The type of work the work request is doing. */ operationType: string; /** * The resources this work request affects. */ resources: outputs.ContainerEngine.GetWorkRequestsWorkRequestResource[]; /** * A work request status to filter on. Can have multiple parameters of this name. */ status: string; /** * The time the work request was accepted. */ timeAccepted: string; /** * The time the work request was finished. */ timeFinished: string; /** * The time the work request was started. */ timeStarted: string; } interface GetWorkRequestsWorkRequestResource { /** * The way in which this resource was affected by the work tracked by the work request. */ actionType: string; /** * The resource type the work request affects. */ entityType: string; /** * The URI path on which the user can issue a GET request to access the resource metadata. */ entityUri: string; /** * The OCID of the resource the work request affects. */ identifier: string; } interface NodePoolInitialNodeLabel { /** * (Updatable) The key of the pair. */ key: string; /** * (Updatable) The value of the pair. */ value: string; } interface NodePoolNode { /** * The name of the availability domain in which this node is placed. */ availabilityDomain: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * An error that may be associated with the node. */ errors: outputs.ContainerEngine.NodePoolNodeError[]; /** * The fault domain of this node. */ faultDomain: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the compute instance backing this node. */ id: string; /** * (Updatable) The version of Kubernetes to install on the nodes in the node pool. */ kubernetesVersion: string; /** * Details about the state of the node. */ lifecycleDetails: string; /** * (Updatable) The name of the node pool. Avoid entering confidential information. */ name: string; /** * The OCID of the node pool to which this node belongs. */ nodePoolId: string; /** * The private IP address of this node. */ privateIp: string; /** * The public IP address of this node. */ publicIp: string; /** * The state of the nodepool. For more information, see [Monitoring Clusters](https://docs.cloud.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm) */ state: string; /** * the ocid of the subnet to create the vnic in */ subnetId: string; } interface NodePoolNodeConfigDetails { /** * The OCID of the Compute Cluster to be associated with the worker node instance. */ computeClusterId?: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * (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. */ isPvEncryptionInTransitEnabled: boolean; /** * (Updatable) The OCID of the Key Management Service key assigned to the boot volume. */ kmsKeyId: string; /** * (Updatable) The CNI related configuration of pods in the node pool. */ nodePoolPodNetworkOptionDetails: outputs.ContainerEngine.NodePoolNodeConfigDetailsNodePoolPodNetworkOptionDetails; /** * (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/). */ nsgIds: string[]; /** * (Updatable) The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node. * * To 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. */ placementConfigs: outputs.ContainerEngine.NodePoolNodeConfigDetailsPlacementConfig[]; /** * (Updatable) The number of nodes that should be in the node pool. */ size: number; } interface NodePoolNodeConfigDetailsNodePoolPodNetworkOptionDetails { /** * (Updatable) The CNI plugin used by this node pool */ cniType: string; /** * (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 */ maxPodsPerNode: number; /** * (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/). */ podNsgIds: string[]; /** * (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 */ podSubnetIds: string[]; } interface NodePoolNodeConfigDetailsPlacementConfig { /** * (Updatable) The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * (Updatable) The OCID of the compute capacity reservation in which to place the compute instance. */ capacityReservationId: string; /** * (Updatable) A list of fault domains in which to place nodes. */ faultDomains: string[]; /** * (Updatable) The OCID of the Host Group to be associated with the worker node instance. */ hostGroupId?: string; /** * (Updatable) Configuration options for preemptible nodes. */ preemptibleNodeConfig: outputs.ContainerEngine.NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfig; /** * (Updatable) The OCID of the subnet in which to place nodes. */ subnetId: string; } interface NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfig { /** * (Updatable) The action to run when the preemptible node is interrupted for eviction. */ preemptionAction: outputs.ContainerEngine.NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfigPreemptionAction; } interface NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfigPreemptionAction { /** * (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. */ isPreserveBootVolume: boolean; /** * (Updatable) The type of action to run when the instance is interrupted for eviction. */ type: string; } interface NodePoolNodeError { /** * 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). */ code: string; /** * A human-readable error string of the upstream error. */ message: string; /** * The status of the HTTP response encountered in the upstream error. */ status: string; } interface NodePoolNodeEvictionNodePoolSettings { /** * (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 */ evictionGraceDuration: string; /** * (Updatable) If the node action should be performed if not all the pods can be evicted in the grace period */ isForceActionAfterGraceDuration: boolean; /** * (Updatable) If the underlying compute instance should be deleted if you cannot evict all the pods in grace period */ isForceDeleteAfterGraceDuration: boolean; } interface NodePoolNodePoolCyclingDetails { /** * (Updatable) An ordered list of cycle modes that should be performed on the OKE nodes. */ cycleModes: string[]; /** * (Updatable) If cycling operation should be performed on the nodes in the node pool. */ isNodeCyclingEnabled: boolean; /** * (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% */ maximumSurge: string; /** * (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% */ maximumUnavailable: string; } interface NodePoolNodeShapeConfig { /** * (Updatable) The total amount of memory available to each node, in gigabytes. */ memoryInGbs: number; /** * (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. */ ocpus: number; } interface NodePoolNodeSource { /** * The OCID of the image used to boot the node. */ imageId: string; /** * The user-friendly name of the entity corresponding to the OCID. */ sourceName: string; /** * The source type for the node. Use `IMAGE` when specifying an OCID of an image. */ sourceType: string; } interface NodePoolNodeSourceDetails { /** * (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. */ bootVolumeSizeInGbs: string; /** * (Updatable) The OCID of the image used to boot the node. */ imageId: string; /** * (Updatable) The source type for the node. Use `IMAGE` when specifying an OCID of an image. */ sourceType: string; } interface NodePoolPrimaryVnic { /** * (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. */ securityAttributes: { [key: string]: string; }; } interface NodePoolSecondaryVnic { /** * (Updatable) The properties of the secondary vnics */ createVnicDetails: outputs.ContainerEngine.NodePoolSecondaryVnicCreateVnicDetails; /** * (Updatable) Display name for vnic attachment */ displayName: string; /** * (Updatable) Which physical network interface card (NIC) the VNIC will use */ nicIndex: number; } interface NodePoolSecondaryVnicCreateVnicDetails { /** * (Updatable) The application resource that corresponds to this secondary vnic. Used to map pods to this specific vnic for scheduling */ applicationResources: string[]; /** * (Updatable) Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet */ assignIpv6ip: boolean; /** * (Updatable) Whether the VNIC should be assigned a public IP address */ assignPublicIp: boolean; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) Display name for secondary vnic */ displayName: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * (Updatable) The number of ip addresses to attach to secondary vnic */ ipCount: number; /** * (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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.ContainerEngine.NodePoolSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail[]; /** * (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the VNIC to */ nsgIds: string[]; /** * (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. */ securityAttributes: { [key: string]: string; }; /** * (Updatable) Whether the source/destination check is disabled on the VNIC */ skipSourceDestCheck: boolean; /** * (Updatable) the ocid of the subnet to create the vnic in */ subnetId: string; } interface NodePoolSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail { /** * (Updatable) An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix */ ipv6address: string; /** * (Updatable) The IPv6 prefix allocated to the subnet */ ipv6subnetCidr: string; } interface VirtualNodePoolInitialVirtualNodeLabel { /** * (Updatable) The key of the pair. */ key: string; /** * (Updatable) The value of the pair. */ value: string; } interface VirtualNodePoolPlacementConfiguration { /** * (Updatable) The availability domain in which to place virtual nodes. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * (Updatable) The fault domain of this virtual node. */ faultDomains: string[]; /** * (Updatable) The OCID of the subnet in which to place virtual nodes. */ subnetId: string; } interface VirtualNodePoolPodConfiguration { /** * (Updatable) List of network security group IDs applied to the Pod VNIC. */ nsgIds: string[]; /** * (Updatable) Shape of the pods. */ shape: string; /** * (Updatable) The private regional subnet where pods' VNIC will be placed. */ subnetId: string; } interface VirtualNodePoolTaint { /** * (Updatable) The effect of the pair. */ effect: string; /** * (Updatable) The key of the pair. */ key: string; /** * (Updatable) The value of the pair. */ value: string; } interface VirtualNodePoolVirtualNodePoolCyclingDetails { /** * (Updatable) If virtual nodes in the virtual nodepool will be cycled to have new changes. */ isVirtualNodeCyclingEnabled: boolean; /** * (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% */ maximumSurge: string; /** * (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% */ maximumUnavailable: string; } interface VirtualNodePoolVirtualNodeTags { /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (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"}` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ freeformTags: { [key: string]: string; }; } } export declare namespace ContainerInstances { interface GetContainerInstanceContainer { arguments: string[]; /** * The availability domain to place the container instance. */ availabilityDomain: string; commands: string[]; /** * The OCID of the compartment. */ compartmentId: string; /** * The OCID of the container. */ containerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance. */ containerInstanceId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; environmentVariables: { [key: string]: string; }; exitCode: number; /** * The fault domain to place the container instance. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; healthChecks: outputs.ContainerInstances.GetContainerInstanceContainerHealthCheck[]; imageUrl: string; isResourcePrincipalDisabled: boolean; /** * A message that describes the current state of the container in more detail. Can be used to provide actionable information. */ lifecycleDetails: string; resourceConfigs: outputs.ContainerInstances.GetContainerInstanceContainerResourceConfig[]; /** * Security context for all containers in a container instance. */ securityContexts: outputs.ContainerInstances.GetContainerInstanceContainerSecurityContext[]; /** * The current state of the container instance. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`. */ systemTags: { [key: string]: string; }; /** * The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; timeTerminated: string; /** * The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; volumeMounts: outputs.ContainerInstances.GetContainerInstanceContainerVolumeMount[]; workingDirectory: string; } interface GetContainerInstanceContainerHealthCheck { failureAction: string; failureThreshold: number; headers: outputs.ContainerInstances.GetContainerInstanceContainerHealthCheckHeader[]; healthCheckType: string; initialDelayInSeconds: number; intervalInSeconds: number; /** * The name of the volume. This must be unique within a single container instance. */ name: string; /** * (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. */ path: string; port: number; status: string; statusDetails: string; successThreshold: number; timeoutInSeconds: number; } interface GetContainerInstanceContainerHealthCheckHeader { /** * The name of the volume. This must be unique within a single container instance. */ name: string; /** * The value of the mount option. */ value: string; } interface GetContainerInstanceContainerResourceConfig { memoryLimitInGbs: number; vcpusLimit: number; } interface GetContainerInstanceContainerSecurityContext { capabilities: outputs.ContainerInstances.GetContainerInstanceContainerSecurityContextCapability[]; isNonRootUserCheckEnabled: boolean; isRootFileSystemReadonly: boolean; runAsGroup: number; runAsUser: number; /** * The type of security context */ securityContextType: string; } interface GetContainerInstanceContainerSecurityContextCapability { addCapabilities: string[]; dropCapabilities: string[]; } interface GetContainerInstanceContainerVolumeMount { isReadOnly: boolean; mountPath: string; partition: number; subPath: string; volumeName: string; } interface GetContainerInstanceDnsConfig { /** * IP address of the name server.. */ nameservers: string[]; /** * Options allows certain internal resolver variables to be modified. */ options: string[]; /** * Search list for hostname lookup. */ searches: string[]; } interface GetContainerInstanceImagePullSecret { password: string; /** * The registry endpoint of the container image. */ registryEndpoint: string; /** * The OCID of the secret for registry credentials. */ secretId: string; /** * The type of ImagePullSecret. */ secretType: string; username: string; } interface GetContainerInstanceSecurityContext { /** * 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. */ fsGroup: number; /** * 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. */ fsGroupChangePolicy: string; /** * The type of security context */ securityContextType: string; } interface GetContainerInstanceShapeConfig { /** * The total amount of memory available to the container instance, in gigabytes. */ memoryInGbs: number; /** * The networking bandwidth available to the container instance, in gigabits per second. */ networkingBandwidthInGbps: number; /** * The total number of OCPUs available to the container instance. */ ocpus: number; /** * A short description of the container instance's processor (CPU). */ processorDescription: string; } interface GetContainerInstanceShapeItem { /** * For a flexible shape, the amount of memory available for instances that use this shape. */ memoryOptions: outputs.ContainerInstances.GetContainerInstanceShapeItemMemoryOption[]; /** * The name identifying the shape. */ name: string; /** * For a flexible shape, the amount of networking bandwidth available for instances that use this shape. */ networkingBandwidthOptions: outputs.ContainerInstances.GetContainerInstanceShapeItemNetworkingBandwidthOption[]; /** * For a flexible shape, the number of OCPUs available for instances that use this shape. */ ocpuOptions: outputs.ContainerInstances.GetContainerInstanceShapeItemOcpuOption[]; /** * A short description of the Instance's processor (CPU). */ processorDescription: string; } interface GetContainerInstanceShapeItemMemoryOption { /** * The default amount of memory per OCPU available for this shape, in gigabytes. */ defaultPerOcpuInGbs: number; /** * The maximum amount of memory, in gigabytes. */ maxInGbs: number; /** * The maximum amount of memory per OCPU available for this shape, in gigabytes. */ maxPerOcpuInGbs: number; /** * The minimum amount of memory, in gigabytes. */ minInGbs: number; /** * The minimum amount of memory per OCPU available for this shape, in gigabytes. */ minPerOcpuInGbs: number; } interface GetContainerInstanceShapeItemNetworkingBandwidthOption { /** * The default amount of networking bandwidth per OCPU, in gigabits per second. */ defaultPerOcpuInGbps: number; /** * The maximum amount of networking bandwidth, in gigabits per second. */ maxInGbps: number; /** * The minimum amount of networking bandwidth, in gigabits per second. */ minInGbps: number; } interface GetContainerInstanceShapeItemOcpuOption { /** * The maximum number of OCPUs. */ max: number; /** * The minimum number of OCPUs. */ min: number; } interface GetContainerInstanceShapesContainerInstanceShapeCollection { /** * A list of shapes. */ items: outputs.ContainerInstances.GetContainerInstanceShapesContainerInstanceShapeCollectionItem[]; } interface GetContainerInstanceShapesContainerInstanceShapeCollectionItem { /** * For a flexible shape, the amount of memory available for container instances that use this shape. */ memoryOptions: outputs.ContainerInstances.GetContainerInstanceShapesContainerInstanceShapeCollectionItemMemoryOption[]; /** * The name identifying the shape. */ name: string; /** * For a flexible shape, the amount of networking bandwidth available for container instances that use this shape. */ networkingBandwidthOptions: outputs.ContainerInstances.GetContainerInstanceShapesContainerInstanceShapeCollectionItemNetworkingBandwidthOption[]; /** * For a flexible shape, the number of OCPUs available for container instances that use this shape. */ ocpuOptions: outputs.ContainerInstances.GetContainerInstanceShapesContainerInstanceShapeCollectionItemOcpuOption[]; /** * A short description of the container instance's processor (CPU). */ processorDescription: string; } interface GetContainerInstanceShapesContainerInstanceShapeCollectionItemMemoryOption { /** * The default amount of memory per OCPU available for this shape (GB). */ defaultPerOcpuInGbs: number; /** * The maximum amount of memory (GB). */ maxInGbs: number; /** * The maximum amount of memory per OCPU available for this shape (GB). */ maxPerOcpuInGbs: number; /** * The minimum amount of memory (GB). */ minInGbs: number; /** * The minimum amount of memory per OCPU available for this shape (GB). */ minPerOcpuInGbs: number; } interface GetContainerInstanceShapesContainerInstanceShapeCollectionItemNetworkingBandwidthOption { /** * The default amount of networking bandwidth per OCPU, in gigabits per second. */ defaultPerOcpuInGbps: number; /** * The maximum amount of networking bandwidth, in gigabits per second. */ maxInGbps: number; /** * The minimum amount of networking bandwidth, in gigabits per second. */ minInGbps: number; } interface GetContainerInstanceShapesContainerInstanceShapeCollectionItemOcpuOption { /** * The maximum number of OCPUs. */ max: number; /** * The minimum number of OCPUs. */ min: number; } interface GetContainerInstanceShapesFilter { /** * The name identifying the shape. */ name: string; regex?: boolean; values: string[]; } interface GetContainerInstanceVnic { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; hostnameLabel: string; isPublicIpAssigned: boolean; nsgIds: string[]; privateIp: string; skipSourceDestCheck: boolean; /** * 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. */ subnetId: string; /** * The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network. */ vnicId: string; } interface GetContainerInstanceVolume { /** * The volume type of the empty directory, can be either File Storage or Memory. */ backingStore: string; /** * 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. */ configs: outputs.ContainerInstances.GetContainerInstanceVolumeConfig[]; /** * 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. */ exports: outputs.ContainerInstances.GetContainerInstanceVolumeExport[]; /** * Specifications for the mount command to mount the Oracle Cloud Infrastructure File Storage Service (FSS) File System to Containers. */ mountCommands: outputs.ContainerInstances.GetContainerInstanceVolumeMountCommand[]; /** * 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. */ mountTargets: outputs.ContainerInstances.GetContainerInstanceVolumeMountTarget[]; /** * The name of the volume. This must be unique within a single container instance. */ name: string; /** * Security options for Oracle Cloud Infrastructure FSS File System. */ securities: outputs.ContainerInstances.GetContainerInstanceVolumeSecurity[]; /** * 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. */ subnetId: string; /** * The type of volume. */ volumeType: string; } interface GetContainerInstanceVolumeConfig { /** * 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. */ data: string; /** * The name of the file. The fileName should be unique across the volume. */ fileName: string; /** * (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. */ path: string; } interface GetContainerInstanceVolumeExport { /** * The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target. */ id: string; /** * 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. */ ociFssExportType: string; } interface GetContainerInstanceVolumeMountCommand { /** * List of mount options to be used in the mount command. The order of this array will be maintained while preparing the mount command. */ mountOptions: outputs.ContainerInstances.GetContainerInstanceVolumeMountCommandMountOption[]; } interface GetContainerInstanceVolumeMountCommandMountOption { /** * 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. */ option: string; /** * The value of the mount option. */ value: string; } interface GetContainerInstanceVolumeMountTarget { /** * The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target. */ id: string; /** * 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. */ ociFssMountTargetType: string; } interface GetContainerInstanceVolumeSecurity { /** * NFS authentication type to be used. Currently, only auth type SYS is supported. */ auth: string; /** * 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. */ isEncryptedInTransit: boolean; } interface GetContainerInstancesContainerInstanceCollection { items: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItem[]; } interface GetContainerInstancesContainerInstanceCollectionItem { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The number of containers on the container instance. */ containerCount: number; /** * The container restart policy is applied for all containers in container instance. */ containerRestartPolicy: string; /** * The containers on the container instance. */ containers: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemContainer[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * DNS settings for containers. */ dnsConfigs: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemDnsConfig[]; /** * The fault domain to place the container instance. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ gracefulShutdownTimeoutInSeconds: string; /** * The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target. */ id: string; /** * The image pulls secrets so you can access private registry to pull container images. */ imagePullSecrets: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemImagePullSecret[]; /** * A message that describes the current state of the container in more detail. Can be used to provide actionable information. */ lifecycleDetails: string; /** * Security context for all containers in a container instance. */ securityContexts: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemSecurityContext[]; /** * 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. */ shape: string; /** * The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers. */ shapeConfigs: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemShapeConfig[]; /** * A filter to only return resources that match the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`. */ systemTags: { [key: string]: string; }; /** * TenantId id of the container instance. */ tenantId: string; /** * The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; /** * The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; /** * The virtual networks available to the containers in the container instance. */ vnics: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemVnic[]; /** * The number of volumes that are attached to the container instance. */ volumeCount: number; /** * A volume is a directory with data that is accessible across multiple containers in a container instance. */ volumes: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemVolume[]; } interface GetContainerInstancesContainerInstanceCollectionItemContainer { arguments: string[]; /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; commands: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The OCID of the container. */ containerId: string; containerInstanceId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; environmentVariables: { [key: string]: string; }; exitCode: number; /** * The fault domain to place the container instance. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; healthChecks: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemContainerHealthCheck[]; imageUrl: string; isResourcePrincipalDisabled: boolean; /** * A message that describes the current state of the container in more detail. Can be used to provide actionable information. */ lifecycleDetails: string; resourceConfigs: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemContainerResourceConfig[]; /** * Security context for all containers in a container instance. */ securityContexts: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemContainerSecurityContext[]; /** * A filter to only return resources that match the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`. */ systemTags: { [key: string]: string; }; /** * The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; timeTerminated: string; /** * The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; volumeMounts: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemContainerVolumeMount[]; workingDirectory: string; } interface GetContainerInstancesContainerInstanceCollectionItemContainerHealthCheck { failureAction: string; failureThreshold: number; headers: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemContainerHealthCheckHeader[]; healthCheckType: string; initialDelayInSeconds: number; intervalInSeconds: number; /** * The name of the volume. This must be unique within a single container instance. */ name: string; /** * (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. */ path: string; port: number; status: string; statusDetails: string; successThreshold: number; timeoutInSeconds: number; } interface GetContainerInstancesContainerInstanceCollectionItemContainerHealthCheckHeader { /** * The name of the volume. This must be unique within a single container instance. */ name: string; /** * The value of the mount option. */ value: string; } interface GetContainerInstancesContainerInstanceCollectionItemContainerResourceConfig { memoryLimitInGbs: number; vcpusLimit: number; } interface GetContainerInstancesContainerInstanceCollectionItemContainerSecurityContext { capabilities: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemContainerSecurityContextCapability[]; isNonRootUserCheckEnabled: boolean; isRootFileSystemReadonly: boolean; runAsGroup: number; runAsUser: number; /** * The type of security context */ securityContextType: string; } interface GetContainerInstancesContainerInstanceCollectionItemContainerSecurityContextCapability { addCapabilities: string[]; dropCapabilities: string[]; } interface GetContainerInstancesContainerInstanceCollectionItemContainerVolumeMount { isReadOnly: boolean; mountPath: string; partition: number; subPath: string; volumeName: string; } interface GetContainerInstancesContainerInstanceCollectionItemDnsConfig { /** * IP address of the name server.. */ nameservers: string[]; /** * Options allows certain internal resolver variables to be modified. */ options: string[]; /** * Search list for hostname lookup. */ searches: string[]; } interface GetContainerInstancesContainerInstanceCollectionItemImagePullSecret { password: string; /** * The registry endpoint of the container image. */ registryEndpoint: string; /** * The OCID of the secret for registry credentials. */ secretId: string; /** * The type of ImagePullSecret. */ secretType: string; username: string; } interface GetContainerInstancesContainerInstanceCollectionItemSecurityContext { /** * 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. */ fsGroup: number; /** * 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. */ fsGroupChangePolicy: string; /** * The type of security context */ securityContextType: string; } interface GetContainerInstancesContainerInstanceCollectionItemShapeConfig { /** * The total amount of memory available to the container instance, in gigabytes. */ memoryInGbs: number; /** * The networking bandwidth available to the container instance, in gigabits per second. */ networkingBandwidthInGbps: number; /** * The total number of OCPUs available to the container instance. */ ocpus: number; /** * A short description of the container instance's processor (CPU). */ processorDescription: string; } interface GetContainerInstancesContainerInstanceCollectionItemVnic { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; hostnameLabel: string; isPublicIpAssigned: boolean; nsgIds: string[]; privateIp: string; skipSourceDestCheck: boolean; /** * 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. */ subnetId: string; /** * The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network. */ vnicId: string; } interface GetContainerInstancesContainerInstanceCollectionItemVolume { /** * The volume type of the empty directory, can be either File Storage or Memory. */ backingStore: string; /** * 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. */ configs: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemVolumeConfig[]; /** * 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. */ exports: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemVolumeExport[]; /** * Specifications for the mount command to mount the Oracle Cloud Infrastructure File Storage Service (FSS) File System to Containers. */ mountCommands: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemVolumeMountCommand[]; /** * 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. */ mountTargets: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemVolumeMountTarget[]; /** * The name of the volume. This must be unique within a single container instance. */ name: string; /** * Security options for Oracle Cloud Infrastructure FSS File System. */ securities: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemVolumeSecurity[]; /** * 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. */ subnetId: string; /** * The type of volume. */ volumeType: string; } interface GetContainerInstancesContainerInstanceCollectionItemVolumeConfig { /** * 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. */ data: string; /** * The name of the file. The fileName should be unique across the volume. */ fileName: string; /** * (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. */ path: string; } interface GetContainerInstancesContainerInstanceCollectionItemVolumeExport { /** * The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target. */ id: string; /** * 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. */ ociFssExportType: string; } interface GetContainerInstancesContainerInstanceCollectionItemVolumeMountCommand { /** * List of mount options to be used in the mount command. The order of this array will be maintained while preparing the mount command. */ mountOptions: outputs.ContainerInstances.GetContainerInstancesContainerInstanceCollectionItemVolumeMountCommandMountOption[]; } interface GetContainerInstancesContainerInstanceCollectionItemVolumeMountCommandMountOption { /** * 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. */ option: string; /** * The value of the mount option. */ value: string; } interface GetContainerInstancesContainerInstanceCollectionItemVolumeMountTarget { /** * The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target. */ id: string; /** * 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. */ ociFssMountTargetType: string; } interface GetContainerInstancesContainerInstanceCollectionItemVolumeSecurity { /** * NFS authentication type to be used. Currently, only auth type SYS is supported. */ auth: string; /** * 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. */ isEncryptedInTransit: boolean; } interface GetContainerInstancesFilter { /** * The name of the volume. This must be unique within a single container instance. */ name: string; regex?: boolean; values: string[]; } } export declare namespace Core { interface BootVolumeAutotunePolicy { /** * (Updatable) This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface BootVolumeBackupRetentionPeriod { /** * (Updatable) The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period. */ retentionTimeAmount: number; /** * (Updatable) The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS". */ retentionTimeUnit: string; } interface BootVolumeBackupSourceDetails { bootVolumeBackupId: string; /** * The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup. */ kmsKeyId?: string; /** * The region of the volume backup source. */ region: string; } interface BootVolumeBootVolumeReplica { /** * (Updatable) The availability domain of the boot volume replica. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The boot volume replica's Oracle ID (OCID). */ bootVolumeReplicaId: string; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * (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). */ xrrKmsKeyId: string; } interface BootVolumeSourceDetails { /** * 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). */ changeBlockSizeInBytes?: string; /** * The OCID of the first boot volume backup. */ firstBackupId?: string; /** * The OCID of the boot volume replica. */ id?: string; /** * The OCID of the second boot volume backup. */ secondBackupId?: string; /** * The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica` */ type: string; } interface ByoasnByoipRange { /** * The as path prepend length. */ asPathPrependLength: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. */ byoipRangeId: string; /** * The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. */ cidrBlock: string; /** * 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. */ ipv6cidrBlock: string; } interface CaptureFilterFlowLogCaptureFilterRule { /** * (Updatable) Traffic to this CIDR will be captured in the flow log. */ destinationCidr: string; /** * (Updatable) Type or types of flow logs to store. `ALL` includes records for both accepted traffic and rejected traffic. */ flowLogType: string; /** * (Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) * * If 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. */ icmpOptions: outputs.Core.CaptureFilterFlowLogCaptureFilterRuleIcmpOptions; /** * (Updatable) Indicates whether a flow log capture filter rule is enabled. */ isEnabled: boolean; /** * (Updatable) A lower number indicates a higher priority, range 0-9. Each rule must have a distinct priority. */ priority: number; /** * (Updatable) The transport protocol the filter uses. */ protocol: string; /** * (Updatable) Include or exclude a ruleAction object. */ ruleAction: string; /** * (Updatable) Sampling interval as 1 of X, where X is an integer not greater than 100000. */ samplingRate: number; /** * (Updatable) Traffic from this CIDR will be captured in the flow log. */ sourceCidr: string; /** * (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. */ tcpOptions: outputs.Core.CaptureFilterFlowLogCaptureFilterRuleTcpOptions; /** * (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. */ udpOptions: outputs.Core.CaptureFilterFlowLogCaptureFilterRuleUdpOptions; } interface CaptureFilterFlowLogCaptureFilterRuleIcmpOptions { /** * (Updatable) The ICMP code (optional). */ code: number; /** * (Updatable) The ICMP type. */ type: number; } interface CaptureFilterFlowLogCaptureFilterRuleTcpOptions { /** * (Updatable) */ destinationPortRange: outputs.Core.CaptureFilterFlowLogCaptureFilterRuleTcpOptionsDestinationPortRange; /** * (Updatable) */ sourcePortRange: outputs.Core.CaptureFilterFlowLogCaptureFilterRuleTcpOptionsSourcePortRange; } interface CaptureFilterFlowLogCaptureFilterRuleTcpOptionsDestinationPortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface CaptureFilterFlowLogCaptureFilterRuleTcpOptionsSourcePortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface CaptureFilterFlowLogCaptureFilterRuleUdpOptions { /** * (Updatable) */ destinationPortRange: outputs.Core.CaptureFilterFlowLogCaptureFilterRuleUdpOptionsDestinationPortRange; /** * (Updatable) */ sourcePortRange: outputs.Core.CaptureFilterFlowLogCaptureFilterRuleUdpOptionsSourcePortRange; } interface CaptureFilterFlowLogCaptureFilterRuleUdpOptionsDestinationPortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface CaptureFilterFlowLogCaptureFilterRuleUdpOptionsSourcePortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface CaptureFilterVtapCaptureFilterRule { /** * (Updatable) Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target. */ destinationCidr: string; /** * (Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) * * If 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. */ icmpOptions: outputs.Core.CaptureFilterVtapCaptureFilterRuleIcmpOptions; /** * (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: * * 1 = ICMP * * 6 = TCP * * 17 = UDP */ protocol: string; /** * (Updatable) Include or exclude packets meeting this definition from mirrored traffic. */ ruleAction: string; /** * (Updatable) Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target. */ sourceCidr: string; /** * (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. */ tcpOptions: outputs.Core.CaptureFilterVtapCaptureFilterRuleTcpOptions; /** * (Updatable) The traffic direction the VTAP is configured to mirror. */ trafficDirection: string; /** * (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. */ udpOptions: outputs.Core.CaptureFilterVtapCaptureFilterRuleUdpOptions; } interface CaptureFilterVtapCaptureFilterRuleIcmpOptions { /** * (Updatable) The ICMP code (optional). */ code: number; /** * (Updatable) The ICMP type. */ type: number; } interface CaptureFilterVtapCaptureFilterRuleTcpOptions { /** * (Updatable) */ destinationPortRange: outputs.Core.CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRange; /** * (Updatable) */ sourcePortRange: outputs.Core.CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRange; } interface CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface CaptureFilterVtapCaptureFilterRuleUdpOptions { /** * (Updatable) */ destinationPortRange: outputs.Core.CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRange; /** * (Updatable) */ sourcePortRange: outputs.Core.CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRange; } interface CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number, which must not be greater than the maximum port number. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ min: number; } interface ClusterNetworkClusterConfiguration { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island. */ hpcIslandId: string; /** * The list of network block OCIDs. */ networkBlockIds: string[]; } interface ClusterNetworkInstancePool { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the instance pool. */ compartmentId: string; /** * Count of instance in running state associated to the Instance Pool. */ currentSize: number; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated with the instance pool. */ instanceConfigurationId: string; instanceDisplayNameFormatter: string; instanceHostnameFormatter: string; /** * The load balancers attached to the instance pool. */ loadBalancers: outputs.Core.ClusterNetworkInstancePoolLoadBalancer[]; /** * The placement configurations for the instance pool. */ placementConfigurations: outputs.Core.ClusterNetworkInstancePoolPlacementConfiguration[]; /** * The type of resources managed by the pool. */ poolType: string; /** * (Updatable) The number of instances that should be in the instance pool. */ size: number; /** * The current state of the cluster network. */ state: string; /** * 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` */ timeCreated: string; } interface ClusterNetworkInstancePoolLoadBalancer { /** * The name of the backend set on the load balancer. */ backendSetName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment. */ instancePoolId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool. */ loadBalancerId: string; /** * The port value used for the backends. */ port: number; /** * The current state of the cluster network. */ state: string; /** * 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. */ vnicSelection: string; } interface ClusterNetworkInstancePoolPlacementConfiguration { /** * The availability domain to place instances. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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. */ computeClusterId: string; /** * The fault domains to place instances. */ faultDomains: string[]; /** * 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. */ primarySubnetId: string; /** * Details about the IPv6 primary subnet. */ primaryVnicSubnets: outputs.Core.ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet[]; /** * The set of secondary VNIC data for instances in the pool. */ secondaryVnicSubnets: outputs.Core.ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet[]; } interface ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet { /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface ClusterNetworkPlacementConfiguration { /** * The availability domain to place instances. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; placementConstraint: string; /** * 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. */ primarySubnetId: string; /** * Details about the IPv6 primary subnet. */ primaryVnicSubnets: outputs.Core.ClusterNetworkPlacementConfigurationPrimaryVnicSubnets; /** * The set of secondary VNIC data for instances in the pool. */ secondaryVnicSubnets: outputs.Core.ClusterNetworkPlacementConfigurationSecondaryVnicSubnet[]; } interface ClusterNetworkPlacementConfigurationPrimaryVnicSubnets { /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.ClusterNetworkPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface ClusterNetworkPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface ClusterNetworkPlacementConfigurationSecondaryVnicSubnet { /** * The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC. */ displayName: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.ClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ subnetId: string; } interface ClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface ComputeCapacityReportShapeAvailability { /** * A flag denoting whether capacity is available. */ availabilityStatus: string; /** * The total number of new instances that can be created with the specified shape configuration. */ availableCount: string; /** * The fault domain for the capacity report. * * If you do not specify a fault domain, the capacity report includes information about all fault domains. */ faultDomain: string; /** * 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). */ instanceShape: string; /** * The shape configuration for a shape in a capacity report. */ instanceShapeConfig: outputs.Core.ComputeCapacityReportShapeAvailabilityInstanceShapeConfig; } interface ComputeCapacityReportShapeAvailabilityInstanceShapeConfig { /** * 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`. * * The following values are supported: * * `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. * * `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. * * `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance. */ baselineOcpuUtilization: string; /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. */ nvmes: number; /** * The total number of OCPUs available to the instance. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ ocpus: number; } interface ComputeCapacityReservationInstanceReservationConfig { /** * (Updatable) The HPC cluster configuration requested when launching instances in a compute capacity reservation. * * If 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. */ clusterConfig: outputs.Core.ComputeCapacityReservationInstanceReservationConfigClusterConfig; /** * (Updatable) The OCID of the cluster placement group for this instance reservation capacity configuration. */ clusterPlacementGroupId?: string; /** * (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. * * To 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/). * * Example: `FAULT-DOMAIN-1` */ faultDomain?: string; /** * (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). */ instanceShape: string; /** * (Updatable) The shape configuration requested when launching instances in a compute capacity reservation. * * If 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 `shape` that you specify. * * Each shape only supports certain configurable values. If the values that you provide are not valid for the specified `shape`, an error is returned. * * For 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). */ instanceShapeConfig: outputs.Core.ComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig; /** * (Updatable) The total number of instances that can be launched from the capacity configuration. */ reservedCount: string; /** * The amount of capacity in use out of the total capacity reserved in this capacity configuration. */ usedCount: string; } interface ComputeCapacityReservationInstanceReservationConfigClusterConfig { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island. */ hpcIslandId: string; /** * (Updatable) The list of OCIDs of the network blocks. */ networkBlockIds: string[]; } interface ComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig { /** * (Updatable) The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs available to the instance. */ ocpus: number; resourceManagement: string; } interface ComputeCapacityTopologyCapacitySource { /** * (Updatable) The capacity type of bare metal hosts. */ capacityType: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment of this capacity source. */ compartmentId: string; } interface ComputeClusterPlacementConstraintDetails { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island for the compute cluster. * * This field cannot be updated after creation of the compute cluster. */ hpcIslandId?: string; /** * The logical placement strategy to apply. Allowed values are `SINGLE_TIER`, `SINGLE_BLOCK`, and `PACKED_DISTRIBUTION_MULTI_BLOCK`. */ logicalPlacementConstraint: string; /** * The list of target GPU memory fabric OCIDs to constrain placement. Up to 15 items are allowed. * * If GMFs are passed in, the `hpcIslandId` must be set on the compute cluster, and the provided GMFs must belong to that same HPC island. * * The ordering of the array will be preserved. Ensure that all items in the array are unique. */ targetMemoryFabricIds?: string[]; /** * The list of target network block OCIDs to constrain placement. Up to 15 items are allowed. * * If `targetNetworkBlockIds` is provided, the `hpcIslandId` must be set on the compute cluster, and the provided network blocks must belong to that same HPC island. * * The ordering of the array will be preserved. Ensure that all items in the array are unique. */ targetNetworkBlockIds?: string[]; /** * (Updatable) The type for the placement constraints. Supported value: `COMPUTE_CLUSTER`. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface ComputeGpuMemoryClusterGpuMemoryClusterScaleConfig { /** * (Updatable) Enables downsizing towards the target size. */ isDownsizeEnabled: boolean; /** * (Updatable) Enables upsizing towards the target size. */ isUpsizeEnabled: boolean; /** * (Updatable) The configured target size for the GPU Memory Cluster. */ targetSize: string; } interface ComputeGpuMemoryFabricMemoryFabricPreferences { /** * (Updatable) The desired firmware bundle id on the GPU memory fabric. */ customerDesiredFirmwareBundleId: string; /** * (Updatable) The recycle level of GPU memory fabric. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ fabricRecycleLevel: string; } interface ComputeHostConfigurationData { /** * Compute Host Group Configuration Details Check */ checkDetails: outputs.Core.ComputeHostConfigurationDataCheckDetail[]; /** * The time that was last applied. */ timeLastApply: string; } interface ComputeHostConfigurationDataCheckDetail { /** * Configuration state of the Compute Bare Metal Host. */ configurationState: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique firmware bundle associated with the Host. */ firmwareBundleId: string; /** * Preferred recycle level for hosts associated with the reservation config. * * `SKIP_RECYCLE` - Skips host wipe. * * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. */ recycleLevel: string; /** * The type of configuration */ type: string; } interface ComputeHostGroupConfiguration { /** * (Updatable) The OCID for firmware bundle */ firmwareBundleId: string; /** * (Updatable) Additional quick recycle settings. */ quickRecycleSettings: outputs.Core.ComputeHostGroupConfigurationQuickRecycleSettings; /** * (Updatable) Preferred recycle level for hosts associated with the reservation config. * * `SKIP_RECYCLE` - Skips host wipe. * * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. */ recycleLevel: string; /** * (Updatable) The state of the host group configuration. */ state: string; /** * (Updatable) Either the platform name or compute shape that the configuration is targeting */ target: string; } interface ComputeHostGroupConfigurationQuickRecycleSettings { /** * (Updatable) Whether to wipe NVMe data during quick recycle. */ nvmeWipe: boolean; } interface ComputeHostRecycleDetail { /** * 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. */ computeHostGroupId: string; /** * Preferred recycle level for hosts associated with the reservation config. * * `SKIP_RECYCLE` - Skips host wipe. * * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. */ recycleLevel: string; } interface CrossConnectGroupMacsecProperties { /** * (Updatable) Type of encryption cipher suite to use for the MACsec connection. */ encryptionCipher: string; /** * (Updatable) Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. */ isUnprotectedTrafficAllowed: boolean; /** * (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. */ primaryKey: outputs.Core.CrossConnectGroupMacsecPropertiesPrimaryKey; /** * (Updatable) Indicates whether or not MACsec is enabled. */ state: string; } interface CrossConnectGroupMacsecPropertiesPrimaryKey { /** * (Updatable) Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. */ connectivityAssociationKeySecretId: string; /** * (Updatable) The secret version of the `connectivityAssociationKeySecretId` secret in Vault. * * NOTE: Only the latest secret version will be used. */ connectivityAssociationKeySecretVersion: string; /** * (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. */ connectivityAssociationNameSecretId: string; /** * (Updatable) The secret version of the `connectivityAssociationNameSecretId` secret in Vault. * * NOTE: Only the latest secret version will be used. */ connectivityAssociationNameSecretVersion: string; } interface CrossConnectLoaProperties { /** * (Updatable) Name of a customer authorized agent to append to the LOA as `Authorized Agent`. Set this to an empty string to remove the current authorized agent. */ authorizedAgent: string; /** * (Updatable) Terraform-managed count of self-service expiry extensions requested for the LOA. Increase this value by 1 to request one additional expiry extension. This value cannot be decreased or increased by more than 1 in a single update. The service enforces the maximum number of allowed extensions. */ expiryExtensionCount?: number; } interface CrossConnectMacsecProperties { /** * (Updatable) Type of encryption cipher suite to use for the MACsec connection. */ encryptionCipher: string; /** * (Updatable) Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. */ isUnprotectedTrafficAllowed: boolean; /** * (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. */ primaryKey: outputs.Core.CrossConnectMacsecPropertiesPrimaryKey; /** * The cross-connect's current state. */ state: string; } interface CrossConnectMacsecPropertiesPrimaryKey { /** * (Updatable) Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. */ connectivityAssociationKeySecretId: string; /** * The secret version of the `connectivityAssociationKey` secret in Vault. */ connectivityAssociationKeySecretVersion: string; /** * Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. */ connectivityAssociationNameSecretId: string; /** * The secret version of the connectivity association name secret in Vault. */ connectivityAssociationNameSecretVersion: string; } interface DedicatedVmHostCapacityBin { /** * Zero-based index for the corresponding capacity bucket. */ capacityIndex: number; /** * The current available local volume of the dedicated VM host, in GBs. */ remainingLocalVolumeInGbs: number; /** * The current available memory of the dedicated VM host, in GBs. */ remainingMemoryInGbs: number; /** * The current available OCPUs of the dedicated VM host. */ remainingOcpus: number; /** * List of VMI shapes supported on each capacity bucket. */ supportedShapes: string[]; /** * The current total local volume of the dedicated VM host, in GBs. */ totalLocalVolumeInGbs: number; /** * The current total memory of the dedicated VM host, in GBs. */ totalMemoryInGbs: number; /** * The current total OCPUs of the dedicated VM host. */ totalOcpus: number; } interface DedicatedVmHostPlacementConstraintDetails { /** * The OCID of the compute bare metal host. This is only available for dedicated capacity customers. */ computeBareMetalHostId: string; /** * 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. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface DefaultDhcpOptionsOption { customDnsServers?: string[]; searchDomainNames: string[]; serverType: string; type: string; } interface DefaultRouteTableRouteRule { /** * @deprecated The 'cidr_block' field has been deprecated. Please use 'destination' instead. */ cidrBlock: string; description: string; destination: string; destinationType: string; networkEntityId: string; routeType: string; } interface DefaultSecurityListEgressSecurityRule { description: string; destination: string; destinationType: string; icmpOptions?: outputs.Core.DefaultSecurityListEgressSecurityRuleIcmpOptions; protocol: string; stateless: boolean; tcpOptions?: outputs.Core.DefaultSecurityListEgressSecurityRuleTcpOptions; udpOptions?: outputs.Core.DefaultSecurityListEgressSecurityRuleUdpOptions; } interface DefaultSecurityListEgressSecurityRuleIcmpOptions { code?: number; type: number; } interface DefaultSecurityListEgressSecurityRuleTcpOptions { max?: number; min?: number; sourcePortRange?: outputs.Core.DefaultSecurityListEgressSecurityRuleTcpOptionsSourcePortRange; } interface DefaultSecurityListEgressSecurityRuleTcpOptionsSourcePortRange { max: number; min: number; } interface DefaultSecurityListEgressSecurityRuleUdpOptions { max?: number; min?: number; sourcePortRange?: outputs.Core.DefaultSecurityListEgressSecurityRuleUdpOptionsSourcePortRange; } interface DefaultSecurityListEgressSecurityRuleUdpOptionsSourcePortRange { max: number; min: number; } interface DefaultSecurityListIngressSecurityRule { description: string; icmpOptions?: outputs.Core.DefaultSecurityListIngressSecurityRuleIcmpOptions; protocol: string; source: string; sourceType: string; stateless?: boolean; tcpOptions?: outputs.Core.DefaultSecurityListIngressSecurityRuleTcpOptions; udpOptions?: outputs.Core.DefaultSecurityListIngressSecurityRuleUdpOptions; } interface DefaultSecurityListIngressSecurityRuleIcmpOptions { code?: number; type: number; } interface DefaultSecurityListIngressSecurityRuleTcpOptions { max?: number; min?: number; sourcePortRange?: outputs.Core.DefaultSecurityListIngressSecurityRuleTcpOptionsSourcePortRange; } interface DefaultSecurityListIngressSecurityRuleTcpOptionsSourcePortRange { max: number; min: number; } interface DefaultSecurityListIngressSecurityRuleUdpOptions { max?: number; min?: number; sourcePortRange?: outputs.Core.DefaultSecurityListIngressSecurityRuleUdpOptionsSourcePortRange; } interface DefaultSecurityListIngressSecurityRuleUdpOptionsSourcePortRange { max: number; min: number; } interface DhcpOptionsOption { /** * (Updatable) If you set `serverType` to `CustomDnsServer`, specify the IP address of at least one DNS server of your choice (three maximum). */ customDnsServers?: string[]; /** * (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. * * If 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`). * * If 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. */ searchDomainNames: string[]; /** * (Updatable) * * **VcnLocal:** Reserved for future use. * * **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). * * **CustomDnsServer:** Instances use a DNS server of your choice (three maximum). */ serverType: string; /** * (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/)). */ type: string; } interface DrgAttachmentManagementNetworkDetails { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG. */ id: string; /** * The IPSec connection that contains the attached IPSec tunnel. */ ipsecConnectionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the DRG attachment is using. * * For information about why you would associate a route table with a DRG attachment, see: * * [Transit Routing: Access to Multiple VCNs in Same Region](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm) * * [Transit Routing: Private Access to Oracle Services](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm) */ routeTableId: string; /** * The type can be one of these values: `IPSEC_TUNNEL`, `REMOTE_PEERING_CONNECTION`, `VCN`,`VIRTUAL_CIRCUIT` */ type: string; } interface DrgAttachmentNetworkDetails { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target IPSec tunnel attachment. */ ids: string[]; /** * The IPSec connection that contains the attached IPSec tunnel. */ ipsecConnectionId: string; /** * (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. * * For 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: * * [Transit Routing: Access to Multiple VCNs in Same Region](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm) * * [Transit Routing: Private Access to Oracle Services](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm) */ routeTableId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit's DRG attachment. */ transportAttachmentId: string; /** * Boolean flag that determines wether all traffic over the virtual circuits is encrypted. Example: `true` */ transportOnlyMode: boolean; /** * (Updatable) The type can be one of these values: `IPSEC_TUNNEL`, `LOOPBACK`, `REMOTE_PEERING_CONNECTION`, `VCN`, `VIRTUAL_CIRCUIT` */ type: string; /** * (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. */ vcnRouteType: string; } interface DrgAttachmentsListDrgAllAttachment { /** * The Oracle-assigned ID of the DRG attachment */ id: string; } interface DrgDefaultDrgRouteTable { /** * 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. */ ipsecTunnel: string; /** * 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. */ remotePeeringConnection: string; /** * 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. */ vcn: string; /** * 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. */ virtualCircuit: string; } interface DrgRouteDistributionStatementMatchCriteria { /** * 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. */ attachmentType?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment. */ drgAttachmentId?: string; /** * (Updatable) The type of the match criteria for a route distribution statement. */ matchType?: string; } interface GetAppCatalogListingResourceVersionsAppCatalogListingResourceVersion { /** * List of accessible ports for instances launched with this listing resource version. */ accessiblePorts: number[]; /** * Allowed actions for the listing resource. */ allowedActions: string[]; /** * List of regions that this listing resource version is available. */ availableRegions: string[]; /** * Array of shapes compatible with this resource. */ compatibleShapes: string[]; /** * The OCID of the listing. */ listingId: string; /** * OCID of the listing resource. */ listingResourceId: string; /** * Resource Version. */ listingResourceVersion: string; /** * 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` */ timePublished: string; } interface GetAppCatalogListingResourceVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetAppCatalogListingsAppCatalogListing { /** * Listing's contact URL. */ contactUrl: string; /** * Description of the listing. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * the region free ocid of the listing resource. */ listingId: string; /** * Publisher's logo URL. */ publisherLogoUrl: string; /** * A filter to return only the publisher that matches the given publisher name exactly. */ publisherName: string; /** * The short summary for the listing. */ summary: string; /** * Date and time the listing was published, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. Example: `2018-03-20T12:32:53.532Z` */ timePublished: string; } interface GetAppCatalogListingsFilter { name: string; regex?: boolean; values: string[]; } interface GetAppCatalogSubscriptionsAppCatalogSubscription { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; eulaLink?: string; /** * A filter to return only the listings that matches the given listing id. */ listingId: string; /** * Listing resource id. */ listingResourceId: string; /** * Listing resource version. */ listingResourceVersion: string; oracleTermsOfUseLink: string; /** * Name of the publisher who published this listing. */ publisherName: string; signature: string; /** * The short summary to the listing. */ summary: string; /** * 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` */ timeCreated: string; timeRetrieved: string; } interface GetAppCatalogSubscriptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetBlockVolumeReplicasBlockVolumeReplica { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the source block volume. */ blockVolumeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The block volume replica's Oracle ID (OCID). */ id: string; /** * 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). */ kmsKeyId: string; /** * The size of the source block volume, in GBs. */ sizeInGbs: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the block volume replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * 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). */ timeLastSynced: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the volume group replica. */ volumeGroupReplicaId: string; } interface GetBlockVolumeReplicasFilter { name: string; regex?: boolean; values: string[]; } interface GetBootVolumeAttachmentsBootVolumeAttachment { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the boot volume. */ bootVolumeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Refer the top-level definition of encryptionInTransitType. The default value is NONE. */ encryptionInTransitType: string; /** * The OCID of the boot volume attachment. */ id: string; /** * The OCID of the instance. */ instanceId: string; /** * Whether in-transit encryption for the boot volume's paravirtualized attachment is enabled or not. */ isPvEncryptionInTransitEnabled: boolean; /** * The current state of the boot volume attachment. */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; } interface GetBootVolumeAttachmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetBootVolumeAutotunePolicy { /** * This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface GetBootVolumeBackupRetentionPeriod { /** * The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period. */ retentionTimeAmount: number; /** * The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS". */ retentionTimeUnit: string; } interface GetBootVolumeBackupSourceDetail { /** * The OCID of the boot volume backup. */ bootVolumeBackupId: string; /** * 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). */ kmsKeyId: string; region: string; } interface GetBootVolumeBackupsBootVolumeBackup { /** * The OCID of the boot volume. */ bootVolumeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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. */ expirationTime: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the boot volume backup. */ id: string; /** * The image OCID used to create the boot volume the backup is taken from. */ imageId: string; /** * feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. */ isIndefiniteRetentionEnabled: boolean; /** * Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. */ isPreventDeletionEnabled: boolean; /** * feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. */ isRetentionLockEnabled: boolean; /** * 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). */ kmsKeyId: string; /** * This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ retentionPeriods: outputs.Core.GetBootVolumeBackupsBootVolumeBackupRetentionPeriod[]; /** * The size of the boot volume, in GBs. */ sizeInGbs: string; /** * A filter to return only resources that originated from the given source boot volume backup. */ sourceBootVolumeBackupId: string; sourceDetails: outputs.Core.GetBootVolumeBackupsBootVolumeBackupSourceDetail[]; /** * Specifies whether the backup was created manually, or via scheduled backup policy. */ sourceType: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ systemTags: { [key: string]: string; }; /** * 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). */ timeCreated: string; /** * The date and time the request to create the boot volume backup was received. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeRequestReceived: string; /** * The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ timeRetentionExpiresAt: string; /** * The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'. */ type: string; /** * 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. */ uniqueSizeInGbs: string; /** * The OCID of the volume group backup associated with the backup. This is an optional field. If it is not present in the response, the backup does not belong to a volume group. */ volumeGroupBackupId: string; } interface GetBootVolumeBackupsBootVolumeBackupRetentionPeriod { /** * The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period. */ retentionTimeAmount: number; /** * The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS". */ retentionTimeUnit: string; } interface GetBootVolumeBackupsBootVolumeBackupSourceDetail { bootVolumeBackupId: string; /** * 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). */ kmsKeyId: string; region: string; } interface GetBootVolumeBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetBootVolumeBootVolumeReplica { /** * The availability domain of the boot volume replica. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The boot volume replica's Oracle ID (OCID). */ bootVolumeReplicaId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The OCID of the Vault service master encryption key assigned to the boot volume. */ kmsKeyId: string; xrrKmsKeyId: string; } interface GetBootVolumeReplicasBootVolumeReplica { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the source boot volume. */ bootVolumeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The boot volume replica's Oracle ID (OCID). */ id: string; /** * The image OCID used to create the boot volume the replica is replicated from. */ imageId: string; /** * 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). */ kmsKeyId: string; /** * The size of the source boot volume, in GBs. */ sizeInGbs: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the boot volume replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * 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). */ timeLastSynced: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the volume group replica. */ volumeGroupReplicaId: string; } interface GetBootVolumeReplicasFilter { name: string; regex?: boolean; values: string[]; } interface GetBootVolumeSourceDetail { /** * (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). */ changeBlockSizeInBytes: string; /** * (Required when type=bootVolumeBackupDelta) The OCID of the first boot volume backup. */ firstBackupId: string; /** * (Required when type=bootVolume | bootVolumeBackup | bootVolumeReplica) The OCID of the boot volume replica. */ id: string; /** * (Required when type=bootVolumeBackupDelta) The OCID of the second boot volume backup. */ secondBackupId: string; /** * (Required) The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica` */ type: string; } interface GetBootVolumesBootVolume { /** * The number of Volume Performance Units per GB that this boot volume is effectively tuned to. */ autoTunedVpusPerGb: string; /** * The list of autotune policies enabled for this volume. */ autotunePolicies: outputs.Core.GetBootVolumesBootVolumeAutotunePolicy[]; /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * @deprecated The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead. */ backupPolicyId: string; /** * The list of boot volume replicas of this boot volume */ bootVolumeReplicas: outputs.Core.GetBootVolumesBootVolumeBootVolumeReplica[]; bootVolumeReplicasDeletion: boolean; /** * The clusterPlacementGroup Id of the volume for volume placement. */ clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * (Required when type=bootVolume | bootVolumeBackup | bootVolumeReplica) The OCID of the boot volume replica. */ id: string; /** * The image OCID used to create the boot volume. */ imageId: string; /** * 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. */ isAutoTuneEnabled: boolean; /** * Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup. */ isHydrated: boolean; /** * The OCID of the Vault service master encryption key assigned to the boot volume. */ kmsKeyId: string; /** * The size of the boot volume in GBs. */ sizeInGbs: string; /** * The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use `sizeInGbs`. */ sizeInMbs: string; sourceDetails: outputs.Core.GetBootVolumesBootVolumeSourceDetail[]; /** * The current state of a boot volume. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ systemTags: { [key: string]: string; }; /** * The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The OCID of the volume group. */ volumeGroupId: string; /** * 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. */ vpusPerGb: string; xrcKmsKeyId: string; } interface GetBootVolumesBootVolumeAutotunePolicy { /** * This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface GetBootVolumesBootVolumeBootVolumeReplica { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The boot volume replica's Oracle ID (OCID). */ bootVolumeReplicaId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The OCID of the Vault service master encryption key assigned to the boot volume. */ kmsKeyId: string; xrrKmsKeyId: string; } interface GetBootVolumesBootVolumeSourceDetail { /** * (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). */ changeBlockSizeInBytes: string; /** * (Required when type=bootVolumeBackupDelta) The OCID of the first boot volume backup. */ firstBackupId: string; /** * (Required when type=bootVolume | bootVolumeBackup | bootVolumeReplica) The OCID of the boot volume replica. */ id: string; /** * (Required when type=bootVolumeBackupDelta) The OCID of the second boot volume backup. */ secondBackupId: string; /** * (Required) The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica` */ type: string; } interface GetBootVolumesFilter { name: string; regex?: boolean; values: string[]; } interface GetByoasnByoipRange { /** * The as path prepend length. */ asPathPrependLength: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. */ byoipRangeId: string; /** * The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. */ cidrBlock: string; /** * 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. */ ipv6cidrBlock: string; } interface GetByoasnsByoasnCollection { items: outputs.Core.GetByoasnsByoasnCollectionItem[]; } interface GetByoasnsByoasnCollectionItem { /** * The Autonomous System Number (ASN) you are importing to the Oracle cloud. */ asn: string; /** * The BYOIP Ranges that has the `Byoasn` as origin. */ byoipRanges: outputs.Core.GetByoasnsByoasnCollectionItemByoipRange[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. */ id: string; /** * A filter to return only resources that match the given lifecycle state name exactly. */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; /** * 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` */ timeValidated: string; /** * 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. */ validationToken: string; } interface GetByoasnsByoasnCollectionItemByoipRange { /** * The as path prepend length. */ asPathPrependLength: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. */ byoipRangeId: string; /** * The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. */ cidrBlock: string; /** * 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. */ ipv6cidrBlock: string; } interface GetByoasnsFilter { name: string; regex?: boolean; values: string[]; } interface GetByoipAllocatedRangesByoipAllocatedRangeCollection { /** * A list of subranges of a BYOIP CIDR block allocated to an IP pool. */ items: outputs.Core.GetByoipAllocatedRangesByoipAllocatedRangeCollectionItem[]; } interface GetByoipAllocatedRangesByoipAllocatedRangeCollectionItem { /** * The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. */ cidrBlock: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IP pool containing the CIDR block. */ publicIpPoolId: string; } interface GetByoipAllocatedRangesFilter { name: string; regex?: boolean; values: string[]; } interface GetByoipRangeByoipRangeVcnIpv6allocation { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block. */ byoipRangeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOIP CIDR block. */ compartmentId: string; /** * 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. */ ipv6cidrBlock: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Vcn` resource to which the ByoipRange belongs. */ vcnId: string; } interface GetByoipRangeOriginAsn { /** * The as path prepend length. */ asPathPrependLength: number; /** * The Autonomous System Number (ASN) you are importing to the Oracle cloud. */ asn: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. */ byoasnId: string; } interface GetByoipRangesByoipRangeCollection { items: outputs.Core.GetByoipRangesByoipRangeCollectionItem[]; } interface GetByoipRangesByoipRangeCollectionItem { /** * A list of `ByoipRangeVcnIpv6AllocationSummary` objects. */ byoipRangeVcnIpv6allocations: outputs.Core.GetByoipRangesByoipRangeCollectionItemByoipRangeVcnIpv6allocation[]; /** * The public IPv4 CIDR block being imported from on-premises to the Oracle cloud. */ cidrBlock?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId?: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource. */ id: string; ipAnycastId: string; /** * 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. */ ipv6cidrBlock: string; /** * The `ByoipRange` resource's current status. */ lifecycleDetails: string; monitorIp: string; /** * Information about the origin asn. */ originAsns: outputs.Core.GetByoipRangesByoipRangeCollectionItemOriginAsn[]; /** * A filter to return only resources that match the given lifecycle state name exactly. */ state: string; /** * 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` */ timeAdvertised: string; /** * 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` */ timeCreated: string; /** * 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` */ timeValidated: string; /** * 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` */ timeWithdrawn: string; /** * 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. */ validationToken: string; } interface GetByoipRangesByoipRangeCollectionItemByoipRangeVcnIpv6allocation { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. */ byoipRangeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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. */ ipv6cidrBlock: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Vcn` resource to which the ByoipRange belongs. */ vcnId: string; } interface GetByoipRangesByoipRangeCollectionItemOriginAsn { /** * The as path prepend length. */ asPathPrependLength: number; /** * The Autonomous System Number (ASN) you are importing to the Oracle cloud. */ asn: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. */ byoasnId: string; } interface GetByoipRangesFilter { name: string; regex?: boolean; values: string[]; } interface GetCaptureFilterFlowLogCaptureFilterRule { /** * Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target. */ destinationCidr: string; /** * Type or types of flow logs to store. `ALL` includes records for both accepted traffic and rejected traffic. */ flowLogType: string; /** * Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) */ icmpOptions: outputs.Core.GetCaptureFilterFlowLogCaptureFilterRuleIcmpOption[]; /** * Indicates whether a flow log capture filter rule is enabled. */ isEnabled: boolean; /** * A lower number indicates a higher priority, range 0-9. Each rule must have a distinct priority. */ priority: number; /** * The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are: * * 1 = ICMP * * 6 = TCP * * 17 = UDP */ protocol: string; /** * Include or exclude packets meeting this definition from mirrored traffic. */ ruleAction: string; /** * Sampling interval as 1 of X, where X is an integer not greater than 100000. */ samplingRate: number; /** * Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target. */ sourceCidr: string; /** * 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. */ tcpOptions: outputs.Core.GetCaptureFilterFlowLogCaptureFilterRuleTcpOption[]; /** * 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. */ udpOptions: outputs.Core.GetCaptureFilterFlowLogCaptureFilterRuleUdpOption[]; } interface GetCaptureFilterFlowLogCaptureFilterRuleIcmpOption { /** * The ICMP code (optional). */ code: number; /** * The ICMP type. */ type: number; } interface GetCaptureFilterFlowLogCaptureFilterRuleTcpOption { destinationPortRanges: outputs.Core.GetCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange[]; sourcePortRanges: outputs.Core.GetCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange[]; } interface GetCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFilterFlowLogCaptureFilterRuleUdpOption { destinationPortRanges: outputs.Core.GetCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange[]; sourcePortRanges: outputs.Core.GetCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange[]; } interface GetCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFilterVtapCaptureFilterRule { /** * Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target. */ destinationCidr: string; /** * Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) */ icmpOptions: outputs.Core.GetCaptureFilterVtapCaptureFilterRuleIcmpOption[]; /** * The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are: * * 1 = ICMP * * 6 = TCP * * 17 = UDP */ protocol: string; /** * Include or exclude packets meeting this definition from mirrored traffic. */ ruleAction: string; /** * Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target. */ sourceCidr: string; /** * 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. */ tcpOptions: outputs.Core.GetCaptureFilterVtapCaptureFilterRuleTcpOption[]; /** * The traffic direction the VTAP is configured to mirror. */ trafficDirection: string; /** * 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. */ udpOptions: outputs.Core.GetCaptureFilterVtapCaptureFilterRuleUdpOption[]; } interface GetCaptureFilterVtapCaptureFilterRuleIcmpOption { /** * The ICMP code (optional). */ code: number; /** * The ICMP type. */ type: number; } interface GetCaptureFilterVtapCaptureFilterRuleTcpOption { destinationPortRanges: outputs.Core.GetCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange[]; sourcePortRanges: outputs.Core.GetCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange[]; } interface GetCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFilterVtapCaptureFilterRuleUdpOption { destinationPortRanges: outputs.Core.GetCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange[]; sourcePortRanges: outputs.Core.GetCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange[]; } interface GetCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFiltersCaptureFilter { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * A filter to only return resources that match the given capture filterType. The filterType value is the string representation of enum - VTAP, FLOWLOG. */ filterType: string; /** * The set of rules governing what traffic the Flow Log collects when creating a flow log capture filter. */ flowLogCaptureFilterRules: outputs.Core.GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRule[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The capture filter's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * A filter to return only resources that match the given capture filter lifecycle state. The state value is case-insensitive. */ state: string; /** * 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` */ timeCreated: string; /** * The set of rules governing what traffic a VTAP mirrors. */ vtapCaptureFilterRules: outputs.Core.GetCaptureFiltersCaptureFilterVtapCaptureFilterRule[]; } interface GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRule { /** * Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target. */ destinationCidr: string; /** * Type or types of flow logs to store. `ALL` includes records for both accepted traffic and rejected traffic. */ flowLogType: string; /** * Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) */ icmpOptions: outputs.Core.GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleIcmpOption[]; /** * Indicates whether a flow log capture filter rule is enabled. */ isEnabled: boolean; /** * A lower number indicates a higher priority, range 0-9. Each rule must have a distinct priority. */ priority: number; /** * The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are: * * 1 = ICMP * * 6 = TCP * * 17 = UDP */ protocol: string; /** * Include or exclude packets meeting this definition from mirrored traffic. */ ruleAction: string; /** * Sampling interval as 1 of X, where X is an integer not greater than 100000. */ samplingRate: number; /** * Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target. */ sourceCidr: string; /** * 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. */ tcpOptions: outputs.Core.GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOption[]; /** * 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. */ udpOptions: outputs.Core.GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOption[]; } interface GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleIcmpOption { /** * The ICMP code (optional). */ code: number; /** * The ICMP type. */ type: number; } interface GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOption { destinationPortRanges: outputs.Core.GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange[]; sourcePortRanges: outputs.Core.GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange[]; } interface GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOption { destinationPortRanges: outputs.Core.GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange[]; sourcePortRanges: outputs.Core.GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange[]; } interface GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFiltersCaptureFilterVtapCaptureFilterRule { /** * Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target. */ destinationCidr: string; /** * Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) */ icmpOptions: outputs.Core.GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleIcmpOption[]; /** * The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are: * * 1 = ICMP * * 6 = TCP * * 17 = UDP */ protocol: string; /** * Include or exclude packets meeting this definition from mirrored traffic. */ ruleAction: string; /** * Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target. */ sourceCidr: string; /** * 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. */ tcpOptions: outputs.Core.GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOption[]; /** * The traffic direction the VTAP is configured to mirror. */ trafficDirection: string; /** * 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. */ udpOptions: outputs.Core.GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOption[]; } interface GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleIcmpOption { /** * The ICMP code (optional). */ code: number; /** * The ICMP type. */ type: number; } interface GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOption { destinationPortRanges: outputs.Core.GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange[]; sourcePortRanges: outputs.Core.GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange[]; } interface GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOption { destinationPortRanges: outputs.Core.GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange[]; sourcePortRanges: outputs.Core.GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange[]; } interface GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface GetCaptureFiltersFilter { name: string; regex?: boolean; values: string[]; } interface GetClusterNetworkClusterConfiguration { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island used by the cluster network. */ hpcIslandId: string; /** * The list of network block OCIDs of the HPC island. */ networkBlockIds: string[]; } interface GetClusterNetworkInstancePool { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the instance pool. */ compartmentId: string; /** * Count of instance in running state associated to the Instance Pool. */ currentSize: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated with the instance pool. */ instanceConfigurationId: string; instanceDisplayNameFormatter: string; instanceHostnameFormatter: string; /** * The load balancers attached to the instance pool. */ loadBalancers: outputs.Core.GetClusterNetworkInstancePoolLoadBalancer[]; /** * The placement configurations for the instance pool. */ placementConfigurations: outputs.Core.GetClusterNetworkInstancePoolPlacementConfiguration[]; /** * The type of resources managed by the pool. */ poolType: string; /** * The number of instances that should be in the instance pool. */ size: number; /** * The current state of the cluster network. */ state: string; /** * 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` */ timeCreated: string; } interface GetClusterNetworkInstancePoolLoadBalancer { /** * The name of the backend set on the load balancer. */ backendSetName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment. */ instancePoolId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool. */ loadBalancerId: string; /** * The port value used for the backends. */ port: number; /** * The current state of the cluster network. */ state: string; /** * 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. */ vnicSelection: string; } interface GetClusterNetworkInstancePoolPlacementConfiguration { /** * The availability domain to place instances. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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. */ computeClusterId: string; /** * The fault domains to place instances. */ faultDomains: string[]; /** * 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. */ primarySubnetId: string; /** * Details about the IPv6 primary subnet. */ primaryVnicSubnets: outputs.Core.GetClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet[]; /** * The set of secondary VNIC data for instances in the pool. */ secondaryVnicSubnets: outputs.Core.GetClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet[]; } interface GetClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet { /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet { /** * The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC. */ displayName: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetClusterNetworkInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetClusterNetworkInstancesInstance { /** * The availability domain the instance is running in. */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The fault domain the instance is running in. */ faultDomain: string; /** * The OCID of the instance. */ id: string; /** * The OCID of the instance confgiuration used to create the instance. */ instanceConfigurationId: string; /** * The load balancer backends that are configured for the instance pool instance. */ loadBalancerBackends: outputs.Core.GetClusterNetworkInstancesInstanceLoadBalancerBackend[]; /** * The region that contains the availability domain the instance is running in. */ region: string; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The current state of the instance pool instance. */ state: string; /** * 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` */ timeCreated: string; } interface GetClusterNetworkInstancesInstanceLoadBalancerBackend { /** * The health of the backend as observed by the load balancer. */ backendHealthStatus: string; /** * The name of the backend in the backend set. */ backendName: string; /** * The name of the backend set on the load balancer. */ backendSetName: string; /** * The OCID of the load balancer attached to the instance pool. */ loadBalancerId: string; /** * The current state of the instance pool instance. */ state: string; } interface GetClusterNetworkPlacementConfiguration { /** * The availability domain to place instances. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; placementConstraint: string; /** * 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. */ primarySubnetId: string; /** * Details about the IPv6 primary subnet. */ primaryVnicSubnets: outputs.Core.GetClusterNetworkPlacementConfigurationPrimaryVnicSubnet[]; /** * The set of secondary VNIC data for instances in the pool. */ secondaryVnicSubnets: outputs.Core.GetClusterNetworkPlacementConfigurationSecondaryVnicSubnet[]; } interface GetClusterNetworkPlacementConfigurationPrimaryVnicSubnet { /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetClusterNetworkPlacementConfigurationSecondaryVnicSubnet { /** * The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC. */ displayName: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetClusterNetworksClusterNetwork { clusterConfigurations: outputs.Core.GetClusterNetworksClusterNetworkClusterConfiguration[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island used by the cluster network. */ hpcIslandId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * The instance pools in the cluster network. */ instancePools: outputs.Core.GetClusterNetworksClusterNetworkInstancePool[]; /** * The list of network block OCIDs of the HPC island. */ networkBlockIds: string[]; /** * The location for where the instance pools in a cluster network will place instances. */ placementConfigurations: outputs.Core.GetClusterNetworksClusterNetworkPlacementConfiguration[]; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; } interface GetClusterNetworksClusterNetworkClusterConfiguration { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island used by the cluster network. */ hpcIslandId: string; /** * The list of network block OCIDs of the HPC island. */ networkBlockIds: string[]; } interface GetClusterNetworksClusterNetworkInstancePool { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Count of instance in running state associated to the Instance Pool. */ currentSize: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated with the instance pool. */ instanceConfigurationId: string; instanceDisplayNameFormatter: string; instanceHostnameFormatter: string; /** * The load balancers attached to the instance pool. */ loadBalancers: outputs.Core.GetClusterNetworksClusterNetworkInstancePoolLoadBalancer[]; /** * The placement configurations for the instance pool. */ placementConfigurations: outputs.Core.GetClusterNetworksClusterNetworkInstancePoolPlacementConfiguration[]; /** * The type of resources managed by the pool. */ poolType: string; /** * The number of instances that should be in the instance pool. */ size: number; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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` */ timeCreated: string; } interface GetClusterNetworksClusterNetworkInstancePoolLoadBalancer { /** * The name of the backend set on the load balancer. */ backendSetName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment. */ instancePoolId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool. */ loadBalancerId: string; /** * The port value used for the backends. */ port: number; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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. */ vnicSelection: string; } interface GetClusterNetworksClusterNetworkInstancePoolPlacementConfiguration { /** * The availability domain to place instances. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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. */ computeClusterId: string; /** * The fault domains to place instances. */ faultDomains: string[]; /** * 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. */ primarySubnetId: string; /** * Details about the IPv6 primary subnet. */ primaryVnicSubnets: outputs.Core.GetClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet[]; /** * The set of secondary VNIC data for instances in the pool. */ secondaryVnicSubnets: outputs.Core.GetClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet[]; } interface GetClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet { /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet { /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetClusterNetworksClusterNetworkPlacementConfiguration { /** * The availability domain to place instances. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; placementConstraint: string; /** * 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. */ primarySubnetId: string; /** * Details about the IPv6 primary subnet. */ primaryVnicSubnets: outputs.Core.GetClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnet[]; /** * The set of secondary VNIC data for instances in the pool. */ secondaryVnicSubnets: outputs.Core.GetClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnet[]; } interface GetClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnet { /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnet { /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetClusterNetworksFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeCapacityReservationInstanceReservationConfig { /** * The HPC cluster configuration requested when launching instances in a compute capacity reservation. */ clusterConfigs: outputs.Core.GetComputeCapacityReservationInstanceReservationConfigClusterConfig[]; /** * The OCID of the cluster placement group for this instance reservation capacity configuration. */ clusterPlacementGroupId: string; /** * 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). */ faultDomain: string; /** * 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). */ instanceShape: string; /** * The shape configuration requested when launching instances in a compute capacity reservation. */ instanceShapeConfigs: outputs.Core.GetComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig[]; /** * The total number of instances that can be launched from the capacity configuration. */ reservedCount: string; /** * The amount of capacity in use out of the total capacity reserved in this capacity configuration. */ usedCount: string; } interface GetComputeCapacityReservationInstanceReservationConfigClusterConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island. */ hpcIslandId: string; /** * The list of OCIDs of the network blocks. */ networkBlockIds: string[]; } interface GetComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig { /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; resourceManagement: string; } interface GetComputeCapacityReservationInstanceShapesComputeCapacityReservationInstanceShape { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The name of the available shape used to launch instances in a compute capacity reservation. */ instanceShape: string; } interface GetComputeCapacityReservationInstanceShapesFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeCapacityReservationInstancesCapacityReservationInstance { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The fault domain the instance is running in. */ faultDomain: string; /** * The OCID of the instance. */ id: string; /** * The shape of the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested when launching instances in a compute capacity reservation. */ shapeConfigs: outputs.Core.GetComputeCapacityReservationInstancesCapacityReservationInstanceShapeConfig[]; } interface GetComputeCapacityReservationInstancesCapacityReservationInstanceShapeConfig { /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance */ ocpus: number; resourceManagement: string; } interface GetComputeCapacityReservationInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeCapacityReservationsComputeCapacityReservation { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity reservation. */ id: string; /** * The capacity configurations for the capacity reservation. */ instanceReservationConfigs: outputs.Core.GetComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfig[]; /** * 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). */ isDefaultReservation: boolean; /** * 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. */ reservedInstanceCount: string; /** * A filter to only return resources that match the given lifecycle state. */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; /** * 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. */ usedInstanceCount: string; } interface GetComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfig { /** * The HPC cluster configuration requested when launching instances in a compute capacity reservation. */ clusterConfigs: outputs.Core.GetComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigClusterConfig[]; /** * The OCID of the cluster placement group for this instance reservation capacity configuration. */ clusterPlacementGroupId: string; /** * 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). */ faultDomain: string; /** * 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). */ instanceShape: string; /** * The shape configuration requested when launching instances in a compute capacity reservation. */ instanceShapeConfigs: outputs.Core.GetComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig[]; /** * The total number of instances that can be launched from the capacity configuration. */ reservedCount: string; /** * The amount of capacity in use out of the total capacity reserved in this capacity configuration. */ usedCount: string; } interface GetComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigClusterConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island. */ hpcIslandId: string; /** * The list of OCIDs of the network blocks. */ networkBlockIds: string[]; } interface GetComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig { /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; resourceManagement: string; } interface GetComputeCapacityReservationsFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeCapacityTopologiesComputeCapacityTopologyCollection { items: outputs.Core.GetComputeCapacityTopologiesComputeCapacityTopologyCollectionItem[]; } interface GetComputeCapacityTopologiesComputeCapacityTopologyCollectionItem { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * A capacity source of bare metal hosts. */ capacitySources: outputs.Core.GetComputeCapacityTopologiesComputeCapacityTopologyCollectionItemCapacitySource[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology. */ id: string; /** * The current state of the compute capacity topology. */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; } interface GetComputeCapacityTopologiesComputeCapacityTopologyCollectionItemCapacitySource { /** * The capacity type of bare metal hosts. */ capacityType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; } interface GetComputeCapacityTopologiesFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeCapacityTopologyCapacitySource { /** * The capacity type of bare metal hosts. */ capacityType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute capacity topology. */ compartmentId: string; } interface GetComputeCapacityTopologyComputeBareMetalHostsComputeBareMetalHostCollection { /** * The list of compute bare metal hosts. */ items: outputs.Core.GetComputeCapacityTopologyComputeBareMetalHostsComputeBareMetalHostCollectionItem[]; } interface GetComputeCapacityTopologyComputeBareMetalHostsComputeBareMetalHostCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology. */ computeCapacityTopologyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island. */ computeHpcIslandId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute local block. */ computeLocalBlockId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute network block. */ computeNetworkBlockId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute bare metal host. */ id: string; /** * 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. */ instanceId: string; /** * The shape of the compute instance that runs on the compute bare metal host. */ instanceShape: string; /** * The lifecycle state details of the compute bare metal host. */ lifecycleDetails: string; /** * The current state of the compute bare metal host. */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; } interface GetComputeCapacityTopologyComputeBareMetalHostsFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeCapacityTopologyComputeHpcIslandsComputeHpcIslandCollection { /** * The list of compute HPC islands. */ items: outputs.Core.GetComputeCapacityTopologyComputeHpcIslandsComputeHpcIslandCollectionItem[]; } interface GetComputeCapacityTopologyComputeHpcIslandsComputeHpcIslandCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology. */ computeCapacityTopologyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island. */ id: string; /** * The current state of the compute HPC island. */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; /** * The total number of compute bare metal hosts located in this compute HPC island. */ totalComputeBareMetalHostCount: string; } interface GetComputeCapacityTopologyComputeHpcIslandsFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeCapacityTopologyComputeNetworkBlocksComputeNetworkBlockCollection { /** * The list of compute network blocks. */ items: outputs.Core.GetComputeCapacityTopologyComputeNetworkBlocksComputeNetworkBlockCollectionItem[]; } interface GetComputeCapacityTopologyComputeNetworkBlocksComputeNetworkBlockCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology. */ computeCapacityTopologyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island. */ computeHpcIslandId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute network block. */ id: string; /** * The current state of the compute network block. */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; /** * The total number of compute bare metal hosts located in the compute network block. */ totalComputeBareMetalHostCount: string; } interface GetComputeCapacityTopologyComputeNetworkBlocksFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeClusterPlacementConstraintDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island for the compute cluster. */ hpcIslandId: string; /** * The logical placement strategy to apply. Allowed values are `SINGLE_TIER`, `SINGLE_BLOCK`, and `PACKED_DISTRIBUTION_MULTI_BLOCK`. */ logicalPlacementConstraint: string; /** * The list of target GPU memory fabric OCIDs to constrain placement. Up to 15 items are allowed. */ targetMemoryFabricIds: string[]; /** * The list of target network block OCIDs to constrain placement. Up to 15 items are allowed. */ targetNetworkBlockIds: string[]; /** * The type for the placement constraints. Supported value: `COMPUTE_CLUSTER`. */ type: string; } interface GetComputeClustersComputeClusterCollection { items: outputs.Core.GetComputeClustersComputeClusterCollectionItem[]; } interface GetComputeClustersComputeClusterCollectionItem { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. */ id: string; /** * The details for providing placement constraints. */ placementConstraintDetails: outputs.Core.GetComputeClustersComputeClusterCollectionItemPlacementConstraintDetail[]; /** * The current state of the compute cluster. */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; } interface GetComputeClustersComputeClusterCollectionItemPlacementConstraintDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island for the compute cluster. */ hpcIslandId: string; /** * The logical placement strategy to apply. Allowed values are `SINGLE_TIER`, `SINGLE_BLOCK`, and `PACKED_DISTRIBUTION_MULTI_BLOCK`. */ logicalPlacementConstraint: string; /** * The list of target GPU memory fabric OCIDs to constrain placement. Up to 15 items are allowed. */ targetMemoryFabricIds: string[]; /** * The list of target network block OCIDs to constrain placement. Up to 15 items are allowed. */ targetNetworkBlockIds: string[]; /** * The type for the placement constraints. Supported value: `COMPUTE_CLUSTER`. */ type: string; } interface GetComputeClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeGlobalImageCapabilitySchemasComputeGlobalImageCapabilitySchema { /** * A filter to return only resources that match the given compartment OCID exactly. */ compartmentId: string; /** * The name of the global capabilities version resource that is considered the current version. */ currentVersionName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema */ id: string; /** * 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` */ timeCreated: string; } interface GetComputeGlobalImageCapabilitySchemasFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeGlobalImageCapabilitySchemasVersionsComputeGlobalImageCapabilitySchemaVersion { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema */ computeGlobalImageCapabilitySchemaId: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The name of the compute global image capability schema version */ name: string; /** * The map of each capability name to its ImageCapabilityDescriptor. */ schemaData: { [key: string]: string; }; /** * 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` */ timeCreated: string; } interface GetComputeGlobalImageCapabilitySchemasVersionsFilter { /** * The name of the compute global image capability schema version */ name: string; regex?: boolean; /** * the list of values for the enum */ values: string[]; } interface GetComputeGpuMemoryClusterGpuMemoryClusterScaleConfig { /** * Whether downsizing is enabled. */ isDownsizeEnabled: boolean; /** * Whether upsizing is enabled. */ isUpsizeEnabled: boolean; /** * The configured target size for the GPU Memory Cluster. */ targetSize: string; } interface GetComputeGpuMemoryClusterInstancesComputeGpuMemoryClusterInstanceCollection { /** * The list of compute GPU Memory Cluster instances. */ items: outputs.Core.GetComputeGpuMemoryClusterInstancesComputeGpuMemoryClusterInstanceCollectionItem[]; } interface GetComputeGpuMemoryClusterInstancesComputeGpuMemoryClusterInstanceCollectionItem { /** * The availability domain of the GPU Memory Cluster instance. */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the compartment compartment. */ compartmentId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The fault domain the GPU Memory Cluster instance is running in. */ faultDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster instance */ id: string; /** * Configuration to be used for this GPU Memory Cluster instance. */ instanceConfigurationId: string; /** * 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). */ instanceShape: string; /** * The region that contains the availability domain the instance is running in. */ region: string; /** * The lifecycle state of the GPU Memory Cluster instance */ state: string; /** * The date and time the GPU Memory Cluster instance was created. Example: `2016-09-15T21:10:29.600Z` */ timeCreated: string; } interface GetComputeGpuMemoryClusterInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeGpuMemoryClustersComputeGpuMemoryClusterCollection { items: outputs.Core.GetComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItem[]; } interface GetComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItem { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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. */ computeClusterId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Configuration settings for GPU Memory Cluster scaling. */ gpuMemoryClusterScaleConfigs: outputs.Core.GetComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItemGpuMemoryClusterScaleConfig[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the GPU memory fabric. */ gpuMemoryFabricId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster */ id: string; /** * The OCID of the Instance Configuration used to source launch details for this instance. */ instanceConfigurationId: string; /** * Unique list of OCIDs for private IPs (IPv4/IPv6) associated with the GPU Memory Cluster */ privateIpIds: string[]; /** * 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. */ size: string; /** * The lifecycle state of the GPU Memory Cluster */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the GPU Memory Cluster was created. Example: `2016-09-15T21:10:29.600Z` */ timeCreated: string; } interface GetComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItemGpuMemoryClusterScaleConfig { /** * Whether downsizing is enabled. */ isDownsizeEnabled: boolean; /** * Whether upsizing is enabled. */ isUpsizeEnabled: boolean; /** * The configured target size for the GPU Memory Cluster. */ targetSize: string; } interface GetComputeGpuMemoryClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeGpuMemoryFabricMemoryFabricPreference { /** * The desired firmware bundle id on the GPU memory fabric. */ customerDesiredFirmwareBundleId: string; /** * The recycle level of GPU memory fabric. */ fabricRecycleLevel: string; } interface GetComputeGpuMemoryFabricsComputeGpuMemoryFabricCollection { items: outputs.Core.GetComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItem[]; } interface GetComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItem { /** * Additional data that can be exposed to the customer. Right now it will include the switch tray ids. */ additionalData: { [key: string]: string; }; /** * The total number of available bare metal hosts located in this compute GPU memory fabric. */ availableHostCount: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * List of GPU memory clusters within this GPU memory fabric. */ computeGpuMemoryClusters: string[]; /** * A filter to return only the listings that matches the given GPU memory fabric id. */ computeGpuMemoryFabricId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island. */ computeHpcIslandId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block */ computeLocalBlockId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute network block. */ computeNetworkBlockId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for current firmware bundle */ currentFirmwareBundleId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The health state of the GPU memory fabric */ fabricHealth: string; /** * The reason for updating firmware bundle version of the GPU memory fabric. */ firmwareUpdateReason: string; /** * The state of Memory Fabric Firmware update */ firmwareUpdateState: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The total number of healthy bare metal hosts located in this compute GPU memory fabric. */ healthyHostCount: string; /** * The host platform identifier used for bundle queries */ hostPlatformName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU memory fabric */ id: string; /** * The preference object specified by customer. Contains customerDesiredFirmwareBundleId, fabricRecycleLevel. */ memoryFabricPreferences: outputs.Core.GetComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItemMemoryFabricPreference[]; /** * The lifecycle state of the GPU memory fabric */ state: string; /** * The switch platform identifier used for bundle queries */ switchPlatformName: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for targeted firmware bundle */ targetFirmwareBundleId: string; /** * 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` */ timeCreated: string; /** * The total number of bare metal hosts located in this compute GPU memory fabric. */ totalHostCount: string; } interface GetComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItemMemoryFabricPreference { /** * The desired firmware bundle id on the GPU memory fabric. */ customerDesiredFirmwareBundleId: string; /** * The recycle level of GPU memory fabric. */ fabricRecycleLevel: string; } interface GetComputeGpuMemoryFabricsFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeHostConfigurationData { /** * Compute Host Group Configuration Details Check */ checkDetails: outputs.Core.GetComputeHostConfigurationDataCheckDetail[]; /** * The time that was last applied. */ timeLastApply: string; } interface GetComputeHostConfigurationDataCheckDetail { /** * Configuration state of the Compute Bare Metal Host. */ configurationState: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique firmware bundle associated with the Host. */ firmwareBundleId: string; /** * Preferred recycle level for hosts associated with the reservation config. * * `SKIP_RECYCLE` - Skips host wipe. * * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. */ recycleLevel: string; /** * The type of configuration */ type: string; } interface GetComputeHostGroupConfiguration { /** * The OCID for firmware bundle */ firmwareBundleId: string; /** * Additional quick recycle settings. */ quickRecycleSettings: outputs.Core.GetComputeHostGroupConfigurationQuickRecycleSetting[]; /** * Preferred recycle level for hosts associated with the reservation config. * * `SKIP_RECYCLE` - Skips host wipe. * * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. */ recycleLevel: string; /** * The lifecycle state of the host group */ state: string; /** * Either the platform name or compute shape that the configuration is targeting */ target: string; } interface GetComputeHostGroupConfigurationQuickRecycleSetting { /** * Whether to wipe NVMe data during quick recycle. */ nvmeWipe: boolean; } interface GetComputeHostGroupsComputeHostGroupCollection { items: outputs.Core.GetComputeHostGroupsComputeHostGroupCollectionItem[]; } interface GetComputeHostGroupsComputeHostGroupCollectionItem { /** * The availability domain of a host group. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A list of HostGroupConfiguration objects */ configurations: outputs.Core.GetComputeHostGroupsComputeHostGroupCollectionItemConfiguration[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host group */ id: string; /** * 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. */ isTargetedPlacementRequired: boolean; /** * The lifecycle state of the host group */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; } interface GetComputeHostGroupsComputeHostGroupCollectionItemConfiguration { /** * The OCID for firmware bundle */ firmwareBundleId: string; /** * Additional quick recycle settings. */ quickRecycleSettings: outputs.Core.GetComputeHostGroupsComputeHostGroupCollectionItemConfigurationQuickRecycleSetting[]; /** * Preferred recycle level for hosts associated with the reservation config. * * `SKIP_RECYCLE` - Skips host wipe. * * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. */ recycleLevel: string; /** * The lifecycle state of the host group */ state: string; /** * Either the platform name or compute shape that the configuration is targeting */ target: string; } interface GetComputeHostGroupsComputeHostGroupCollectionItemConfigurationQuickRecycleSetting { /** * Whether to wipe NVMe data during quick recycle. */ nvmeWipe: boolean; } interface GetComputeHostGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeHostRecycleDetail { /** * 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. */ computeHostGroupId: string; /** * Preferred recycle level for hosts associated with the reservation config. * * `SKIP_RECYCLE` - Skips host wipe. * * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. */ recycleLevel: string; } interface GetComputeHostsComputeHostCollection { items: outputs.Core.GetComputeHostsComputeHostCollectionItem[]; } interface GetComputeHostsComputeHostCollectionItem { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Capacity Reserver that is currently on host */ capacityReservationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute host group. */ computeHostGroupId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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. */ faultDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique firmware bundle associated with the Host. */ firmwareBundleId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique GPU Memory Fabric */ gpuMemoryFabricId: string; hasImpactedComponents: boolean; /** * The heathy state of the host */ health: string; /** * The ID that remains consistent when a host moves between capacity pools within the same tenancy. */ hostCorrelationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island */ hpcIslandId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host */ id: string; /** * The public [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Virtual Machine or Bare Metal instance */ instanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block */ localBlockId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block */ networkBlockId: string; /** * The platform of the host */ platform: string; /** * The shape of host */ shape: string; /** * The lifecycle state of the host */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; } interface GetComputeHostsFilter { name: string; regex?: boolean; values: string[]; } interface GetComputeImageCapabilitySchemasComputeImageCapabilitySchema { /** * A filter to return only resources that match the given compartment OCID exactly. */ compartmentId: string; /** * The ocid of the compute global image capability schema */ computeGlobalImageCapabilitySchemaId: string; /** * The name of the compute global image capability schema version */ computeGlobalImageCapabilitySchemaVersionName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The compute image capability schema [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an image. */ imageId: string; /** * A mapping of each capability name to its ImageCapabilityDescriptor. */ schemaData: { [key: string]: string; }; /** * 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` */ timeCreated: string; } interface GetComputeImageCapabilitySchemasFilter { name: string; regex?: boolean; /** * the list of values for the enum */ values: string[]; } interface GetConsoleHistoriesConsoleHistory { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the console history metadata object. */ id: string; /** * The OCID of the instance. */ instanceId: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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` */ timeCreated: string; } interface GetConsoleHistoriesFilter { name: string; regex?: boolean; values: string[]; } interface GetCpeDeviceShapeCpeDeviceInfo { /** * The platform or software version of the CPE device. */ platformSoftwareVersion: string; /** * The vendor that makes the CPE device. */ vendor: string; } interface GetCpeDeviceShapeParameter { /** * A descriptive label for the question (for example, to display in a form in a graphical interface). Avoid entering confidential information. */ displayName: string; /** * A description or explanation of the question, to help the customer answer accurately. */ explanation: string; /** * A string that identifies the question. */ key: string; } interface GetCpeDeviceShapesCpeDeviceShape { /** * Basic information about a particular CPE device type. */ cpeDeviceInfos: outputs.Core.GetCpeDeviceShapesCpeDeviceShapeCpeDeviceInfo[]; /** * 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. */ cpeDeviceShapeId: string; /** * 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: * * [GetCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) * * [GetIpsecCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) * * [GetTunnelCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) */ template: string; } interface GetCpeDeviceShapesCpeDeviceShapeCpeDeviceInfo { /** * The platform or software version of the CPE device. */ platformSoftwareVersion: string; /** * The vendor that makes the CPE device. */ vendor: string; } interface GetCpeDeviceShapesFilter { name: string; regex?: boolean; values: string[]; } interface GetCpesCpe { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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). */ cpeDeviceShapeId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The CPE's Oracle ID (OCID). */ id: string; /** * The public IP address of the on-premises router. */ ipAddress: string; /** * Indicates whether this CPE is of type `private` or not. */ isPrivate: boolean; /** * 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` */ timeCreated: string; } interface GetCpesFilter { name: string; regex?: boolean; values: string[]; } interface GetCrossConnectGroupMacsecProperty { /** * Type of encryption cipher suite to use for the MACsec connection. */ encryptionCipher: string; /** * Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. */ isUnprotectedTrafficAllowed: boolean; /** * An object defining the Secrets-in-Vault OCIDs representing the MACsec key. */ primaryKeys: outputs.Core.GetCrossConnectGroupMacsecPropertyPrimaryKey[]; /** * The cross-connect group's current state. */ state: string; } interface GetCrossConnectGroupMacsecPropertyPrimaryKey { /** * Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. */ connectivityAssociationKeySecretId: string; /** * The secret version of the `connectivityAssociationKey` secret in Vault. */ connectivityAssociationKeySecretVersion: string; /** * Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. */ connectivityAssociationNameSecretId: string; /** * The secret version of the connectivity association name secret in Vault. */ connectivityAssociationNameSecretVersion: string; } interface GetCrossConnectGroupsCrossConnectGroup { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A reference name or identifier for the physical fiber connection that this cross-connect group uses. */ customerReferenceName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The cross-connect group's Oracle ID (OCID). */ id: string; /** * The duration of the interface down timer in milliseconds between 0 and 3000 in multiples of 500. */ interfaceDownTimerValueInMilliseconds: number; /** * The flag to enable or disable the down timer for the interface. */ isInterfaceHoldTimerEnabled: boolean; /** * The flag to enable or disable the Qos for the cross-connect-group. */ isQosEnabled: boolean; /** * Properties used for MACsec (if capable). */ macsecProperties: outputs.Core.GetCrossConnectGroupsCrossConnectGroupMacsecProperty[]; /** * Minimum number of active cross-connects required for the cross-connect group to be considered operational. If the number of active cross-connects falls below this value, the group is not considered operational. If this value was not explicitly set when the group was created or updated, it defaults to 1. */ minimumLinks: number; /** * The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection. */ ociLogicalDeviceName: string; /** * The FastConnect device that terminates the physical connection. */ ociPhysicalDeviceName: string; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * 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` */ timeCreated: string; } interface GetCrossConnectGroupsCrossConnectGroupMacsecProperty { /** * Type of encryption cipher suite to use for the MACsec connection. */ encryptionCipher: string; /** * Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. */ isUnprotectedTrafficAllowed: boolean; /** * An object defining the Secrets-in-Vault OCIDs representing the MACsec key. */ primaryKeys: outputs.Core.GetCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey[]; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; } interface GetCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey { /** * Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. */ connectivityAssociationKeySecretId: string; /** * The secret version of the `connectivityAssociationKey` secret in Vault. */ connectivityAssociationKeySecretVersion: string; /** * Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. */ connectivityAssociationNameSecretId: string; /** * The secret version of the connectivity association name secret in Vault. */ connectivityAssociationNameSecretVersion: string; } interface GetCrossConnectGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetCrossConnectLoaProperty { authorizedAgent: string; expiryExtensionCount: number; } interface GetCrossConnectLocationsCrossConnectLocation { /** * A description of the location. */ description: string; /** * The name of the location. Example: `CyrusOne, Chandler, AZ` */ name: string; } interface GetCrossConnectLocationsFilter { /** * The name of the location. Example: `CyrusOne, Chandler, AZ` */ name: string; regex?: boolean; values: string[]; } interface GetCrossConnectMacsecProperty { /** * Type of encryption cipher suite to use for the MACsec connection. */ encryptionCipher: string; /** * Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. */ isUnprotectedTrafficAllowed: boolean; /** * An object defining the Secrets-in-Vault OCIDs representing the MACsec key. */ primaryKeys: outputs.Core.GetCrossConnectMacsecPropertyPrimaryKey[]; /** * The cross-connect's current state. */ state: string; } interface GetCrossConnectMacsecPropertyPrimaryKey { /** * Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. */ connectivityAssociationKeySecretId: string; /** * The secret version of the `connectivityAssociationKey` secret in Vault. */ connectivityAssociationKeySecretVersion: string; /** * Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. */ connectivityAssociationNameSecretId: string; /** * The secret version of the connectivity association name secret in Vault. */ connectivityAssociationNameSecretVersion: string; } interface GetCrossConnectPortSpeedShapeCrossConnectPortSpeedShape { /** * The name of the port speed shape. Example: `10 Gbps` */ name: string; /** * The port speed in Gbps. Example: `10` */ portSpeedInGbps: number; } interface GetCrossConnectPortSpeedShapeFilter { /** * The name of the port speed shape. Example: `10 Gbps` */ name: string; regex?: boolean; values: string[]; } interface GetCrossConnectsCrossConnect { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group. */ crossConnectGroupId: string; /** * A reference name or identifier for the physical fiber connection that this cross-connect uses. */ customerReferenceName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; farCrossConnectOrCrossConnectGroupId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The cross-connect's Oracle ID (OCID). */ id: string; /** * The duration of the interface down timer in milliseconds between 0 and 3000 in multiples of 500. */ interfaceDownTimerValueInMilliseconds: number; /** * The name of the FastConnect interface where this cross-connect is installed. */ interfaceName: string; isActive: boolean; /** * The flag to enable or disable the down timer for the interface. */ isInterfaceHoldTimerEnabled: boolean; /** * The flag to enable or disable the Qos for the cross-connect. */ isQosEnabled: boolean; loaProperties: outputs.Core.GetCrossConnectsCrossConnectLoaProperty[]; /** * The name of the FastConnect location where this cross-connect is installed. */ locationName: string; /** * Properties used for MACsec (if capable). */ macsecProperties: outputs.Core.GetCrossConnectsCrossConnectMacsecProperty[]; nearCrossConnectOrCrossConnectGroupId: string; /** * The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection. */ ociLogicalDeviceName: string; /** * The FastConnect device that terminates the physical connection. */ ociPhysicalDeviceName: string; /** * A string identifying the meet-me room port for this cross-connect. */ portName: string; /** * The port speed for this cross-connect. Example: `10 Gbps` */ portSpeedShapeName: string; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * 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` */ timeCreated: string; } interface GetCrossConnectsCrossConnectLoaProperty { authorizedAgent: string; expiryExtensionCount: number; } interface GetCrossConnectsCrossConnectMacsecProperty { /** * Type of encryption cipher suite to use for the MACsec connection. */ encryptionCipher: string; /** * Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. */ isUnprotectedTrafficAllowed: boolean; /** * An object defining the Secrets-in-Vault OCIDs representing the MACsec key. */ primaryKeys: outputs.Core.GetCrossConnectsCrossConnectMacsecPropertyPrimaryKey[]; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; } interface GetCrossConnectsCrossConnectMacsecPropertyPrimaryKey { /** * Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. */ connectivityAssociationKeySecretId: string; /** * The secret version of the `connectivityAssociationKey` secret in Vault. */ connectivityAssociationKeySecretVersion: string; /** * Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. */ connectivityAssociationNameSecretId: string; /** * The secret version of the connectivity association name secret in Vault. */ connectivityAssociationNameSecretVersion: string; } interface GetCrossConnectsFilter { name: string; regex?: boolean; values: string[]; } interface GetDedicatedVmHostCapacityBin { /** * Zero-based index for the corresponding capacity bucket. */ capacityIndex: number; /** * The current available local volume of the dedicated VM host, in GBs. */ remainingLocalVolumeInGbs: number; /** * The current available memory of the dedicated VM host, in GBs. */ remainingMemoryInGbs: number; /** * The current available OCPUs of the dedicated VM host. */ remainingOcpus: number; /** * List of VMI shapes supported on each capacity bucket. */ supportedShapes: string[]; /** * The current total local volume of the dedicated VM host, in GBs. */ totalLocalVolumeInGbs: number; /** * The current total memory of the dedicated VM host, in GBs. */ totalMemoryInGbs: number; /** * The current total OCPUs of the dedicated VM host. */ totalOcpus: number; } interface GetDedicatedVmHostInstanceShapesDedicatedVmHostInstanceShape { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The name of the virtual machine instance shapes that can be launched on a dedicated VM host. */ instanceShapeName: string; /** * Specifies the capabilities that the Dedicated Virtual Machine Host (DVMH) Shape or Virtual Machine Instance Shape could support. */ supportedCapabilities: outputs.Core.GetDedicatedVmHostInstanceShapesDedicatedVmHostInstanceShapeSupportedCapability[]; } interface GetDedicatedVmHostInstanceShapesDedicatedVmHostInstanceShapeSupportedCapability { /** * Whether the DVMH shape could support confidential VMs or the VM instance shape could be confidential. */ isMemoryEncryptionSupported: boolean; } interface GetDedicatedVmHostInstanceShapesFilter { name: string; regex?: boolean; values: string[]; } interface GetDedicatedVmHostInstancesDedicatedVmHostInstance { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The OCID of the virtual machine instance. */ instanceId: string; /** * A filter to return only confidential Dedicated VM hosts (DVMH) or confidential VM instances on DVMH. */ isMemoryEncryptionEnabled: boolean; /** * The shape of the VM instance. */ shape: string; /** * 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` */ timeCreated: string; } interface GetDedicatedVmHostInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetDedicatedVmHostPlacementConstraintDetail { /** * The OCID of the compute bare metal host. This is only available for dedicated capacity customers. */ computeBareMetalHostId: string; /** * 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. */ type: string; } interface GetDedicatedVmHostShapesDedicatedVmHostShape { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * A list of capacity configs that are supported by this dedicated VM host shape. */ capacityConfigs: outputs.Core.GetDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfig[]; /** * 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). */ dedicatedVmHostShape: string; } interface GetDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfig { /** * A list of total CPU and memory per capacity bucket. */ capacityBins: outputs.Core.GetDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigCapacityBin[]; /** * The name of each capacity config. */ capacityConfigName: string; /** * Whether this capacity config is the default config. */ isDefault: boolean; /** * Specifies the capabilities that the Dedicated Virtual Machine Host (DVMH) Shape or Virtual Machine Instance Shape could support. */ supportedCapabilities: outputs.Core.GetDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigSupportedCapability[]; } interface GetDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigCapacityBin { /** * Zero-based index for the corresponding capacity bucket. */ capacityIndex: number; /** * List of VMI shapes supported on each capacity bucket. */ supportedShapes: string[]; /** * The total local volume of the capacity bucket, in GBs. */ totalLocalVolumeInGbs: number; /** * The total memory of the capacity bucket, in GBs. */ totalMemoryInGbs: number; /** * The total OCPUs of the capacity bucket. */ totalOcpus: number; } interface GetDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigSupportedCapability { /** * Whether the DVMH shape could support confidential VMs or the VM instance shape could be confidential. */ isMemoryEncryptionSupported: boolean; } interface GetDedicatedVmHostShapesFilter { name: string; regex?: boolean; values: string[]; } interface GetDedicatedVmHostsDedicatedVmHost { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * A list of total and remaining CPU, memory, and local volume per capacity bucket. */ capacityBins: outputs.Core.GetDedicatedVmHostsDedicatedVmHostCapacityBin[]; /** * 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. */ capacityConfig: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The OCID of the compute bare metal host. This is only available for dedicated capacity customers. */ computeBareMetalHostId: string; /** * The dedicated virtual machine host shape. The shape determines the number of CPUs and other resources available for VMs. */ dedicatedVmHostShape: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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). */ faultDomain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated VM host. */ id: string; /** * A filter to return only confidential Dedicated VM hosts (DVMH) or confidential VM instances on DVMH. */ isMemoryEncryptionEnabled: boolean; /** * The details for providing placement constraints. */ placementConstraintDetails: outputs.Core.GetDedicatedVmHostsDedicatedVmHostPlacementConstraintDetail[]; /** * The current available local volume of the dedicated VM host, in GBs. */ remainingLocalVolumeInGbs: number; /** * The current available memory of the dedicated VM host, in GBs. */ remainingMemoryInGbs: number; /** * The current available OCPUs of the dedicated VM host. */ remainingOcpus: number; /** * A filter to only return resources that match the given lifecycle state. */ state: string; /** * 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` */ timeCreated: string; /** * The current total local volume of the dedicated VM host, in GBs. */ totalLocalVolumeInGbs: number; /** * The current total memory of the dedicated VM host, in GBs. */ totalMemoryInGbs: number; /** * The current total OCPUs of the dedicated VM host. */ totalOcpus: number; } interface GetDedicatedVmHostsDedicatedVmHostCapacityBin { /** * Zero-based index for the corresponding capacity bucket. */ capacityIndex: number; /** * The current available local volume of the dedicated VM host, in GBs. */ remainingLocalVolumeInGbs: number; /** * The current available memory of the dedicated VM host, in GBs. */ remainingMemoryInGbs: number; /** * The current available OCPUs of the dedicated VM host. */ remainingOcpus: number; /** * List of VMI shapes supported on each capacity bucket. */ supportedShapes: string[]; /** * The current total local volume of the dedicated VM host, in GBs. */ totalLocalVolumeInGbs: number; /** * The current total memory of the dedicated VM host, in GBs. */ totalMemoryInGbs: number; /** * The current total OCPUs of the dedicated VM host. */ totalOcpus: number; } interface GetDedicatedVmHostsDedicatedVmHostPlacementConstraintDetail { /** * The OCID of the compute bare metal host. This is only available for dedicated capacity customers. */ computeBareMetalHostId: string; /** * 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. */ type: string; } interface GetDedicatedVmHostsFilter { name: string; regex?: boolean; values: string[]; } interface GetDhcpOptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetDhcpOptionsOption { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The search domain name type of DHCP options */ domainNameType: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) for the set of DHCP options. */ id: string; /** * The collection of individual DHCP options. */ options: outputs.Core.GetDhcpOptionsOptionOption[]; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetDhcpOptionsOptionOption { /** * If you set `serverType` to `CustomDnsServer`, specify the IP address of at least one DNS server of your choice (three maximum). */ customDnsServers: string[]; /** * 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. */ searchDomainNames: string[]; /** * * **VcnLocal:** Reserved for future use. * * **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). * * **CustomDnsServer:** Instances use a DNS server of your choice (three maximum). */ serverType: string; /** * 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/)). */ type: string; } interface GetDrgAttachmentsDrgAttachment { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG. */ drgId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to the DRG attachment. */ drgRouteTableId: string; /** * 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. */ exportDrgRouteDistributionId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG. */ id: string; /** * Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: `false` */ isCrossTenancy: boolean; networkDetails: outputs.Core.GetDrgAttachmentsDrgAttachmentNetworkDetail[]; removeExportDrgRouteDistributionTrigger: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the DRG attachment is using. */ routeTableId: string; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * 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` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetDrgAttachmentsDrgAttachmentNetworkDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target IPSec tunnel attachment. */ ids: string[]; /** * The IPSec connection that contains the attached IPSec tunnel. */ ipsecConnectionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the DRG attachment is using. */ routeTableId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit's DRG attachment. */ transportAttachmentId: string; /** * Boolean flag that determines wether all traffic over the virtual circuits is encrypted. Example: `true` */ transportOnlyMode: boolean; /** * The type can be one of these values: `IPSEC_TUNNEL`, `LOOPBACK`, `REMOTE_PEERING_CONNECTION`, `VCN`, `VIRTUAL_CIRCUIT` */ type: string; /** * 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. */ vcnRouteType: string; } interface GetDrgAttachmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetDrgRouteDistributionStatementsDrgRouteDistributionStatement { /** * `ACCEPT` indicates the route should be imported or exported as-is. */ action: string; /** * The Oracle-assigned ID of the route distribution statement. */ id: string; /** * 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. */ matchCriterias: outputs.Core.GetDrgRouteDistributionStatementsDrgRouteDistributionStatementMatchCriteria[]; /** * 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. */ priority: number; } interface GetDrgRouteDistributionStatementsDrgRouteDistributionStatementMatchCriteria { /** * 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. */ attachmentType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment. */ drgAttachmentId: string; /** * The type of the match criteria for a route distribution statement. */ matchType: string; } interface GetDrgRouteDistributionStatementsFilter { name: string; regex?: boolean; values: string[]; } interface GetDrgRouteDistributionsDrgRouteDistribution { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the route distribution. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * Whether this distribution defines how routes get imported into route tables or exported through DRG attachments. */ distributionType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG. */ drgId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The route distribution's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * A filter that only returns resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * 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` */ timeCreated: string; } interface GetDrgRouteDistributionsFilter { name: string; regex?: boolean; values: string[]; } interface GetDrgRouteTableRouteRulesDrgRouteRule { /** * Additional properties for the route, computed by the service. */ attributes: { [key: string]: string; }; /** * Represents the range of IP addresses to match against when routing traffic. */ destination: string; /** * The type of destination for the rule. */ destinationType: string; /** * The Oracle-assigned ID of the DRG route rule. */ id: string; /** * Indicates that if the next hop attachment does not exist, so traffic for this route is discarded without notification. */ isBlackhole: boolean; /** * Indicates that the route was not imported due to a conflict between route rules. */ isConflict: boolean; /** * 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. */ nextHopDrgAttachmentId: string; /** * 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. */ routeProvenance: string; /** * 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. */ routeType: string; } interface GetDrgRouteTableRouteRulesFilter { name: string; regex?: boolean; values: string[]; } interface GetDrgRouteTablesDrgRouteTable { /** * 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. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG. */ drgId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution. */ importDrgRouteDistributionId: string; /** * 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. */ isEcmpEnabled: boolean; removeImportTrigger: boolean; /** * A filter that only returns matches for the specified lifecycle state. The value is case insensitive. */ state: string; /** * 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` */ timeCreated: string; } interface GetDrgRouteTablesFilter { name: string; regex?: boolean; values: string[]; } interface GetDrgsDrg { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The default DRG route table for this DRG. Each network type has a default DRG route table. */ defaultDrgRouteTables: outputs.Core.GetDrgsDrgDefaultDrgRouteTable[]; /** * 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. */ defaultExportDrgRouteDistributionId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The DRG's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; redundancyStatus: string; /** * The DRG's current state. */ state: string; /** * 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` */ timeCreated: string; } interface GetDrgsDrgDefaultDrgRouteTable { /** * 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. */ ipsecTunnel: string; /** * 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. */ remotePeeringConnection: string; /** * 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. */ vcn: string; /** * 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. */ virtualCircuit: string; } interface GetDrgsFilter { name: string; regex?: boolean; values: string[]; } interface GetFastConnectProviderServicesFastConnectProviderService { /** * Who is responsible for managing the virtual circuit bandwidth. */ bandwithShapeManagement: string; /** * Who is responsible for managing the ASN information for the network at the other end of the connection from Oracle. */ customerAsnManagement: string; /** * 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` */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider. */ id: string; /** * Who is responsible for managing the private peering BGP information. */ privatePeeringBgpManagement: string; /** * The name of the provider. */ providerName: string; /** * Who is responsible for managing the provider service key. */ providerServiceKeyManagement: string; /** * The name of the service offered by the provider. */ providerServiceName: string; /** * Who is responsible for managing the public peering BGP information. */ publicPeeringBgpManagement: string; /** * Total number of cross-connect or cross-connect groups required for the virtual circuit. */ requiredTotalCrossConnects: number; /** * An array of virtual circuit types supported by this service. */ supportedVirtualCircuitTypes: string[]; /** * Provider service type. */ type: string; } interface GetFastConnectProviderServicesFilter { name: string; regex?: boolean; values: string[]; } interface GetFirmwareBundleAllowableTransition { /** * An array of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle downgrades. */ downgrades: string[]; /** * An array of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle upgrades. */ upgrades: string[]; } interface GetFirmwareBundlePlatform { /** * The name of the platform supported by this bundle. */ platform: string; /** * An array of pinned components and their respective firmware versions. */ versions: outputs.Core.GetFirmwareBundlePlatformVersion[]; } interface GetFirmwareBundlePlatformVersion { /** * The type of component. */ componentType: string; /** * A list of firmware versions associated with this component type. */ versions: string[]; } interface GetFirmwareBundlesFilter { name: string; regex?: boolean; values: string[]; } interface GetFirmwareBundlesFirmwareBundlesCollection { items: outputs.Core.GetFirmwareBundlesFirmwareBundlesCollectionItem[]; } interface GetFirmwareBundlesFirmwareBundlesCollectionItem { /** * A map of firmware bundle upgrades/downgrades validated by OCI. */ allowableTransitions: outputs.Core.GetFirmwareBundlesFirmwareBundlesCollectionItemAllowableTransition[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A brief description or metadata about this firmware bundle. */ description: string; /** * The user-friendly name of this firmware bundle. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this firmware bundle. */ id: string; lifecycleState: string; /** * A map of platforms to pinned firmware versions. */ platforms: outputs.Core.GetFirmwareBundlesFirmwareBundlesCollectionItemPlatform[]; /** * 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` */ timeCreated: string; /** * 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` */ timeUpdated: string; } interface GetFirmwareBundlesFirmwareBundlesCollectionItemAllowableTransition { /** * An array of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle downgrades. */ downgrades: string[]; /** * An array of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle upgrades. */ upgrades: string[]; } interface GetFirmwareBundlesFirmwareBundlesCollectionItemPlatform { /** * platform name */ platform: string; /** * An array of pinned components and their respective firmware versions. */ versions: outputs.Core.GetFirmwareBundlesFirmwareBundlesCollectionItemPlatformVersion[]; } interface GetFirmwareBundlesFirmwareBundlesCollectionItemPlatformVersion { /** * The type of component. */ componentType: string; /** * A list of firmware versions associated with this component type. */ versions: string[]; } interface GetImageAgentFeature { /** * This attribute is not used. */ isManagementSupported: boolean; /** * This attribute is not used. */ isMonitoringSupported: boolean; } interface GetImageImageSourceDetail { bucketName: string; namespaceName: string; objectName: string; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; sourceImageType: string; sourceType: string; sourceUri: string; } interface GetImageLaunchOption { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface GetImageShapeMemoryConstraint { /** * The maximum amount of memory, in gigabytes. */ maxInGbs: number; /** * The minimum amount of memory, in gigabytes. */ minInGbs: number; } interface GetImageShapeOcpuConstraint { /** * The maximum number of OCPUs supported for this image and shape. */ max: number; /** * The minimum number of OCPUs supported for this image and shape. */ min: number; } interface GetImageShapesFilter { name: string; regex?: boolean; values: string[]; } interface GetImageShapesImageShapeCompatibility { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the image. */ imageId: string; /** * For a flexible image and shape, the amount of memory supported for instances that use this image. */ memoryConstraints: outputs.Core.GetImageShapesImageShapeCompatibilityMemoryConstraint[]; /** * OCPU options for an image and shape. */ ocpuConstraints: outputs.Core.GetImageShapesImageShapeCompatibilityOcpuConstraint[]; /** * The shape name. */ shape: string; } interface GetImageShapesImageShapeCompatibilityMemoryConstraint { /** * The maximum amount of memory, in gigabytes. */ maxInGbs: number; /** * The minimum amount of memory, in gigabytes. */ minInGbs: number; } interface GetImageShapesImageShapeCompatibilityOcpuConstraint { /** * The maximum number of OCPUs supported for this image and shape. */ max: number; /** * The minimum number of OCPUs supported for this image and shape. */ min: number; } interface GetImagesFilter { name: string; regex?: boolean; values: string[]; } interface GetImagesImage { /** * Oracle Cloud Agent features supported on the image. */ agentFeatures: outputs.Core.GetImagesImageAgentFeature[]; /** * The OCID of the image originally used to launch the instance. */ baseImageId: string; /** * The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: `100` */ billableSizeInGbs: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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: `true` */ createImageAllowed: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the image. */ id: string; imageSourceDetails: outputs.Core.GetImagesImageImageSourceDetail[]; instanceId: string; /** * Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: * * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. * * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. */ launchMode: string; /** * Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. */ launchOptions: outputs.Core.GetImagesImageLaunchOption[]; /** * The listing type of the image. The default value is "NONE". */ listingType: string; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; /** * 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: `47694` */ sizeInMbs: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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` */ timeCreated: string; } interface GetImagesImageAgentFeature { /** * This attribute is not used. */ isManagementSupported: boolean; /** * This attribute is not used. */ isMonitoringSupported: boolean; } interface GetImagesImageImageSourceDetail { bucketName: string; namespaceName: string; objectName: string; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; sourceImageType: string; sourceType: string; sourceUri: string; } interface GetImagesImageLaunchOption { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface GetInstanceAgentConfig { /** * Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. */ isManagementDisabled: boolean; /** * Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.Core.GetInstanceAgentConfigPluginsConfig[]; } interface GetInstanceAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetInstanceAvailabilityConfig { /** * 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. */ isLiveMigrationPreferred: boolean; /** * The lifecycle state for an instance when it is recovered after infrastructure maintenance. * * `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. * * `STOP_INSTANCE` - The instance is recovered in the stopped state. */ recoveryAction: string; } interface GetInstanceConfigurationGmcConfig { /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compartment containing images to search */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Configuration settings for GPU Memory Cluster scaling. */ gpuMemoryClusterScaleConfigs: outputs.Core.GetInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig[]; /** * The OCID of the instance configuration. */ instanceConfigurationId: string; /** * The desired number of instances for this GMC configuration entry. */ size: string; } interface GetInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig { /** * Enables downsizing towards the target size. */ isDownsizeEnabled: boolean; /** * Enables upsizing towards the target size. */ isUpsizeEnabled: boolean; /** * The configured target size for the GPU Memory Cluster. */ targetSize: string; } interface GetInstanceConfigurationInstanceDetail { /** * Block volume parameters. */ blockVolumes: outputs.Core.GetInstanceConfigurationInstanceDetailBlockVolume[]; /** * The type of instance details. Supported instanceType is compute */ instanceType: string; /** * 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. */ launchDetails: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetail[]; /** * Multiple Compute Instance Configuration instance details. */ options: outputs.Core.GetInstanceConfigurationInstanceDetailOption[]; /** * Secondary VNIC parameters. */ secondaryVnics: outputs.Core.GetInstanceConfigurationInstanceDetailSecondaryVnic[]; } interface GetInstanceConfigurationInstanceDetailBlockVolume { /** * Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/) */ attachDetails: outputs.Core.GetInstanceConfigurationInstanceDetailBlockVolumeAttachDetail[]; /** * Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/) */ createDetails: outputs.Core.GetInstanceConfigurationInstanceDetailBlockVolumeCreateDetail[]; /** * The OCID of the volume. */ volumeId: string; } interface GetInstanceConfigurationInstanceDetailBlockVolumeAttachDetail { /** * The device name. */ device: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Whether the attachment should be created in read-only mode. */ isReadOnly: boolean; /** * 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. */ isShareable: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; /** * Whether to use CHAP authentication for the volume attachment. Defaults to false. */ useChap: boolean; } interface GetInstanceConfigurationInstanceDetailBlockVolumeCreateDetail { /** * The list of autotune policies enabled for this volume. */ autotunePolicies: outputs.Core.GetInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned. */ backupPolicyId: string; /** * The list of block volume replicas to be enabled for this volume in the specified destination availability domains. */ blockVolumeReplicas: outputs.Core.GetInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica[]; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * The OCID of the compartment containing images to search */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ isAutoTuneEnabled: boolean; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The size of the volume in GBs. */ sizeInGbs: string; sourceDetails: outputs.Core.GetInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail[]; /** * 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. */ vpusPerGb: string; /** * 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). */ xrcKmsKeyId: string; } interface GetInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy { /** * This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface GetInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica { /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; } interface GetInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail { /** * The OCID of the volume backup. */ id: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetail { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailAgentConfig[]; /** * Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware. */ availabilityConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compute capacity reservation this instance is launched under. */ capacityReservationId: string; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * The OCID of the compartment containing images to search */ compartmentId: string; /** * 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. */ computeClusterId: string; /** * 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. */ createVnicDetails: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail[]; /** * The OCID of the dedicated virtual machine host to place the instance on. */ dedicatedVmHostId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. */ extendedMetadata: { [key: string]: string; }; /** * 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. */ faultDomain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints. */ instanceOptions: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * Whether to enable AI enterprise on the instance. */ isAiEnterpriseEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: * * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. * * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. */ launchMode: string; /** * Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. */ launchOptions: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailLaunchOption[]; /** * List of licensing configurations associated with target launch values. */ licensingConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig[]; /** * Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance. */ metadata: { [key: string]: string; }; /** * The details for providing placement constraints. */ placementConstraintDetails: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail[]; /** * The platform configuration requested for the instance. */ platformConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig[]; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig[]; /** * The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported. * * `LIVE_MIGRATE` - Run maintenance using a live migration. * * `REBOOT` - Run maintenance using a reboot. */ preferredMaintenanceAction: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailShapeConfig[]; sourceDetails: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailSourceDetail[]; } interface GetInstanceConfigurationInstanceDetailLaunchDetailAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig[]; } interface GetInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig { /** * 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. */ isLiveMigrationPreferred: boolean; /** * The lifecycle state for an instance when it is recovered after infrastructure maintenance. * * `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. * * `STOP_INSTANCE` - The instance is recovered in the stopped state. */ recoveryAction: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetailInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetInstanceConfigurationInstanceDetailLaunchDetailLaunchOption { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig { /** * License Type for the OS license. * * `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour). * * `BRING_YOUR_OWN_LICENSE` - Bring your own license. * * `PARTNER_PROVIDED` - Partner provided license. */ licenseType: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail { /** * The OCID of the compute host group. This is only available for dedicated capacity customers. */ computeHostGroupId: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig { /** * Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. */ areVirtualInstructionsEnabled: boolean; /** * Instance Platform Configuration Configuration Map for flexible setting input. */ configMap: { [key: string]: string; }; /** * 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. */ isAccessControlServiceEnabled: boolean; /** * Whether the input-output memory management unit is enabled. */ isInputOutputMemoryManagementUnitEnabled: boolean; /** * Whether the Measured Boot feature is enabled on the instance. */ isMeasuredBootEnabled: boolean; /** * Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. */ isMemoryEncryptionEnabled: boolean; /** * Whether Secure Boot is enabled on the instance. */ isSecureBootEnabled: boolean; /** * Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading. */ isSymmetricMultiThreadingEnabled: boolean; /** * Whether the Trusted Platform Module (TPM) is enabled on the instance. */ isTrustedPlatformModuleEnabled: boolean; /** * The number of NUMA nodes per socket (NPS). */ numaNodesPerSocket: string; /** * 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. */ percentageOfCoresEnabled: number; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction[]; } interface GetInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetailShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * 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. */ localVolumeSizeInGbs: number; /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; /** * This field is reserved for internal use. */ resourceManagement: string; /** * 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. */ vcpus: number; } interface GetInstanceConfigurationInstanceDetailLaunchDetailSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * These are the criteria for selecting an image. This is required if imageId is not specified. */ instanceSourceImageFilterDetails: outputs.Core.GetInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail[]; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail { /** * The OCID of the compartment containing images to search */ compartmentId: string; /** * 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). */ definedTagsFilter: { [key: string]: string; }; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; } interface GetInstanceConfigurationInstanceDetailOption { /** * Block volume parameters. */ blockVolumes: outputs.Core.GetInstanceConfigurationInstanceDetailOptionBlockVolume[]; /** * 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. */ launchDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetail[]; /** * Secondary VNIC parameters. */ secondaryVnics: outputs.Core.GetInstanceConfigurationInstanceDetailOptionSecondaryVnic[]; } interface GetInstanceConfigurationInstanceDetailOptionBlockVolume { /** * Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/) */ attachDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail[]; /** * Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/) */ createDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail[]; /** * The OCID of the volume. */ volumeId: string; } interface GetInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail { /** * The device name. */ device: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Whether the attachment should be created in read-only mode. */ isReadOnly: boolean; /** * 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. */ isShareable: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; /** * Whether to use CHAP authentication for the volume attachment. Defaults to false. */ useChap: boolean; } interface GetInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail { /** * The list of autotune policies enabled for this volume. */ autotunePolicies: outputs.Core.GetInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned. */ backupPolicyId: string; /** * The list of block volume replicas to be enabled for this volume in the specified destination availability domains. */ blockVolumeReplicas: outputs.Core.GetInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica[]; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * The OCID of the compartment containing images to search */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ isAutoTuneEnabled: boolean; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The size of the volume in GBs. */ sizeInGbs: string; sourceDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail[]; /** * 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. */ vpusPerGb: string; /** * 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). */ xrcKmsKeyId: string; } interface GetInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy { /** * This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface GetInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica { /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; } interface GetInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail { /** * The OCID of the volume backup. */ id: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetail { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig[]; /** * Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware. */ availabilityConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compute capacity reservation this instance is launched under. */ capacityReservationId: string; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * The OCID of the compartment containing images to search */ compartmentId: string; /** * 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. */ computeClusterId: string; /** * 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. */ createVnicDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail[]; /** * The OCID of the dedicated virtual machine host to place the instance on. */ dedicatedVmHostId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. */ extendedMetadata: { [key: string]: string; }; /** * 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. */ faultDomain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints. */ instanceOptions: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * Whether to enable AI enterprise on the instance. */ isAiEnterpriseEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: * * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. * * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. */ launchMode: string; /** * Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. */ launchOptions: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption[]; /** * List of licensing configurations associated with target launch values. */ licensingConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig[]; /** * Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance. */ metadata: { [key: string]: string; }; /** * The details for providing placement constraints. */ placementConstraintDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail[]; /** * The platform configuration requested for the instance. */ platformConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig[]; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig[]; /** * The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported. * * `LIVE_MIGRATE` - Run maintenance using a live migration. * * `REBOOT` - Run maintenance using a reboot. */ preferredMaintenanceAction: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig[]; sourceDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail[]; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig[]; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig { /** * 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. */ isLiveMigrationPreferred: boolean; /** * The lifecycle state for an instance when it is recovered after infrastructure maintenance. * * `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. * * `STOP_INSTANCE` - The instance is recovered in the stopped state. */ recoveryAction: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig { /** * License Type for the OS license. * * `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour). * * `BRING_YOUR_OWN_LICENSE` - Bring your own license. * * `PARTNER_PROVIDED` - Partner provided license. */ licenseType: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail { /** * The OCID of the compute host group. This is only available for dedicated capacity customers. */ computeHostGroupId: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig { /** * Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. */ areVirtualInstructionsEnabled: boolean; /** * 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. */ isAccessControlServiceEnabled: boolean; /** * Whether the input-output memory management unit is enabled. */ isInputOutputMemoryManagementUnitEnabled: boolean; /** * Whether the Measured Boot feature is enabled on the instance. */ isMeasuredBootEnabled: boolean; /** * Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. */ isMemoryEncryptionEnabled: boolean; /** * Whether Secure Boot is enabled on the instance. */ isSecureBootEnabled: boolean; /** * Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading. */ isSymmetricMultiThreadingEnabled: boolean; /** * Whether the Trusted Platform Module (TPM) is enabled on the instance. */ isTrustedPlatformModuleEnabled: boolean; /** * The number of NUMA nodes per socket (NPS). */ numaNodesPerSocket: string; /** * 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. */ percentageOfCoresEnabled: number; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction[]; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * 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. */ localVolumeSizeInGbs: number; /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; /** * This field is reserved for internal use. */ resourceManagement: string; /** * 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. */ vcpus: number; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * These are the criteria for selecting an image. This is required if imageId is not specified. */ instanceSourceImageFilterDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail[]; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail { /** * The OCID of the compartment containing images to search */ compartmentId: string; /** * 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). */ definedTagsFilter: { [key: string]: string; }; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; } interface GetInstanceConfigurationInstanceDetailOptionSecondaryVnic { /** * 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. */ createVnicDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail[]; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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). */ nicIndex: number; } interface GetInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface GetInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstanceConfigurationInstanceDetailSecondaryVnic { /** * 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. */ createVnicDetails: outputs.Core.GetInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail[]; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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). */ nicIndex: number; } interface GetInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface GetInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstanceConfigurationsFilter { /** * 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). */ name: string; regex?: boolean; values: string[]; } interface GetInstanceConfigurationsInstanceConfiguration { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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. */ deferredFields: string[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The GPU Memory Cluster configuration entries for. */ gmcConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationGmcConfig[]; /** * The OCID of the volume backup. */ id: string; instanceDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetail[]; instanceId: string; /** * Differentiator for instance configuration. Following values are supported: * * INSTANCE : All details related to instance will be passed within instanceDetails. * * GMC : All details related to gpu memory cluster will be passed within gmcConfigs. */ source: string; /** * 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` */ timeCreated: string; } interface GetInstanceConfigurationsInstanceConfigurationGmcConfig { /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Configuration settings for GPU Memory Cluster scaling. */ gpuMemoryClusterScaleConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig[]; /** * 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. */ instanceConfigurationId: string; /** * The desired number of instances for this GMC configuration entry. */ size: string; } interface GetInstanceConfigurationsInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig { /** * Enables downsizing towards the target size. */ isDownsizeEnabled: boolean; /** * Enables upsizing towards the target size. */ isUpsizeEnabled: boolean; /** * The configured target size for the GPU Memory Cluster. */ targetSize: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetail { /** * Block volume parameters. */ blockVolumes: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolume[]; /** * The type of instance details. Supported instanceType is compute */ instanceType: string; /** * 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. */ launchDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetail[]; /** * Multiple Compute Instance Configuration instance details. */ options: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOption[]; /** * Secondary VNIC parameters. */ secondaryVnics: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnic[]; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolume { /** * Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/) */ attachDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeAttachDetail[]; /** * Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/) */ createDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetail[]; /** * The OCID of the volume. */ volumeId: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeAttachDetail { /** * The device name. */ device: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Whether the attachment should be created in read-only mode. */ isReadOnly: boolean; /** * 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. */ isShareable: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; /** * Whether to use CHAP authentication for the volume attachment. Defaults to false. */ useChap: boolean; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetail { /** * The list of autotune policies enabled for this volume. */ autotunePolicies: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned. */ backupPolicyId: string; /** * The list of block volume replicas to be enabled for this volume in the specified destination availability domains. */ blockVolumeReplicas: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica[]; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ isAutoTuneEnabled: boolean; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The size of the volume in GBs. */ sizeInGbs: string; sourceDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail[]; /** * 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. */ vpusPerGb: string; /** * 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). */ xrcKmsKeyId: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy { /** * This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica { /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail { /** * The OCID of the volume backup. */ id: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetail { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfig[]; /** * Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware. */ availabilityConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compute capacity reservation this instance is launched under. */ capacityReservationId: string; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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. */ computeClusterId: string; /** * 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. */ createVnicDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail[]; /** * The OCID of the dedicated virtual machine host to place the instance on. */ dedicatedVmHostId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. */ extendedMetadata: { [key: string]: string; }; /** * 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. */ faultDomain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints. */ instanceOptions: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * Whether to enable AI enterprise on the instance. */ isAiEnterpriseEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: * * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. * * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. */ launchMode: string; /** * Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. */ launchOptions: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLaunchOption[]; /** * List of licensing configurations associated with target launch values. */ licensingConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig[]; /** * Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance. */ metadata: { [key: string]: string; }; /** * The details for providing placement constraints. */ placementConstraintDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail[]; /** * The platform configuration requested for the instance. */ platformConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig[]; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig[]; /** * The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported. * * `LIVE_MIGRATE` - Run maintenance using a live migration. * * `REBOOT` - Run maintenance using a reboot. */ preferredMaintenanceAction: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailShapeConfig[]; sourceDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetail[]; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig[]; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig { /** * 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. */ isLiveMigrationPreferred: boolean; /** * The lifecycle state for an instance when it is recovered after infrastructure maintenance. * * `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. * * `STOP_INSTANCE` - The instance is recovered in the stopped state. */ recoveryAction: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLaunchOption { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig { /** * License Type for the OS license. * * `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour). * * `BRING_YOUR_OWN_LICENSE` - Bring your own license. * * `PARTNER_PROVIDED` - Partner provided license. */ licenseType: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail { /** * The OCID of the compute host group. This is only available for dedicated capacity customers. */ computeHostGroupId: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig { /** * Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. */ areVirtualInstructionsEnabled: boolean; /** * Instance Platform Configuration Configuration Map for flexible setting input. */ configMap: { [key: string]: string; }; /** * 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. */ isAccessControlServiceEnabled: boolean; /** * Whether the input-output memory management unit is enabled. */ isInputOutputMemoryManagementUnitEnabled: boolean; /** * Whether the Measured Boot feature is enabled on the instance. */ isMeasuredBootEnabled: boolean; /** * Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. */ isMemoryEncryptionEnabled: boolean; /** * Whether Secure Boot is enabled on the instance. */ isSecureBootEnabled: boolean; /** * Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading. */ isSymmetricMultiThreadingEnabled: boolean; /** * Whether the Trusted Platform Module (TPM) is enabled on the instance. */ isTrustedPlatformModuleEnabled: boolean; /** * The number of NUMA nodes per socket (NPS). */ numaNodesPerSocket: string; /** * 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. */ percentageOfCoresEnabled: number; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction[]; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * 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. */ localVolumeSizeInGbs: number; /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; /** * This field is reserved for internal use. */ resourceManagement: string; /** * 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. */ vcpus: number; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * These are the criteria for selecting an image. This is required if imageId is not specified. */ instanceSourceImageFilterDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail[]; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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). */ definedTagsFilter: { [key: string]: string; }; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOption { /** * Block volume parameters. */ blockVolumes: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolume[]; /** * 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. */ launchDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetail[]; /** * Secondary VNIC parameters. */ secondaryVnics: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnic[]; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolume { /** * Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/) */ attachDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail[]; /** * Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/) */ createDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail[]; /** * The OCID of the volume. */ volumeId: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail { /** * The device name. */ device: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Whether the attachment should be created in read-only mode. */ isReadOnly: boolean; /** * 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. */ isShareable: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; /** * Whether to use CHAP authentication for the volume attachment. Defaults to false. */ useChap: boolean; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail { /** * The list of autotune policies enabled for this volume. */ autotunePolicies: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned. */ backupPolicyId: string; /** * The list of block volume replicas to be enabled for this volume in the specified destination availability domains. */ blockVolumeReplicas: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica[]; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ isAutoTuneEnabled: boolean; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The size of the volume in GBs. */ sizeInGbs: string; sourceDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail[]; /** * 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. */ vpusPerGb: string; /** * 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). */ xrcKmsKeyId: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy { /** * This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica { /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail { /** * The OCID of the volume backup. */ id: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetail { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig[]; /** * Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware. */ availabilityConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig[]; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compute capacity reservation this instance is launched under. */ capacityReservationId: string; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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. */ computeClusterId: string; /** * 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. */ createVnicDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail[]; /** * The OCID of the dedicated virtual machine host to place the instance on. */ dedicatedVmHostId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. */ extendedMetadata: { [key: string]: string; }; /** * 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. */ faultDomain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints. */ instanceOptions: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption[]; /** * This is an advanced option. */ ipxeScript: string; /** * Whether to enable AI enterprise on the instance. */ isAiEnterpriseEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: * * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. * * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. */ launchMode: string; /** * Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. */ launchOptions: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption[]; /** * List of licensing configurations associated with target launch values. */ licensingConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig[]; /** * Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance. */ metadata: { [key: string]: string; }; /** * The details for providing placement constraints. */ placementConstraintDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail[]; /** * The platform configuration requested for the instance. */ platformConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig[]; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig[]; /** * The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported. * * `LIVE_MIGRATE` - Run maintenance using a live migration. * * `REBOOT` - Run maintenance using a reboot. */ preferredMaintenanceAction: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig[]; sourceDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail[]; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig[]; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig { /** * 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. */ isLiveMigrationPreferred: boolean; /** * The lifecycle state for an instance when it is recovered after infrastructure maintenance. * * `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. * * `STOP_INSTANCE` - The instance is recovered in the stopped state. */ recoveryAction: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig { /** * License Type for the OS license. * * `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour). * * `BRING_YOUR_OWN_LICENSE` - Bring your own license. * * `PARTNER_PROVIDED` - Partner provided license. */ licenseType: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail { /** * The OCID of the compute host group. This is only available for dedicated capacity customers. */ computeHostGroupId: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig { /** * Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. */ areVirtualInstructionsEnabled: boolean; /** * 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. */ isAccessControlServiceEnabled: boolean; /** * Whether the input-output memory management unit is enabled. */ isInputOutputMemoryManagementUnitEnabled: boolean; /** * Whether the Measured Boot feature is enabled on the instance. */ isMeasuredBootEnabled: boolean; /** * Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. */ isMemoryEncryptionEnabled: boolean; /** * Whether Secure Boot is enabled on the instance. */ isSecureBootEnabled: boolean; /** * Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading. */ isSymmetricMultiThreadingEnabled: boolean; /** * Whether the Trusted Platform Module (TPM) is enabled on the instance. */ isTrustedPlatformModuleEnabled: boolean; /** * The number of NUMA nodes per socket (NPS). */ numaNodesPerSocket: string; /** * 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. */ percentageOfCoresEnabled: number; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction[]; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * 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. */ localVolumeSizeInGbs: number; /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; /** * This field is reserved for internal use. */ resourceManagement: string; /** * 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. */ vcpus: number; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * These are the criteria for selecting an image. This is required if imageId is not specified. */ instanceSourceImageFilterDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail[]; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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). */ definedTagsFilter: { [key: string]: string; }; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnic { /** * 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. */ createVnicDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail[]; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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). */ nicIndex: number; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnic { /** * 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. */ createVnicDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail[]; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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). */ nicIndex: number; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface GetInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstanceConsoleConnectionsFilter { name: string; regex?: boolean; values: string[]; } interface GetInstanceConsoleConnectionsInstanceConsoleConnection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The SSH connection string for the console connection. */ connectionString: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The SSH public key's fingerprint for client authentication to the console connection. */ fingerprint: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the console connection. */ id: string; /** * The OCID of the instance. */ instanceId: string; publicKey: string; /** * The SSH public key's fingerprint for the console connection service host. */ serviceHostKeyFingerprint: string; /** * The current state of the console connection. */ state: string; /** * The SSH connection string for the SSH tunnel used to connect to the console connection over VNC. */ vncConnectionString: string; } interface GetInstanceCreateVnicDetail { assignIpv6ip: boolean; assignPrivateDnsRecord: boolean; assignPublicIp: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The hostname for the instance VNIC's primary private IP. */ hostnameLabel: string; ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; nsgIds: string[]; /** * The private IP address of instance VNIC. To set the private IP address, use the `privateIp` argument in create_vnic_details. */ privateIp: string; privateIpId: string; /** * 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"}` */ securityAttributes: { [key: string]: string; }; skipSourceDestCheck: boolean; subnetCidr: string; subnetId: string; vlanId: string; } interface GetInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { ipv6address: string; ipv6id: string; ipv6subnetCidr: string; } interface GetInstanceDevicesDevice { /** * A filter to return only available devices or only used devices. */ isAvailable: boolean; /** * A filter to return only devices that match the given name exactly. */ name: string; } interface GetInstanceDevicesFilter { /** * A filter to return only devices that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetInstanceInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetInstanceLaunchOption { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface GetInstanceLaunchVolumeAttachment { device: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; encryptionInTransitType: string; isAgentAutoIscsiLoginEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; isReadOnly: boolean; isShareable: boolean; launchCreateVolumeDetails: outputs.Core.GetInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail[]; /** * (Required) The type of action to run when the instance is interrupted for eviction. */ type: string; useChap: boolean; volumeId: string; } interface GetInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail { /** * The OCID of the compartment containing images to search */ compartmentId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The OCID of the Vault service key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; sizeInGbs: string; volumeCreationType: string; vpusPerGb: string; } interface GetInstanceLicensingConfig { /** * License Type for the OS license. * * `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour). * * `BRING_YOUR_OWN_LICENSE` - Bring your own license. * * `PARTNER_PROVIDED` - Partner provided license. */ licenseType: string; /** * The Operating System version of the license config. */ osVersion: string; /** * (Required) The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceMaintenanceEventsFilter { name: string; regex?: boolean; values: string[]; } interface GetInstanceMaintenanceEventsInstanceMaintenanceEvent { /** * Additional details of the maintenance in the form of json. */ additionalDetails: { [key: string]: string; }; alternativeResolutionAction: string; /** * These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance. */ alternativeResolutionActions: string[]; /** * For Instances that have local storage, this field is set to true when local storage will be deleted as a result of the Maintenance. */ canDeleteLocalStorage: boolean; /** * Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate. */ canReschedule: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A filter to only return resources that have a matching correlationToken. */ correlationToken: string; /** * The creator of the maintenance event. */ createdBy: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * It is the descriptive information about the maintenance taking place on the customer instance. */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state. */ estimatedDuration: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance event. */ id: string; /** * A filter to only return resources that match the given instance action. */ instanceAction: string; /** * The OCID of the instance. */ instanceId: string; instanceMaintenanceEventId: string; /** * 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. */ maintenanceCategory: string; /** * 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. */ maintenanceReason: string; /** * The duration of the time window Maintenance is scheduled to begin within. */ startWindowDuration: string; /** * A filter to only return resources that match the given lifecycle state. */ state: string; /** * 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` */ timeCreated: string; /** * The time at which the Maintenance actually finished. */ timeFinished: string; /** * 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. */ timeHardDueDate: string; /** * The time at which the Maintenance actually started. */ timeStarted: string; /** * The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time. */ timeWindowStart: string; } interface GetInstanceMeasuredBootReportMeasurement { /** * The list of actual PCR entries measured during boot. */ actuals: outputs.Core.GetInstanceMeasuredBootReportMeasurementActual[]; /** * The list of expected PCR entries to use during verification. */ policies: outputs.Core.GetInstanceMeasuredBootReportMeasurementPolicy[]; } interface GetInstanceMeasuredBootReportMeasurementActual { /** * The type of algorithm used to calculate the hash. */ hashAlgorithm: string; /** * The index of the policy. */ pcrIndex: string; /** * The hashed PCR value. */ value: string; } interface GetInstanceMeasuredBootReportMeasurementPolicy { /** * The type of algorithm used to calculate the hash. */ hashAlgorithm: string; /** * The index of the policy. */ pcrIndex: string; /** * The hashed PCR value. */ value: string; } interface GetInstancePlacementConstraintDetail { /** * The OCID of the compute bare metal host. */ computeBareMetalHostId: string; /** * The OCID of the compute host group. */ computeHostGroupId: string; /** * (Required) The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstancePlatformConfig { /** * Whether virtualization instructions are available. */ areVirtualInstructionsEnabled: boolean; /** * Instance Platform Configuration Configuration Map for flexible setting input. */ configMap: { [key: string]: string; }; /** * Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough. */ isAccessControlServiceEnabled: boolean; /** * Whether the input-output memory management unit is enabled. */ isInputOutputMemoryManagementUnitEnabled: boolean; /** * Whether the Measured Boot is to be enabled on the instance */ isMeasuredBootEnabled: boolean; /** * Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. */ isMemoryEncryptionEnabled: boolean; /** * Whether the Secure Boot is to be enabled on the instance. */ isSecureBootEnabled: boolean; /** * Whether symmetric multi-threading is enabled on the instance. */ isSymmetricMultiThreadingEnabled: boolean; /** * Whether the Trusted Platform Module (TPM) is to be enabled on the instance. */ isTrustedPlatformModuleEnabled: boolean; /** * The number of NUMA nodes per socket (NPS). */ numaNodesPerSocket: string; /** * The percentage of cores enabled. */ percentageOfCoresEnabled: number; /** * (Required) The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstancePoolInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetInstancePoolInstancesInstance { autoTerminateInstanceOnDelete: boolean; /** * The availability domain the instance is running in. */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; decrementSizeOnDelete: boolean; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The fault domain the instance is running in. */ faultDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration used to create the instance. */ instanceConfigurationId: string; instanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool. */ instancePoolId: string; /** * The load balancer backends that are configured for the instance pool instance. */ loadBalancerBackends: outputs.Core.GetInstancePoolInstancesInstanceLoadBalancerBackend[]; /** * The region that contains the availability domain the instance is running in. */ region: string; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The lifecycle state of the instance. Refer to `lifecycleState` in the [Instance](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Instance) resource. */ state: string; /** * 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` */ timeCreated: string; } interface GetInstancePoolInstancesInstanceLoadBalancerBackend { /** * The health of the backend as observed by the load balancer. */ backendHealthStatus: string; /** * The name of the backend in the backend set. */ backendName: string; /** * The name of the backend set on the load balancer. */ backendSetName: string; /** * The OCID of the load balancer attached to the instance pool. */ loadBalancerId: string; /** * The lifecycle state of the instance. Refer to `lifecycleState` in the [Instance](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Instance) resource. */ state: string; } interface GetInstancePoolLifecycleManagement { /** * The lifecycle actions for the instance pool. */ lifecycleActions: outputs.Core.GetInstancePoolLifecycleManagementLifecycleAction[]; } interface GetInstancePoolLifecycleManagementLifecycleAction { /** * The data for pre-termination action for an instance pool */ preTerminations: outputs.Core.GetInstancePoolLifecycleManagementLifecycleActionPreTermination[]; } interface GetInstancePoolLifecycleManagementLifecycleActionPreTermination { /** * Whether pre-termination action is enabled or not. */ isEnabled: boolean; /** * Options to handle timeout for pre-termination action. */ onTimeouts: outputs.Core.GetInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout[]; /** * The timeout in seconds for pre-termination action for an instance pool(min = 0 sec, max = 7200 secs). */ timeout: number; } interface GetInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout { /** * Whether the block volume should be preserved after termination. */ preserveBlockVolumeMode: string; /** * Whether the boot volume should be preserved after termination. */ preserveBootVolumeMode: string; } interface GetInstancePoolLoadBalancer { /** * The name of the backend set on the load balancer. */ backendSetName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool. */ instancePoolId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool. */ loadBalancerId: string; /** * The port value used for the backends. */ port: number; /** * The current state of the instance pool. */ state: string; /** * 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. */ vnicSelection: string; } interface GetInstancePoolPlacementConfiguration { /** * The availability domain to place instances. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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. */ computeClusterId: string; /** * The fault domains to place instances. */ faultDomains: string[]; /** * 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. */ primarySubnetId: string; /** * Details about the IPv6 primary subnet. */ primaryVnicSubnets: outputs.Core.GetInstancePoolPlacementConfigurationPrimaryVnicSubnet[]; /** * The set of secondary VNIC data for instances in the pool. */ secondaryVnicSubnets: outputs.Core.GetInstancePoolPlacementConfigurationSecondaryVnicSubnet[]; } interface GetInstancePoolPlacementConfigurationPrimaryVnicSubnet { /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstancePoolPlacementConfigurationSecondaryVnicSubnet { /** * The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC. */ displayName: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstancePoolsFilter { name: string; regex?: boolean; values: string[]; } interface GetInstancePoolsInstancePool { actualSize: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Count of instance in running state associated to the Instance Pool. */ currentSize: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated with the instance pool. */ instanceConfigurationId: string; /** * 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 */ instanceDisplayNameFormatter: string; /** * 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 */ instanceHostnameFormatter: string; /** * The lifecycle management options for the instance pool. */ lifecycleManagements: outputs.Core.GetInstancePoolsInstancePoolLifecycleManagement[]; /** * The load balancers attached to the instance pool. */ loadBalancers: outputs.Core.GetInstancePoolsInstancePoolLoadBalancer[]; /** * The placement configurations for the instance pool. */ placementConfigurations: outputs.Core.GetInstancePoolsInstancePoolPlacementConfiguration[]; /** * The type of resources managed by the pool. */ poolType: string; /** * 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. */ size: number; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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` */ timeCreated: string; } interface GetInstancePoolsInstancePoolLifecycleManagement { /** * The lifecycle actions for the instance pool. */ lifecycleActions: outputs.Core.GetInstancePoolsInstancePoolLifecycleManagementLifecycleAction[]; } interface GetInstancePoolsInstancePoolLifecycleManagementLifecycleAction { /** * The data for pre-termination action for an instance pool */ preTerminations: outputs.Core.GetInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTermination[]; } interface GetInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTermination { /** * Whether pre-termination action is enabled or not. */ isEnabled: boolean; /** * Options to handle timeout for pre-termination action. */ onTimeouts: outputs.Core.GetInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout[]; /** * The timeout in seconds for pre-termination action for an instance pool(min = 0 sec, max = 7200 secs). */ timeout: number; } interface GetInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout { /** * Whether the block volume should be preserved after termination. */ preserveBlockVolumeMode: string; /** * Whether the boot volume should be preserved after termination. */ preserveBootVolumeMode: string; } interface GetInstancePoolsInstancePoolLoadBalancer { /** * The name of the backend set on the load balancer. */ backendSetName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment. */ instancePoolId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool. */ loadBalancerId: string; /** * The port value used for the backends. */ port: number; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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. */ vnicSelection: string; } interface GetInstancePoolsInstancePoolPlacementConfiguration { /** * The availability domain to place instances. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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. */ computeClusterId: string; /** * The fault domains to place instances. */ faultDomains: string[]; /** * 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. */ primarySubnetId: string; /** * Details about the IPv6 primary subnet. */ primaryVnicSubnets: outputs.Core.GetInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnet[]; /** * The set of secondary VNIC data for instances in the pool. */ secondaryVnicSubnets: outputs.Core.GetInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnet[]; } interface GetInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnet { /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnet { /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * 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. */ isAssignIpv6ip: boolean; /** * The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface GetInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface GetInstancePreemptibleInstanceConfig { /** * (Required) The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.Core.GetInstancePreemptibleInstanceConfigPreemptionAction[]; } interface GetInstancePreemptibleInstanceConfigPreemptionAction { /** * (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. */ preserveBootVolume: boolean; /** * (Required) The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstanceShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * A short description of the instance's graphics processing unit (GPU). */ gpuDescription: string; /** * The number of GPUs available to the instance. */ gpus: number; /** * A short description of the local disks available to this instance. */ localDiskDescription: string; /** * The number of local disks available to the instance. */ localDisks: number; /** * The aggregate size of all local disks, in gigabytes. */ localDisksTotalSizeInGbs: number; /** * 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. */ localVolumeSizeInGbs: number; /** * The maximum number of VNIC attachments for the instance. */ maxVnicAttachments: number; /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The networking bandwidth available to the instance, in gigabits per second. */ networkingBandwidthInGbps: number; nvmes: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; /** * A short description of the instance's processor (CPU). */ processorDescription: string; /** * This field is reserved for internal use. */ resourceManagement: string; /** * 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. */ vcpus: number; } interface GetInstanceSourceDetail { /** * The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * These are the criteria for selecting an image. This is required if imageId is not specified. */ instanceSourceImageFilterDetails: outputs.Core.GetInstanceSourceDetailInstanceSourceImageFilterDetail[]; isPreserveBootVolumeEnabled: boolean; /** * The OCID of the Vault service key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The OCID of the boot volume used to boot the instance. */ sourceId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetInstanceSourceDetailInstanceSourceImageFilterDetail { /** * The OCID of the compartment containing images to search */ compartmentId: string; /** * 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). */ definedTagsFilter: { [key: string]: string; }; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; } interface GetInstancesFilter { /** * 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). */ name: string; regex?: boolean; values: string[]; } interface GetInstancesInstance { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfigs: outputs.Core.GetInstancesInstanceAgentConfig[]; async: boolean; /** * Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware. */ availabilityConfigs: outputs.Core.GetInstancesInstanceAvailabilityConfig[]; /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the attached boot volume. If the `sourceType` is `bootVolume`, this will be the same OCID as the `sourceId`. */ bootVolumeId: string; /** * The OCID of the compute capacity reservation. */ capacityReservationId: string; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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. */ computeClusterId: string; createVnicDetails: outputs.Core.GetInstancesInstanceCreateVnicDetail[]; /** * The OCID of the dedicated virtual machine host that the instance is placed on. */ dedicatedVmHostId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. */ extendedMetadata: { [key: string]: string; }; /** * The name of the fault domain the instance is running in. */ faultDomain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * @deprecated The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead. */ hostnameLabel: string; /** * The OCID of the instance. */ id: string; /** * Deprecated. Use `sourceDetails` instead. * * @deprecated The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used. */ image: string; /** * 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. */ instanceConfigurationId: string; /** * Optional mutable instance options */ instanceOptions: outputs.Core.GetInstancesInstanceInstanceOption[]; /** * 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. */ ipxeScript: string; /** * Whether AI enterprise is enabled on the instance. */ isAiEnterpriseEnabled: boolean; /** * Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes. */ isCrossNumaNode: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: * * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. * * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. */ launchMode: string; /** * Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. */ launchOptions: outputs.Core.GetInstancesInstanceLaunchOption[]; launchVolumeAttachments: outputs.Core.GetInstancesInstanceLaunchVolumeAttachment[]; /** * List of licensing configurations associated with the instance. */ licensingConfigs: outputs.Core.GetInstancesInstanceLicensingConfig[]; /** * Custom metadata that you provide. */ metadata: { [key: string]: string; }; /** * 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. */ placementConstraintDetails: outputs.Core.GetInstancesInstancePlacementConstraintDetail[]; /** * The platform configuration for the instance. */ platformConfigs: outputs.Core.GetInstancesInstancePlatformConfig[]; /** * (Optional) Configuration options for preemptible instances. */ preemptibleInstanceConfigs: outputs.Core.GetInstancesInstancePreemptibleInstanceConfig[]; /** * (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. */ preserveBootVolume: boolean; preserveDataVolumesCreatedAtLaunch: boolean; privateIp: string; publicIp: string; /** * The region that contains the availability domain the instance is running in. */ region: string; /** * 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"}` */ securityAttributes: { [key: string]: string; }; /** * The lifecycle state of the `securityAttributes` */ securityAttributesState: string; /** * 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). */ shape: string; /** * The shape configuration for an instance. The shape configuration determines the resources allocated to an instance. */ shapeConfigs: outputs.Core.GetInstancesInstanceShapeConfig[]; sourceDetails: outputs.Core.GetInstancesInstanceSourceDetail[]; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * @deprecated The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead. */ subnetId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ systemTags: { [key: string]: string; }; /** * 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` */ timeCreated: string; /** * 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` */ timeMaintenanceRebootDue: string; updateOperationConstraint: string; } interface GetInstancesInstanceAgentConfig { /** * Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins. */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. */ isManagementDisabled: boolean; /** * Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.Core.GetInstancesInstanceAgentConfigPluginsConfig[]; } interface GetInstancesInstanceAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface GetInstancesInstanceAvailabilityConfig { /** * 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. */ isLiveMigrationPreferred: boolean; /** * The lifecycle state for an instance when it is recovered after infrastructure maintenance. * * `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. * * `STOP_INSTANCE` - The instance is recovered in the stopped state. */ recoveryAction: string; } interface GetInstancesInstanceCreateVnicDetail { assignIpv6ip: boolean; assignPrivateDnsRecord: boolean; assignPublicIp: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; hostnameLabel: string; ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetInstancesInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; nsgIds: string[]; privateIp: string; privateIpId: string; /** * 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"}` */ securityAttributes: { [key: string]: string; }; skipSourceDestCheck: boolean; subnetCidr: string; subnetId: string; vlanId: string; } interface GetInstancesInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { ipv6address: string; ipv6id: string; ipv6subnetCidr: string; } interface GetInstancesInstanceInstanceOption { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface GetInstancesInstanceLaunchOption { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface GetInstancesInstanceLaunchVolumeAttachment { device: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; encryptionInTransitType: string; isAgentAutoIscsiLoginEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; isReadOnly: boolean; isShareable: boolean; launchCreateVolumeDetails: outputs.Core.GetInstancesInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail[]; /** * (Required) The type of action to run when the instance is interrupted for eviction. */ type: string; useChap: boolean; volumeId: string; } interface GetInstancesInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The OCID of the Vault service key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; sizeInGbs: string; volumeCreationType: string; vpusPerGb: string; } interface GetInstancesInstanceLicensingConfig { /** * License Type for the OS license. * * `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour). * * `BRING_YOUR_OWN_LICENSE` - Bring your own license. * * `PARTNER_PROVIDED` - Partner provided license. */ licenseType: string; /** * The Operating System version of the license config. */ osVersion: string; /** * (Required) The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstancesInstancePlacementConstraintDetail { /** * The OCID of the compute bare metal host. */ computeBareMetalHostId: string; /** * The OCID of the compute host group. */ computeHostGroupId: string; /** * (Required) The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstancesInstancePlatformConfig { /** * Whether virtualization instructions are available. */ areVirtualInstructionsEnabled: boolean; /** * Instance Platform Configuration Configuration Map for flexible setting input. */ configMap: { [key: string]: string; }; /** * Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough. */ isAccessControlServiceEnabled: boolean; /** * Whether the input-output memory management unit is enabled. */ isInputOutputMemoryManagementUnitEnabled: boolean; /** * Whether the Measured Boot is to be enabled on the instance. */ isMeasuredBootEnabled: boolean; /** * Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. */ isMemoryEncryptionEnabled: boolean; /** * Whether the Secure Boot is to be enabled on the instance. */ isSecureBootEnabled: boolean; /** * Whether symmetric multi-threading is enabled on the instance. */ isSymmetricMultiThreadingEnabled: boolean; /** * Whether the Trusted Platform Module (TPM) is to be enabled on the instance. */ isTrustedPlatformModuleEnabled: boolean; /** * The number of NUMA nodes per socket (NPS). */ numaNodesPerSocket: string; /** * The percentage of cores enabled. */ percentageOfCoresEnabled: number; /** * (Required) The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstancesInstancePreemptibleInstanceConfig { /** * (Required) The action to run when the preemptible instance is interrupted for eviction. */ preemptionActions: outputs.Core.GetInstancesInstancePreemptibleInstanceConfigPreemptionAction[]; } interface GetInstancesInstancePreemptibleInstanceConfigPreemptionAction { /** * (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. */ preserveBootVolume: boolean; /** * (Required) The type of action to run when the instance is interrupted for eviction. */ type: string; } interface GetInstancesInstanceShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * A short description of the instance's graphics processing unit (GPU). */ gpuDescription: string; /** * The number of GPUs available to the instance. */ gpus: number; /** * A short description of the local disks available to this instance. */ localDiskDescription: string; /** * The number of local disks available to the instance. */ localDisks: number; /** * The aggregate size of all local disks, in gigabytes. */ localDisksTotalSizeInGbs: number; /** * 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. */ localVolumeSizeInGbs: number; /** * The maximum number of VNIC attachments for the instance. */ maxVnicAttachments: number; /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The networking bandwidth available to the instance, in gigabits per second. */ networkingBandwidthInGbps: number; nvmes: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; /** * A short description of the instance's processor (CPU). */ processorDescription: string; /** * This field is reserved for internal use. */ resourceManagement: string; /** * 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. */ vcpus: number; } interface GetInstancesInstanceSourceDetail { /** * The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * These are the criteria for selecting an image. This is required if imageId is not specified. */ instanceSourceImageFilterDetails: outputs.Core.GetInstancesInstanceSourceDetailInstanceSourceImageFilterDetail[]; isPreserveBootVolumeEnabled: boolean; /** * The OCID of the Vault service key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The OCID of an image or a boot volume to use, depending on the value of `sourceType`. */ sourceId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface GetInstancesInstanceSourceDetailInstanceSourceImageFilterDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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). */ definedTagsFilter: { [key: string]: string; }; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; } interface GetInternetGatewaysFilter { name: string; regex?: boolean; values: string[]; } interface GetInternetGatewaysGateway { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * Whether the gateway is enabled. When the gateway is disabled, traffic is not routed to/from the Internet, regardless of route rules. */ enabled: boolean; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The internet gateway's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using. */ routeTableId: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetIpInventorySubnetCidrIpInventoryCidrUtilizationSummary { /** * Address type of the CIDR within a subnet. */ addressType: string; /** * The CIDR range of a subnet. */ cidr: string; /** * The CIDR utilisation of a subnet. */ utilization: number; } interface GetIpInventorySubnetIpInventorySubnetResourceSummary { /** * Address type of the allocated private IP address. */ addressType: string; /** * Name of the created resource. */ assignedResourceName: string; /** * Type of the resource. */ assignedResourceType: string; /** * Assigned time of the private IP address. */ assignedTime: string; /** * Associated public IP address for the private IP address. */ associatedPublicIp: string; /** * Public IP address Pool the IP address is allocated from. */ associatedPublicIpPool: string; /** * DNS hostname of the IP address. */ dnsHostName: string; /** * Lists the allocated private IP address. */ ipAddress: string; /** * Lifetime of the allocated private IP address. */ ipAddressLifetime: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IP address. */ ipId: string; /** * The address range the IP address is assigned from. */ parentCidr: string; /** * Lifetime of the assigned public IP address. */ publicIpLifetime: string; } interface GetIpInventoryVcnOverlapsFilter { name: string; regex?: boolean; values: string[]; } interface GetIpInventoryVcnOverlapsIpInventoryVcnOverlapSummary { /** * CIDR prefix of the VCN. */ cidr: string; /** * The overlapping CIDR prefix. */ overlappingCidr: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN . */ overlappingVcnId: string; /** * Name of the overlapping VCN. */ overlappingVcnName: string; } interface GetIpsecAlgorithmAllowedPhaseOneParameter { /** * Allowed phase two authentication algorithms. */ authenticationAlgorithms: string[]; /** * Allowed phase one Diffie-Hellman groups. */ dhGroups: string[]; /** * Allowed phase two encryption algorithms. */ encryptionAlgorithms: string[]; } interface GetIpsecAlgorithmAllowedPhaseTwoParameter { /** * Allowed phase two authentication algorithms. */ authenticationAlgorithms: string[]; /** * Allowed phase two encryption algorithms. */ encryptionAlgorithms: string[]; /** * Allowed perfect forward secrecy Diffie-Hellman groups. */ pfsDhGroups: string[]; } interface GetIpsecAlgorithmDefaultPhaseOneParameter { /** * Default phase two authentication algorithms. */ defaultAuthenticationAlgorithms: string[]; /** * Default phase one Diffie-Hellman groups. */ defaultDhGroups: string[]; /** * Default phase two encryption algorithms. */ defaultEncryptionAlgorithms: string[]; } interface GetIpsecAlgorithmDefaultPhaseTwoParameter { /** * Default phase two authentication algorithms. */ defaultAuthenticationAlgorithms: string[]; /** * Default phase two encryption algorithms. */ defaultEncryptionAlgorithms: string[]; /** * Default perfect forward secrecy Diffie-Hellman groups. */ defaultPfsDhGroup: string; } interface GetIpsecConfigFilter { name: string; regex?: boolean; values: string[]; } interface GetIpsecConfigTunnel { /** * The IP address of Oracle's VPN headend. Example: ` 203.0.113.50 ` */ ipAddress: string; /** * The shared secret of the IPSec tunnel. */ sharedSecret: string; /** * 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` */ timeCreated: string; } interface GetIpsecConnectionTunnelBgpSessionInfo { /** * The state of the BGP IPv6 session. */ bgpIpv6State: string; /** * @deprecated The 'bgp_session_info.0.bgp_ipv6state' field has been deprecated. Please use 'bgp_session_info.0.bgp_ipv6_state' instead. */ bgpIpv6state: string; /** * the state of the BGP. */ bgpState: string; /** * 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) */ customerBgpAsn: string; /** * This is the IPv4 Address used in the BGP peering session for the non-Oracle router. Example: 10.0.0.2/31 */ customerInterfaceIp: string; /** * The IPv6 address for the CPE end of the inside tunnel interface. */ customerInterfaceIpv6: string; /** * 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) */ oracleBgpAsn: string; /** * This is the IPv4 Address used in the BGP peering session for the Oracle router. Example: 10.0.0.1/31 */ oracleInterfaceIp: string; /** * The IPv6 address for the Oracle end of the inside tunnel interface. */ oracleInterfaceIpv6: string; } interface GetIpsecConnectionTunnelDpdConfig { /** * Dead peer detection (DPD) mode set on the Oracle side of the connection. */ dpdMode: string; /** * DPD timeout in seconds. */ dpdTimeoutInSec: number; } interface GetIpsecConnectionTunnelEncryptionDomainConfig { /** * Lists IPv4 or IPv6-enabled subnets in your on-premises network. */ cpeTrafficSelectors: string[]; /** * Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy. */ oracleTrafficSelectors: string[]; } interface GetIpsecConnectionTunnelPhaseOneDetail { /** * Phase two authentication algorithm proposed during tunnel negotiation. */ customAuthenticationAlgorithm: string; /** * The proposed custom Diffie-Hellman group. */ customDhGroup: string; /** * The proposed custom phase two encryption algorithm. */ customEncryptionAlgorithm: string; /** * Indicates whether custom phase one configuration is enabled. If this option is not enabled, default settings are proposed. */ isCustomPhaseOneConfig: boolean; /** * Indicates whether IKE phase one is established. */ isIkeEstablished: boolean; /** * The total configured lifetime of the IKE security association. */ lifetime: number; /** * The negotiated phase two authentication algorithm. */ negotiatedAuthenticationAlgorithm: string; /** * The negotiated Diffie-Hellman group. */ negotiatedDhGroup: string; /** * The negotiated encryption algorithm. */ negotiatedEncryptionAlgorithm: string; /** * @deprecated The 'phase_one_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_one_details.0.remaining_lifetime_int' instead. */ remainingLifetime: string; /** * The remaining lifetime before the key is refreshed. */ remainingLifetimeInt: number; /** * 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` */ remainingLifetimeLastRetrieved: string; } interface GetIpsecConnectionTunnelPhaseTwoDetail { /** * Phase two authentication algorithm proposed during tunnel negotiation. */ customAuthenticationAlgorithm: string; /** * The proposed custom phase two encryption algorithm. */ customEncryptionAlgorithm: string; /** * The proposed Diffie-Hellman group. */ dhGroup: string; /** * Indicates whether custom phase two configuration is enabled. If this option is not enabled, default settings are proposed. */ isCustomPhaseTwoConfig: boolean; /** * Indicates that ESP phase two is established. */ isEspEstablished: boolean; /** * Indicates that PFS (perfect forward secrecy) is enabled. */ isPfsEnabled: boolean; /** * The total configured lifetime of the IKE security association. */ lifetime: number; /** * The negotiated phase two authentication algorithm. */ negotiatedAuthenticationAlgorithm: string; /** * The negotiated Diffie-Hellman group. */ negotiatedDhGroup: string; /** * The negotiated encryption algorithm. */ negotiatedEncryptionAlgorithm: string; /** * @deprecated The 'phase_two_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_two_details.0.remaining_lifetime_int' instead. */ remainingLifetime: string; /** * The remaining lifetime before the key is refreshed. */ remainingLifetimeInt: number; /** * 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` */ remainingLifetimeLastRetrieved: string; } interface GetIpsecConnectionTunnelRoutesFilter { name: string; regex?: boolean; values: string[]; } interface GetIpsecConnectionTunnelRoutesTunnelRoute { /** * 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. */ advertiser: string; /** * The age of the route. */ age: string; /** * A list of ASNs in AS_Path. */ asPaths: number[]; /** * Indicates this is the best route. */ isBestPath: boolean; /** * The BGP network layer reachability information. */ prefix: string; } interface GetIpsecConnectionTunnelsFilter { name: string; regex?: boolean; values: string[]; } interface GetIpsecConnectionTunnelsIpSecConnectionTunnel { /** * 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. */ associatedVirtualCircuits: string[]; /** * Information for establishing a BGP session for the IPSec tunnel. */ bgpSessionInfos: outputs.Core.GetIpsecConnectionTunnelsIpSecConnectionTunnelBgpSessionInfo[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the tunnel. */ compartmentId: string; /** * The IP address of the CPE device's VPN headend. Example: `203.0.113.22` */ cpeIp: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; dpdConfigs: outputs.Core.GetIpsecConnectionTunnelsIpSecConnectionTunnelDpdConfig[]; /** * 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. */ dpdMode: string; /** * DPD timeout in seconds. */ dpdTimeoutInSec: number; /** * Configuration information used by the encryption domain policy. */ encryptionDomainConfigs: outputs.Core.GetIpsecConnectionTunnelsIpSecConnectionTunnelEncryptionDomainConfig[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tunnel. */ id: string; /** * Internet Key Exchange protocol version. */ ikeVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection. */ ipsecId: string; /** * 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. */ natTranslationEnabled: string; /** * 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. */ oracleCanInitiate: string; /** * IPSec tunnel details specific to ISAKMP phase one. */ phaseOneDetails: outputs.Core.GetIpsecConnectionTunnelsIpSecConnectionTunnelPhaseOneDetail[]; /** * IPsec tunnel detail information specific to phase two. */ phaseTwoDetails: outputs.Core.GetIpsecConnectionTunnelsIpSecConnectionTunnelPhaseTwoDetail[]; /** * The type of routing used for this tunnel (BGP dynamic routing, static routing, or policy-based routing). */ routing: string; sharedSecret: string; /** * The tunnel's lifecycle state. */ state: string; /** * The status of the tunnel based on IPSec protocol characteristics. */ status: string; /** * 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` */ timeCreated: string; /** * 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` */ timeStatusUpdated: string; tunnelId: string; /** * The IP address of the Oracle VPN headend for the connection. Example: `203.0.113.21` */ vpnIp: string; } interface GetIpsecConnectionTunnelsIpSecConnectionTunnelBgpSessionInfo { /** * The state of the BGP IPv6 session. */ bgpIpv6State: string; /** * @deprecated The 'bgp_session_info.0.bgp_ipv6state' field has been deprecated. Please use 'bgp_session_info.0.bgp_ipv6_state' instead. */ bgpIpv6state: string; /** * The state of the BGP session. */ bgpState: string; /** * If the tunnel's `routing` 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. */ customerBgpAsn: string; /** * The IP address for the CPE end of the inside tunnel interface. */ customerInterfaceIp: string; /** * The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional. */ customerInterfaceIpv6: string; /** * The Oracle BGP ASN. */ oracleBgpAsn: string; /** * The IP address for the Oracle end of the inside tunnel interface. */ oracleInterfaceIp: string; /** * The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional. */ oracleInterfaceIpv6: string; } interface GetIpsecConnectionTunnelsIpSecConnectionTunnelDpdConfig { /** * 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. */ dpdMode: string; /** * DPD timeout in seconds. */ dpdTimeoutInSec: number; } interface GetIpsecConnectionTunnelsIpSecConnectionTunnelEncryptionDomainConfig { /** * Lists IPv4 or IPv6-enabled subnets in your on-premises network. */ cpeTrafficSelectors: string[]; /** * Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy. */ oracleTrafficSelectors: string[]; } interface GetIpsecConnectionTunnelsIpSecConnectionTunnelPhaseOneDetail { /** * Phase two authentication algorithm proposed during tunnel negotiation. */ customAuthenticationAlgorithm: string; /** * The proposed custom Diffie-Hellman group. */ customDhGroup: string; /** * The proposed custom phase two encryption algorithm. */ customEncryptionAlgorithm: string; /** * Indicates whether custom phase one configuration is enabled. If this option is not enabled, default settings are proposed. */ isCustomPhaseOneConfig: boolean; /** * Indicates whether IKE phase one is established. */ isIkeEstablished: boolean; /** * The total configured lifetime of the IKE security association. */ lifetime: number; /** * The negotiated phase two authentication algorithm. */ negotiatedAuthenticationAlgorithm: string; /** * The negotiated Diffie-Hellman group. */ negotiatedDhGroup: string; /** * The negotiated encryption algorithm. */ negotiatedEncryptionAlgorithm: string; /** * @deprecated The 'phase_one_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_one_details.0.remaining_lifetime_int' instead. */ remainingLifetime: string; /** * The remaining lifetime before the key is refreshed. */ remainingLifetimeInt: number; /** * 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` */ remainingLifetimeLastRetrieved: string; } interface GetIpsecConnectionTunnelsIpSecConnectionTunnelPhaseTwoDetail { /** * Phase two authentication algorithm proposed during tunnel negotiation. */ customAuthenticationAlgorithm: string; /** * The proposed custom phase two encryption algorithm. */ customEncryptionAlgorithm: string; /** * The proposed Diffie-Hellman group. */ dhGroup: string; /** * Indicates whether custom phase two configuration is enabled. If this option is not enabled, default settings are proposed. */ isCustomPhaseTwoConfig: boolean; /** * Indicates that ESP phase two is established. */ isEspEstablished: boolean; /** * Indicates that PFS (perfect forward secrecy) is enabled. */ isPfsEnabled: boolean; /** * The total configured lifetime of the IKE security association. */ lifetime: number; /** * The negotiated phase two authentication algorithm. */ negotiatedAuthenticationAlgorithm: string; /** * The negotiated Diffie-Hellman group. */ negotiatedDhGroup: string; /** * The negotiated encryption algorithm. */ negotiatedEncryptionAlgorithm: string; /** * @deprecated The 'phase_two_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_two_details.0.remaining_lifetime_int' instead. */ remainingLifetime: string; /** * The remaining lifetime before the key is refreshed. */ remainingLifetimeInt: number; /** * 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` */ remainingLifetimeLastRetrieved: string; } interface GetIpsecConnectionsConnection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE. */ cpeId: string; /** * 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`. */ cpeLocalIdentifier: string; /** * The type of identifier for your CPE device. The value here must correspond to the value for `cpeLocalIdentifier`. */ cpeLocalIdentifierType: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG. */ drgId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The IPSec connection's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * The IPSec connection's current state. */ state: string; /** * Static routes to the CPE. The CIDR must not be a multicast address or class E address. */ staticRoutes: string[]; /** * 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` */ timeCreated: string; /** * The transport type used for the IPSec connection. */ transportType: string; tunnelConfigurations: outputs.Core.GetIpsecConnectionsConnectionTunnelConfiguration[]; } interface GetIpsecConnectionsConnectionTunnelConfiguration { associatedVirtualCircuits: string[]; drgRouteTableId: string; oracleTunnelIp: string; } interface GetIpsecConnectionsFilter { name: string; regex?: boolean; values: string[]; } interface GetIpsecStatusFilter { name: string; regex?: boolean; values: string[]; } interface GetIpsecStatusTunnel { /** * The IP address of Oracle's VPN headend. Example: `203.0.113.50` */ ipAddress: string; /** * The tunnel's current state. */ state: string; /** * 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` */ timeCreated: string; /** * 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` */ timeStateModified: string; } interface GetIpv6sFilter { name: string; regex?: boolean; values: string[]; } interface GetIpv6sIpv6 { cidrPrefixLength: number; /** * 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. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; hostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IPv6. */ id: string; /** * An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: `10.0.3.3` */ ipAddress: string; ipState: string; ipv6subnetCidr: string; lifetime: string; routeTableId: string; /** * The IPv6's current state. */ state: string; /** * The OCID of the subnet. */ subnetId: string; /** * 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` */ timeCreated: string; /** * The OCID of the VNIC. */ vnicId: string; } interface GetLetterOfAuthorityExtensionDetail { /** * Chronologically sorted list of date and time when the Letter of Authority's expiration was last updated, most recent first, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). List is empty if the LOA's expiration date has never been extended. */ histories: string[]; /** * The number of self-service LOA expiry extensions still available. */ remainingExtensions: string; } interface GetListingResourceVersionsAppCatalogListingResourceVersion { accessiblePorts: number[]; allowedActions: string[]; availableRegions: string[]; compatibleShapes: string[]; listingId: string; listingResourceId: string; listingResourceVersion: string; timePublished: string; } interface GetListingResourceVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetLocalPeeringGatewaysFilter { name: string; regex?: boolean; values: string[]; } interface GetLocalPeeringGatewaysLocalPeeringGateway { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The LPG's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * Whether the VCN at the other end of the peering is in a different tenancy. Example: `false` */ isCrossTenancyPeering: boolean; /** * 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 `null` 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` */ peerAdvertisedCidr: string; /** * 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 `null` 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`] */ peerAdvertisedCidrDetails: string[]; /** * The OCID of the peered LPG */ peerId: string; /** * 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. */ peeringStatus: string; /** * Additional information regarding the peering status, if applicable. */ peeringStatusDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG is using. */ routeTableId: string; /** * The LPG's current lifecycle state. */ state: string; /** * 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` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetNatGatewaysFilter { name: string; regex?: boolean; values: string[]; } interface GetNatGatewaysNatGateway { /** * Whether the NAT gateway blocks traffic through it. The default is `false`. Example: `true` */ blockTraffic: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the NAT gateway. */ id: string; /** * The IP address associated with the NAT gateway. */ natIp: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway. */ publicIpId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. */ routeTableId: string; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * 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` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetNetworkSecurityGroupSecurityRulesFilter { name: string; regex?: boolean; values: string[]; } interface GetNetworkSecurityGroupSecurityRulesSecurityRule { /** * An optional description of your choice for the rule. */ description: string; /** * Conceptually, this is the range of IP addresses that a packet originating from the instance can go to. */ destination: string; /** * Type of destination for the rule. Required if `direction` = `EGRESS`. */ destinationType: string; /** * Direction of the security rule. Set to `EGRESS` for rules that allow outbound IP packets, or `INGRESS` for rules that allow inbound IP packets. */ direction: string; /** * Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) */ icmpOptions: outputs.Core.GetNetworkSecurityGroupSecurityRulesSecurityRuleIcmpOption[]; /** * An Oracle-assigned identifier for the security rule. You specify this ID when you want to update or delete the rule. Example: `04ABEC` */ id: string; /** * Whether the rule is valid. The value is `True` when the rule is first created. If the rule's `source` or `destination` is a network security group, the value changes to `False` if that network security group is deleted. */ isValid: boolean; /** * The transport protocol. Specify either `all` 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"). */ protocol: string; /** * Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. */ source: string; /** * Type of source for the rule. Required if `direction` = `INGRESS`. * * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation. * * `SERVICE_CIDR_BLOCK`: If the rule's `source` 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). * * `NETWORK_SECURITY_GROUP`: If the rule's `source` 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/). */ sourceType: string; /** * 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. */ stateless: boolean; /** * 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. */ tcpOptions: outputs.Core.GetNetworkSecurityGroupSecurityRulesSecurityRuleTcpOption[]; /** * The date and time the security rule was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * 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. */ udpOptions: outputs.Core.GetNetworkSecurityGroupSecurityRulesSecurityRuleUdpOption[]; } interface GetNetworkSecurityGroupSecurityRulesSecurityRuleIcmpOption { /** * The ICMP code (optional). */ code: number; /** * The ICMP type. */ type: number; } interface GetNetworkSecurityGroupSecurityRulesSecurityRuleTcpOption { destinationPortRanges: outputs.Core.GetNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionDestinationPortRange[]; sourcePortRanges: outputs.Core.GetNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionSourcePortRange[]; } interface GetNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface GetNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface GetNetworkSecurityGroupSecurityRulesSecurityRuleUdpOption { destinationPortRanges: outputs.Core.GetNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionDestinationPortRange[]; sourcePortRanges: outputs.Core.GetNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionSourcePortRange[]; } interface GetNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface GetNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface GetNetworkSecurityGroupVnicsFilter { name: string; regex?: boolean; values: string[]; } interface GetNetworkSecurityGroupVnicsNetworkSecurityGroupVnic { /** * 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). */ resourceId: string; /** * 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` */ timeAssociated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. */ vnicId: string; } interface GetNetworkSecurityGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetNetworkSecurityGroupsNetworkSecurityGroup { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security group. */ id: string; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * 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` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetPeerRegionForRemotePeeringsFilter { /** * The region's name. Example: `us-phoenix-1` */ name: string; regex?: boolean; values: string[]; } interface GetPeerRegionForRemotePeeringsPeerRegionForRemotePeering { /** * The region's name. Example: `us-phoenix-1` */ name: string; } interface GetPrivateIpsFilter { name: string; regex?: boolean; values: string[]; } interface GetPrivateIpsPrivateIp { /** * 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` */ availabilityDomain: string; /** * The secondary IPv4 CIDR prefix length. */ cidrPrefixLength: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the private IP. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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, `bminstance1` 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). */ hostnameLabel: string; /** * The private IP's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: `10.0.3.3` */ ipAddress: string; /** * State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE */ ipState: string; /** * Ipv4 Subnet CIDR specified whn creating the PrivateIP. */ ipv4subnetCidrAtCreation: string; /** * 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: `true` */ isPrimary: boolean; isReserved: boolean; /** * Lifetime of the IP address. There are two types of IPs: * * Ephemeral * * Reserved */ lifetime: string; /** * 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). */ routeTableId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet. */ subnetId: string; /** * 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` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. */ vlanId: string; /** * The OCID of the VNIC. */ vnicId: string; } interface GetPublicIpPoolsFilter { name: string; regex?: boolean; values: string[]; } interface GetPublicIpPoolsPublicIpPoolCollection { items: outputs.Core.GetPublicIpPoolsPublicIpPoolCollectionItem[]; } interface GetPublicIpPoolsPublicIpPoolCollectionItem { /** * The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block. */ cidrBlocks: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool. */ id: string; /** * The public IP pool's current state. */ state: string; /** * 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` */ timeCreated: string; } interface GetPublicIpsFilter { name: string; regex?: boolean; values: string[]; } interface GetPublicIpsPublicIp { /** * 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. */ assignedEntityId: string; /** * The type of entity the public IP is assigned to, or in the process of being assigned to. */ assignedEntityType: string; /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The public IP's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * The public IP address of the `publicIp` object. Example: `203.0.113.2` */ ipAddress: string; /** * A filter to return only public IPs that match given lifetime. */ lifetime: string; /** * Deprecated. Use `assignedEntityId` instead. */ privateIpId: string; /** * A filter to return only resources that belong to the given public IP pool. */ publicIpPoolId: string; /** * Whether the public IP is regional or specific to a particular availability domain. * * `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 `scope` = `REGION`, as do ephemeral public IPs assigned to a regional entity. * * `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 `scope` = `AVAILABILITY_DOMAIN`. */ scope: string; /** * The public IP's current state. */ state: string; /** * 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` */ timeCreated: string; } interface GetRemotePeeringConnectionsFilter { name: string; regex?: boolean; values: string[]; } interface GetRemotePeeringConnectionsRemotePeeringConnection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG. */ drgId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the RPC. */ id: string; /** * Whether the VCN at the other end of the peering is in a different tenancy. Example: `false` */ isCrossTenancyPeering: boolean; /** * If this RPC is peered, this value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the other RPC. */ peerId: string; /** * If this RPC is peered, this value is the region that contains the other RPC. Example: `us-ashburn-1` */ peerRegionName: string; /** * If this RPC is peered, this value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the other RPC's tenancy. */ peerTenancyId: string; /** * Whether the RPC is peered with another RPC. `NEW` means the RPC has not yet been peered. `PENDING` means the peering is being established. `REVOKED` means the RPC at the other end of the peering has been deleted. */ peeringStatus: string; /** * The RPC's current lifecycle state. */ state: string; /** * The date and time the RPC was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetRouteTablesFilter { name: string; regex?: boolean; values: string[]; } interface GetRouteTablesRouteTable { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The route table's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * The collection of rules for routing destination IPs to network devices. */ routeRules: outputs.Core.GetRouteTablesRouteTableRouteRule[]; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the route table was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetRouteTablesRouteTableRouteRule { /** * Deprecated. Instead use `destination` and `destinationType`. Requests that include both `cidrBlock` and `destination` will be rejected. * * @deprecated The 'cidr_block' field has been deprecated. Please use 'destination' instead. */ cidrBlock: string; /** * An optional description of your choice for the rule. */ description: string; /** * Conceptually, this is the range of IP addresses used for matching when routing traffic. Required if you provide a `destinationType`. */ destination: string; /** * Type of destination for the rule. Required if you provide a `destination`. * * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. * * `SERVICE_CIDR_BLOCK`: If the rule's `destination` 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). */ destinationType: string; /** * 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). */ networkEntityId: string; /** * A route rule can be STATIC if manually added to the route table, LOCAL if added by Oracle Cloud Infrastructure to the route table. */ routeType: string; } interface GetSecurityListsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityListsSecurityList { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * Rules for allowing egress IP packets. */ egressSecurityRules: outputs.Core.GetSecurityListsSecurityListEgressSecurityRule[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The security list's Oracle Cloud ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * Rules for allowing ingress IP packets. */ ingressSecurityRules: outputs.Core.GetSecurityListsSecurityListIngressSecurityRule[]; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the security list was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetSecurityListsSecurityListEgressSecurityRule { /** * An optional description of your choice for the rule. */ description: string; /** * Conceptually, this is the range of IP addresses that a packet originating from the instance can go to. */ destination: string; /** * Type of destination for the rule. The default is `CIDR_BLOCK`. */ destinationType: string; /** * Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) */ icmpOptions: outputs.Core.GetSecurityListsSecurityListEgressSecurityRuleIcmpOption[]; /** * The transport protocol. Specify either `all` 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"). */ protocol: string; /** * 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. */ stateless: boolean; /** * 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. * * The following 2 attributes specify an inclusive range of allowed destination ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified. */ tcpOptions: outputs.Core.GetSecurityListsSecurityListEgressSecurityRuleTcpOption[]; /** * 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. * * The following 2 attributes specify an inclusive range of allowed destination ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified. */ udpOptions: outputs.Core.GetSecurityListsSecurityListEgressSecurityRuleUdpOption[]; } interface GetSecurityListsSecurityListEgressSecurityRuleIcmpOption { /** * The ICMP code (optional). */ code: number; /** * The ICMP type. */ type: number; } interface GetSecurityListsSecurityListEgressSecurityRuleTcpOption { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; sourcePortRanges: outputs.Core.GetSecurityListsSecurityListEgressSecurityRuleTcpOptionSourcePortRange[]; } interface GetSecurityListsSecurityListEgressSecurityRuleTcpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface GetSecurityListsSecurityListEgressSecurityRuleUdpOption { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; sourcePortRanges: outputs.Core.GetSecurityListsSecurityListEgressSecurityRuleUdpOptionSourcePortRange[]; } interface GetSecurityListsSecurityListEgressSecurityRuleUdpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface GetSecurityListsSecurityListIngressSecurityRule { /** * An optional description of your choice for the rule. */ description: string; /** * Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) */ icmpOptions: outputs.Core.GetSecurityListsSecurityListIngressSecurityRuleIcmpOption[]; /** * The transport protocol. Specify either `all` 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"). */ protocol: string; /** * Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. */ source: string; /** * Type of source for the rule. The default is `CIDR_BLOCK`. * * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation. * * `SERVICE_CIDR_BLOCK`: If the rule's `source` 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). */ sourceType: string; /** * 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. */ stateless: boolean; /** * 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. * * The following 2 attributes specify an inclusive range of allowed destination ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified. */ tcpOptions: outputs.Core.GetSecurityListsSecurityListIngressSecurityRuleTcpOption[]; /** * 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. * * The following 2 attributes specify an inclusive range of allowed destination ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified. */ udpOptions: outputs.Core.GetSecurityListsSecurityListIngressSecurityRuleUdpOption[]; } interface GetSecurityListsSecurityListIngressSecurityRuleIcmpOption { /** * The ICMP code (optional). */ code: number; /** * The ICMP type. */ type: number; } interface GetSecurityListsSecurityListIngressSecurityRuleTcpOption { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; sourcePortRanges: outputs.Core.GetSecurityListsSecurityListIngressSecurityRuleTcpOptionSourcePortRange[]; } interface GetSecurityListsSecurityListIngressSecurityRuleTcpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface GetSecurityListsSecurityListIngressSecurityRuleUdpOption { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; sourcePortRanges: outputs.Core.GetSecurityListsSecurityListIngressSecurityRuleUdpOptionSourcePortRange[]; } interface GetSecurityListsSecurityListIngressSecurityRuleUdpOptionSourcePortRange { /** * 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. */ max: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface GetServiceGatewaysFilter { name: string; regex?: boolean; values: string[]; } interface GetServiceGatewaysServiceGateway { /** * Whether the service gateway blocks all traffic through it. The default is `false`. When this is `true`, traffic is not routed to any services, regardless of route rules. Example: `true` */ blockTraffic: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service gateway. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the service gateway is using. For information about why you would associate a route table with a service gateway, see [Transit Routing: Private Access to Oracle Services](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm). */ routeTableId: string; /** * List of the [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Service/) objects enabled for this service gateway. The list can be empty. You can enable a particular `Service` by using [AttachServiceId](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/ServiceGateway/AttachServiceId) or [UpdateServiceGateway](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/ServiceGateway/UpdateServiceGateway). */ services: outputs.Core.GetServiceGatewaysServiceGatewayService[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the service gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetServiceGatewaysServiceGatewayService { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service. */ serviceId: string; /** * The name of the service. */ serviceName: string; } interface GetServicesFilter { /** * Name of the `Service` object. This name can change and is not guaranteed to be unique. Example: `OCI PHX Object Storage` */ name: string; regex?: boolean; values: string[]; } interface GetServicesService { /** * A string that represents the regional public IP address ranges for the Oracle service or services covered by this `Service` object. Also known as the `Service` object's *service CIDR label*. */ cidrBlock: string; /** * Description of the Oracle service or services covered by this `Service` object. Example: `OCI PHX Object Storage` */ description: string; /** * The `Service` object's [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * Name of the `Service` object. This name can change and is not guaranteed to be unique. Example: `OCI PHX Object Storage` */ name: string; } interface GetShapeFilter { name: string; regex?: boolean; values: string[]; } interface GetShapeShape { baselineOcpuUtilizations: string[]; billingType: string; gpuDescription: string; gpus: number; isBilledForStoppedInstance: boolean; isCnic: boolean; isFlexible: boolean; isLiveMigrationSupported: boolean; isSubcore: boolean; localDiskDescription: string; localDisks: number; localDisksTotalSizeInGbs: number; maxVnicAttachmentOptions: outputs.Core.GetShapeShapeMaxVnicAttachmentOption[]; maxVnicAttachments: number; memoryInGbs: number; memoryOptions: outputs.Core.GetShapeShapeMemoryOption[]; minTotalBaselineOcpusRequired: number; name: string; networkPorts: number; networkingBandwidthInGbps: number; networkingBandwidthOptions: outputs.Core.GetShapeShapeNetworkingBandwidthOption[]; ocpuOptions: outputs.Core.GetShapeShapeOcpuOption[]; ocpus: number; platformConfigOptions: outputs.Core.GetShapeShapePlatformConfigOption[]; platformNames: string[]; processorDescription: string; quotaNames: string[]; rdmaBandwidthInGbps: number; rdmaPorts: number; recommendedAlternatives: outputs.Core.GetShapeShapeRecommendedAlternative[]; resizeCompatibleShapes: string[]; } interface GetShapeShapeMaxVnicAttachmentOption { defaultPerOcpu: number; max: number; min: number; } interface GetShapeShapeMemoryOption { defaultPerOcpuInGbs: number; maxInGbs: number; maxPerNumaNodeInGbs: number; maxPerOcpuInGbs: number; minInGbs: number; minPerOcpuInGbs: number; } interface GetShapeShapeNetworkingBandwidthOption { defaultPerOcpuInGbps: number; maxInGbps: number; minInGbps: number; } interface GetShapeShapeOcpuOption { max: number; maxPerNumaNode: number; min: number; } interface GetShapeShapePlatformConfigOption { accessControlServiceOptions: outputs.Core.GetShapeShapePlatformConfigOptionAccessControlServiceOption[]; inputOutputMemoryManagementUnitOptions: outputs.Core.GetShapeShapePlatformConfigOptionInputOutputMemoryManagementUnitOption[]; measuredBootOptions: outputs.Core.GetShapeShapePlatformConfigOptionMeasuredBootOption[]; memoryEncryptionOptions: outputs.Core.GetShapeShapePlatformConfigOptionMemoryEncryptionOption[]; numaNodesPerSocketPlatformOptions: outputs.Core.GetShapeShapePlatformConfigOptionNumaNodesPerSocketPlatformOption[]; percentageOfCoresEnabledOptions: outputs.Core.GetShapeShapePlatformConfigOptionPercentageOfCoresEnabledOption[]; secureBootOptions: outputs.Core.GetShapeShapePlatformConfigOptionSecureBootOption[]; symmetricMultiThreadingOptions: outputs.Core.GetShapeShapePlatformConfigOptionSymmetricMultiThreadingOption[]; trustedPlatformModuleOptions: outputs.Core.GetShapeShapePlatformConfigOptionTrustedPlatformModuleOption[]; type: string; virtualInstructionsOptions: outputs.Core.GetShapeShapePlatformConfigOptionVirtualInstructionsOption[]; } interface GetShapeShapePlatformConfigOptionAccessControlServiceOption { allowedValues: boolean[]; isDefaultEnabled: boolean; } interface GetShapeShapePlatformConfigOptionInputOutputMemoryManagementUnitOption { allowedValues: boolean[]; isDefaultEnabled: boolean; } interface GetShapeShapePlatformConfigOptionMeasuredBootOption { allowedValues: boolean[]; isDefaultEnabled: boolean; } interface GetShapeShapePlatformConfigOptionMemoryEncryptionOption { allowedValues: boolean[]; isDefaultEnabled: boolean; } interface GetShapeShapePlatformConfigOptionNumaNodesPerSocketPlatformOption { allowedValues: string[]; defaultValue: string; } interface GetShapeShapePlatformConfigOptionPercentageOfCoresEnabledOption { defaultValue: number; max: number; min: number; } interface GetShapeShapePlatformConfigOptionSecureBootOption { allowedValues: boolean[]; isDefaultEnabled: boolean; } interface GetShapeShapePlatformConfigOptionSymmetricMultiThreadingOption { allowedValues: boolean[]; isDefaultEnabled: boolean; } interface GetShapeShapePlatformConfigOptionTrustedPlatformModuleOption { allowedValues: boolean[]; isDefaultEnabled: boolean; } interface GetShapeShapePlatformConfigOptionVirtualInstructionsOption { allowedValues: boolean[]; isDefaultEnabled: boolean; } interface GetShapeShapeRecommendedAlternative { shapeName: string; } interface GetShapesFilter { /** * The name of the shape. You can enumerate all available shapes by calling [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Shape/ListShapes). */ name: string; regex?: boolean; values: string[]; } interface GetShapesShape { /** * For a subcore burstable VM, the supported baseline OCPU utilization for instances that use this shape. */ baselineOcpuUtilizations: string[]; /** * How instances that use this shape are charged. */ billingType: string; /** * A short description of the graphics processing unit (GPU) available for this shape. */ gpuDescription: string; /** * The number of GPUs available for this shape. */ gpus: number; /** * Whether billing continues when the instances that use this shape are in the stopped state. */ isBilledForStoppedInstance: boolean; /** * Whether the shape supports CNIC networking. */ isCnic: boolean; /** * Whether the shape supports creating flexible instances. A [flexible shape](https://docs.cloud.oracle.com/iaas/Content/Compute/References/computeshapes.htm#flexible) is a shape that lets you customize the number of OCPUs and the amount of memory when launching or resizing your instance. */ isFlexible: boolean; /** * Whether live migration is supported for this shape. */ isLiveMigrationSupported: boolean; /** * Whether the shape supports creating subcore or burstable instances. A [burstable instance](https://docs.cloud.oracle.com/iaas/Content/Compute/References/burstable-instances.htm) is a virtual machine (VM) instance that provides a baseline level of CPU performance with the ability to burst to a higher level to support occasional spikes in usage. */ isSubcore: boolean; /** * A short description of the local disks available for this shape. */ localDiskDescription: string; /** * The number of local disks available for this shape. */ localDisks: number; /** * The aggregate size of the local disks available for this shape, in gigabytes. */ localDisksTotalSizeInGbs: number; /** * For a flexible shape, the number of VNIC attachments that are available for instances that use this shape. */ maxVnicAttachmentOptions: outputs.Core.GetShapesShapeMaxVnicAttachmentOption[]; /** * The maximum number of VNIC attachments available for this shape. */ maxVnicAttachments: number; /** * The default amount of memory available for this shape, in gigabytes. */ memoryInGbs: number; /** * For a flexible shape, the amount of memory available for instances that use this shape. */ memoryOptions: outputs.Core.GetShapesShapeMemoryOption[]; /** * For a subcore burstable VM, the minimum total baseline OCPUs required. The total baseline OCPUs is equal to baselineOcpuUtilization chosen multiplied by the number of OCPUs chosen. */ minTotalBaselineOcpusRequired: number; /** * The name of the shape. You can enumerate all available shapes by calling [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Shape/ListShapes). */ name: string; /** * The number of physical network interface card (NIC) ports available for this shape. */ networkPorts: number; /** * The networking bandwidth available for this shape, in gigabits per second. */ networkingBandwidthInGbps: number; /** * For a flexible shape, the amount of networking bandwidth available for instances that use this shape. */ networkingBandwidthOptions: outputs.Core.GetShapesShapeNetworkingBandwidthOption[]; /** * For a flexible shape, the number of OCPUs available for instances that use this shape. */ ocpuOptions: outputs.Core.GetShapesShapeOcpuOption[]; /** * The default number of OCPUs available for this shape. */ ocpus: number; /** * The list of supported platform configuration options for this shape. */ platformConfigOptions: outputs.Core.GetShapesShapePlatformConfigOption[]; /** * The list of platform names that can be used for this shape */ platformNames: string[]; /** * A short description of the shape's processor (CPU). */ processorDescription: string; /** * The list of compartment quotas for the shape. */ quotaNames: string[]; /** * The networking bandwidth available for the remote direct memory access (RDMA) network for this shape, in gigabits per second. */ rdmaBandwidthInGbps: number; /** * The number of networking ports available for the remote direct memory access (RDMA) network between nodes in a high performance computing (HPC) cluster network. If the shape does not support cluster networks, this value is `0`. */ rdmaPorts: number; /** * The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape. */ recommendedAlternatives: outputs.Core.GetShapesShapeRecommendedAlternative[]; /** * The list of compatible shapes that this shape can be changed to. For more information, see [Changing the Shape of an Instance](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/resizinginstances.htm). */ resizeCompatibleShapes: string[]; } interface GetShapesShapeMaxVnicAttachmentOption { /** * The default number of VNIC attachments allowed per OCPU. */ defaultPerOcpu: number; /** * The maximum allowed percentage of cores enabled. */ max: number; /** * The minimum allowed percentage of cores enabled. */ min: number; } interface GetShapesShapeMemoryOption { /** * The default amount of memory per OCPU available for this shape, in gigabytes. */ defaultPerOcpuInGbs: number; /** * The maximum amount of memory, in gigabytes. */ maxInGbs: number; /** * The maximum amount of memory per NUMA node, in gigabytes. */ maxPerNumaNodeInGbs: number; /** * The maximum amount of memory per OCPU available for this shape, in gigabytes. */ maxPerOcpuInGbs: number; /** * The minimum amount of memory, in gigabytes. */ minInGbs: number; /** * The minimum amount of memory per OCPU available for this shape, in gigabytes. */ minPerOcpuInGbs: number; } interface GetShapesShapeNetworkingBandwidthOption { /** * The default amount of networking bandwidth per OCPU, in gigabits per second. */ defaultPerOcpuInGbps: number; /** * The maximum amount of networking bandwidth, in gigabits per second. */ maxInGbps: number; /** * The minimum amount of networking bandwidth, in gigabits per second. */ minInGbps: number; } interface GetShapesShapeOcpuOption { /** * The maximum allowed percentage of cores enabled. */ max: number; /** * The maximum number of cores available per NUMA node. */ maxPerNumaNode: number; /** * The minimum allowed percentage of cores enabled. */ min: number; } interface GetShapesShapePlatformConfigOption { /** * Configuration options for the Access Control Service. */ accessControlServiceOptions: outputs.Core.GetShapesShapePlatformConfigOptionAccessControlServiceOption[]; /** * Configuration options for the input-output memory management unit. */ inputOutputMemoryManagementUnitOptions: outputs.Core.GetShapesShapePlatformConfigOptionInputOutputMemoryManagementUnitOption[]; /** * Configuration options for the Measured Boot feature. */ measuredBootOptions: outputs.Core.GetShapesShapePlatformConfigOptionMeasuredBootOption[]; /** * Configuration options for memory encryption. */ memoryEncryptionOptions: outputs.Core.GetShapesShapePlatformConfigOptionMemoryEncryptionOption[]; /** * Configuration options for NUMA nodes per socket. */ numaNodesPerSocketPlatformOptions: outputs.Core.GetShapesShapePlatformConfigOptionNumaNodesPerSocketPlatformOption[]; /** * Configuration options for the percentage of cores enabled. */ percentageOfCoresEnabledOptions: outputs.Core.GetShapesShapePlatformConfigOptionPercentageOfCoresEnabledOption[]; /** * Configuration options for Secure Boot. */ secureBootOptions: outputs.Core.GetShapesShapePlatformConfigOptionSecureBootOption[]; /** * Configuration options for symmetric multi-threading. */ symmetricMultiThreadingOptions: outputs.Core.GetShapesShapePlatformConfigOptionSymmetricMultiThreadingOption[]; /** * Configuration options for the Trusted Platform Module (TPM). */ trustedPlatformModuleOptions: outputs.Core.GetShapesShapePlatformConfigOptionTrustedPlatformModuleOption[]; /** * The type of platform being configured. (Supported types=[INTEL_VM, AMD_MILAN_BM, AMD_ROME_BM, AMD_ROME_BM_GPU, INTEL_ICELAKE_BM, INTEL_SKYLAKE_BM]) */ type: string; /** * Configuration options for the virtualization instructions. */ virtualInstructionsOptions: outputs.Core.GetShapesShapePlatformConfigOptionVirtualInstructionsOption[]; } interface GetShapesShapePlatformConfigOptionAccessControlServiceOption { /** * Whether virtualization instructions can be enabled. */ allowedValues: boolean[]; /** * Whether virtualization instructions are enabled by default. */ isDefaultEnabled: boolean; } interface GetShapesShapePlatformConfigOptionInputOutputMemoryManagementUnitOption { /** * Whether virtualization instructions can be enabled. */ allowedValues: boolean[]; /** * Whether virtualization instructions are enabled by default. */ isDefaultEnabled: boolean; } interface GetShapesShapePlatformConfigOptionMeasuredBootOption { /** * Whether virtualization instructions can be enabled. */ allowedValues: boolean[]; /** * Whether virtualization instructions are enabled by default. */ isDefaultEnabled: boolean; } interface GetShapesShapePlatformConfigOptionMemoryEncryptionOption { /** * Whether virtualization instructions can be enabled. */ allowedValues: boolean[]; /** * Whether virtualization instructions are enabled by default. */ isDefaultEnabled: boolean; } interface GetShapesShapePlatformConfigOptionNumaNodesPerSocketPlatformOption { /** * Whether virtualization instructions can be enabled. */ allowedValues: string[]; /** * The default percentage of cores enabled. */ defaultValue: string; } interface GetShapesShapePlatformConfigOptionPercentageOfCoresEnabledOption { /** * The default percentage of cores enabled. */ defaultValue: number; /** * The maximum allowed percentage of cores enabled. */ max: number; /** * The minimum allowed percentage of cores enabled. */ min: number; } interface GetShapesShapePlatformConfigOptionSecureBootOption { /** * Whether virtualization instructions can be enabled. */ allowedValues: boolean[]; /** * Whether virtualization instructions are enabled by default. */ isDefaultEnabled: boolean; } interface GetShapesShapePlatformConfigOptionSymmetricMultiThreadingOption { /** * Whether virtualization instructions can be enabled. */ allowedValues: boolean[]; /** * Whether virtualization instructions are enabled by default. */ isDefaultEnabled: boolean; } interface GetShapesShapePlatformConfigOptionTrustedPlatformModuleOption { /** * Whether virtualization instructions can be enabled. */ allowedValues: boolean[]; /** * Whether virtualization instructions are enabled by default. */ isDefaultEnabled: boolean; } interface GetShapesShapePlatformConfigOptionVirtualInstructionsOption { /** * Whether virtualization instructions can be enabled. */ allowedValues: boolean[]; /** * Whether virtualization instructions are enabled by default. */ isDefaultEnabled: boolean; } interface GetShapesShapeRecommendedAlternative { /** * The name of the shape. */ shapeName: string; } interface GetSubnetsFilter { name: string; regex?: boolean; values: string[]; } interface GetSubnetsSubnet { /** * The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The subnet's CIDR block. Example: `10.0.1.0/24` */ cidrBlock: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the set of DHCP options that the subnet uses. */ dhcpOptionsId: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed. */ dnsLabel: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The subnet's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * The list of all IPv4 CIDR blocks for the subnet that meets the following criteria: * * Ipv4 CIDR blocks must be valid. * * Multiple Ipv4 CIDR blocks must not overlap each other or the on-premises network CIDR block. * * The number of prefixes must not exceed the limit of IPv4 prefixes allowed to a subnet. */ ipv4cidrBlocks: string[]; /** * For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:0db8:0123:1111::/64` */ ipv6cidrBlock: string; /** * The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet. */ ipv6cidrBlocks: string[]; /** * For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: `2001:0db8:0123:1111:89ab:cdef:1234:5678` */ ipv6virtualRouterIp: string; /** * Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false. */ prohibitInternetIngress: boolean; /** * Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the `assignPublicIp` flag in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/)). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet). Example: `true` */ prohibitPublicIpOnVnic: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table that the subnet uses. */ routeTableId: string; /** * The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated *with the subnet*, but the rules are applied to the individual VNICs in the subnet. */ securityListIds: string[]; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the `oraclevcn.com` domain. */ subnetDomainName: string; /** * The date and time the subnet was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; /** * The IP address of the virtual router. Example: `10.0.14.1` */ virtualRouterIp: string; /** * The MAC address of the virtual router. Example: `00:00:00:00:00:01` */ virtualRouterMac: string; } interface GetTunnelSecurityAssociationsFilter { name: string; regex?: boolean; values: string[]; } interface GetTunnelSecurityAssociationsTunnelSecurityAssociation { /** * The IP address and mask of the partner subnet used in policy based VPNs or static routes. */ cpeSubnet: string; /** * The IP address and mask of the local subnet used in policy based VPNs or static routes. */ oracleSubnet: string; /** * Time in the current state, in seconds. */ time: string; /** * Current state if the IPSec tunnel status is not `UP`, including phase one and phase two details and a possible reason the tunnel is not `UP`. */ tunnelSaErrorInfo: string; /** * The IPSec tunnel's phase one status. */ tunnelSaStatus: string; } interface GetVcnByoipv6cidrDetail { byoipv6rangeId: string; ipv6cidrBlock: string; } interface GetVcnsFilter { name: string; regex?: boolean; values: string[]; } interface GetVcnsVirtualNetwork { /** * The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges. */ byoipv6cidrBlocks: string[]; byoipv6cidrDetails: outputs.Core.GetVcnsVirtualNetworkByoipv6cidrDetail[]; /** * Deprecated. The first CIDR IP address from cidr_blocks. Example: `172.16.0.0/16` */ cidrBlock: string; /** * The list of IPv4 CIDR blocks the VCN will use. */ cidrBlocks: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default set of DHCP options. */ defaultDhcpOptionsId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default route table. */ defaultRouteTableId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default security list. */ defaultSecurityListId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter. The value cannot be changed. */ dnsLabel: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The VCN's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP address space. The prefixes are provided by Oracle and the sizes are always /56. */ ipv6cidrBlocks: string[]; /** * For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space. */ ipv6privateCidrBlocks: string[]; isIpv6enabled: boolean; isOracleGuaAllocationEnabled: boolean; /** * 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"}` */ securityAttributes: { [key: string]: string; }; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the VCN was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The VCN's domain name, which consists of the VCN's DNS label, and the `oraclevcn.com` domain. */ vcnDomainName: string; } interface GetVcnsVirtualNetworkByoipv6cidrDetail { byoipv6rangeId: string; ipv6cidrBlock: string; } interface GetVirtualCircuitAssociatedTunnelsFilter { name: string; regex?: boolean; values: string[]; } interface GetVirtualCircuitAssociatedTunnelsVirtualCircuitAssociatedTunnelDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of IPSec connection associated with the virtual circuit. */ ipsecConnectionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IPSec tunnel associated with the virtual circuit. */ tunnelId: string; /** * The type of the tunnel associated with the virtual circuit. */ tunnelType: string; } interface GetVirtualCircuitBandwidthShapesFilter { /** * The name of the bandwidth shape. Example: `10 Gbps` */ name: string; regex?: boolean; values: string[]; } interface GetVirtualCircuitBandwidthShapesVirtualCircuitBandwidthShape { /** * The bandwidth in Mbps. Example: `10000` */ bandwidthInMbps: number; /** * The name of the bandwidth shape. Example: `10 Gbps` */ name: string; } interface GetVirtualCircuitCrossConnectMapping { /** * 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. */ bgpMd5authKey: string; /** * 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). */ crossConnectOrCrossConnectGroupId: string; /** * 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. */ customerBgpPeeringIp: string; /** * 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. */ customerBgpPeeringIpv6: string; /** * The IPv4 address for Oracle's end of the BGP session. Must use a /30 or /31 subnet mask. 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. */ oracleBgpPeeringIp: string; /** * 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. */ oracleBgpPeeringIpv6: string; /** * 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: `200` */ vlan: number; } interface GetVirtualCircuitPublicPrefix { cidrBlock: string; } interface GetVirtualCircuitPublicPrefixesFilter { name: string; regex?: boolean; values: string[]; } interface GetVirtualCircuitPublicPrefixesVirtualCircuitPublicPrefix { /** * Publix IP prefix (CIDR) that the customer specified. */ cidrBlock: string; /** * A filter to only return resources that match the given verification state. * * The state value is case-insensitive. */ verificationState: string; } interface GetVirtualCircuitVirtualCircuitRedundancyMetadata { /** * The configured redundancy level of the virtual circuit. */ configuredRedundancyLevel: string; /** * Indicates if the configured level is met for IPv4 BGP redundancy. */ ipv4bgpSessionRedundancyStatus: string; /** * Indicates if the configured level is met for IPv6 BGP redundancy. */ ipv6bgpSessionRedundancyStatus: string; } interface GetVirtualCircuitsFilter { name: string; regex?: boolean; values: string[]; } interface GetVirtualCircuitsVirtualCircuit { /** * The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see [ListFastConnectProviderServiceVirtualCircuitBandwidthShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderVirtualCircuitBandwidthShapes). Example: `10 Gbps` */ bandwidthShapeName: string; /** * Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit. */ bgpAdminState: string; /** * The state of the Ipv6 BGP session associated with the virtual circuit. */ bgpIpv6sessionState: string; /** * Deprecated. Instead use the information in [FastConnectProviderService](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/FastConnectProviderService/). * * @deprecated The 'bgp_management' field has been deprecated. Please use the 'oci_core_fast_connect_provider_service' data source instead. */ bgpManagement: string; /** * The state of the Ipv4 BGP session associated with the virtual circuit. */ bgpSessionState: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit. */ crossConnectMappings: outputs.Core.GetVirtualCircuitsVirtualCircuitCrossConnectMapping[]; /** * The BGP ASN of the network at the other end of the BGP session from Oracle. If the session is between the customer's edge router and Oracle, the value is the customer's ASN. If the BGP session is between the provider's edge router and Oracle, the value is the provider's ASN. Can be a 2-byte or 4-byte ASN. Uses "asplain" format. */ customerAsn: string; /** * Deprecated. Instead use `customerAsn`. If you specify values for both, the request will be rejected. * * @deprecated The 'customer_bgp_asn' field has been deprecated. Please use 'customer_asn' instead. */ customerBgpAsn: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer's [dynamic routing gateway (DRG)](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Drg) that this virtual circuit uses. Applicable only to private virtual circuits. */ gatewayId: string; /** * The virtual circuit's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * The layer 3 IP MTU to use on this virtual circuit. */ ipMtu: string; /** * Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD. If this is not set, the default is `false`. */ isBfdEnabled: boolean; /** * Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic. If this is not set, the default is `false`. */ isTransportMode: boolean; /** * The Oracle BGP ASN. */ oracleBgpAsn: number; /** * The OCI's FastConnect MultiCloud Provider/Partner remote region name associated with the Oracle Cloud Infrastructure region. To get the list of associated provider remote region use the ListProviderRemoteRegions operation */ providerRemoteRegion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider (if the customer is connecting via a provider). */ providerServiceId: string; /** * The service key name offered by the provider (if the customer is connecting via a provider). */ providerServiceKeyName: string; /** * The provider's state in relation to this virtual circuit (if the customer is connecting via a provider). ACTIVE means the provider has provisioned the virtual circuit from their end. INACTIVE means the provider has not yet provisioned the virtual circuit, or has de-provisioned it. */ providerState: string; /** * For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed. */ publicPrefixes: outputs.Core.GetVirtualCircuitsVirtualCircuitPublicPrefix[]; /** * Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider). */ referenceComment: string; /** * The Oracle Cloud Infrastructure region where this virtual circuit is located. */ region: string; /** * Customer's account on Provider/Partner cloud (AWS, GCP or any other) */ remoteAccountId: string; /** * The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. Policies available are: `ORACLE_SERVICE_NETWORK`, `REGIONAL`, `MARKET_LEVEL`, and `GLOBAL`. See [Route Filtering](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/routingonprem.htm#route_filtering) for details. By default, routing information is shared for all routes in the same market. */ routingPolicies: string[]; /** * Provider service type. */ serviceType: string; /** * The Shared unique identifier for the connection between the multicloud interconnect providers */ sharedConnectionUuid: string; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * The date and time the virtual circuit was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The current traffic mode for the Virtual Circuit. This indicates whether the traffic is drained for the associated Virtual Circuit or not. */ trafficMode: string; /** * Whether the virtual circuit supports private or public peering. For more information, see [FastConnect Overview](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). */ type: string; virtualCircuitId: string; /** * This resource provides redundancy level details for the virtual circuit. For more about redundancy, see [FastConnect Redundancy Best Practices](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnectresiliency.htm). */ virtualCircuitRedundancyMetadatas: outputs.Core.GetVirtualCircuitsVirtualCircuitVirtualCircuitRedundancyMetadata[]; } interface GetVirtualCircuitsVirtualCircuitCrossConnectMapping { /** * 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. */ bgpMd5authKey: string; /** * 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). */ crossConnectOrCrossConnectGroupId: string; /** * 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. */ customerBgpPeeringIp: string; /** * 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. */ customerBgpPeeringIpv6: string; /** * 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. */ oracleBgpPeeringIp: string; /** * 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. */ oracleBgpPeeringIpv6: string; /** * 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: `200` */ vlan: number; } interface GetVirtualCircuitsVirtualCircuitPublicPrefix { cidrBlock: string; } interface GetVirtualCircuitsVirtualCircuitVirtualCircuitRedundancyMetadata { /** * The configured redundancy level of the virtual circuit. */ configuredRedundancyLevel: string; /** * Indicates if the configured level is met for IPv4 BGP redundancy. */ ipv4bgpSessionRedundancyStatus: string; /** * Indicates if the configured level is met for IPv6 BGP redundancy. */ ipv6bgpSessionRedundancyStatus: string; } interface GetVirtualNetworksFilter { name: string; regex?: boolean; values: string[]; } interface GetVirtualNetworksVirtualNetwork { byoipv6cidrBlocks: string[]; byoipv6cidrDetails: outputs.Core.GetVirtualNetworksVirtualNetworkByoipv6cidrDetail[]; cidrBlock: string; cidrBlocks: string[]; compartmentId: string; defaultDhcpOptionsId: string; defaultRouteTableId: string; defaultSecurityListId: string; definedTags: { [key: string]: string; }; displayName: string; dnsLabel: string; freeformTags: { [key: string]: string; }; id: string; ipv6cidrBlocks: string[]; ipv6privateCidrBlocks: string[]; isIpv6enabled: boolean; isOracleGuaAllocationEnabled: boolean; securityAttributes: { [key: string]: string; }; state: string; timeCreated: string; vcnDomainName: string; } interface GetVirtualNetworksVirtualNetworkByoipv6cidrDetail { byoipv6rangeId: string; ipv6cidrBlock: string; } interface GetVlansFilter { name: string; regex?: boolean; values: string[]; } interface GetVlansVlan { /** * The VLAN's availability domain. This attribute will be null if this is a regional VLAN rather than an AD-specific VLAN. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN. Example: `192.168.1.0/24` */ cidrBlock: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The VLAN's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. All VNICs in the VLAN belong to these NSGs. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/). */ nsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table that the VLAN uses. */ routeTableId: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the VLAN was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; /** * The IEEE 802.1Q VLAN tag of this VLAN. Example: `100` */ vlanTag: number; } interface GetVnicAttachmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetVnicAttachmentsVnicAttachment { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; createVnicDetails: outputs.Core.GetVnicAttachmentsVnicAttachmentCreateVnicDetail[]; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The OCID of the VNIC attachment. */ id: string; /** * The OCID of the instance. */ instanceId: string; /** * Which physical network interface card (NIC) the VNIC uses. 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). */ nicIndex: number; /** * The current state of the VNIC attachment. */ state: string; /** * The OCID of the subnet to create the VNIC in. */ subnetId: string; /** * The date and time the VNIC attachment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The OCID of the VLAN to create the VNIC in. Creating the VNIC in a VLAN (instead of a subnet) is possible only if you are an Oracle Cloud VMware Solution customer. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan). */ vlanId: string; /** * The Oracle-assigned VLAN tag of the attached VNIC. Available after the attachment process is complete. */ vlanTag: number; /** * The OCID of the VNIC. */ vnicId: string; } interface GetVnicAttachmentsVnicAttachmentCreateVnicDetail { assignIpv6ip: boolean; assignPrivateDnsRecord: boolean; assignPublicIp: string; definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; freeformTags: { [key: string]: string; }; hostnameLabel: string; ipv6addressIpv6subnetCidrPairDetails: outputs.Core.GetVnicAttachmentsVnicAttachmentCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail[]; nsgIds: string[]; privateIp: string; privateIpId: string; routeTableId: string; securityAttributes: { [key: string]: string; }; skipSourceDestCheck: boolean; subnetCidr: string; /** * The OCID of the subnet to create the VNIC in. */ subnetId: string; /** * The OCID of the VLAN to create the VNIC in. Creating the VNIC in a VLAN (instead of a subnet) is possible only if you are an Oracle Cloud VMware Solution customer. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan). */ vlanId: string; } interface GetVnicAttachmentsVnicAttachmentCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail { ipv6address: string; ipv6id: string; ipv6subnetCidr: string; } interface GetVolumeAttachmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetVolumeAttachmentsVolumeAttachment { /** * The type of volume attachment. */ attachmentType: string; /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".) */ chapSecret: string; /** * The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See [RFC 1994](https://tools.ietf.org/html/rfc1994) for more on CHAP. Example: `ocid1.volume.oc1.phx.` */ chapUsername: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. * * @deprecated The 'compartment_id' field has been deprecated and may be removed in a future version. Do not use this field. */ compartmentId: string; /** * The device name. */ device: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Refer the top-level definition of encryptionInTransitType. The default value is NONE. */ encryptionInTransitType: string; /** * The OCID of the volume attachment. */ id: string; /** * The OCID of the instance. */ instanceId: string; /** * The volume's iSCSI IP address. Example: `169.254.2.2` */ ipv4: string; /** * The volume's iSCSI IPv6 address. Example: `2001:db8::1/64` */ ipv6: string; /** * 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` */ iqn: string; /** * Whether Oracle Cloud Agent is enabled perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments. */ isAgentAutoIscsiLoginEnabled: boolean; /** * Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment. */ isMultipath: boolean; /** * Whether in-transit encryption for the data volume's paravirtualized attachment is enabled or not. */ isPvEncryptionInTransitEnabled: boolean; /** * Whether the attachment was created in read-only mode. */ isReadOnly: boolean; /** * 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. */ isShareable: boolean; /** * Flag indicating if this volume was created for the customer as part of a simplified launch. Used to determine whether the volume requires deletion on instance termination. */ isVolumeCreatedDuringLaunch: boolean; /** * The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state. */ iscsiLoginState: string; /** * A list of secondary multipath devices */ multipathDevices: outputs.Core.GetVolumeAttachmentsVolumeAttachmentMultipathDevice[]; /** * The volume's iSCSI port, usually port 860 or 3260. Example: `3260` */ port: number; /** * The current state of the volume attachment. */ state: string; /** * The date and time the volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; useChap: boolean; /** * The OCID of the volume. */ volumeId: string; } interface GetVolumeAttachmentsVolumeAttachmentMultipathDevice { /** * The volume's iSCSI IP address. Example: `169.254.2.2` */ ipv4: string; /** * 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` */ iqn: string; /** * The volume's iSCSI port, usually port 860 or 3260. Example: `3260` */ port: number; } interface GetVolumeAutotunePolicy { /** * This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface GetVolumeBackupPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetVolumeBackupPoliciesVolumeBackupPolicy { /** * The OCID of the compartment. If no compartment is specified, the Oracle defined backup policies are listed. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The paired destination region for copying scheduled backups to. Example `us-ashburn-1`. See [Region Pairs](https://docs.cloud.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#RegionPairs) for details about paired regions. */ destinationRegion: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the volume backup policy. */ id: string; /** * The collection of schedules that this policy will apply. */ schedules: outputs.Core.GetVolumeBackupPoliciesVolumeBackupPolicySchedule[]; /** * The date and time the volume backup policy was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; } interface GetVolumeBackupPoliciesVolumeBackupPolicySchedule { /** * The type of volume backup to create. */ backupType: string; /** * The day of the month to schedule the volume backup. */ dayOfMonth: number; /** * The day of the week to schedule the volume backup. */ dayOfWeek: string; /** * The hour of the day to schedule the volume backup. */ hourOfDay: number; /** * Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. */ isPreventDeletionEnabled: boolean; /** * feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. */ isRetentionLockEnabled: boolean; /** * The month of the year to schedule the volume backup. */ month: string; /** * 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. */ offsetSeconds: number; /** * Indicates how the offset is defined. If value is `STRUCTURED`, then `hourOfDay`, `dayOfWeek`, `dayOfMonth`, and `month` fields are used and `offsetSeconds` will be ignored in requests and users should ignore its value from the responses. */ offsetType: string; /** * The volume backup frequency. */ period: string; /** * This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ retentionPeriods: outputs.Core.GetVolumeBackupPoliciesVolumeBackupPolicyScheduleRetentionPeriod[]; /** * How long, in seconds, to keep the volume backups created by this schedule. */ retentionSeconds: number; /** * Specifies what time zone is the schedule in */ timeZone: string; } interface GetVolumeBackupPoliciesVolumeBackupPolicyScheduleRetentionPeriod { /** * The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period. */ retentionTimeAmount: number; /** * The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS". */ retentionTimeUnit: string; } interface GetVolumeBackupPolicyAssignmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetVolumeBackupPolicyAssignmentsVolumeBackupPolicyAssignment { /** * The OCID of an asset (e.g. a volume). */ assetId: string; /** * The OCID of the volume backup policy assignment. */ id: string; /** * The OCID of the volume backup policy that has been assigned to the volume. */ policyId: string; /** * The date and time the volume backup policy was assigned to the volume. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The OCID of the Vault service key which is the master encryption key for the block / boot 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). */ xrcKmsKeyId: string; } interface GetVolumeBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetVolumeBackupsVolumeBackup { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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. */ expirationTime: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the volume backup. */ id: string; /** * feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. */ isIndefiniteRetentionEnabled: boolean; /** * Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. */ isPreventDeletionEnabled: boolean; /** * feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. */ isRetentionLockEnabled: boolean; /** * The OCID of the Vault service key which is the master encryption key for the 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). */ kmsKeyId: string; /** * This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ retentionPeriods: outputs.Core.GetVolumeBackupsVolumeBackupRetentionPeriod[]; /** * The size of the volume, in GBs. */ sizeInGbs: string; /** * The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use `sizeInGbs`. * * @deprecated The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead. */ sizeInMbs: string; sourceDetails: outputs.Core.GetVolumeBackupsVolumeBackupSourceDetail[]; /** * Specifies whether the backup was created manually, or via scheduled backup policy. */ sourceType: string; /** * A filter to return only resources that originated from the given source volume backup. */ sourceVolumeBackupId: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ systemTags: { [key: string]: string; }; /** * The date and time the 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). */ timeCreated: string; /** * The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339. */ timeRequestReceived: string; /** * The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ timeRetentionExpiresAt: string; /** * The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'. */ type: string; /** * The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental. */ uniqueSizeInGbs: string; /** * The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs. * * @deprecated The 'unique_size_in_mbs' field has been deprecated. Please use 'unique_size_in_gbs' instead. */ uniqueSizeInMbs: string; /** * The OCID of the volume group backup associated with the backup. This is an optional field. If it is not present in the response, the backup does not belong to a volume group. */ volumeGroupBackupId: string; /** * The OCID of the volume. */ volumeId: string; } interface GetVolumeBackupsVolumeBackupRetentionPeriod { /** * The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period. */ retentionTimeAmount: number; /** * The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS". */ retentionTimeUnit: string; } interface GetVolumeBackupsVolumeBackupSourceDetail { /** * The OCID of the Vault service key which is the master encryption key for the 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). */ kmsKeyId: string; region: string; volumeBackupId: string; } interface GetVolumeBlockVolumeReplica { /** * The availability domain of the block volume replica. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The block volume replica's Oracle ID (OCID). */ blockVolumeReplicaId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The OCID of the Vault service key which is the master encryption key for the volume. */ kmsKeyId: string; xrrKmsKeyId: string; } interface GetVolumeGroupBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetVolumeGroupBackupsVolumeGroupBackup { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The date and time the volume group backup will expire and be automatically deleted. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for volume group backups that were created automatically by a scheduled-backup policy. For manually created volume group backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted. */ expirationTime: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the volume group backup. */ id: string; /** * feature that preserves backup data from modification or deletion to ensure it remains available for legal or regulatory investigations or litigation, regardless of standard retention policies. This is an optional field. If it is not specified, it is set to null, no legal hold will be applied to the backups. */ isIndefiniteRetentionEnabled: boolean; /** * Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. */ isPreventDeletionEnabled: boolean; /** * feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. */ isRetentionLockEnabled: boolean; /** * This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ retentionPeriods: outputs.Core.GetVolumeGroupBackupsVolumeGroupBackupRetentionPeriod[]; /** * The aggregate size of the volume group backup, in GBs. */ sizeInGbs: string; /** * The aggregate size of the volume group backup, in MBs. */ sizeInMbs: string; sourceDetails: outputs.Core.GetVolumeGroupBackupsVolumeGroupBackupSourceDetail[]; /** * Specifies whether the volume group backup was created manually, or via scheduled backup policy. */ sourceType: string; /** * The OCID of the source volume group backup. */ sourceVolumeGroupBackupId: string; /** * The current state of a volume group backup. */ state: string; /** * The date and time the volume group backup was created. This is the time the actual point-in-time image of the volume group data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the request to create the volume group backup was received. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeRequestReceived: string; /** * The date and time when a backup’s retention period ends and it is set to expire. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ timeRetentionExpiresAt: string; /** * The type of backup. */ type: string; /** * The aggregate size used by the volume group backup, in GBs. It is typically smaller than `sizeInGbs`, depending on the space consumed on the volume group and whether the volume backup is full or incremental. */ uniqueSizeInGbs: string; /** * The aggregate size used by the volume group backup, in MBs. It is typically smaller than `sizeInMbs`, depending on the space consumed on the volume group and whether the volume backup is full or incremental. */ uniqueSizeInMbs: string; /** * OCIDs for the volume backups in this volume group backup. */ volumeBackupIds: string[]; /** * The OCID of the volume group. */ volumeGroupId: string; } interface GetVolumeGroupBackupsVolumeGroupBackupRetentionPeriod { /** * The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period. */ retentionTimeAmount: number; /** * The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS". */ retentionTimeUnit: string; } interface GetVolumeGroupBackupsVolumeGroupBackupSourceDetail { kmsKeyId: string; region: string; volumeGroupBackupId: string; } interface GetVolumeGroupReplicaMemberReplica { /** * Membership state of the volume replica in relation to the volume group replica. */ membershipState: string; /** * The volume replica ID. */ volumeReplicaId: string; } interface GetVolumeGroupReplicasFilter { name: string; regex?: boolean; values: string[]; } interface GetVolumeGroupReplicasVolumeGroupReplica { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID for the volume group replica. */ id: string; /** * Volume replicas within this volume group replica. */ memberReplicas: outputs.Core.GetVolumeGroupReplicasVolumeGroupReplicaMemberReplica[]; /** * The aggregate size of the volume group replica in GBs. */ sizeInGbs: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the volume group replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the volume group replica was last synced from the source volume group. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeLastSynced: string; /** * The OCID of the source volume group. */ volumeGroupId: string; } interface GetVolumeGroupReplicasVolumeGroupReplicaMemberReplica { /** * Membership state of the volume replica in relation to the volume group replica. */ membershipState: string; /** * The volume replica ID. */ volumeReplicaId: string; } interface GetVolumeGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetVolumeGroupsVolumeGroup { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * @deprecated The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead. */ backupPolicyId: string; clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID for the volume group. */ id: string; /** * Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup. */ isHydrated: boolean; preserveVolumeReplica: boolean; /** * The aggregate size of the volume group in GBs. */ sizeInGbs: string; /** * The aggregate size of the volume group in MBs. */ sizeInMbs: string; /** * Specifies the source for a volume group. */ sourceDetails: outputs.Core.GetVolumeGroupsVolumeGroupSourceDetail[]; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the volume group was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The list of volume group replicas of this volume group. */ volumeGroupReplicas: outputs.Core.GetVolumeGroupsVolumeGroupVolumeGroupReplica[]; volumeGroupReplicasDeletion: boolean; /** * OCIDs for the volumes in this volume group. */ volumeIds: string[]; xrcKmsKeyId: string; } interface GetVolumeGroupsVolumeGroupSourceDetail { /** * The type can be one of these values: `volumeGroupBackupId`, `volumeGroupId`, `volumeIds` */ type: string; /** * The OCID of the volume group backup to restore from, if the type is `volumeGroupBackup` */ volumeGroupBackupId: string; /** * The OCID of the volume group to clone from, if the type is `volumeGroup` */ volumeGroupId: string; /** * The volume group replica's Oracle ID (OCID). */ volumeGroupReplicaId: string; /** * OCIDs for the volumes in this volume group. */ volumeIds: string[]; } interface GetVolumeGroupsVolumeGroupVolumeGroupReplica { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The volume group replica's Oracle ID (OCID). */ volumeGroupReplicaId: string; xrrKmsKeyId: string; } interface GetVolumeSourceDetail { /** * (Applicable when type=volumeBackupDelta) 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). */ changeBlockSizeInBytes: string; /** * (Required when type=volumeBackupDelta) The OCID of the first volume backup. */ firstBackupId: string; /** * (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica. */ id: string; /** * (Required when type=volumeBackupDelta) The OCID of the second volume backup. */ secondBackupId: string; /** * (Required) The type can be one of these values: `blockVolumeReplica`, `volume`, `volumeBackup`, `volumeBackupDelta` */ type: string; } interface GetVolumesFilter { name: string; regex?: boolean; values: string[]; } interface GetVolumesVolume { /** * The number of Volume Performance Units per GB that this volume is effectively tuned to. */ autoTunedVpusPerGb: string; /** * The list of autotune policies enabled for this volume. */ autotunePolicies: outputs.Core.GetVolumesVolumeAutotunePolicy[]; /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * @deprecated The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead. */ backupPolicyId: string; /** * The list of block volume replicas of this volume. */ blockVolumeReplicas: outputs.Core.GetVolumesVolumeBlockVolumeReplica[]; blockVolumeReplicasDeletion: boolean; /** * A filter to return only resources that match the given cluster placement group Id exactly. */ clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica. */ id: string; /** * Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune. */ isAutoTuneEnabled: boolean; /** * Specifies whether the cloned volume's data has finished copying from the source volume or backup. */ isHydrated: boolean; /** * Reservations-enabled is a boolean field that allows to enable PR (Persistent Reservation) on a volume. */ isReservationsEnabled: boolean; /** * The OCID of the Vault service key which is the master encryption key for the volume. */ kmsKeyId: string; /** * The size of the volume in GBs. */ sizeInGbs: string; /** * The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead. * * @deprecated The 'size_in_mbs' field has been deprecated. Please use 'size_in_gbs' instead. */ sizeInMbs: string; /** * Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup. */ sourceDetails: outputs.Core.GetVolumesVolumeSourceDetail[]; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ systemTags: { [key: string]: string; }; /** * The date and time the volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; volumeBackupId: string; /** * The OCID of the volume group. */ volumeGroupId: string; /** * 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. */ vpusPerGb: string; xrcKmsKeyId: string; } interface GetVolumesVolumeAutotunePolicy { /** * This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface GetVolumesVolumeBlockVolumeReplica { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The block volume replica's Oracle ID (OCID). */ blockVolumeReplicaId: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The OCID of the Vault service key which is the master encryption key for the volume. */ kmsKeyId: string; xrrKmsKeyId: string; } interface GetVolumesVolumeSourceDetail { /** * (Applicable when type=volumeBackupDelta) 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). */ changeBlockSizeInBytes: string; /** * (Required when type=volumeBackupDelta) The OCID of the first volume backup. */ firstBackupId: string; /** * (Required when type=blockVolumeReplica | volume | volumeBackup) The OCID of the block volume replica. */ id: string; /** * (Required when type=volumeBackupDelta) The OCID of the second volume backup. */ secondBackupId: string; /** * (Required) The type can be one of these values: `blockVolumeReplica`, `volume`, `volumeBackup`, `volumeBackupDelta` */ type: string; } interface GetVtapsFilter { name: string; regex?: boolean; values: string[]; } interface GetVtapsVtap { /** * The capture filter's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ captureFilterId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * Defines an encapsulation header type for the VTAP's mirrored traffic. */ encapsulationProtocol: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The VTAP's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). */ id: string; /** * Indicates whether to list all VTAPs or only running VTAPs. * * When `FALSE`, lists ALL running and stopped VTAPs. * * When `TRUE`, lists only running VTAPs (VTAPs where isVtapEnabled = `TRUE`). */ isVtapEnabled: boolean; /** * The VTAP's current running state. */ lifecycleStateDetails: string; /** * The maximum size of the packets to be included in the filter. */ maxPacketSize: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. */ sourceId: string; /** * The IP Address of the source private endpoint. */ sourcePrivateEndpointIp: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. */ sourcePrivateEndpointSubnetId: string; /** * The source type for the VTAP. */ sourceType: string; /** * A filter to return only resources that match the given VTAP administrative lifecycle state. The state value is case-insensitive. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VTAP target. */ targetId: string; /** * The IP address of the VTAP target. */ targetIp: string; /** * The target type for the VTAP. */ targetType: string; /** * The date and time the VTAP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-08-25T21:10:29.600Z` */ timeCreated: string; /** * Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT */ trafficMode: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; /** * The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. */ vxlanNetworkIdentifier: string; } interface ImageAgentFeature { /** * This attribute is not used. */ isManagementSupported: boolean; /** * This attribute is not used. */ isMonitoringSupported: boolean; } interface ImageImageSourceDetails { /** * The Object Storage bucket for the image. */ bucketName?: string; /** * The Object Storage namespace for the image. */ namespaceName?: string; /** * The Object Storage name for the image. */ objectName?: string; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem?: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion?: string; /** * 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: * * `QCOW2` * * `VMDK` */ sourceImageType?: string; /** * 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. */ sourceType: string; /** * The Object Storage URL for the image. */ sourceUri?: string; } interface ImageLaunchOption { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface InstanceAgentConfig { /** * (Updatable) Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. * * 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). */ areAllPluginsDisabled: boolean; /** * (Updatable) Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled). * * These are the management plugins: OS Management Service Agent and Compute Instance Run Command. * * The management plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object. * * If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of the per-plugin configuration. * * 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. */ isManagementDisabled: boolean; /** * (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). * * These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring. * * The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object. * * If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration. * * 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. */ isMonitoringDisabled: boolean; /** * (Updatable) The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.Core.InstanceAgentConfigPluginsConfig[]; } interface InstanceAgentConfigPluginsConfig { /** * (Updatable) Whether the plugin should be enabled or disabled. * * To enable the monitoring and management plugins, the `isMonitoringDisabled` and `isManagementDisabled` attributes must also be set to false. */ desiredState: string; /** * (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). */ name: string; } interface InstanceAvailabilityConfig { /** * (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. */ isLiveMigrationPreferred: boolean; /** * (Updatable) The lifecycle state for an instance when it is recovered after infrastructure maintenance. * * `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. * * `STOP_INSTANCE` - The instance is recovered in the stopped state. */ recoveryAction: string; } interface InstanceConfigurationGmcConfigs { /** * The availability domain for this GMC configuration entry. */ availabilityDomain: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment associated with this GMC configuration entry. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Configuration settings for GPU Memory Cluster scaling. */ gpuMemoryClusterScaleConfig: outputs.Core.InstanceConfigurationGmcConfigsGpuMemoryClusterScaleConfig; /** * 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. */ instanceConfigurationId: string; /** * The desired number of instances for this GMC configuration entry. */ size: string; } interface InstanceConfigurationGmcConfigsGpuMemoryClusterScaleConfig { /** * Enables downsizing towards the target size. */ isDownsizeEnabled: boolean; /** * Enables upsizing towards the target size. */ isUpsizeEnabled: boolean; /** * The configured target size for the GPU Memory Cluster. */ targetSize: string; } interface InstanceConfigurationInstanceDetails { /** * Block volume parameters. */ blockVolumes: outputs.Core.InstanceConfigurationInstanceDetailsBlockVolume[]; /** * The type of instance details. Supported instanceType is compute */ instanceType: string; /** * 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. * See [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/LaunchInstanceDetails) for more information. */ launchDetails: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetails; /** * Multiple Compute Instance Configuration instance details. */ options: outputs.Core.InstanceConfigurationInstanceDetailsOption[]; /** * Secondary VNIC parameters. */ secondaryVnics: outputs.Core.InstanceConfigurationInstanceDetailsSecondaryVnic[]; } interface InstanceConfigurationInstanceDetailsBlockVolume { /** * Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/) */ attachDetails: outputs.Core.InstanceConfigurationInstanceDetailsBlockVolumeAttachDetails; /** * Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/) */ createDetails: outputs.Core.InstanceConfigurationInstanceDetailsBlockVolumeCreateDetails; /** * The OCID of the volume. */ volumeId: string; } interface InstanceConfigurationInstanceDetailsBlockVolumeAttachDetails { /** * The device name. */ device: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false. */ isPvEncryptionInTransitEnabled: boolean; /** * Whether the attachment should be created in read-only mode. */ isReadOnly: boolean; /** * 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. */ isShareable: boolean; /** * The type of volume. The only supported values are "iscsi" and "paravirtualized" */ type: string; /** * Whether to use CHAP authentication for the volume attachment. Defaults to false. */ useChap: boolean; } interface InstanceConfigurationInstanceDetailsBlockVolumeCreateDetails { /** * The list of autotune policies enabled for this volume. */ autotunePolicies: outputs.Core.InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsAutotunePolicy[]; /** * The availability domain of the volume. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned. */ backupPolicyId: string; /** * The list of block volume replicas to be enabled for this volume in the specified destination availability domains. */ blockVolumeReplicas: outputs.Core.InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsBlockVolumeReplicas; /** * The clusterPlacementGroup Id of the volume for volume placement. */ clusterPlacementGroupId: string; /** * The OCID of the compartment that contains the volume. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ isAutoTuneEnabled: boolean; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The size of the volume in GBs. */ sizeInGbs: string; sourceDetails: outputs.Core.InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsSourceDetails; /** * 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. * * Allowed values: */ vpusPerGb: string; /** * 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). */ xrcKmsKeyId: string; } interface InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsAutotunePolicy { /** * This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsBlockVolumeReplicas { /** * The availability domain of the block volume replica. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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. */ displayName: string; } interface InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsSourceDetails { /** * The OCID of the volume backup. */ id: string; /** * The type can be one of these values: `volume`, `volumeBackup` */ type: string; } interface InstanceConfigurationInstanceDetailsLaunchDetails { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfig: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfig; /** * Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware. */ availabilityConfig: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsAvailabilityConfig; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compute capacity reservation this instance is launched under. */ capacityReservationId: string; /** * The OCID of the cluster placement group of the instance. */ clusterPlacementGroupId: string; /** * 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. */ compartmentId: string; /** * 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. */ computeClusterId: string; /** * 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. */ createVnicDetails: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetails; /** * The OCID of the dedicated virtual machine host to place the instance on. * * Dedicated VM hosts can be used when launching individual instances from an instance configuration. They cannot be used to launch instance pools. */ dedicatedVmHostId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. * * They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata` fields are string/string maps only). * * The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of 32,000 bytes. */ extendedMetadata: { [key: string]: string; }; /** * 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. * * If you do not specify the fault domain, the system selects one for you. * * To 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. * * Example: `FAULT-DOMAIN-1` */ faultDomain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints. */ instanceOptions: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsInstanceOptions; /** * This is an advanced option. * * 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. * * If 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. * * The 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. * * For 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). * * For more information about iPXE, see http://ipxe.org. */ ipxeScript: string; /** * Whether to enable AI enterprise on the instance. */ isAiEnterpriseEnabled: boolean; /** * Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false. */ isPvEncryptionInTransitEnabled: boolean; /** * Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: * * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. */ launchMode: string; /** * Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. */ launchOptions: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsLaunchOptions; /** * List of licensing configurations associated with target launch values. */ licensingConfigs: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsLicensingConfigs; /** * Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance. * * A 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: * * Provide information to [Cloud-Init](https://cloudinit.readthedocs.org/en/latest/) to be used for various system initialization tasks. * * Get information about the instance, including the custom metadata that you provide when you launch the instance. * * **Providing Cloud-Init Metadata** * * You can use the following metadata key names to provide information to Cloud-Init: * * **"sshAuthorizedKeys"** - 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 `authorizedKeys` file, as shown in the example below. * * **"userData"** - 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). * * **Metadata Example** * * "metadata" : { "quakeBotLevel" : "Severe", "sshAuthorizedKeys" : "ssh-rsa == rsa-key-20160227", "userData" : "==" } **Getting Metadata on the Instance** * * To get information about your instance, connect to the instance using SSH and issue any of the following GET requests: * * curl -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/ * * You'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. * * The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of 32,000 bytes. */ metadata: { [key: string]: string; }; /** * The details for providing placement constraints. */ placementConstraintDetails: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsPlacementConstraintDetails; /** * (Optional) (Updatable only for VM's) The platform configuration requested for the instance. * * If 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 `shape` that you specify. If you don't provide the parameter, the default values for the `shape` are used. * * Each shape only supports certain configurable values. If the values that you provide are not valid for the specified `shape`, an error is returned. */ platformConfig: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsPlatformConfig; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfig: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfig; /** * The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported. * * `LIVE_MIGRATE` - Run maintenance using a live migration. * * `REBOOT` - Run maintenance using a reboot. */ preferredMaintenanceAction: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources 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). */ shape: string; /** * The shape configuration requested for the instance. * * If 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 `shape` that you specify. * * Each shape only supports certain configurable values. If the values that you provide are not valid for the specified `shape`, an error is returned. */ shapeConfig: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsShapeConfig; sourceDetails: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetails; } interface InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. * * 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). */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled). */ isManagementDisabled: boolean; /** * Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled). */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfigPluginsConfig[]; } interface InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. */ desiredState: string; /** * 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). */ name: string; } interface InstanceConfigurationInstanceDetailsLaunchDetailsAvailabilityConfig { /** * 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. */ isLiveMigrationPreferred: boolean; /** * The lifecycle state for an instance when it is recovered after infrastructure maintenance. * * `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. * * `STOP_INSTANCE` - The instance is recovered in the stopped state. */ recoveryAction: string; } interface InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetails { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord?: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds?: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface InstanceConfigurationInstanceDetailsLaunchDetailsInstanceOptions { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface InstanceConfigurationInstanceDetailsLaunchDetailsLaunchOptions { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface InstanceConfigurationInstanceDetailsLaunchDetailsLicensingConfigs { /** * License Type for the OS license. * * `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour). * * `BRING_YOUR_OWN_LICENSE` - Bring your own license. * * `PARTNER_PROVIDED` - Partner provided license. */ licenseType: string; /** * Operating System type of the Configuration. */ type: string; } interface InstanceConfigurationInstanceDetailsLaunchDetailsPlacementConstraintDetails { /** * The OCID of the compute host group. This is only available for dedicated capacity customers. */ computeHostGroupId: string; /** * The type for the placement constraints. Use `HOST_GROUP` when specifying the compute host group OCID. */ type: string; } interface InstanceConfigurationInstanceDetailsLaunchDetailsPlatformConfig { /** * Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. */ areVirtualInstructionsEnabled: boolean; /** * Instance Platform Configuration Configuration Map for flexible setting input. */ configMap: { [key: string]: string; }; /** * 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. */ isAccessControlServiceEnabled: boolean; /** * Whether the input-output memory management unit is enabled. */ isInputOutputMemoryManagementUnitEnabled: boolean; /** * Whether the Measured Boot feature is enabled on the instance. */ isMeasuredBootEnabled: boolean; /** * Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. */ isMemoryEncryptionEnabled: boolean; /** * Whether Secure Boot is enabled on the instance. */ isSecureBootEnabled: boolean; /** * (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. * * Intel 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. */ isSymmetricMultiThreadingEnabled: boolean; /** * Whether the Trusted Platform Module (TPM) is enabled on the instance. */ isTrustedPlatformModuleEnabled: boolean; /** * The number of NUMA nodes per socket (NPS). */ numaNodesPerSocket: string; /** * 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. * * If 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. */ percentageOfCoresEnabled: number; /** * The type of platform being configured. */ type: string; } interface InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionAction: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfigPreemptionAction; } interface InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface InstanceConfigurationInstanceDetailsLaunchDetailsShapeConfig { /** * 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`. * * The following values are supported: * * `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. * * `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. * * `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance. */ baselineOcpuUtilization: string; /** * 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. */ localVolumeSizeInGbs: number; /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; /** * This field is reserved for internal use. */ resourceManagement: string; /** * 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. */ vcpus: number; } interface InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetails { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. * * Allowed values: */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * These are the criteria for selecting an image. This is required if imageId is not specified. */ instanceSourceImageFilterDetails: outputs.Core.InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails; /** * The OCID of the Vault service key to assign as the master encryption key for the boot volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails { /** * (Updatable) The OCID of the compartment containing images to search */ compartmentId: string; /** * 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). */ definedTagsFilter: { [key: string]: string; }; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; } interface InstanceConfigurationInstanceDetailsOption { /** * Block volume parameters. */ blockVolumes: outputs.Core.InstanceConfigurationInstanceDetailsOptionBlockVolume[]; /** * 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. * * See [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/LaunchInstanceDetails) for more information. */ launchDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetails; /** * Secondary VNIC parameters. */ secondaryVnics: outputs.Core.InstanceConfigurationInstanceDetailsOptionSecondaryVnic[]; } interface InstanceConfigurationInstanceDetailsOptionBlockVolume { /** * Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/) */ attachDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionBlockVolumeAttachDetails; /** * Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/) */ createDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetails; /** * The OCID of the volume. */ volumeId: string; } interface InstanceConfigurationInstanceDetailsOptionBlockVolumeAttachDetails { /** * The device name. */ device: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false. */ isPvEncryptionInTransitEnabled: boolean; /** * Whether the attachment should be created in read-only mode. */ isReadOnly: boolean; /** * 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. */ isShareable: boolean; /** * The type of volume. The only supported values are "iscsi" and "paravirtualized". */ type: string; /** * Whether to use CHAP authentication for the volume attachment. Defaults to false. */ useChap: boolean; } interface InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetails { /** * The list of autotune policies enabled for this volume. */ autotunePolicies: outputs.Core.InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsAutotunePolicy[]; /** * The availability domain of the volume. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned. */ backupPolicyId: string; /** * The list of block volume replicas to be enabled for this volume in the specified destination availability domains. */ blockVolumeReplicas: outputs.Core.InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsBlockVolumeReplicas; /** * The clusterPlacementGroup Id of the volume for volume placement. */ clusterPlacementGroupId: string; /** * (Updatable) The OCID of the compartment that contains the volume. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ isAutoTuneEnabled: boolean; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The size of the volume in GBs. */ sizeInGbs: string; sourceDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsSourceDetails; /** * 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. * * Allowed values: */ vpusPerGb: string; /** * 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). */ xrcKmsKeyId: string; } interface InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsAutotunePolicy { /** * This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsBlockVolumeReplicas { /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; } interface InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsSourceDetails { /** * The OCID of the volume backup. */ id: string; /** * The type can be one of these values: `volume`, `volumeBackup` */ type: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetails { /** * Configuration options for the Oracle Cloud Agent software running on the instance. */ agentConfig: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfig; /** * Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware. */ availabilityConfig: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsAvailabilityConfig; /** * The availability domain of the instance. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The OCID of the compute capacity reservation this instance is launched under. */ capacityReservationId: string; /** * The clusterPlacementGroup Id of the volume for volume placement. */ clusterPlacementGroupId: string; /** * (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. */ compartmentId: string; /** * 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. */ computeClusterId: string; /** * 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. */ createVnicDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetails; /** * The OCID of the dedicated virtual machine host to place the instance on. */ dedicatedVmHostId: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. */ extendedMetadata: { [key: string]: string; }; /** * 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. */ faultDomain: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints. */ instanceOptions: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsInstanceOptions; /** * This is an advanced option. */ ipxeScript: string; /** * Whether to enable AI enterprise on the instance. */ isAiEnterpriseEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: * * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter. */ launchMode: string; /** * Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values. */ launchOptions: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsLaunchOptions; /** * List of licensing configurations associated with target launch values. */ licensingConfigs: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsLicensingConfigs; /** * Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance. */ metadata: { [key: string]: string; }; /** * The details for providing placement constraints. */ placementConstraintDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlacementConstraintDetails; /** * The platform configuration requested for the instance. */ platformConfig: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlatformConfig; /** * Configuration options for preemptible instances. */ preemptibleInstanceConfig: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfig; /** * The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported. * * `LIVE_MIGRATE` - Run maintenance using a live migration. * * `REBOOT` - Run maintenance using a reboot. */ preferredMaintenanceAction: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. */ shape: string; /** * The shape configuration requested for the instance. */ shapeConfig: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsShapeConfig; sourceDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetails; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfig { /** * Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. * * 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). */ areAllPluginsDisabled: boolean; /** * Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled). * * These are the management plugins: OS Management Service Agent and Compute Instance Run Command. * * The management plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object. * * If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of the per-plugin configuration. * * 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. */ isManagementDisabled: boolean; /** * Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled). * * These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring. * * The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object. * * If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration. * * 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. */ isMonitoringDisabled: boolean; /** * The configuration of plugins associated with this instance. */ pluginsConfigs: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfigPluginsConfig[]; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfigPluginsConfig { /** * Whether the plugin should be enabled or disabled. * * To enable the monitoring and management plugins, the `isMonitoringDisabled` and `isManagementDisabled` attributes must also be set to false. */ desiredState: string; /** * 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). */ name: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsAvailabilityConfig { /** * 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. */ isLiveMigrationPreferred: boolean; /** * The lifecycle state for an instance when it is recovered after infrastructure maintenance. * * `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. * * `STOP_INSTANCE` - The instance is recovered in the stopped state. */ recoveryAction: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetails { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsInstanceOptions { /** * 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. */ areLegacyImdsEndpointsDisabled: boolean; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsLaunchOptions { /** * Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails). */ isPvEncryptionInTransitEnabled: boolean; /** * Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsLicensingConfigs { /** * License Type for the OS license. * * `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour). * * `BRING_YOUR_OWN_LICENSE` - Bring your own license. * * `PARTNER_PROVIDED` - Partner provided license. */ licenseType: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlacementConstraintDetails { /** * The OCID of the compute host group. This is only available for dedicated capacity customers. */ computeHostGroupId: string; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlatformConfig { /** * Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. */ areVirtualInstructionsEnabled: boolean; /** * 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. */ isAccessControlServiceEnabled: boolean; /** * Whether the input-output memory management unit is enabled. */ isInputOutputMemoryManagementUnitEnabled: boolean; /** * Whether the Measured Boot feature is enabled on the instance. */ isMeasuredBootEnabled: boolean; /** * Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. */ isMemoryEncryptionEnabled: boolean; /** * Whether Secure Boot is enabled on the instance. */ isSecureBootEnabled: boolean; /** * Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading. */ isSymmetricMultiThreadingEnabled: boolean; /** * Whether the Trusted Platform Module (TPM) is enabled on the instance. */ isTrustedPlatformModuleEnabled: boolean; /** * The number of NUMA nodes per socket (NPS). */ numaNodesPerSocket: string; /** * 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. */ percentageOfCoresEnabled: number; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionAction: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfigPreemptionAction; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsShapeConfig { /** * 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`. */ baselineOcpuUtilization: string; /** * 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. */ localVolumeSizeInGbs: number; /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; /** * This field is reserved for internal use. */ resourceManagement: string; /** * 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. */ vcpus: number; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetails { /** * The OCID of the boot volume used to boot the instance. */ bootVolumeId: string; /** * The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. */ bootVolumeVpusPerGb: string; /** * The OCID of the image used to boot the instance. */ imageId: string; /** * These are the criteria for selecting an image. This is required if imageId is not specified. */ instanceSourceImageFilterDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the instance configuration. */ compartmentId: string; /** * 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). */ definedTagsFilter: { [key: string]: string; }; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; } interface InstanceConfigurationInstanceDetailsOptionSecondaryVnic { /** * 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. */ createVnicDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetails; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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). */ nicIndex: number; } interface InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetails { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface InstanceConfigurationInstanceDetailsSecondaryVnic { /** * 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. */ createVnicDetails: outputs.Core.InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetails; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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). */ nicIndex: number; } interface InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetails { /** * 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. */ assignIpv6ip: boolean; /** * 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. */ assignPrivateDnsRecord?: boolean; /** * 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. */ assignPublicIp: boolean; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * 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. */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail[]; /** * 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/). */ nsgIds?: string[]; /** * 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. */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * 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. */ skipSourceDestCheck: boolean; /** * 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. */ subnetCidr: string; /** * 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. */ subnetId: string; } interface InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail { /** * Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned). */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface InstanceCreateVnicDetails { /** * 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. */ assignIpv6ip: boolean; /** * 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. * If you specify a `hostnameLabel`, the `assignPrivateDnsRecord` is require to be set to true. */ assignPrivateDnsRecord?: boolean; /** * (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. * * **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). * * **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). * * Example: `false` * * If you specify a `vlanId`, then `assignPublicIp` must be set to false. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan). */ assignPublicIp?: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * (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, `bminstance1` 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). * * For more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm). * * When 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. * * Example: `bminstance1` * * If 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). */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail[]; /** * (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/). * * If 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). */ nsgIds: string[]; /** * 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). * * If you specify a `vlanId`, the `privateIp` cannot be specified. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan). * * If you specify a 'privateIpId', the 'privateIp' cannot be specified. * * Example: `10.0.3.3` */ privateIp: string; /** * 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. */ privateIpId: string; /** * [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"}` */ securityAttributes: { [key: string]: string; }; /** * (Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). * * If 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). * * Example: `true` */ skipSourceDestCheck: boolean; /** * 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` */ subnetCidr: string; /** * 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. * * If 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. */ subnetId: string; /** * 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). * * Provide a `vlanId` instead of a `subnetId`. If you provide both a `vlanId` and `subnetId`, the request fails. */ vlanId: string; } interface InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail { /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. If an IPv6 address is not provided: * * 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. * * Oracle will automatically assign an IPv6 address from the subnet's IPv6 Oracle GUA prefix if it exists on the subnet. */ ipv6address: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * The IPv6 prefix allocated to the subnet. */ ipv6subnetCidr: string; } interface InstanceInstanceOptions { /** * (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. */ areLegacyImdsEndpointsDisabled: boolean; } interface InstanceLaunchOptions { /** * (Updatable) Emulation type for the boot volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ bootVolumeType: string; /** * Firmware used to boot VM. Select the option that matches your operating system. * * `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. * * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images. */ firmware: string; /** * Whether to enable consistent volume naming feature. Defaults to false. */ isConsistentVolumeNamingEnabled: boolean; /** * (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). */ isPvEncryptionInTransitEnabled: boolean; /** * (Updatable) Emulation type for the physical network interface card (NIC). * * `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. * * `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. * * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers. * * `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type. */ networkType: string; /** * Emulation type for volume. * * `ISCSI` - ISCSI attached block storage device. * * `SCSI` - Emulated SCSI disk. * * `IDE` - Emulated IDE disk. * * `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images. * * `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. */ remoteDataVolumeType: string; } interface InstanceLaunchVolumeAttachment { /** * 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). */ device: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Refer the top-level definition of encryptionInTransitType. The default value is NONE. */ encryptionInTransitType: string; /** * 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. */ isAgentAutoIscsiLoginEnabled: boolean; /** * Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false. */ isPvEncryptionInTransitEnabled: boolean; /** * Whether the attachment was created in read-only mode. */ isReadOnly: boolean; /** * 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. */ isShareable: boolean; /** * Define a volume that will be created and attached or attached to an instance on creation. */ launchCreateVolumeDetails: outputs.Core.InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails; /** * The type of volume attachment. Currently, the only supported values are "iscsi" and "paravirtualized". */ type: string; /** * Whether to use CHAP authentication for the volume attachment. Defaults to false. */ useChap: boolean; /** * The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request. */ volumeId: string; } interface InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails { /** * (Updatable) The OCID of the compartment that contains the volume. If not provided, it will be inherited from the instance. */ compartmentId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * The size of the volume in GBs. */ sizeInGbs: string; /** * Specifies the method for volume creation. */ volumeCreationType: string; /** * 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. * * Allowed values: */ vpusPerGb: string; } interface InstanceLicensingConfigs { /** * (Updatable) License Type for the OS license. * * `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour). * * `BRING_YOUR_OWN_LICENSE` - Bring your own license. * * `PARTNER_PROVIDED` - Partner provided license. */ licenseType: string; /** * The Operating System version of the license config. */ osVersion: string; /** * (Updatable) Operating System type of the Configuration. */ type: string; } interface InstancePlacementConstraintDetails { /** * The OCID of the compute bare metal host. */ computeBareMetalHostId: string; /** * The OCID of the compute host group. */ computeHostGroupId: string; /** * Determines the type of targeted launch. */ type: string; } interface InstancePlatformConfig { /** * Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. */ areVirtualInstructionsEnabled: boolean; /** * Instance Platform Configuration Configuration Map for flexible setting input. */ configMap: { [key: string]: string; }; /** * 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. */ isAccessControlServiceEnabled: boolean; /** * Whether the input-output memory management unit is enabled. */ isInputOutputMemoryManagementUnitEnabled: boolean; /** * Whether the Measured Boot feature is enabled on the instance. */ isMeasuredBootEnabled: boolean; /** * Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`. */ isMemoryEncryptionEnabled: boolean; /** * Whether Secure Boot is enabled on the instance. */ isSecureBootEnabled: boolean; /** * (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. * * Intel 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. */ isSymmetricMultiThreadingEnabled: boolean; /** * Whether the Trusted Platform Module (TPM) is enabled on the instance. */ isTrustedPlatformModuleEnabled: boolean; /** * The number of NUMA nodes per socket (NPS). */ numaNodesPerSocket: string; /** * 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. * * If 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. */ percentageOfCoresEnabled: number; /** * The type of platform being configured. */ type: string; } interface InstancePoolInstanceLoadBalancerBackend { /** * The health of the backend as observed by the load balancer. */ backendHealthStatus: string; /** * The name of the backend in the backend set. */ backendName: string; /** * The name of the backend set on the load balancer. */ backendSetName: string; /** * The OCID of the load balancer attached to the instance pool. */ loadBalancerId: string; /** * The lifecycle state of the instance. Refer to `lifecycleState` in the [Instance](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Instance) resource. */ state: string; } interface InstancePoolLifecycleManagement { /** * (Updatable) The lifecycle actions for the instance pool. */ lifecycleActions: outputs.Core.InstancePoolLifecycleManagementLifecycleActions; } interface InstancePoolLifecycleManagementLifecycleActions { /** * (Updatable) The data for pre-termination action for an instance pool */ preTermination: outputs.Core.InstancePoolLifecycleManagementLifecycleActionsPreTermination; } interface InstancePoolLifecycleManagementLifecycleActionsPreTermination { /** * (Updatable) Whether pre-termination action is enabled or not. */ isEnabled: boolean; /** * (Updatable) Options to handle timeout for pre-termination action. */ onTimeout: outputs.Core.InstancePoolLifecycleManagementLifecycleActionsPreTerminationOnTimeout; /** * (Updatable) The timeout in seconds for pre-termination action for an instance pool(min = 0 sec, max = 7200 secs). */ timeout: number; } interface InstancePoolLifecycleManagementLifecycleActionsPreTerminationOnTimeout { /** * (Updatable) Whether the block volume should be preserved after termination. */ preserveBlockVolumeMode: string; /** * (Updatable) Whether the boot volume should be preserved after termination. */ preserveBootVolumeMode: string; } interface InstancePoolLoadBalancer { /** * The name of the backend set on the load balancer to add instances to. */ backendSetName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment. */ instancePoolId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer to attach to the instance pool. */ loadBalancerId: string; /** * The port value to use when creating the backend set. */ port: number; /** * (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. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ state: string; /** * 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. */ vnicSelection: string; } interface InstancePoolPlacementConfiguration { /** * (Updatable) The availability domain to place instances. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * 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. * * Make 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. */ computeClusterId?: string; /** * (Updatable) The fault domains to place instances. * * If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. * * To 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. * * To 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. * * Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]` */ faultDomains: string[]; /** * (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. */ primarySubnetId: string; /** * (Updatable) Details about the IPv6 primary subnet. */ primaryVnicSubnets: outputs.Core.InstancePoolPlacementConfigurationPrimaryVnicSubnets; /** * (Updatable) The set of secondary VNIC data for instances in the pool. */ secondaryVnicSubnets: outputs.Core.InstancePoolPlacementConfigurationSecondaryVnicSubnet[]; } interface InstancePoolPlacementConfigurationPrimaryVnicSubnets { /** * (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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.InstancePoolPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail[]; /** * (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. */ isAssignIpv6ip: boolean; /** * (Updatable) The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface InstancePoolPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail { /** * (Updatable) Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface InstancePoolPlacementConfigurationSecondaryVnicSubnet { /** * (Updatable) The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC. */ displayName: string; /** * (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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.InstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail[]; /** * (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. */ isAssignIpv6ip: boolean; /** * (Updatable) The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC. */ subnetId: string; } interface InstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail { /** * (Updatable) Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. */ ipv6subnetCidr: string; } interface InstancePreemptibleInstanceConfig { /** * The action to run when the preemptible instance is interrupted for eviction. */ preemptionAction: outputs.Core.InstancePreemptibleInstanceConfigPreemptionAction; } interface InstancePreemptibleInstanceConfigPreemptionAction { /** * 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. */ preserveBootVolume: boolean; /** * The type of action to run when the instance is interrupted for eviction. */ type: string; } interface InstanceShapeConfig { /** * (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`. * * The following values are supported: * * `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. * * `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. * * `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance. */ baselineOcpuUtilization: string; /** * A short description of the instance's graphics processing unit (GPU). */ gpuDescription: string; /** * The number of GPUs available to the instance. */ gpus: number; /** * A short description of the local disks available to this instance. */ localDiskDescription: string; /** * The number of local disks available to the instance. */ localDisks: number; /** * The aggregate size of all local disks, in gigabytes. */ localDisksTotalSizeInGbs: number; /** * (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. */ localVolumeSizeInGbs: number; /** * The maximum number of VNIC attachments for the instance. */ maxVnicAttachments: number; /** * (Updatable) The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The networking bandwidth available to the instance, in gigabits per second. */ networkingBandwidthInGbps: number; /** * (Updatable) The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. */ nvmes: number; /** * (Updatable) The total number of OCPUs available to the instance. */ ocpus: number; /** * A short description of the instance's processor (CPU). */ processorDescription: string; /** * (Updatable) This field is reserved for internal use. */ resourceManagement: string; /** * (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. */ vcpus: number; } interface InstanceSourceDetails { /** * (Updatable) The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB). */ bootVolumeSizeInGbs: string; /** * 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. * * Allowed values: */ bootVolumeVpusPerGb: string; /** * These are the criteria for selecting an image. This is required if imageId is not specified. */ instanceSourceImageFilterDetails: outputs.Core.InstanceSourceDetailsInstanceSourceImageFilterDetails; /** * (Updatable) Whether to preserve the boot volume that was previously attached to the instance after a successful replacement of that boot volume. */ isPreserveBootVolumeEnabled?: boolean; /** * (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume. */ kmsKeyId?: string; /** * (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. */ sourceId: string; /** * (Updatable) The source type for the instance. Use `image` when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. */ sourceType: string; } interface InstanceSourceDetailsInstanceSourceImageFilterDetails { /** * (Updatable) The OCID of the compartment containing images to search */ compartmentId: string; /** * 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). */ definedTagsFilter: { [key: string]: string; }; /** * The image's operating system. Example: `Oracle Linux` */ operatingSystem: string; /** * The image's operating system version. Example: `7.2` */ operatingSystemVersion: string; } interface IpsecConnectionTunnelManagementBgpSessionInfo { /** * The state of the BGP IPv6 session. */ bgpIpv6State: string; /** * @deprecated The 'bgp_session_info.0.bgp_ipv6state' field has been deprecated. Please use 'bgp_session_info.0.bgp_ipv6_state' instead. */ bgpIpv6state: string; /** * The state of the BGP session. */ bgpState: string; /** * If the tunnel's `routing` 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. * * If the tunnel's `routing` attribute is set to `STATIC`, the `customerBgpAsn` must be null. * * Example: `12345` (2-byte) or `1587232876` (4-byte) */ customerBgpAsn: string; /** * The IP address for the CPE end of the inside tunnel interface. * * If the tunnel's `routing` 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. * * If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP address to troubleshoot or monitor the tunnel. * * The value must be a /30 or /31. * * Example: `10.0.0.5/31` */ customerInterfaceIp: string; /** * The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional. * * If the tunnel's `routing` 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. * * If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel. * * Only subnet masks from /64 up to /127 are allowed. * * Example: `2001:db8::1/64` */ customerInterfaceIpv6: string; /** * The Oracle BGP ASN. */ oracleBgpAsn: string; /** * The IP address for the Oracle end of the inside tunnel interface. * * If the tunnel's `routing` 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. * * If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP address to troubleshoot or monitor the tunnel. * * The value must be a /30 or /31. * * Example: `10.0.0.4/31` */ oracleInterfaceIp: string; /** * The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional. * * If the tunnel's `routing` 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. * * If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel. * * Only subnet masks from /64 up to /127 are allowed. * * Example: `2001:db8::1/64` */ oracleInterfaceIpv6: string; } interface IpsecConnectionTunnelManagementDpdConfig { /** * This option defines whether DPD can be initiated from the Oracle side of the connection. `INITIATE_AND_RESPOND` or `RESPOND_ONLY` */ dpdMode?: string; /** * 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. */ dpdTimeoutInSec?: number; } interface IpsecConnectionTunnelManagementEncryptionDomainConfig { /** * Lists IPv4 or IPv6-enabled subnets in your on-premises network. */ cpeTrafficSelectors: string[]; /** * Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy. */ oracleTrafficSelectors: string[]; } interface IpsecConnectionTunnelManagementPhaseOneDetails { /** * The custom authentication algorithm proposed during phase one tunnel negotiation. */ customAuthenticationAlgorithm: string; /** * The custom Diffie-Hellman group proposed during phase one tunnel negotiation. */ customDhGroup: string; /** * The custom encryption algorithm proposed during phase one tunnel negotiation. */ customEncryptionAlgorithm: string; /** * Indicates whether custom configuration is enabled for phase one options. */ isCustomPhaseOneConfig: boolean; /** * Indicates whether IKE phase one is established. */ isIkeEstablished: boolean; /** * Internet key association (IKE) session key lifetime in seconds for IPSec phase one. The default is 28800 which is equivalent to 8 hours. */ lifetime: number; /** * The negotiated phase two authentication algorithm. */ negotiatedAuthenticationAlgorithm: string; /** * The negotiated Diffie-Hellman group. */ negotiatedDhGroup: string; /** * The negotiated encryption algorithm. */ negotiatedEncryptionAlgorithm: string; /** * @deprecated The 'phase_one_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_one_details.0.remaining_lifetime_int' instead. */ remainingLifetime: string; /** * The remaining lifetime before the key is refreshed. */ remainingLifetimeInt: number; /** * 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` */ remainingLifetimeLastRetrieved: string; } interface IpsecConnectionTunnelManagementPhaseTwoDetails { /** * The authentication algorithm proposed during phase two tunnel negotiation. */ customAuthenticationAlgorithm: string; /** * The encryption algorithm proposed during phase two tunnel negotiation. */ customEncryptionAlgorithm: string; /** * The Diffie-Hellman group used for PFS, if PFS is enabled. */ dhGroup: string; /** * Indicates whether custom configuration is enabled for phase two options. */ isCustomPhaseTwoConfig: boolean; /** * Indicates that ESP phase two is established. */ isEspEstablished: boolean; /** * Indicates whether perfect forward secrecy (PFS) is enabled. */ isPfsEnabled: boolean; /** * Lifetime in seconds for the IPSec session key set in phase two. The default is 3600 which is equivalent to 1 hour. */ lifetime: number; /** * The negotiated phase two authentication algorithm. */ negotiatedAuthenticationAlgorithm: string; /** * The negotiated Diffie-Hellman group. */ negotiatedDhGroup: string; /** * The negotiated encryption algorithm. */ negotiatedEncryptionAlgorithm: string; /** * @deprecated The 'phase_two_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_two_details.0.remaining_lifetime_int' instead. */ remainingLifetime: string; /** * The remaining lifetime before the key is refreshed. */ remainingLifetimeInt: number; /** * 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` */ remainingLifetimeLastRetrieved: string; } interface IpsecTunnelConfiguration { associatedVirtualCircuits: string[]; drgRouteTableId: string; oracleTunnelIp: string; } interface NetworkSecurityGroupSecurityRuleIcmpOptions { /** * The ICMP code (optional). */ code?: number; /** * The ICMP type. */ type: number; } interface NetworkSecurityGroupSecurityRuleTcpOptions { destinationPortRange?: outputs.Core.NetworkSecurityGroupSecurityRuleTcpOptionsDestinationPortRange; sourcePortRange?: outputs.Core.NetworkSecurityGroupSecurityRuleTcpOptionsSourcePortRange; } interface NetworkSecurityGroupSecurityRuleTcpOptionsDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface NetworkSecurityGroupSecurityRuleTcpOptionsSourcePortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface NetworkSecurityGroupSecurityRuleUdpOptions { destinationPortRange: outputs.Core.NetworkSecurityGroupSecurityRuleUdpOptionsDestinationPortRange; sourcePortRange: outputs.Core.NetworkSecurityGroupSecurityRuleUdpOptionsSourcePortRange; } interface NetworkSecurityGroupSecurityRuleUdpOptionsDestinationPortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface NetworkSecurityGroupSecurityRuleUdpOptionsSourcePortRange { /** * 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. */ max: number; /** * The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface RouteTableRouteRule { /** * (Updatable) Deprecated. Instead use `destination` and `destinationType`. Requests that include both `cidrBlock` and `destination` will be rejected. * * A destination IP address range in CIDR notation. Matching packets will be routed to the indicated network entity (the target). * * Cannot be an IPv6 prefix. * * Example: `0.0.0.0/0` * * @deprecated The 'cidr_block' field has been deprecated. Please use 'destination' instead. */ cidrBlock: string; /** * (Updatable) An optional description of your choice for the rule. */ description: string; /** * (Updatable) Conceptually, this is the range of IP addresses used for matching when routing traffic. Required if you provide a `destinationType`. * * Allowed values: * * 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). * * 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`. */ destination: string; /** * (Updatable) Type of destination for the rule. Required if you provide a `destination`. * * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. * * `SERVICE_CIDR_BLOCK`: If the rule's `destination` 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). */ destinationType: string; /** * (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). */ networkEntityId: string; /** * (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. */ routeType: string; } interface SecurityListEgressSecurityRule { /** * (Updatable) An optional description of your choice for the rule. */ description: string; /** * (Updatable) Conceptually, this is the range of IP addresses that a packet originating from the instance can go to. * * Allowed values: * * 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). * * 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`. */ destination: string; /** * (Updatable) Type of destination for the rule. The default is `CIDR_BLOCK`. * * Allowed values: * * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. * * `SERVICE_CIDR_BLOCK`: If the rule's `destination` 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). */ destinationType: string; /** * (Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) * * If 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. */ icmpOptions?: outputs.Core.SecurityListEgressSecurityRuleIcmpOptions; /** * (Updatable) The transport protocol. Specify either `all` 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"). */ protocol: string; /** * (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. */ stateless: boolean; /** * (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. */ tcpOptions?: outputs.Core.SecurityListEgressSecurityRuleTcpOptions; /** * (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. */ udpOptions?: outputs.Core.SecurityListEgressSecurityRuleUdpOptions; } interface SecurityListEgressSecurityRuleIcmpOptions { /** * (Updatable) The ICMP code (optional). */ code?: number; /** * (Updatable) The ICMP type. */ type: number; } interface SecurityListEgressSecurityRuleTcpOptions { /** * 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. */ max?: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min?: number; /** * (Updatable) */ sourcePortRange?: outputs.Core.SecurityListEgressSecurityRuleTcpOptionsSourcePortRange; } interface SecurityListEgressSecurityRuleTcpOptionsSourcePortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface SecurityListEgressSecurityRuleUdpOptions { /** * 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. */ max?: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min?: number; /** * (Updatable) */ sourcePortRange?: outputs.Core.SecurityListEgressSecurityRuleUdpOptionsSourcePortRange; } interface SecurityListEgressSecurityRuleUdpOptionsSourcePortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface SecurityListIngressSecurityRule { /** * (Updatable) An optional description of your choice for the rule. */ description: string; /** * (Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: * * [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) * * [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) * * If 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. */ icmpOptions?: outputs.Core.SecurityListIngressSecurityRuleIcmpOptions; /** * (Updatable) The transport protocol. Specify either `all` 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"). */ protocol: string; /** * (Updatable) Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. * * Allowed values: * * 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). * * 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`. */ source: string; /** * (Updatable) Type of source for the rule. The default is `CIDR_BLOCK`. * * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation. * * `SERVICE_CIDR_BLOCK`: If the rule's `source` 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). */ sourceType: string; /** * (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. */ stateless?: boolean; /** * (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. */ tcpOptions?: outputs.Core.SecurityListIngressSecurityRuleTcpOptions; /** * (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. */ udpOptions?: outputs.Core.SecurityListIngressSecurityRuleUdpOptions; } interface SecurityListIngressSecurityRuleIcmpOptions { /** * (Updatable) The ICMP code (optional). */ code?: number; /** * (Updatable) The ICMP type. */ type: number; } interface SecurityListIngressSecurityRuleTcpOptions { /** * 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. */ max?: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min?: number; /** * (Updatable) */ sourcePortRange?: outputs.Core.SecurityListIngressSecurityRuleTcpOptionsSourcePortRange; } interface SecurityListIngressSecurityRuleTcpOptionsSourcePortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number. Must not be greater than the maximum port number. */ min: number; } interface SecurityListIngressSecurityRuleUdpOptions { /** * 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. */ max?: number; /** * The minimum port number. Must not be greater than the maximum port number. */ min?: number; /** * (Updatable) */ sourcePortRange?: outputs.Core.SecurityListIngressSecurityRuleUdpOptionsSourcePortRange; } interface SecurityListIngressSecurityRuleUdpOptionsSourcePortRange { /** * (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. */ max: number; /** * (Updatable) The minimum port number, which must not be greater than the maximum port number. */ min: number; } interface ServiceGatewayService { /** * (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/). */ serviceId: string; /** * The name of the service. */ serviceName: string; } interface VcnByoipv6cidrDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. */ byoipv6rangeId: string; /** * 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` * * When updating `byoipv6cidrDetails`, 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. */ ipv6cidrBlock: string; } interface VirtualCircuitCrossConnectMapping { /** * (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. */ bgpMd5authKey: string; /** * (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). */ crossConnectOrCrossConnectGroupId: string; /** * (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. * * There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. * * Example: `10.0.0.18/31` */ customerBgpPeeringIp: string; /** * (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. * * There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. * * IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm). * * Example: `2001:db8::1/64` */ customerBgpPeeringIpv6: string; /** * (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. * * There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. * * Example: `10.0.0.19/31` */ oracleBgpPeeringIp: string; /** * (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. * * There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. * * 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). * * Example: `2001:db8::2/64` */ oracleBgpPeeringIpv6: string; /** * (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: `200` */ vlan: number; } interface VirtualCircuitPublicPrefix { /** * (Updatable) An individual public IP prefix (CIDR) to add to the public virtual circuit. All prefix sizes are allowed. */ cidrBlock: string; } interface VirtualCircuitVirtualCircuitRedundancyMetadata { /** * The configured redundancy level of the virtual circuit. */ configuredRedundancyLevel: string; /** * Indicates if the configured level is met for IPv4 BGP redundancy. */ ipv4bgpSessionRedundancyStatus: string; /** * Indicates if the configured level is met for IPv6 BGP redundancy. */ ipv6bgpSessionRedundancyStatus: string; } interface VirtualNetworkByoipv6cidrDetail { byoipv6rangeId: string; ipv6cidrBlock: string; } interface VnicAttachmentCreateVnicDetails { /** * 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. */ assignIpv6ip: boolean; /** * 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: `true` * * If you specify a `hostnameLabel`, the `assignPrivateDnsRecord` is require to be set to true. */ assignPrivateDnsRecord?: boolean; /** * 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. * * **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). * * **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). * * Example: `false` * * If you specify a `vlanId`, then `assignPublicIp` must be set to false. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan). */ assignPublicIp?: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * (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, `bminstance1` 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). * * For more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm). * * When 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. * * Example: `bminstance1` * * If 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). */ hostnameLabel: string; /** * 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. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Core.VnicAttachmentCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail[]; /** * (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/). * * If 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). */ nsgIds?: string[]; /** * 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). * * If you specify a `vlanId`, the `privateIp` cannot be specified. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan). * * If you specify a 'privateIpId', the 'privateIp' cannot be specified. * * Example: `10.0.3.3` */ privateIp: string; /** * 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. */ privateIpId: string; routeTableId?: string; /** * [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"}` */ securityAttributes: { [key: string]: string; }; /** * (Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to `false`, 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). * * If 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). * * Example: `true` */ skipSourceDestCheck: boolean; /** * 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` */ subnetCidr: string; /** * 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. * * If 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. */ subnetId: string; /** * 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). * * Provide a `vlanId` instead of a `subnetId`. If you provide both a `vlanId` and `subnetId`, the request fails. */ vlanId: string; } interface VnicAttachmentCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail { /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. If an IPv6 address is not provided: * * 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. * * Oracle will automatically assign an IPv6 address from the subnet's IPv6 Oracle GUA prefix if it exists on the subnet. */ ipv6address?: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use. */ ipv6id: string; /** * The IPv6 prefix allocated to the subnet. */ ipv6subnetCidr?: string; } interface VolumeAttachmentMultipathDevice { /** * The volume's iSCSI IP address. Example: `169.254.2.2` */ ipv4: string; /** * 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` */ iqn: string; /** * The volume's iSCSI port, usually port 860 or 3260. Example: `3260` */ port: number; } interface VolumeAutotunePolicy { /** * (Updatable) This specifies the type of autotunes supported by OCI. */ autotuneType: string; /** * (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring. */ maxVpusPerGb: string; } interface VolumeBackupPolicySchedule { /** * (Updatable) The type of volume backup to create. */ backupType: string; /** * (Updatable) The day of the month to schedule the volume backup. */ dayOfMonth?: number; /** * (Updatable) The day of the week to schedule the volume backup. */ dayOfWeek?: string; /** * (Updatable) The hour of the day to schedule the volume backup. */ hourOfDay?: number; /** * (Updatable) Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. */ isPreventDeletionEnabled: boolean; /** * (Updatable) feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. */ isRetentionLockEnabled: boolean; /** * (Updatable) The month of the year to schedule the volume backup. */ month?: string; /** * (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. */ offsetSeconds?: number; /** * (Updatable) Indicates how the offset is defined. If value is `STRUCTURED`, then `hourOfDay`, `dayOfWeek`, `dayOfMonth`, and `month` fields are used and `offsetSeconds` will be ignored in requests and users should ignore its value from the responses. * * `hourOfDay` is applicable for periods `ONE_DAY`, `ONE_WEEK`, `ONE_MONTH` and `ONE_YEAR`. * * `dayOfWeek` is applicable for period `ONE_WEEK`. * * `dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`. * * 'month' is applicable for period 'ONE_YEAR'. * * They will be ignored in the requests for inapplicable periods. * * If 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. * * For clients using older versions of Apis and not sending `offsetType` in their requests, the behaviour is just like `NUMERIC_SECONDS`. */ offsetType?: string; /** * (Updatable) The volume backup frequency. */ period: string; /** * (Updatable) This field is used to define the retention period for backups. This is an optional field. If it is not specified, it is set to null, no retention period will be applied to the backups. */ retentionPeriod: outputs.Core.VolumeBackupPolicyScheduleRetentionPeriod; /** * (Updatable) How long, in seconds, to keep the volume backups created by this schedule. */ retentionSeconds: number; /** * (Updatable) Specifies what time zone is the schedule in * enum: * - `UTC` * - `REGIONAL_DATA_CENTER_TIME` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ timeZone: string; } interface VolumeBackupPolicyScheduleRetentionPeriod { /** * (Updatable) The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period. */ retentionTimeAmount: number; /** * (Updatable) The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS". */ retentionTimeUnit: string; } interface VolumeBackupRetentionPeriod { /** * (Updatable) The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period. */ retentionTimeAmount: number; /** * (Updatable) The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS". */ retentionTimeUnit: string; } interface VolumeBackupSourceDetails { /** * The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup. */ kmsKeyId?: string; /** * The region of the volume backup source. */ region: string; /** * The OCID of the source volume backup. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ volumeBackupId: string; } interface VolumeBlockVolumeReplica { /** * (Updatable) The availability domain of the block volume replica. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The block volume replica's Oracle ID (OCID). */ blockVolumeReplicaId: string; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * (Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume. */ kmsKeyId: string; /** * (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). */ xrrKmsKeyId: string; } interface VolumeGroupBackupRetentionPeriod { /** * (Updatable) The value to enter for the amount of retention time should be a numerical figure (such as 1, 7, 30, etc.) that corresponds to the period specified in the retention time unit property (such as YEARS, DAYS). The combination of these two properties determines the total length of the retention period. */ retentionTimeAmount: number; /** * (Updatable) The value you can assign to the Time Unit property for this Duration may be either "YEARS" or "DAYS". */ retentionTimeUnit: string; } interface VolumeGroupBackupSourceDetails { /** * The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup. */ kmsKeyId?: string; /** * The region of the volume backup source. */ region: string; /** * The OCID of the source volume group backup. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ volumeGroupBackupId: string; } interface VolumeGroupSourceDetails { /** * The type can be one of these values: `volumeGroupBackupId`, `volumeGroupId`, `volumeGroupReplicaId`, `volumeIds` */ type: string; /** * The OCID of the volume group backup to restore from. */ volumeGroupBackupId?: string; /** * The OCID of the volume group to clone from. */ volumeGroupId?: string; /** * The OCID of the volume group replica. */ volumeGroupReplicaId?: string; /** * OCIDs for the volumes used to create this volume group. */ volumeIds?: string[]; } interface VolumeGroupVolumeGroupReplica { /** * (Updatable) The availability domain of the volume group replica. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The volume group replica's Oracle ID (OCID). */ volumeGroupReplicaId: string; /** * (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). */ xrrKmsKeyId: string; } interface VolumeSourceDetails { /** * 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). */ changeBlockSizeInBytes?: string; /** * The OCID of the first volume backup. */ firstBackupId?: string; /** * The OCID of the block volume replica. */ id?: string; /** * The OCID of the second volume backup. */ secondBackupId?: string; /** * The type can be one of these values: `blockVolumeReplica`, `volume`, `volumeBackup`, `volumeBackupDelta` */ type: string; } } export declare namespace DataCatalog { interface CatalogLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the data catalog was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface CatalogPrivateEndpointLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the private endpoint was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetCatalogLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the data catalog was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetCatalogPrivateEndpointLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the private endpoint was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetCatalogPrivateEndpointsCatalogPrivateEndpoint { /** * The list of catalogs using the private reverse connection endpoint */ attachedCatalogs: string[]; /** * The OCID of the compartment where you want to list resources. */ compartmentId: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com */ dnsZones: string[]; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.DataCatalog.GetCatalogPrivateEndpointsCatalogPrivateEndpointLock[]; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * Subnet Identifier */ subnetId: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The time the private endpoint was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * The time the private endpoint was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeUpdated: string; } interface GetCatalogPrivateEndpointsCatalogPrivateEndpointLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the private endpoint was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetCatalogPrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetCatalogTypesFilter { /** * Immutable resource name. */ name: string; regex?: boolean; values: string[]; } interface GetCatalogTypesTypeCollection { count: number; items: outputs.DataCatalog.GetCatalogTypesTypeCollectionItem[]; } interface GetCatalogTypesTypeCollectionItem { /** * Unique catalog identifier. */ catalogId: string; /** * Detailed description of the type. */ description: string; /** * Unique type key that is immutable. */ key: string; /** * Immutable resource name. */ name: string; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * Indicates the category of this type . For example, data assets or connections. */ typeCategory: string; /** * URI to the type instance in the API. */ uri: string; } interface GetCatalogsCatalog { /** * The list of private reverse connection endpoints attached to the catalog */ attachedCatalogPrivateEndpoints: string[]; /** * The OCID of the compartment where you want to list resources. */ compartmentId: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation. */ id: string; /** * An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in 'Failed' state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.DataCatalog.GetCatalogsCatalogLock[]; /** * The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated. */ numberOfObjects: number; /** * The REST front endpoint URL to the data catalog instance. */ serviceApiUrl: string; /** * The console front endpoint URL to the data catalog instance. */ serviceConsoleUrl: string; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The time the data catalog was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * The time the data catalog was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeUpdated: string; } interface GetCatalogsCatalogLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the data catalog was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetCatalogsFilter { name: string; regex?: boolean; values: string[]; } interface GetConnectionsConnectionCollection { count: number; items: outputs.DataCatalog.GetConnectionsConnectionCollectionItem[]; } interface GetConnectionsConnectionCollectionItem { /** * Unique catalog identifier. */ catalogId: string; /** * OCID of the user who created the resource. */ createdById: string; /** * Unique data asset key. */ dataAssetKey: string; /** * A description of the connection. */ description: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; encProperties?: { [key: string]: string; }; /** * Unique external identifier of this resource in the external source system. */ externalKey: string; /** * Indicates whether this connection is the default connection. */ isDefault: boolean; /** * Unique connection key that is immutable. */ key: string; /** * A map of maps that contains the properties which are specific to the connection type. Each connection type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the "default" category. Example: `{"properties": { "default": { "username": "user1"}}}` */ properties: { [key: string]: string; }; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Time that the resource's status was last updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeStatusUpdated: string; /** * Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeUpdated: string; /** * The key of the object type. Type key's can be found via the '/types' endpoint. */ typeKey: string; /** * OCID of the user who updated the resource. */ updatedById: string; /** * URI to the connection instance in the API. */ uri: string; } interface GetConnectionsFilter { name: string; regex?: boolean; values: string[]; } interface GetDataAssetsDataAssetCollection { count: number; items: outputs.DataCatalog.GetDataAssetsDataAssetCollectionItem[]; } interface GetDataAssetsDataAssetCollectionItem { /** * Unique catalog identifier. */ catalogId: string; /** * OCID of the user who created the resource. */ createdById: string; /** * Detailed description of the data asset. */ description: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * Unique external identifier of this resource in the external source system. */ externalKey: string; /** * Unique data asset key that is immutable. */ key: string; /** * A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details. */ lifecycleDetails: string; /** * A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}` */ properties: { [key: string]: string; }; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * The last time that a harvest was performed on the data asset. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeHarvested: string; /** * Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeUpdated: string; /** * The key of the object type. */ typeKey: string; /** * OCID of the user who updated the resource. */ updatedById: string; /** * URI to the data asset instance in the API. */ uri: string; } interface GetDataAssetsFilter { name: string; regex?: boolean; values: string[]; } interface GetMetastoreLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * Time at which the metastore was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetMetastoresFilter { name: string; regex?: boolean; values: string[]; } interface GetMetastoresMetastore { /** * The OCID of the compartment where you want to list resources. */ compartmentId: string; /** * Location under which external tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/ */ defaultExternalTableLocation: string; /** * Location under which managed tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/ */ defaultManagedTableLocation: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The metastore's OCID. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.DataCatalog.GetMetastoresMetastoreLock[]; /** * A filter to return only resources that match the specified lifecycle state. The value is case insensitive. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * Time at which the metastore was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Time at which the metastore was last modified. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeUpdated: string; } interface GetMetastoresMetastoreLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * Time at which the metastore was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface MetastoreLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * Time at which the metastore was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } } export declare namespace DataFlow { interface ApplicationApplicationLogConfig { /** * (Updatable) The log group id for where log objects will be for Data Flow Runs. */ logGroupId: string; /** * (Updatable) The log id of the log object the Application Logs of Data Flow Run will be shipped to. */ logId: string; } interface ApplicationDriverShapeConfig { /** * (Updatable) The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface ApplicationExecutorShapeConfig { /** * (Updatable) The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface ApplicationParameter { /** * (Updatable) The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "inputFile" */ name: string; /** * (Updatable) The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}" */ value: string; } interface GetApplicationApplicationLogConfig { /** * The log group id for where log objects will be for Data Flow Runs. */ logGroupId: string; /** * The log id of the log object the Application Logs of Data Flow Run will be shipped to. */ logId: string; } interface GetApplicationDriverShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetApplicationExecutorShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetApplicationParameter { /** * The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "inputFile" */ name: string; /** * The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}" */ value: string; } interface GetApplicationsApplication { /** * Logging details of Application logs for Data Flow Run. */ applicationLogConfigs: outputs.DataFlow.GetApplicationsApplicationApplicationLogConfig[]; /** * A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. */ archiveUri: string; /** * The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as `Service Api Spec`, where `name` is the name of the parameter. Example: `[ "--input", "${input_file}", "--name", "John Doe" ]` If "inputFile" has a value of "mydata.xml", then the value above will be translated to `--input mydata.xml --name "John Doe"` */ arguments: string[]; /** * The class for the application. */ className: string; /** * The OCID of the compartment. */ compartmentId: string; /** * The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. */ configuration: { [key: string]: string; }; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description. */ description: string; /** * The query parameter for the Spark application name. */ displayName: string; /** * The VM shape for the driver. Sets the driver cores and memory. */ driverShape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ driverShapeConfigs: outputs.DataFlow.GetApplicationsApplicationDriverShapeConfig[]; /** * The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments. Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10`` Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only. */ execute: string; /** * The VM shape for the executors. Sets the executor cores and memory. */ executorShape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ executorShapeConfigs: outputs.DataFlow.GetApplicationsApplicationExecutorShapeConfig[]; /** * An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. */ fileUri: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The application ID. */ id: string; /** * The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days) */ idleTimeoutInMinutes: string; /** * The Spark language. */ language: string; /** * An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. */ logsBucketUri: string; /** * The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to `IN_PROGRESS` state. */ maxDurationInMinutes: string; /** * The OCID of Oracle Cloud Infrastructure Hive Metastore. */ metastoreId: string; /** * The number of executor VMs requested. */ numExecutors: number; /** * The OCID of the user who created the resource. */ ownerPrincipalId: string; /** * The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. */ ownerUserName: string; /** * An array of name/value pairs used to fill placeholders found in properties like `Application.arguments`. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "inputFile", value: "mydata.xml" }, { name: "variableX", value: "${x}"} ] */ parameters: outputs.DataFlow.GetApplicationsApplicationParameter[]; /** * The OCID of a pool. Unique Id to indentify a dataflow pool resource. */ poolId: string; /** * The OCID of a private endpoint. */ privateEndpointId: string; /** * The Spark version utilized to run the application. */ sparkVersion: string; /** * The current state of this application. */ state: string; terminateRunsOnDeletion: boolean; /** * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeCreated: string; /** * The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeUpdated: string; /** * The Spark application processing type. */ type: string; /** * An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. */ warehouseBucketUri: string; } interface GetApplicationsApplicationApplicationLogConfig { /** * The log group id for where log objects will be for Data Flow Runs. */ logGroupId: string; /** * The log id of the log object the Application Logs of Data Flow Run will be shipped to. */ logId: string; } interface GetApplicationsApplicationDriverShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetApplicationsApplicationExecutorShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetApplicationsApplicationParameter { /** * The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "inputFile" */ name: string; /** * The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}" */ value: string; } interface GetApplicationsFilter { /** * The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "inputFile" */ name: string; regex?: boolean; values: string[]; } interface GetInvokeRunApplicationLogConfig { /** * The log group id for where log objects will be for Data Flow Runs. */ logGroupId: string; /** * The log id of the log object the Application Logs of Data Flow Run will be shipped to. */ logId: string; } interface GetInvokeRunDriverShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetInvokeRunExecutorShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetInvokeRunParameter { /** * The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "inputFile" */ name: string; /** * The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}" */ value: string; } interface GetInvokeRunsFilter { /** * The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "inputFile" */ name: string; regex?: boolean; values: string[]; } interface GetInvokeRunsRun { /** * The ID of the application. */ applicationId: string; /** * Logging details of Application logs for Data Flow Run. */ applicationLogConfigs: outputs.DataFlow.GetInvokeRunsRunApplicationLogConfig[]; /** * A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. */ archiveUri: string; /** * The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as `Service Api Spec`, where `name` is the name of the parameter. Example: `[ "--input", "${input_file}", "--name", "John Doe" ]` If "inputFile" has a value of "mydata.xml", then the value above will be translated to `--input mydata.xml --name "John Doe"` */ arguments: string[]; asynchronous: boolean; /** * The class for the application. */ className: string; /** * The OCID of the compartment. */ compartmentId: string; /** * The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. */ configuration: { [key: string]: string; }; /** * The data read by the run in bytes. */ dataReadInBytes: string; /** * The data written by the run in bytes. */ dataWrittenInBytes: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The query parameter for the Spark application name. */ displayName: string; /** * The VM shape for the driver. Sets the driver cores and memory. */ driverShape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ driverShapeConfigs: outputs.DataFlow.GetInvokeRunsRunDriverShapeConfig[]; /** * The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments. Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10`` Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only. */ execute: string; /** * The VM shape for the executors. Sets the executor cores and memory. */ executorShape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ executorShapeConfigs: outputs.DataFlow.GetInvokeRunsRunExecutorShapeConfig[]; /** * An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. */ fileUri: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The ID of a run. */ id: string; /** * The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days) */ idleTimeoutInMinutes: string; /** * The Spark language. */ language: string; /** * The detailed messages about the lifecycle state. */ lifecycleDetails: string; /** * An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. */ logsBucketUri: string; /** * The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to `IN_PROGRESS` state. */ maxDurationInMinutes: string; /** * The OCID of Oracle Cloud Infrastructure Hive Metastore. */ metastoreId: string; /** * The number of executor VMs requested. */ numExecutors: number; opcParentRptUrl: string; /** * Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. */ opcRequestId: string; /** * The OCID of the user who created the resource. */ ownerPrincipalId: string; /** * The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. */ ownerUserName: string; /** * An array of name/value pairs used to fill placeholders found in properties like `Application.arguments`. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "inputFile", value: "mydata.xml" }, { name: "variableX", value: "${x}"} ] */ parameters: outputs.DataFlow.GetInvokeRunsRunParameter[]; /** * The ID of the pool. */ poolId: string; /** * An array of DNS zone names. Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]` */ privateEndpointDnsZones: string[]; /** * The OCID of a private endpoint. */ privateEndpointId: string; /** * The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512. */ privateEndpointMaxHostCount: number; /** * An array of network security group OCIDs. */ privateEndpointNsgIds: string[]; /** * The OCID of a subnet. */ privateEndpointSubnetId: string; /** * The duration of the run in milliseconds. */ runDurationInMilliseconds: string; /** * The Spark version utilized to run the application. */ sparkVersion: string; /** * The LifecycleState of the run. */ state: string; /** * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeCreated: string; /** * The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeUpdated: string; /** * The total number of oCPU requested by the run. */ totalOcpu: number; /** * The Spark application processing type. */ type: string; /** * An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. */ warehouseBucketUri: string; } interface GetInvokeRunsRunApplicationLogConfig { /** * The log group id for where log objects will be for Data Flow Runs. */ logGroupId: string; /** * The log id of the log object the Application Logs of Data Flow Run will be shipped to. */ logId: string; } interface GetInvokeRunsRunDriverShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetInvokeRunsRunExecutorShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetInvokeRunsRunParameter { /** * The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "inputFile" */ name: string; /** * The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}" */ value: string; } interface GetPoolConfiguration { /** * Maximum number of compute instances in the pool for a given compute shape. */ max: number; /** * Minimum number of compute instances in the pool for a given compute shape. */ min: number; /** * The compute shape of the resources you would like to provision. */ shape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ shapeConfigs: outputs.DataFlow.GetPoolConfigurationShapeConfig[]; } interface GetPoolConfigurationShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetPoolPoolMetric { /** * The number of runs that are currently running that are using this pool. */ activeRunsCount: string; /** * A count of the nodes that are currently being used for each shape in this pool. */ activelyUsedNodeCounts: outputs.DataFlow.GetPoolPoolMetricActivelyUsedNodeCount[]; /** * The last time the mertics were updated for this. */ timeLastMetricsUpdated: string; /** * The last time this pool was started. */ timeLastStarted: string; /** * The last time this pool was stopped. */ timeLastStopped: string; /** * The last time a run used this pool. */ timeLastUsed: string; } interface GetPoolPoolMetricActivelyUsedNodeCount { /** * The compute shape of the nodes that the count is for. */ logicalShape: string; /** * The node count of this compute shape. */ poolCount: number; } interface GetPoolSchedule { /** * Day of the week SUN-SAT */ dayOfWeek: string; /** * Hour of the day to start or stop pool. */ startTime: number; /** * Hour of the day to stop the pool. */ stopTime: number; } interface GetPoolsFilter { name: string; regex?: boolean; values: string[]; } interface GetPoolsPoolCollection { items: outputs.DataFlow.GetPoolsPoolCollectionItem[]; } interface GetPoolsPoolCollectionItem { /** * The OCID of the compartment. */ compartmentId: string; /** * List of PoolConfig items. */ configurations: outputs.DataFlow.GetPoolsPoolCollectionItemConfiguration[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description. Avoid entering confidential information. */ description: string; /** * The query parameter for the Spark application name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of a pool. Unique Id to indentify a dataflow pool resource. */ id: string; /** * Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto. */ idleTimeoutInMinutes: number; /** * The detailed messages about the lifecycle state. */ lifecycleDetails: string; /** * The OCID of the user who created the resource. */ ownerPrincipalId: string; /** * The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. */ ownerUserName: string; /** * A collection of metrics related to a particular pool. */ poolMetrics: outputs.DataFlow.GetPoolsPoolCollectionItemPoolMetric[]; /** * A list of schedules for pool to auto start and stop. */ schedules: outputs.DataFlow.GetPoolsPoolCollectionItemSchedule[]; /** * The LifecycleState of the pool. */ state: string; /** * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeCreated: string; /** * The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeUpdated: string; } interface GetPoolsPoolCollectionItemConfiguration { /** * Maximum number of compute instances in the pool for a given compute shape. */ max: number; /** * Minimum number of compute instances in the pool for a given compute shape. */ min: number; /** * The compute shape of the resources you would like to provision. */ shape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ shapeConfigs: outputs.DataFlow.GetPoolsPoolCollectionItemConfigurationShapeConfig[]; } interface GetPoolsPoolCollectionItemConfigurationShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetPoolsPoolCollectionItemPoolMetric { /** * The number of runs that are currently running that are using this pool. */ activeRunsCount: string; /** * A count of the nodes that are currently being used for each shape in this pool. */ activelyUsedNodeCounts: outputs.DataFlow.GetPoolsPoolCollectionItemPoolMetricActivelyUsedNodeCount[]; /** * The last time the mertics were updated for this. */ timeLastMetricsUpdated: string; /** * The last time this pool was started. */ timeLastStarted: string; /** * The last time this pool was stopped. */ timeLastStopped: string; /** * The last time a run used this pool. */ timeLastUsed: string; } interface GetPoolsPoolCollectionItemPoolMetricActivelyUsedNodeCount { /** * The compute shape of the nodes that the count is for. */ logicalShape: string; /** * The node count of this compute shape. */ poolCount: number; } interface GetPoolsPoolCollectionItemSchedule { /** * Day of the week SUN-SAT */ dayOfWeek: string; /** * Hour of the day to start or stop pool. */ startTime: number; /** * Hour of the day to stop the pool. */ stopTime: number; } interface GetPrivateEndpointScanDetail { /** * A fully-qualified domain name (FQDN). */ fqdn: string; /** * The port number of the FQDN */ port: string; } interface GetPrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetPrivateEndpointsPrivateEndpointCollection { items: outputs.DataFlow.GetPrivateEndpointsPrivateEndpointCollectionItem[]; } interface GetPrivateEndpointsPrivateEndpointCollectionItem { /** * The OCID of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description. Avoid entering confidential information. */ description: string; /** * The query parameter for the Spark application name. Note: At a time only one optional filter can be used with `compartmentId` to get the list of Private Endpoint resources. */ displayName: string; /** * An array of DNS zone names. Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]` */ dnsZones: string[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of a private endpoint. */ id: string; /** * The detailed messages about the lifecycle state. */ lifecycleDetails: string; /** * The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512. */ maxHostCount: number; /** * An array of network security group OCIDs. */ nsgIds: string[]; /** * The OCID of the user who created the resource. */ ownerPrincipalId: string; /** * The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. */ ownerUserName: string; /** * An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ] */ scanDetails: outputs.DataFlow.GetPrivateEndpointsPrivateEndpointCollectionItemScanDetail[]; /** * The LifecycleState of the private endpoint. */ state: string; /** * The OCID of a subnet. */ subnetId: string; /** * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeCreated: string; /** * The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeUpdated: string; } interface GetPrivateEndpointsPrivateEndpointCollectionItemScanDetail { /** * A fully-qualified domain name (FQDN). */ fqdn: string; /** * The port number of the FQDN */ port: string; } interface GetRunLogsFilter { name: string; regex?: boolean; values: string[]; } interface GetRunLogsRunLog { name: string; /** * The unique ID for the run */ runId: string; sizeInBytes: string; source: string; timeCreated: string; type: string; } interface GetRunStatementOutput { /** * An object representing execution output of a statement. */ datas: outputs.DataFlow.GetRunStatementOutputData[]; /** * The name of the error in the statement output. */ errorName: string; /** * The value of the error in the statement output. */ errorValue: string; /** * Status of the statement output. */ status: string; /** * The traceback of the statement output. */ tracebacks: string[]; } interface GetRunStatementOutputData { /** * The type of the `StatementOutputData` like `TEXT_PLAIN`, `TEXT_HTML` or `IMAGE_PNG`. */ type: string; /** * The statement code execution output in html format. */ value: string; } interface GetRunStatementsFilter { name: string; regex?: boolean; values: string[]; } interface GetRunStatementsStatementCollection { items: outputs.DataFlow.GetRunStatementsStatementCollectionItem[]; } interface GetRunStatementsStatementCollectionItem { /** * The statement code to execute. Example: `println(sc.version)` */ code: string; /** * The statement ID. */ id: string; /** * The execution output of a statement. */ outputs: outputs.DataFlow.GetRunStatementsStatementCollectionItemOutput[]; /** * The execution progress. */ progress: number; /** * The unique ID for the run */ runId: string; /** * The LifecycleState of the statement. */ state: string; /** * The date and time a statement execution was completed, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-05-31T21:10:29.600Z` */ timeCompleted: string; /** * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeCreated: string; } interface GetRunStatementsStatementCollectionItemOutput { /** * An object representing execution output of a statement. */ datas: outputs.DataFlow.GetRunStatementsStatementCollectionItemOutputData[]; /** * The name of the error in the statement output. */ errorName: string; /** * The value of the error in the statement output. */ errorValue: string; /** * Status of the statement output. */ status: string; /** * The traceback of the statement output. */ tracebacks: string[]; } interface GetRunStatementsStatementCollectionItemOutputData { /** * The type of the `StatementOutputData` like `TEXT_PLAIN`, `TEXT_HTML` or `IMAGE_PNG`. */ type: string; /** * The statement code execution output in html format. */ value: string; } interface GetSqlEndpointDriverShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetSqlEndpointExecutorShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetSqlEndpointNetworkConfiguration { /** * A list of SecureAccessControlRule's to which access is limited to */ accessControlRules: outputs.DataFlow.GetSqlEndpointNetworkConfigurationAccessControlRule[]; /** * The host name prefix. */ hostNamePrefix: string; /** * The type of network configuration. */ networkType: string; /** * The OCIDs of Network Security Groups (NSGs). */ nsgIds: string[]; /** * Ip Address of private endpoint */ privateEndpointIp: string; /** * Ip Address of public endpoint */ publicEndpointIp: string; /** * The VCN Subnet OCID. */ subnetId: string; /** * The VCN OCID. */ vcnId: string; } interface GetSqlEndpointNetworkConfigurationAccessControlRule { /** * The type of IP notation. */ ipNotation: string; /** * The associated value of the selected IP notation. */ value: string; /** * A comma-separated IP or CIDR address for VCN OCID IP notation selection. */ vcnIps: string; } interface GetSqlEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetSqlEndpointsSqlEndpointCollection { items: outputs.DataFlow.GetSqlEndpointsSqlEndpointCollectionItem[]; } interface GetSqlEndpointsSqlEndpointCollectionItem { /** * The OCID of the compartment in which to query resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the SQL Endpoint. */ description: string; /** * The query parameter for the Spark application name. */ displayName: string; /** * The shape of the SQL Endpoint driver instance. */ driverShape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ driverShapeConfigs: outputs.DataFlow.GetSqlEndpointsSqlEndpointCollectionItemDriverShapeConfig[]; /** * The shape of the SQL Endpoint executor instance. */ executorShape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ executorShapeConfigs: outputs.DataFlow.GetSqlEndpointsSqlEndpointCollectionItemExecutorShapeConfig[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The provision identifier that is immutable on creation. */ id: string; /** * The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI */ jdbcEndpointUrl: string; /** * The OCID of Oracle Cloud Infrastructure Lake. */ lakeId: string; logCompartmentId: string; logDisplayName: string; logGroupId: string; logRetentionDuration: number; /** * The maximum number of executors. */ maxExecutorCount: number; /** * The OCID of Oracle Cloud Infrastructure Hive Metastore. */ metastoreId: string; /** * The minimum number of executors. */ minExecutorCount: number; /** * The network configuration of a SQL Endpoint. */ networkConfigurations: outputs.DataFlow.GetSqlEndpointsSqlEndpointCollectionItemNetworkConfiguration[]; /** * The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. */ sparkAdvancedConfigurations: { [key: string]: string; }; /** * The version of SQL Endpoint. */ sqlEndpointVersion: string; /** * A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState. */ state: string; /** * A message describing the reason why the resource is in it's current state. Helps bubble up errors in state changes. For example, it can be used to provide actionable information for a resource in the Failed state. */ stateMessage: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time the Sql Endpoint was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the Sql Endpoint was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html */ warehouseBucketUri: string; } interface GetSqlEndpointsSqlEndpointCollectionItemDriverShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetSqlEndpointsSqlEndpointCollectionItemExecutorShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface GetSqlEndpointsSqlEndpointCollectionItemNetworkConfiguration { /** * A list of SecureAccessControlRule's to which access is limited to */ accessControlRules: outputs.DataFlow.GetSqlEndpointsSqlEndpointCollectionItemNetworkConfigurationAccessControlRule[]; /** * The host name prefix. */ hostNamePrefix: string; /** * The type of network configuration. */ networkType: string; /** * The OCIDs of Network Security Groups (NSGs). */ nsgIds: string[]; /** * Ip Address of private endpoint */ privateEndpointIp: string; /** * Ip Address of public endpoint */ publicEndpointIp: string; /** * The VCN Subnet OCID. */ subnetId: string; /** * The VCN OCID. */ vcnId: string; } interface GetSqlEndpointsSqlEndpointCollectionItemNetworkConfigurationAccessControlRule { /** * The type of IP notation. */ ipNotation: string; /** * The associated value of the selected IP notation. */ value: string; /** * A comma-separated IP or CIDR address for VCN OCID IP notation selection. */ vcnIps: string; } interface InvokeRunApplicationLogConfig { /** * The log group id for where log objects will be for Data Flow Runs. */ logGroupId: string; /** * The log id of the log object the Application Logs of Data Flow Run will be shipped to. */ logId: string; } interface InvokeRunDriverShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface InvokeRunExecutorShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface InvokeRunParameter { /** * The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "inputFile" */ name: string; /** * The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}" */ value: string; } interface PoolConfiguration { /** * (Updatable) Maximum number of compute instances in the pool for a given compute shape. */ max: number; /** * (Updatable) Minimum number of compute instances in the pool for a given compute shape. */ min: number; /** * (Updatable) The compute shape of the resources you would like to provision. */ shape: string; /** * (Updatable) This is used to configure the shape of the driver or executor if a flexible shape is used. */ shapeConfig: outputs.DataFlow.PoolConfigurationShapeConfig; } interface PoolConfigurationShapeConfig { /** * (Updatable) The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface PoolPoolMetric { /** * The number of runs that are currently running that are using this pool. */ activeRunsCount: string; /** * A count of the nodes that are currently being used for each shape in this pool. */ activelyUsedNodeCounts: outputs.DataFlow.PoolPoolMetricActivelyUsedNodeCount[]; /** * The last time the mertics were updated for this. */ timeLastMetricsUpdated: string; /** * The last time this pool was started. */ timeLastStarted: string; /** * The last time this pool was stopped. */ timeLastStopped: string; /** * The last time a run used this pool. */ timeLastUsed: string; } interface PoolPoolMetricActivelyUsedNodeCount { /** * The compute shape of the nodes that the count is for. */ logicalShape: string; /** * The node count of this compute shape. */ poolCount: number; } interface PoolSchedule { /** * (Updatable) Day of the week SUN-SAT */ dayOfWeek: string; /** * (Updatable) Hour of the day to start or stop pool. */ startTime: number; /** * (Updatable) Hour of the day to stop the pool. */ stopTime: number; } interface PrivateEndpointScanDetail { /** * (Updatable) A fully-qualified domain name (FQDN). */ fqdn: string; /** * (Updatable) The port number of the FQDN */ port: string; } interface RunStatementOutput { /** * An object representing execution output of a statement. */ datas: outputs.DataFlow.RunStatementOutputData[]; /** * The name of the error in the statement output. */ errorName: string; /** * The value of the error in the statement output. */ errorValue: string; /** * Status of the statement output. */ status: string; /** * The traceback of the statement output. */ tracebacks: string[]; } interface RunStatementOutputData { /** * The type of the `StatementOutputData` like `TEXT_PLAIN`, `TEXT_HTML` or `IMAGE_PNG`. */ type: string; /** * The statement code execution output in html format. */ value: string; } interface SqlEndpointDriverShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface SqlEndpointExecutorShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. */ ocpus: number; } interface SqlEndpointNetworkConfiguration { /** * A list of SecureAccessControlRule's to which access is limited to */ accessControlRules: outputs.DataFlow.SqlEndpointNetworkConfigurationAccessControlRule[]; /** * The host name prefix. */ hostNamePrefix: string; /** * The type of network configuration. */ networkType: string; /** * The OCIDs of Network Security Groups (NSGs). */ nsgIds: string[]; /** * Ip Address of private endpoint */ privateEndpointIp: string; /** * Ip Address of public endpoint */ publicEndpointIp: string; /** * The VCN Subnet OCID. */ subnetId: string; /** * The VCN OCID. */ vcnId: string; } interface SqlEndpointNetworkConfigurationAccessControlRule { /** * The type of IP notation. */ ipNotation: string; /** * The associated value of the selected IP notation. */ value: string; /** * A comma-separated IP or CIDR address for VCN OCID IP notation selection. */ vcnIps: string; } } export declare namespace DataIntegration { interface GetWorkspaceApplicationDependentObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * The key of the object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceApplicationMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceApplicationMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time the application was created, in the timestamp format defined by RFC3339. */ timeCreated: string; /** * The date and time the application was updated, in the timestamp format defined by RFC3339. example: 2019-08-25T21:10:29.41Z */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceApplicationMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * The key of the object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceApplicationMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceApplicationMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceApplicationParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationPatchDependentObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * The key of the object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationPatchMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceApplicationPatchMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceApplicationPatchMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceApplicationPatchMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * The key of the object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationPatchMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceApplicationPatchMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceApplicationPatchMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceApplicationPatchParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationPatchPatchObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * The key of the object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationPatchRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceApplicationPatchesFilter { /** * Used to filter by the name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetWorkspaceApplicationPatchesPatchSummaryCollection { items: outputs.DataIntegration.GetWorkspaceApplicationPatchesPatchSummaryCollectionItem[]; } interface GetWorkspaceApplicationPatchesPatchSummaryCollectionItem { /** * The application key. */ applicationKey: string; /** * The application version of the patch. */ applicationVersion: number; /** * List of dependent objects in this patch. */ dependentObjectMetadatas: outputs.DataIntegration.GetWorkspaceApplicationPatchesPatchSummaryCollectionItemDependentObjectMetadata[]; /** * The description of the aggregator. */ description: string; /** * The errors encountered while applying the patch, if any. */ errorMessages: { [key: string]: string; }; /** * Used to filter by the identifier of the published object. */ identifier: string; /** * The key of the object. */ key: string; /** * A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. */ keyMap: { [key: string]: string; }; /** * A summary type containing information about the object including its key, name and when/who created/updated it. */ metadatas: outputs.DataIntegration.GetWorkspaceApplicationPatchesPatchSummaryCollectionItemMetadata[]; /** * The object type. */ modelType: string; /** * The object's model version. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; objectKeys: string[]; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * The object version. */ objectVersion: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceApplicationPatchesPatchSummaryCollectionItemParentRef[]; /** * List of objects that are published or unpublished in this patch. */ patchObjectMetadatas: outputs.DataIntegration.GetWorkspaceApplicationPatchesPatchSummaryCollectionItemPatchObjectMetadata[]; /** * Status of the patch applied or being applied on the application */ patchStatus: string; /** * The type of the patch applied or being applied on the application. */ patchType: string; registryMetadata: outputs.DataIntegration.GetWorkspaceApplicationPatchesPatchSummaryCollectionItemRegistryMetadata; /** * The date and time the patch was applied, in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timePatched: string; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceApplicationPatchesPatchSummaryCollectionItemDependentObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * Used to filter by the identifier of the published object. */ identifier: string; /** * The key of the object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationPatchesPatchSummaryCollectionItemMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceApplicationPatchesPatchSummaryCollectionItemMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceApplicationPatchesPatchSummaryCollectionItemMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceApplicationPatchesPatchSummaryCollectionItemMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * Used to filter by the identifier of the published object. */ identifier: string; /** * The key of the object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationPatchesPatchSummaryCollectionItemMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceApplicationPatchesPatchSummaryCollectionItemMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceApplicationPatchesPatchSummaryCollectionItemMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceApplicationPatchesPatchSummaryCollectionItemParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationPatchesPatchSummaryCollectionItemPatchObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * Used to filter by the identifier of the published object. */ identifier: string; /** * The key of the object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationPatchesPatchSummaryCollectionItemRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceApplicationPublishedObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * The key of the object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceApplicationScheduleFrequencyDetail { /** * This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) */ customExpression: string; /** * This holds the day of the week on which the schedule should be triggered. */ dayOfWeek: string; /** * A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. */ days: number[]; /** * the frequency of the schedule. */ frequency: string; /** * This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. */ interval: number; /** * The type of the object. */ modelType: string; /** * A model to hold time in hour:minute:second format. */ times: outputs.DataIntegration.GetWorkspaceApplicationScheduleFrequencyDetailTime[]; /** * This holds the week of the month in which the schedule should be triggered. */ weekOfMonth: string; } interface GetWorkspaceApplicationScheduleFrequencyDetailTime { /** * The hour value. */ hour: number; /** * The minute value. */ minute: number; /** * The second value. */ second: number; } interface GetWorkspaceApplicationScheduleMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceApplicationScheduleMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceApplicationScheduleMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceApplicationScheduleMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * The identifier of the aggregator. */ identifier: string; /** * The key of the aggregator object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the aggregator. */ type: string; } interface GetWorkspaceApplicationScheduleMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceApplicationScheduleMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceApplicationScheduleMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceApplicationScheduleParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationScheduleRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the aggregator object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceApplicationSchedulesFilter { /** * Used to filter by the name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetWorkspaceApplicationSchedulesScheduleSummaryCollection { items: outputs.DataIntegration.GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItem[]; } interface GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItem { /** * The application key. */ applicationKey: string; /** * The description of the aggregator. */ description: string; /** * The model that holds the frequency details. */ frequencyDetails: outputs.DataIntegration.GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemFrequencyDetails; /** * Used to filter by the identifier of the object. */ identifier: string; /** * A flag to indicate daylight saving. */ isDaylightAdjustmentEnabled: boolean; /** * Used to filter by the key of the object. */ key: string; /** * A summary type containing information about the object including its key, name and when/who created/updated it. */ metadatas: outputs.DataIntegration.GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemMetadata[]; /** * The type of the object. */ modelType: string; /** * This is a version number that is used by the service to upgrade objects if needed through releases of the service. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. */ objectVersion: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemParentRef[]; registryMetadata: outputs.DataIntegration.GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemRegistryMetadata; /** * The timezone for the schedule. */ timezone: string; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemFrequencyDetails { /** * This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) */ customExpression: string; /** * This holds the day of the week on which the schedule should be triggered. */ dayOfWeek: string; /** * A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. */ days: number[]; /** * the frequency of the schedule. */ frequency: string; /** * This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. */ interval: number; /** * The type of the object. */ modelType: string; /** * A model to hold time in hour:minute:second format. */ time: outputs.DataIntegration.GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemFrequencyDetailsTime; /** * This holds the week of the month in which the schedule should be triggered. */ weekOfMonth: string; } interface GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemFrequencyDetailsTime { /** * The hour value. */ hour: number; /** * The minute value. */ minute: number; /** * The second value. */ second: number; } interface GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * Used to filter by the identifier of the object. */ identifier: string; /** * Used to filter by the key of the object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.

Examples:
  • ?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task
*/ type: string; } interface GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationSchedulesScheduleSummaryCollectionItemRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Used to filter by the key of the object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceApplicationSourceApplicationInfo { /** * The application key. */ applicationKey: string; /** * The source application version of the application. */ applicationVersion: string; copyType: string; /** * The last patch key for the application. */ lastPatchKey: string; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceApplicationTaskScheduleLastRunDetail { /** * The description of the aggregator. */ description: string; /** * The identifier of the aggregator. */ identifier: string; /** * The key of the aggregator object. */ key: string; /** * Time in milliseconds for the pervious schedule. */ lastRunTimeMillis: string; /** * The type of the object. */ modelType: string; /** * This is a version number that is used by the service to upgrade objects if needed through releases of the service. */ modelVersion: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. */ objectVersion: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleLastRunDetailParentRef[]; } interface GetWorkspaceApplicationTaskScheduleLastRunDetailParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationTaskScheduleMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceApplicationTaskScheduleMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * The identifier of the aggregator. */ identifier: string; /** * The key of the aggregator object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the aggregator. */ type: string; } interface GetWorkspaceApplicationTaskScheduleMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceApplicationTaskScheduleMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceApplicationTaskScheduleParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationTaskScheduleRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the aggregator object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceApplicationTaskScheduleScheduleRef { /** * The description of the aggregator. */ description: string; /** * The model that holds the frequency details. */ frequencyDetails: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleScheduleRefFrequencyDetail[]; /** * The identifier of the aggregator. */ identifier: string; isDaylightAdjustmentEnabled: boolean; /** * The key of the aggregator object. */ key: string; /** * A summary type containing information about the object including its key, name and when/who created/updated it. */ metadatas: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleScheduleRefMetadata[]; /** * The type of the object. */ modelType: string; /** * This is a version number that is used by the service to upgrade objects if needed through releases of the service. */ modelVersion: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. */ objectVersion: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleScheduleRefParentRef[]; /** * The timezone for the schedule. */ timezone: string; } interface GetWorkspaceApplicationTaskScheduleScheduleRefFrequencyDetail { /** * This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) */ customExpression: string; /** * This holds the day of the week on which the schedule should be triggered. */ dayOfWeek: string; /** * A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. */ days: number[]; /** * the frequency of the schedule. */ frequency: string; /** * This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. */ interval: number; /** * The type of the object. */ modelType: string; /** * A model to hold time in hour:minute:second format. */ times: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleScheduleRefFrequencyDetailTime[]; /** * This holds the week of the month in which the schedule should be triggered. */ weekOfMonth: string; } interface GetWorkspaceApplicationTaskScheduleScheduleRefFrequencyDetailTime { /** * The hour value. */ hour: number; /** * The minute value. */ minute: number; /** * The second value. */ second: number; } interface GetWorkspaceApplicationTaskScheduleScheduleRefMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleScheduleRefMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleScheduleRefMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceApplicationTaskScheduleScheduleRefMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * The identifier of the aggregator. */ identifier: string; /** * The key of the aggregator object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the aggregator. */ type: string; } interface GetWorkspaceApplicationTaskScheduleScheduleRefMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceApplicationTaskScheduleScheduleRefMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceApplicationTaskScheduleScheduleRefMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceApplicationTaskScheduleScheduleRefParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationTaskSchedulesFilter { /** * Used to filter by the name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollection { items: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItem[]; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItem { /** * The application key. */ applicationKey: string; /** * The authorization mode for the task. */ authMode: string; /** * The information about the configuration provider. First level keys to this delegate map should be in the order first "bindings" then "childProviders".refer terraform Example. */ configProviderDelegate: string; /** * The description of the aggregator. */ description: string; /** * The end time in milliseconds. */ endTimeMillis: string; /** * The expected duration of the task execution. */ expectedDuration: number; /** * The expected duration unit of the task execution. */ expectedDurationUnit: string; /** * Used to filter by the identifier of the object. */ identifier: string; /** * Whether the backfill is enabled */ isBackfillEnabled: boolean; /** * Whether the same task can be executed concurrently. */ isConcurrentAllowed: boolean; /** * This filter parameter can be used to filter task schedule by its state. */ isEnabled: boolean; /** * Used to filter by the key of the object. */ key: string; /** * The last run details for the task run. */ lastRunDetails: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemLastRunDetail[]; /** * A summary type containing information about the object including its key, name and when/who created/updated it. */ metadatas: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemMetadata[]; /** * The type of the object. */ modelType: string; /** * This is a version number that is used by the service to upgrade objects if needed through releases of the service. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; nextRunTimeMillis: string; numberOfRetries: number; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. */ objectVersion: number; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemParentRef; registryMetadata: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemRegistryMetadata; /** * The number of retry attempts. */ retryAttempts: number; /** * The retry delay, the unit for measurement is in the property retry delay unit. */ retryDelay: number; /** * The unit for the retry delay. */ retryDelayUnit: string; /** * The schedule object */ scheduleRef: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRef; /** * The start time in milliseconds. */ startTimeMillis: string; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemLastRunDetail { /** * The description of the aggregator. */ description: string; /** * Used to filter by the identifier of the object. */ identifier: string; /** * Used to filter by the key of the object. */ key: string; /** * Time in milliseconds for the pervious schedule. */ lastRunTimeMillis: string; /** * The type of the object. */ modelType: string; /** * This is a version number that is used by the service to upgrade objects if needed through releases of the service. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. */ objectVersion: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemLastRunDetailParentRef[]; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemLastRunDetailParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * Used to filter by the identifier of the object. */ identifier: string; /** * Used to filter by the key of the object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.

Examples:
  • ?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task
*/ type: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Used to filter by the key of the object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRef { /** * The description of the aggregator. */ description: string; /** * The model that holds the frequency details. */ frequencyDetails: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefFrequencyDetails; /** * Used to filter by the identifier of the object. */ identifier: string; isDaylightAdjustmentEnabled: boolean; /** * Used to filter by the key of the object. */ key: string; /** * A summary type containing information about the object including its key, name and when/who created/updated it. */ metadata: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefMetadata; /** * The type of the object. */ modelType: string; /** * This is a version number that is used by the service to upgrade objects if needed through releases of the service. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. */ objectVersion: number; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefParentRef; /** * The timezone for the schedule. */ timezone: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefFrequencyDetails { /** * This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) */ customExpression: string; /** * This holds the day of the week on which the schedule should be triggered. */ dayOfWeek: string; /** * A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. */ days: number[]; /** * the frequency of the schedule. */ frequency: string; /** * This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. */ interval: number; /** * The type of the object. */ modelType: string; /** * A model to hold time in hour:minute:second format. */ time: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefFrequencyDetailsTime; /** * This holds the week of the month in which the schedule should be triggered. */ weekOfMonth: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefFrequencyDetailsTime { /** * The hour value. */ hour: number; /** * The minute value. */ minute: number; /** * The second value. */ second: number; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefMetadata { /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregator: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefMetadataAggregator; /** * The owning object key for this object. */ aggregatorKey: string; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefMetadataCountStatistics; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * Used to filter by the identifier of the object. */ identifier: string; /** * Used to filter by the key of the object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.

Examples:
  • ?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task
*/ type: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefMetadataCountStatistics { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefMetadataCountStatisticsObjectTypeCountList[]; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefMetadataCountStatisticsObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceApplicationTaskSchedulesTaskScheduleSummaryCollectionItemScheduleRefParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationsApplicationSummaryCollection { items: outputs.DataIntegration.GetWorkspaceApplicationsApplicationSummaryCollectionItem[]; } interface GetWorkspaceApplicationsApplicationSummaryCollectionItem { /** * The source application version of the application. */ applicationVersion: number; /** * OCID of the compartment that this resource belongs to. Defaults to compartment of the Workspace. */ compartmentId: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A list of dependent objects in this patch. */ dependentObjectMetadatas: outputs.DataIntegration.GetWorkspaceApplicationsApplicationSummaryCollectionItemDependentObjectMetadata[]; /** * The description of the aggregator. */ description: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID of the resource that is used to uniquely identify the application */ id: string; /** * Used to filter by the identifier of the published object. */ identifier: string; /** * The key of the object. */ key: string; /** * A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. */ keyMap: { [key: string]: string; }; /** * A summary type containing information about the object including its key, name and when/who created/updated it. */ metadatas: outputs.DataIntegration.GetWorkspaceApplicationsApplicationSummaryCollectionItemMetadata[]; /** * The object type. */ modelType: string; /** * The object's model version. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * The object version. */ objectVersion: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceApplicationsApplicationSummaryCollectionItemParentRef[]; /** * A list of objects that are published or unpublished in this patch. */ publishedObjectMetadatas: outputs.DataIntegration.GetWorkspaceApplicationsApplicationSummaryCollectionItemPublishedObjectMetadata[]; registryMetadatas: outputs.DataIntegration.GetWorkspaceApplicationsApplicationSummaryCollectionItemRegistryMetadata[]; /** * The information about the application. */ sourceApplicationInfos: outputs.DataIntegration.GetWorkspaceApplicationsApplicationSummaryCollectionItemSourceApplicationInfo[]; /** * The current state of the workspace. */ state: string; /** * The date and time the application was created, in the timestamp format defined by RFC3339. */ timeCreated: string; /** * The date and time the application was patched, in the timestamp format defined by RFC3339. */ timePatched: string; /** * The date and time the application was updated, in the timestamp format defined by RFC3339. example: 2019-08-25T21:10:29.41Z */ timeUpdated: string; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceApplicationsApplicationSummaryCollectionItemDependentObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * Used to filter by the identifier of the published object. */ identifier: string; /** * The key of the object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationsApplicationSummaryCollectionItemMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceApplicationsApplicationSummaryCollectionItemMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceApplicationsApplicationSummaryCollectionItemMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time the application was created, in the timestamp format defined by RFC3339. */ timeCreated: string; /** * The date and time the application was updated, in the timestamp format defined by RFC3339. example: 2019-08-25T21:10:29.41Z */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceApplicationsApplicationSummaryCollectionItemMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * Used to filter by the identifier of the published object. */ identifier: string; /** * The key of the object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationsApplicationSummaryCollectionItemMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceApplicationsApplicationSummaryCollectionItemMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceApplicationsApplicationSummaryCollectionItemMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceApplicationsApplicationSummaryCollectionItemParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceApplicationsApplicationSummaryCollectionItemPublishedObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * Used to filter by the identifier of the published object. */ identifier: string; /** * The key of the object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface GetWorkspaceApplicationsApplicationSummaryCollectionItemRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceApplicationsApplicationSummaryCollectionItemSourceApplicationInfo { /** * The source application key to use when creating the application. */ applicationKey: string; /** * The source application version of the application. */ applicationVersion: string; copyType: string; /** * The last patch key for the application. */ lastPatchKey: string; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceApplicationsFilter { /** * Used to filter by the name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetWorkspaceExportRequestExportedItem { /** * Aggregator key */ aggregatorKey: string; /** * Object identifier */ identifier: string; /** * Export object request key */ key: string; /** * Name of the export request. */ name: string; /** * Object name path */ namePath: string; /** * Object type */ objectType: string; /** * Object version */ objectVersion: string; /** * time at which this object was last updated. */ timeUpdatedInMillis: string; } interface GetWorkspaceExportRequestsExportRequestSummaryCollection { items: outputs.DataIntegration.GetWorkspaceExportRequestsExportRequestSummaryCollectionItem[]; } interface GetWorkspaceExportRequestsExportRequestSummaryCollectionItem { /** * Controls if the references will be exported along with the objects */ areReferencesIncluded: boolean; /** * The name of the Object Storage Bucket where the objects will be exported to */ bucket: string; /** * Name of the user who initiated export request. */ createdBy: string; /** * Contains key of the error */ errorMessages: { [key: string]: string; }; /** * The array of exported object details. */ exportedItems: outputs.DataIntegration.GetWorkspaceExportRequestsExportRequestSummaryCollectionItemExportedItem[]; /** * Name of the exported zip file. */ fileName: string; /** * Export multiple objects based on filters. */ filters: string[]; /** * Flag to control whether to overwrite the object if it is already present at the provided object storage location. */ isObjectOverwriteEnabled: boolean; /** * Export object request key */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * The list of the objects to be exported */ objectKeys: string[]; /** * Region of the object storage (if using object storage of different region) */ objectStorageRegion: string; /** * Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy) */ objectStorageTenancyId: string; /** * The array of exported referenced objects. */ referencedItems: string; /** * Export Objects request status. */ status: string; /** * Specifies end time of a copy object request. */ timeEndedInMillis: string; /** * Specifies start time of a copy object request. */ timeStartedInMillis: string; /** * Number of objects that are exported. */ totalExportedObjectCount: number; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceExportRequestsExportRequestSummaryCollectionItemExportedItem { /** * Aggregator key */ aggregatorKey: string; /** * Object identifier */ identifier: string; /** * Export object request key */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * Object name path */ namePath: string; /** * Object type */ objectType: string; /** * Object version */ objectVersion: string; /** * time at which this object was last updated. */ timeUpdatedInMillis: string; } interface GetWorkspaceExportRequestsFilter { /** * Used to filter by the name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetWorkspaceFolderMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceFolderMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceFolderMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceFolderMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * The identifier of the aggregator. */ identifier: string; /** * The key of the aggregator object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the aggregator. */ type: string; } interface GetWorkspaceFolderMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceFolderMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceFolderMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceFolderParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceFolderRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the aggregator object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceFoldersFilter { /** * Used to filter by the name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetWorkspaceFoldersFolderSummaryCollection { items: outputs.DataIntegration.GetWorkspaceFoldersFolderSummaryCollectionItem[]; } interface GetWorkspaceFoldersFolderSummaryCollectionItem { /** * The category name. */ categoryName: string; /** * The description of the aggregator. */ description: string; folderKey: string; /** * Used to filter by the identifier of the object. */ identifier: string; /** * The key of the aggregator object. */ key: string; /** * A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key. */ keyMap: { [key: string]: string; }; /** * A summary type containing information about the object including its key, name and when/who created/updated it. */ metadatas: outputs.DataIntegration.GetWorkspaceFoldersFolderSummaryCollectionItemMetadata[]; /** * The type of the object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * The version of the object that is used to track changes in the object instance. */ objectVersion: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceFoldersFolderSummaryCollectionItemParentRef[]; registryMetadata: outputs.DataIntegration.GetWorkspaceFoldersFolderSummaryCollectionItemRegistryMetadata; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceFoldersFolderSummaryCollectionItemMetadata { /** * Used to filter by the project or the folder object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceFoldersFolderSummaryCollectionItemMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceFoldersFolderSummaryCollectionItemMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceFoldersFolderSummaryCollectionItemMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * Used to filter by the identifier of the object. */ identifier: string; /** * The key of the aggregator object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * The type of the aggregator. */ type: string; } interface GetWorkspaceFoldersFolderSummaryCollectionItemMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceFoldersFolderSummaryCollectionItemMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceFoldersFolderSummaryCollectionItemMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceFoldersFolderSummaryCollectionItemParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceFoldersFolderSummaryCollectionItemRegistryMetadata { /** * Used to filter by the project or the folder object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the aggregator object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceImportRequestImportConflictResolution { /** * In case of DUPLICATE mode, prefix will be used to disambiguate the object. */ duplicatePrefix: string; /** * In case of DUPLICATE mode, suffix will be used to disambiguate the object. */ duplicateSuffix: string; /** * Import Objects Conflict resolution Type (RETAIN/DUPLICATE/REPLACE). */ importConflictResolutionType: string; } interface GetWorkspaceImportRequestImportedObject { /** * Aggregator key */ aggregatorKey: string; /** * Object identifier */ identifier: string; /** * Name of the import request. */ name: string; /** * Object name path */ namePath: string; /** * New key of the object */ newKey: string; /** * Object type */ objectType: string; /** * Object version */ objectVersion: string; /** * Old key of the object */ oldKey: string; /** * Object resolution action */ resolutionAction: string; /** * time at which this object was last updated. */ timeUpdatedInMillis: string; } interface GetWorkspaceImportRequestsFilter { /** * Used to filter by the name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetWorkspaceImportRequestsImportRequestSummaryCollection { items: outputs.DataIntegration.GetWorkspaceImportRequestsImportRequestSummaryCollectionItem[]; } interface GetWorkspaceImportRequestsImportRequestSummaryCollectionItem { /** * This field controls if the data asset references will be included during import. */ areDataAssetReferencesIncluded: boolean; /** * The name of the Object Storage Bucket where the objects will be imported from */ bucket: string; /** * Name of the user who initiated import request. */ createdBy: string; /** * Contains key of the error */ errorMessages: { [key: string]: string; }; /** * Name of the zip file from which objects will be imported. */ fileName: string; /** * Import Objects Conflict resolution. */ importConflictResolution: outputs.DataIntegration.GetWorkspaceImportRequestsImportRequestSummaryCollectionItemImportConflictResolution; /** * The array of imported object details. */ importedObjects: outputs.DataIntegration.GetWorkspaceImportRequestsImportRequestSummaryCollectionItemImportedObject[]; /** * Import object request key */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * Key of the object inside which all the objects will be imported */ objectKeyForImport: string; /** * Region of the object storage (if using object storage of different region) */ objectStorageRegion: string; /** * Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy) */ objectStorageTenancyId: string; /** * Import Objects request status. */ status: string; /** * Specifies end time of a copy object request. */ timeEndedInMillis: string; /** * Specifies start time of a copy object request. */ timeStartedInMillis: string; /** * Number of objects that are imported. */ totalImportedObjectCount: number; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceImportRequestsImportRequestSummaryCollectionItemImportConflictResolution { /** * In case of DUPLICATE mode, prefix will be used to disambiguate the object. */ duplicatePrefix: string; /** * In case of DUPLICATE mode, suffix will be used to disambiguate the object. */ duplicateSuffix: string; /** * Import Objects Conflict resolution Type (RETAIN/DUPLICATE/REPLACE). */ importConflictResolutionType: string; } interface GetWorkspaceImportRequestsImportRequestSummaryCollectionItemImportedObject { /** * Aggregator key */ aggregatorKey: string; /** * Object identifier */ identifier: string; /** * Used to filter by the name of the object. */ name: string; /** * Object name path */ namePath: string; /** * New key of the object */ newKey: string; /** * Object type */ objectType: string; /** * Object version */ objectVersion: string; /** * Old key of the object */ oldKey: string; /** * Object resolution action */ resolutionAction: string; /** * time at which this object was last updated. */ timeUpdatedInMillis: string; } interface GetWorkspaceProjectMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceProjectMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceProjectMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceProjectMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * The identifier of the aggregator. */ identifier: string; /** * The key of the aggregator object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the aggregator. */ type: string; } interface GetWorkspaceProjectMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceProjectMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceProjectMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceProjectParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceProjectRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the aggregator object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceProjectsFilter { /** * Used to filter by the name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetWorkspaceProjectsProjectSummaryCollection { items: outputs.DataIntegration.GetWorkspaceProjectsProjectSummaryCollectionItem[]; } interface GetWorkspaceProjectsProjectSummaryCollectionItem { /** * The description of the aggregator. */ description: string; /** * Used to filter by the identifier of the object. */ identifier: string; /** * The key of the aggregator object. */ key: string; /** * A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key. */ keyMap: { [key: string]: string; }; /** * A summary type containing information about the object including its key, name and when/who created/updated it. */ metadatas: outputs.DataIntegration.GetWorkspaceProjectsProjectSummaryCollectionItemMetadata[]; /** * The type of the object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * The version of the object that is used to track changes in the object instance. */ objectVersion: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceProjectsProjectSummaryCollectionItemParentRef[]; projectKey: string; registryMetadata: outputs.DataIntegration.GetWorkspaceProjectsProjectSummaryCollectionItemRegistryMetadata; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceProjectsProjectSummaryCollectionItemMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceProjectsProjectSummaryCollectionItemMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceProjectsProjectSummaryCollectionItemMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceProjectsProjectSummaryCollectionItemMetadataAggregator { /** * The description of the aggregator. */ description: string; /** * Used to filter by the identifier of the object. */ identifier: string; /** * The key of the aggregator object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * The type of the aggregator. */ type: string; } interface GetWorkspaceProjectsProjectSummaryCollectionItemMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceProjectsProjectSummaryCollectionItemMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceProjectsProjectSummaryCollectionItemMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceProjectsProjectSummaryCollectionItemParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceProjectsProjectSummaryCollectionItemRegistryMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the aggregator object. */ key: string; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; } interface GetWorkspaceTaskAuthConfig { /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskAuthConfigParentRef[]; /** * The Oracle Cloud Infrastructure resource type that will supply the authentication token */ resourcePrincipalSource: string; } interface GetWorkspaceTaskAuthConfigParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskCancelRestCallConfig { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTaskCancelRestCallConfigConfigValue[]; /** * The key of the object. */ key: string; /** * The REST method to use. */ methodType: string; /** * The type of the types object. */ modelType: string; /** * The headers for the REST call. */ requestHeaders: { [key: string]: string; }; } interface GetWorkspaceTaskCancelRestCallConfigConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValue[]; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskCancelRestCallConfigConfigValueParentRef[]; } interface GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValue { requestPayloads: outputs.DataIntegration.GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestPayload[]; requestUrls: outputs.DataIntegration.GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestUrl[]; } interface GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestPayload { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValues: outputs.DataIntegration.GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestPayloadRefValue[]; } interface GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestPayloadRefValue { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValue[]; /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; } interface GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValue[]; } interface GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValue { dataParams: outputs.DataIntegration.GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValueDataParam[]; } interface GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValueDataParam { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskCancelRestCallConfigConfigValueConfigParamValueRequestUrl { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskCancelRestCallConfigConfigValueParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskConfigProviderDelegate { bindings: outputs.DataIntegration.GetWorkspaceTaskConfigProviderDelegateBinding[]; } interface GetWorkspaceTaskConfigProviderDelegateBinding { /** * The key of the object. */ key: string; parameterValues: outputs.DataIntegration.GetWorkspaceTaskConfigProviderDelegateBindingParameterValue[]; } interface GetWorkspaceTaskConfigProviderDelegateBindingParameterValue { /** * The root object value, used in custom parameters. */ rootObjectValues: outputs.DataIntegration.GetWorkspaceTaskConfigProviderDelegateBindingParameterValueRootObjectValue[]; simpleValue: string; } interface GetWorkspaceTaskConfigProviderDelegateBindingParameterValueRootObjectValue { /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface GetWorkspaceTaskExecuteRestCallConfig { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTaskExecuteRestCallConfigConfigValue[]; /** * The key of the object. */ key: string; /** * The REST method to use. */ methodType: string; /** * The type of the types object. */ modelType: string; /** * The headers for the REST call. */ requestHeaders: { [key: string]: string; }; } interface GetWorkspaceTaskExecuteRestCallConfigConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValue[]; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskExecuteRestCallConfigConfigValueParentRef[]; } interface GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValue { requestPayloads: outputs.DataIntegration.GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestPayload[]; requestUrls: outputs.DataIntegration.GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestUrl[]; } interface GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestPayload { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValues: outputs.DataIntegration.GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestPayloadRefValue[]; } interface GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestPayloadRefValue { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValue[]; /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; } interface GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValue[]; } interface GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValue { dataParams: outputs.DataIntegration.GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValueDataParam[]; } interface GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValueDataParam { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskExecuteRestCallConfigConfigValueConfigParamValueRequestUrl { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskExecuteRestCallConfigConfigValueParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskInputPort { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTaskInputPortConfigValue[]; /** * Detailed description for the object. */ description: string; /** * An array of fields. */ fields: string[]; /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskInputPortParentRef[]; /** * The port details for the data asset.Type. */ portType: string; } interface GetWorkspaceTaskInputPortConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskInputPortConfigValueConfigParamValue[]; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskInputPortConfigValueParentRef[]; } interface GetWorkspaceTaskInputPortConfigValueConfigParamValue { /** * An integer value of the parameter. */ intValue: number; /** * An object value of the parameter. */ objectValue: string; /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: string; /** * The root object value, used in custom parameters. */ rootObjectValue: string; /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskInputPortConfigValueParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskInputPortParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskMetadata { /** * The owning object's key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceTaskMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceTaskMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceTaskMetadataAggregator { /** * Detailed description for the object. */ description: string; /** * Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * The key of the object. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The object type. */ type: string; } interface GetWorkspaceTaskMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceTaskMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceTaskMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceTaskOpConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskOpConfigValueConfigParamValue[]; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskOpConfigValueParentRef[]; } interface GetWorkspaceTaskOpConfigValueConfigParamValue { configParamValues: outputs.DataIntegration.GetWorkspaceTaskOpConfigValueConfigParamValueConfigParamValue[]; /** * The key of the object. */ key: string; } interface GetWorkspaceTaskOpConfigValueConfigParamValueConfigParamValue { /** * An integer value of the parameter. */ intValue: number; /** * An object value of the parameter. */ objectValue: string; /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValues: outputs.DataIntegration.GetWorkspaceTaskOpConfigValueConfigParamValueConfigParamValueRefValue[]; /** * The root object value, used in custom parameters. */ rootObjectValues: outputs.DataIntegration.GetWorkspaceTaskOpConfigValueConfigParamValueConfigParamValueRootObjectValue[]; /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskOpConfigValueConfigParamValueConfigParamValueRefValue { /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface GetWorkspaceTaskOpConfigValueConfigParamValueConfigParamValueRootObjectValue { /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface GetWorkspaceTaskOpConfigValueParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskOutputPort { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTaskOutputPortConfigValue[]; /** * Detailed description for the object. */ description: string; /** * An array of fields. */ fields: string[]; /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskOutputPortParentRef[]; /** * The port details for the data asset.Type. */ portType: string; } interface GetWorkspaceTaskOutputPortConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskOutputPortConfigValueConfigParamValue[]; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskOutputPortConfigValueParentRef[]; } interface GetWorkspaceTaskOutputPortConfigValueConfigParamValue { /** * An integer value of the parameter. */ intValue: number; /** * An object value of the parameter. */ objectValue: string; /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: string; /** * The root object value, used in custom parameters. */ rootObjectValue: string; /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskOutputPortConfigValueParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskOutputPortParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskParameter { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTaskParameterConfigValue[]; /** * A default value for the vairable. */ defaultValue: string; /** * Detailed description for the object. */ description: string; /** * Specifies whether the parameter is input value. */ isInput: boolean; /** * Specifies whether the parameter is output value. */ isOutput: boolean; /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * The output aggregation type. */ outputAggregationType: string; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskParameterParentRef[]; /** * A base class for all model types, including First Class and its contained objects. */ rootObjectDefaultValue: string; /** * The object type. */ type: string; /** * The type of value the parameter was created for. */ typeName: string; /** * The param name for which parameter is created for for eg. driver Shape, Operation etc. */ usedFor: string; } interface GetWorkspaceTaskParameterConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskParameterConfigValueConfigParamValue[]; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskParameterConfigValueParentRef[]; } interface GetWorkspaceTaskParameterConfigValueConfigParamValue { configParamValues: outputs.DataIntegration.GetWorkspaceTaskParameterConfigValueConfigParamValueConfigParamValue[]; /** * The key of the object. */ key: string; } interface GetWorkspaceTaskParameterConfigValueConfigParamValueConfigParamValue { /** * An integer value of the parameter. */ intValue: number; /** * An object value of the parameter. */ objectValue: string; /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValues: outputs.DataIntegration.GetWorkspaceTaskParameterConfigValueConfigParamValueConfigParamValueRefValue[]; /** * The root object value, used in custom parameters. */ rootObjectValues: outputs.DataIntegration.GetWorkspaceTaskParameterConfigValueConfigParamValueConfigParamValueRootObjectValue[]; /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskParameterConfigValueConfigParamValueConfigParamValueRefValue { /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface GetWorkspaceTaskParameterConfigValueConfigParamValueConfigParamValueRootObjectValue { /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface GetWorkspaceTaskParameterConfigValueParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskParameterParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskPollRestCallConfig { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValue[]; /** * The key of the object. */ key: string; /** * The REST method to use. */ methodType: string; /** * The type of the types object. */ modelType: string; /** * The headers for the REST call. */ requestHeaders: { [key: string]: string; }; } interface GetWorkspaceTaskPollRestCallConfigConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValue[]; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueParentRef[]; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValue { pollConditions: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollCondition[]; pollIntervalUnits: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollIntervalUnit[]; pollIntervals: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollInterval[]; pollMaxDurationUnits: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollMaxDurationUnit[]; pollMaxDurations: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollMaxDuration[]; requestPayloads: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestPayload[]; requestUrls: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestUrl[]; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollCondition { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValues: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollConditionRefValue[]; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollConditionRefValue { /** * The expression string for the object. */ exprString: string; /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollInterval { /** * An object value of the parameter. */ objectValue: number; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollIntervalUnit { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollMaxDuration { /** * An object value of the parameter. */ objectValue: number; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValuePollMaxDurationUnit { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestPayload { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValues: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestPayloadRefValue[]; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestPayloadRefValue { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValue[]; /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValue[]; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValue { dataParams: outputs.DataIntegration.GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValueDataParam[]; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestPayloadRefValueConfigValueConfigParamValueDataParam { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskPollRestCallConfigConfigValueConfigParamValueRequestUrl { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTaskPollRestCallConfigConfigValueParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskRegistryMetadata { /** * The owning object's key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The key of the object. */ key: string; /** * Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version. */ registryVersion: number; } interface GetWorkspaceTaskTypedExpression { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTaskTypedExpressionConfigValue[]; /** * Detailed description for the object. */ description: string; /** * The expression string for the object. */ expression: string; /** * The key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskTypedExpressionParentRef[]; /** * The object type. */ type: string; } interface GetWorkspaceTaskTypedExpressionConfigValue { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTaskTypedExpressionConfigValueConfigParamValue[]; /** * A reference to the object's parent. */ parentReves: outputs.DataIntegration.GetWorkspaceTaskTypedExpressionConfigValueParentRef[]; } interface GetWorkspaceTaskTypedExpressionConfigValueConfigParamValue { lengths: outputs.DataIntegration.GetWorkspaceTaskTypedExpressionConfigValueConfigParamValueLength[]; scales: outputs.DataIntegration.GetWorkspaceTaskTypedExpressionConfigValueConfigParamValueScale[]; } interface GetWorkspaceTaskTypedExpressionConfigValueConfigParamValueLength { /** * An integer value of the parameter. */ intValue: number; } interface GetWorkspaceTaskTypedExpressionConfigValueConfigParamValueScale { /** * An integer value of the parameter. */ intValue: number; } interface GetWorkspaceTaskTypedExpressionConfigValueParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTaskTypedExpressionParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksFilter { /** * Used to filter by the name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetWorkspaceTasksTaskSummaryCollection { items: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItem[]; } interface GetWorkspaceTasksTaskSummaryCollectionItem { /** * The REST invocation pattern to use. ASYNC_OCI_WORKREQUEST is being deprecated as well as cancelEndpoint/MethodType. */ apiCallMode: string; /** * Authentication configuration for Generic REST invocation. */ authConfig: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemAuthConfig; /** * The REST API configuration for cancelling the task. */ cancelRestCallConfig: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfig; /** * The information about the configuration provider. */ configProviderDelegate: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemConfigProviderDelegate; /** * Detailed description for the object. */ description: string; /** * The REST API configuration for execution. */ executeRestCallConfig: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfig; /** * Used to filter by the identifier of the object. */ identifier: string; /** * An array of input ports. */ inputPorts: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemInputPort[]; /** * Defines whether Data Loader task is used for single load or multiple */ isSingleLoad: boolean; /** * Used to filter by the key of the object. */ key: string; /** * A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. */ keyMap: { [key: string]: string; }; /** * A summary type containing information about the object including its key, name and when/who created/updated it. */ metadatas: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemMetadata[]; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. */ objectVersion: number; /** * Configuration values can be string, objects, or parameters. */ opConfigValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValues; /** * Describes the shape of the execution result */ operation: string; /** * An array of output ports. */ outputPorts: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOutputPort[]; /** * Defines the number of entities being loaded in parallel at a time for a Data Loader task */ parallelLoadLimit: number; /** * A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed. */ parameters: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemParameter[]; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemParentRef; /** * The REST API configuration for polling. */ pollRestCallConfig: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfig; /** * Information about the object and its parent. */ registryMetadata: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemRegistryMetadata; /** * List of typed expressions. */ typedExpressions: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemTypedExpression[]; /** * The workspace ID. */ workspaceId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemAuthConfig { /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemAuthConfigParentRef; /** * The Oracle Cloud Infrastructure resource type that will supply the authentication token */ resourcePrincipalSource: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemAuthConfigParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfig { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValues; /** * Used to filter by the key of the object. */ key: string; /** * The REST method to use. */ methodType: string; /** * The type of the types object. */ modelType: string; /** * The headers for the REST call. */ requestHeaders: { [key: string]: string; }; } interface GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValues; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesParentRef; } interface GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValues { requestPayload: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestPayload; requestUrl: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestUrl; } interface GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestPayload { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue; } interface GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues; /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues; } interface GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues { dataParam: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam; } interface GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesConfigParamValuesRequestUrl { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemCancelRestCallConfigConfigValuesParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemConfigProviderDelegate { bindings: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemConfigProviderDelegateBinding[]; } interface GetWorkspaceTasksTaskSummaryCollectionItemConfigProviderDelegateBinding { /** * Used to filter by the key of the object. */ key: string; parameterValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemConfigProviderDelegateBindingParameterValues; } interface GetWorkspaceTasksTaskSummaryCollectionItemConfigProviderDelegateBindingParameterValues { /** * The root object value, used in custom parameters. */ rootObjectValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemConfigProviderDelegateBindingParameterValuesRootObjectValue; simpleValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemConfigProviderDelegateBindingParameterValuesRootObjectValue { /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfig { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValues; /** * Used to filter by the key of the object. */ key: string; /** * The REST method to use. */ methodType: string; /** * The type of the types object. */ modelType: string; /** * The headers for the REST call. */ requestHeaders: { [key: string]: string; }; } interface GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValues; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesParentRef; } interface GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValues { requestPayload: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayload; requestUrl: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestUrl; } interface GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayload { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue; } interface GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues; /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues; } interface GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues { dataParam: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam; } interface GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesConfigParamValuesRequestUrl { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemExecuteRestCallConfigConfigValuesParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemInputPort { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemInputPortConfigValues; /** * Detailed description for the object. */ description: string; /** * Specifies the fields to get for an object. */ fields: string[]; /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemInputPortParentRef; /** * The port details for the data asset.Type. */ portType: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemInputPortConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemInputPortConfigValuesConfigParamValues; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemInputPortConfigValuesParentRef; } interface GetWorkspaceTasksTaskSummaryCollectionItemInputPortConfigValuesConfigParamValues { /** * An integer value of the parameter. */ intValue: number; /** * An object value of the parameter. */ objectValue: string; /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: string; /** * The root object value, used in custom parameters. */ rootObjectValue: string; /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemInputPortConfigValuesParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemInputPortParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemMetadata { /** * The owning object's key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemMetadataAggregator { /** * Detailed description for the object. */ description: string; /** * Used to filter by the identifier of the object. */ identifier: string; /** * Used to filter by the key of the object. */ key: string; /** * Used to filter by the name of the object. */ name: string; /** * Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.

Examples:
  • ?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task
*/ type: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemMetadataCountStatisticObjectTypeCountList[]; } interface GetWorkspaceTasksTaskSummaryCollectionItemMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValuesConfigParamValues; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValuesParentRef; } interface GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValuesConfigParamValues { configParamValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValuesConfigParamValuesConfigParamValue; /** * Used to filter by the key of the object. */ key: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValuesConfigParamValuesConfigParamValue { /** * An integer value of the parameter. */ intValue: number; /** * An object value of the parameter. */ objectValue: string; /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValuesConfigParamValuesConfigParamValueRefValue; /** * The root object value, used in custom parameters. */ rootObjectValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValuesConfigParamValuesConfigParamValueRootObjectValue; /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValuesConfigParamValuesConfigParamValueRefValue { /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValuesConfigParamValuesConfigParamValueRootObjectValue { /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface GetWorkspaceTasksTaskSummaryCollectionItemOpConfigValuesParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemOutputPort { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOutputPortConfigValues; /** * Detailed description for the object. */ description: string; /** * Specifies the fields to get for an object. */ fields: string[]; /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOutputPortParentRef; /** * The port details for the data asset.Type. */ portType: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemOutputPortConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOutputPortConfigValuesConfigParamValues; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemOutputPortConfigValuesParentRef; } interface GetWorkspaceTasksTaskSummaryCollectionItemOutputPortConfigValuesConfigParamValues { /** * An integer value of the parameter. */ intValue: number; /** * An object value of the parameter. */ objectValue: string; /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: string; /** * The root object value, used in custom parameters. */ rootObjectValue: string; /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemOutputPortConfigValuesParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemOutputPortParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemParameter { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValues; /** * A default value for the vairable. */ defaultValue: string; /** * Detailed description for the object. */ description: string; /** * Specifies whether the parameter is input value. */ isInput: boolean; /** * Specifies whether the parameter is output value. */ isOutput: boolean; /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * The output aggregation type. */ outputAggregationType: string; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemParameterParentRef; /** * A base class for all model types, including First Class and its contained objects. */ rootObjectDefaultValue: string; /** * Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.

Examples:
  • ?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task
*/ type: string; /** * The type of value the parameter was created for. */ typeName: string; /** * The param name for which parameter is created for for eg. driver Shape, Operation etc. */ usedFor: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValuesConfigParamValues; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValuesParentRef; } interface GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValuesConfigParamValues { configParamValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValuesConfigParamValuesConfigParamValue; /** * Used to filter by the key of the object. */ key: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValuesConfigParamValuesConfigParamValue { /** * An integer value of the parameter. */ intValue: number; /** * An object value of the parameter. */ objectValue: string; /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValuesConfigParamValuesConfigParamValueRefValue; /** * The root object value, used in custom parameters. */ rootObjectValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValuesConfigParamValuesConfigParamValueRootObjectValue; /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValuesConfigParamValuesConfigParamValueRefValue { /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValuesConfigParamValuesConfigParamValueRootObjectValue { /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface GetWorkspaceTasksTaskSummaryCollectionItemParameterConfigValuesParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemParameterParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfig { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValues; /** * Used to filter by the key of the object. */ key: string; /** * The REST method to use. */ methodType: string; /** * The type of the types object. */ modelType: string; /** * The headers for the REST call. */ requestHeaders: { [key: string]: string; }; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValues; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesParentRef; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValues { pollCondition: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollCondition; pollInterval: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollInterval; pollIntervalUnit: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollIntervalUnit; pollMaxDuration: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollMaxDuration; pollMaxDurationUnit: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollMaxDurationUnit; requestPayload: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestPayload; requestUrl: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestUrl; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollCondition { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollConditionRefValue; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollConditionRefValue { /** * The expression string for the object. */ exprString: string; /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * Used to filter by the name of the object. */ name: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollInterval { /** * An object value of the parameter. */ objectValue: number; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollIntervalUnit { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollMaxDuration { /** * An object value of the parameter. */ objectValue: number; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesPollMaxDurationUnit { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestPayload { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues; /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * Used to filter by the name of the object. */ name: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues { dataParam: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesConfigParamValuesRequestUrl { /** * A string value of the parameter. */ stringValue: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemPollRestCallConfigConfigValuesParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemRegistryMetadata { /** * The owning object's key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Used to filter by the key of the object. */ key: string; /** * Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version. */ registryVersion: number; } interface GetWorkspaceTasksTaskSummaryCollectionItemTypedExpression { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionConfigValues; /** * Detailed description for the object. */ description: string; /** * The expression string for the object. */ expression: string; /** * Used to filter by the key of the object. */ key: string; /** * The type of the types object. */ modelType: string; /** * The model version of an object. */ modelVersion: string; /** * Used to filter by the name of the object. */ name: string; /** * The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionParentRef; /** * Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.

Examples:
  • ?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK returns all objects of type data loader task
  • ?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task
*/ type: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionConfigValuesConfigParamValues; /** * A reference to the object's parent. */ parentRef: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionConfigValuesParentRef; } interface GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionConfigValuesConfigParamValues { length: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionConfigValuesConfigParamValuesLength; scale: outputs.DataIntegration.GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionConfigValuesConfigParamValuesScale; } interface GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionConfigValuesConfigParamValuesLength { /** * An integer value of the parameter. */ intValue: number; } interface GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionConfigValuesConfigParamValuesScale { /** * An integer value of the parameter. */ intValue: number; } interface GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionConfigValuesParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspaceTasksTaskSummaryCollectionItemTypedExpressionParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface GetWorkspacesFilter { /** * Used to filter by the name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetWorkspacesWorkspace { /** * The OCID of the compartment containing the resources you want to list. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A user defined description for the workspace. */ description: string; /** * A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information. */ displayName: string; /** * The IP of the custom DNS. */ dnsServerIp: string; /** * The DNS zone of the custom DNS to use to resolve names. */ dnsServerZone: string; endpointCompartmentId: string; /** * DCMS endpoint associated with the container/workspace. Returns null if there is none. */ endpointId: string; /** * Name of the private endpoint associated with the container/workspace. Returns null if there is none. */ endpointName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * A system-generated and immutable identifier assigned to the workspace upon creation. */ id: string; isForceOperation: boolean; /** * Specifies whether the private network connection is enabled or disabled. */ isPrivateNetworkEnabled: boolean; quiesceTimeout: number; registryCompartmentId: string; /** * DCMS registry associated with the container/workspace. Returns null if there is none. */ registryId: string; registryName: string; /** * The lifecycle state of a resource. When specified, the operation only returns resources that match the given lifecycle state. When not specified, all lifecycle states are processed as a match. */ state: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state. */ stateMessage: string; /** * The OCID of the subnet for customer connected databases. */ subnetId: string; /** * The date and time the workspace was created, in the timestamp format defined by RFC3339. */ timeCreated: string; /** * The date and time the workspace was updated, in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The OCID of the VCN the subnet is in. */ vcnId: string; } interface WorkspaceApplicationDependentObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * (Updatable) Currently not used on application creation. Reserved for future. */ key: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface WorkspaceApplicationMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.WorkspaceApplicationMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.WorkspaceApplicationMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time the application was created, in the timestamp format defined by RFC3339. */ timeCreated: string; /** * The date and time the application was updated, in the timestamp format defined by RFC3339. example: 2019-08-25T21:10:29.41Z */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface WorkspaceApplicationMetadataAggregator { /** * (Updatable) Detailed description for the object. */ description: string; /** * (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * (Updatable) Currently not used on application creation. Reserved for future. */ key: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the object in patch. */ type: string; } interface WorkspaceApplicationMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.WorkspaceApplicationMetadataCountStatisticObjectTypeCountList[]; } interface WorkspaceApplicationMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface WorkspaceApplicationParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface WorkspaceApplicationPatchDependentObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * The object's key. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface WorkspaceApplicationPatchMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.WorkspaceApplicationPatchMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.WorkspaceApplicationPatchMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface WorkspaceApplicationPatchMetadataAggregator { /** * Detailed description for the object. */ description: string; /** * Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * The object's key. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the object in patch. */ type: string; } interface WorkspaceApplicationPatchMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.WorkspaceApplicationPatchMetadataCountStatisticObjectTypeCountList[]; } interface WorkspaceApplicationPatchMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface WorkspaceApplicationPatchParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface WorkspaceApplicationPatchPatchObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * The object's key. */ key: string; /** * Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface WorkspaceApplicationPatchRegistryMetadata { /** * The owning object's key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The identifying key for the object. */ key: string; /** * Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version. */ registryVersion: number; } interface WorkspaceApplicationPublishedObjectMetadata { /** * The patch action indicating if object was created, updated, or deleted. */ action: string; /** * (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * (Updatable) Currently not used on application creation. Reserved for future. */ key: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The fully qualified path of the published object, which would include its project and folder. */ namePath: string; /** * The object version. */ objectVersion: number; /** * The type of the object in patch. */ type: string; } interface WorkspaceApplicationRegistryMetadata { /** * The owning object's key for this object. */ aggregatorKey: string; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * The identifying key for the object. */ key: string; /** * Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version. */ registryVersion: number; } interface WorkspaceApplicationScheduleFrequencyDetails { /** * (Updatable) This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) */ customExpression: string; /** * (Updatable) This holds the day of the week on which the schedule should be triggered. */ dayOfWeek: string; /** * (Updatable) A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. */ days: number[]; /** * (Updatable) the frequency of the schedule. */ frequency: string; /** * (Updatable) This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. */ interval: number; /** * (Updatable) The type of the model */ modelType: string; /** * (Updatable) A model to hold time in hour:minute:second format. */ time: outputs.DataIntegration.WorkspaceApplicationScheduleFrequencyDetailsTime; /** * (Updatable) This holds the week of the month in which the schedule should be triggered. */ weekOfMonth: string; } interface WorkspaceApplicationScheduleFrequencyDetailsTime { /** * (Updatable) The hour value. */ hour: number; /** * (Updatable) The minute value. */ minute: number; /** * (Updatable) The second value. */ second: number; } interface WorkspaceApplicationScheduleMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.WorkspaceApplicationScheduleMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.WorkspaceApplicationScheduleMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface WorkspaceApplicationScheduleMetadataAggregator { /** * (Updatable) Detailed description for the object. */ description: string; /** * (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * (Updatable) Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. */ key: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the aggregator. */ type: string; } interface WorkspaceApplicationScheduleMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.WorkspaceApplicationScheduleMetadataCountStatisticObjectTypeCountList[]; } interface WorkspaceApplicationScheduleMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface WorkspaceApplicationScheduleParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface WorkspaceApplicationScheduleRegistryMetadata { /** * (Updatable) The owning object's key for this object. */ aggregatorKey: string; /** * (Updatable) Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * (Updatable) The identifying key for the object. */ key: string; /** * (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * (Updatable) The registry version. */ registryVersion: number; } interface WorkspaceApplicationSourceApplicationInfo { /** * The source application key to use when creating the application. */ applicationKey: string; /** * The source application version of the application. */ applicationVersion: string; /** * Parameter to specify the link between SOURCE and TARGET application after copying. CONNECTED - Indicate that TARGET application is conneced to SOURCE and can be synced after copy. DISCONNECTED - Indicate that TARGET application is not conneced to SOURCE and can evolve independently. */ copyType: string; /** * The last patch key for the application. */ lastPatchKey: string; /** * The OCID of the workspace containing the application. This allows cross workspace deployment to publish an application from a different workspace into the current workspace specified in this operation. */ workspaceId: string; } interface WorkspaceApplicationTaskScheduleLastRunDetail { /** * (Updatable) Detailed description for the object. */ description: string; /** * (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * (Updatable) Generated key that can be used in API calls to identify taskSchedule. On scenarios where reference to the taskSchedule is needed, a value can be passed in create. */ key: string; /** * Time in milliseconds for the pervious schedule. */ lastRunTimeMillis: string; /** * The type of the object. */ modelType: string; /** * (Updatable) This is a version number that is used by the service to upgrade objects if needed through releases of the service. */ modelVersion: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * (Updatable) This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. */ objectVersion: number; /** * (Updatable) A reference to the object's parent. */ parentReves: outputs.DataIntegration.WorkspaceApplicationTaskScheduleLastRunDetailParentRef[]; } interface WorkspaceApplicationTaskScheduleLastRunDetailParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceApplicationTaskScheduleMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.WorkspaceApplicationTaskScheduleMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.WorkspaceApplicationTaskScheduleMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface WorkspaceApplicationTaskScheduleMetadataAggregator { /** * (Updatable) Detailed description for the object. */ description: string; /** * (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * (Updatable) Generated key that can be used in API calls to identify taskSchedule. On scenarios where reference to the taskSchedule is needed, a value can be passed in create. */ key: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the aggregator. */ type: string; } interface WorkspaceApplicationTaskScheduleMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.WorkspaceApplicationTaskScheduleMetadataCountStatisticObjectTypeCountList[]; } interface WorkspaceApplicationTaskScheduleMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface WorkspaceApplicationTaskScheduleParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceApplicationTaskScheduleRegistryMetadata { /** * (Updatable) The owning object's key for this object. */ aggregatorKey: string; /** * (Updatable) Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * (Updatable) The identifying key for the object. */ key: string; /** * (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * (Updatable) The registry version. */ registryVersion: number; } interface WorkspaceApplicationTaskScheduleScheduleRef { /** * (Updatable) Detailed description for the object. */ description: string; /** * (Updatable) The model that holds the frequency details. */ frequencyDetails: outputs.DataIntegration.WorkspaceApplicationTaskScheduleScheduleRefFrequencyDetails; /** * (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * (Updatable) A flag to indicate daylight saving. */ isDaylightAdjustmentEnabled: boolean; /** * (Updatable) Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. */ key: string; /** * (Updatable) A summary type containing information about the object including its key, name and when/who created/updated it. */ metadata: outputs.DataIntegration.WorkspaceApplicationTaskScheduleScheduleRefMetadata; /** * (Updatable) The type of the object. */ modelType: string; /** * (Updatable) This is a version number that is used by the service to upgrade objects if needed through releases of the service. */ modelVersion: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * (Updatable) This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. */ objectVersion: number; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceApplicationTaskScheduleScheduleRefParentRef; /** * (Updatable) The timezone for the schedule. */ timezone: string; } interface WorkspaceApplicationTaskScheduleScheduleRefFrequencyDetails { /** * (Updatable) This holds the complete cron expression for this schedule, for example, 10 0/5 * * * ? that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.) */ customExpression: string; /** * (Updatable) This holds the day of the week on which the schedule should be triggered. */ dayOfWeek: string; /** * (Updatable) A list of days of the month to be scheduled. i.e. excute every 2nd,3rd, 10th of the month. */ days: number[]; /** * (Updatable) the frequency of the schedule. */ frequency: string; /** * (Updatable) This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc. */ interval: number; /** * (Updatable) The type of the model */ modelType: string; /** * (Updatable) A model to hold time in hour:minute:second format. */ time: outputs.DataIntegration.WorkspaceApplicationTaskScheduleScheduleRefFrequencyDetailsTime; /** * (Updatable) This holds the week of the month in which the schedule should be triggered. */ weekOfMonth: string; } interface WorkspaceApplicationTaskScheduleScheduleRefFrequencyDetailsTime { /** * (Updatable) The hour value. */ hour: number; /** * (Updatable) The minute value. */ minute: number; /** * (Updatable) The second value. */ second: number; } interface WorkspaceApplicationTaskScheduleScheduleRefMetadata { /** * (Updatable) A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregator: outputs.DataIntegration.WorkspaceApplicationTaskScheduleScheduleRefMetadataAggregator; /** * (Updatable) The owning object key for this object. */ aggregatorKey: string; /** * (Updatable) A count statistics. */ countStatistics: outputs.DataIntegration.WorkspaceApplicationTaskScheduleScheduleRefMetadataCountStatistics; /** * (Updatable) The user that created the object. */ createdBy: string; /** * (Updatable) The user that created the object. */ createdByName: string; /** * (Updatable) The full path to identify this object. */ identifierPath: string; /** * (Updatable) Information property fields. */ infoFields: { [key: string]: string; }; /** * (Updatable) Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * (Updatable) Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * (Updatable) The registry version of the object. */ registryVersion: number; /** * (Updatable) The date and time that the object was created. */ timeCreated: string; /** * (Updatable) The date and time that the object was updated. */ timeUpdated: string; /** * (Updatable) The user that updated the object. */ updatedBy: string; /** * (Updatable) The user that updated the object. */ updatedByName: string; } interface WorkspaceApplicationTaskScheduleScheduleRefMetadataAggregator { /** * (Updatable) The description of the aggregator. */ description: string; /** * (Updatable) The identifier of the aggregator. */ identifier: string; /** * (Updatable) The key of the aggregator object. */ key: string; /** * (Updatable) The name of the aggregator. */ name: string; /** * (Updatable) The type of the aggregator. */ type: string; } interface WorkspaceApplicationTaskScheduleScheduleRefMetadataCountStatistics { /** * (Updatable) The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.WorkspaceApplicationTaskScheduleScheduleRefMetadataCountStatisticsObjectTypeCountList[]; } interface WorkspaceApplicationTaskScheduleScheduleRefMetadataCountStatisticsObjectTypeCountList { /** * (Updatable) The value for the count statistic object. */ objectCount: string; /** * (Updatable) The type of object for the count statistic object. */ objectType: string; } interface WorkspaceApplicationTaskScheduleScheduleRefParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceExportRequestExportedItem { /** * Aggregator key */ aggregatorKey: string; /** * Object identifier */ identifier: string; /** * Export object request key */ key: string; /** * Name of the export request. */ name: string; /** * Object name path */ namePath: string; /** * Object type */ objectType: string; /** * Object version */ objectVersion: string; /** * time at which this object was last updated. */ timeUpdatedInMillis: string; } interface WorkspaceFolderMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.WorkspaceFolderMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.WorkspaceFolderMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface WorkspaceFolderMetadataAggregator { /** * (Updatable) A user defined description for the folder. */ description: string; /** * (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * (Updatable) Currently not used on folder creation. Reserved for future. */ key: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the aggregator. */ type: string; } interface WorkspaceFolderMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.WorkspaceFolderMetadataCountStatisticObjectTypeCountList[]; } interface WorkspaceFolderMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface WorkspaceFolderParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface WorkspaceFolderRegistryMetadata { /** * (Updatable) The owning object's key for this object. */ aggregatorKey: string; /** * (Updatable) Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * (Updatable) The identifying key for the object. */ key: string; /** * (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * (Updatable) The registry version. */ registryVersion: number; } interface WorkspaceImportRequestImportConflictResolution { /** * In case of DUPLICATE mode, prefix will be used to disambiguate the object. */ duplicatePrefix: string; /** * In case of DUPLICATE mode, suffix will be used to disambiguate the object. */ duplicateSuffix: string; /** * Import Objects Conflict resolution Type (RETAIN/DUPLICATE/REPLACE). */ importConflictResolutionType: string; } interface WorkspaceImportRequestImportedObject { /** * Aggregator key */ aggregatorKey: string; /** * Object identifier */ identifier: string; /** * Name of the import request. */ name: string; /** * Object name path */ namePath: string; /** * New key of the object */ newKey: string; /** * Object type */ objectType: string; /** * Object version */ objectVersion: string; /** * Old key of the object */ oldKey: string; /** * Object resolution action */ resolutionAction: string; /** * time at which this object was last updated. */ timeUpdatedInMillis: string; } interface WorkspaceProjectMetadata { /** * The owning object key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.WorkspaceProjectMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.WorkspaceProjectMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version of the object. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface WorkspaceProjectMetadataAggregator { /** * (Updatable) A user defined description for the project. */ description: string; /** * (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * (Updatable) Generated key that can be used in API calls to identify project. */ key: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The type of the aggregator. */ type: string; } interface WorkspaceProjectMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.WorkspaceProjectMetadataCountStatisticObjectTypeCountList[]; } interface WorkspaceProjectMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface WorkspaceProjectParentRef { /** * Key of the parent object. */ parent: string; /** * Key of the root document object. */ rootDocId: string; } interface WorkspaceProjectRegistryMetadata { /** * (Updatable) The owning object's key for this object. */ aggregatorKey: string; /** * (Updatable) Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * (Updatable) The identifying key for the object. */ key: string; /** * (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * (Updatable) The registry version. */ registryVersion: number; } interface WorkspaceTaskAuthConfig { /** * (Updatable) Generated key that can be used in API calls to identify this object. */ key: string; /** * (Updatable) The specific authentication configuration to be used for Generic REST invocation. */ modelType: string; /** * (Updatable) The model version of an object. */ modelVersion: string; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskAuthConfigParentRef; /** * (Updatable) The Oracle Cloud Infrastructure resource type that will supply the authentication token */ resourcePrincipalSource: string; } interface WorkspaceTaskAuthConfigParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskCancelRestCallConfig { /** * (Updatable) Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.WorkspaceTaskCancelRestCallConfigConfigValues; /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The REST method to use. */ methodType: string; /** * (Updatable) The type of the task. */ modelType: string; /** * (Updatable) The headers for the REST call. */ requestHeaders: { [key: string]: string; }; } interface WorkspaceTaskCancelRestCallConfigConfigValues { /** * (Updatable) The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValues; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskCancelRestCallConfigConfigValuesParentRef; } interface WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValues { requestPayload: outputs.DataIntegration.WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestPayload; requestUrl: outputs.DataIntegration.WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestUrl; } interface WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestPayload { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue; } interface WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues; /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The type of the task. */ modelType: string; } interface WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues; } interface WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues { dataParam: outputs.DataIntegration.WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam; } interface WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam { /** * A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskCancelRestCallConfigConfigValuesConfigParamValuesRequestUrl { /** * A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskCancelRestCallConfigConfigValuesParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskConfigProviderDelegate { /** * bindings */ bindings: outputs.DataIntegration.WorkspaceTaskConfigProviderDelegateBinding[]; } interface WorkspaceTaskConfigProviderDelegateBinding { /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; parameterValues: outputs.DataIntegration.WorkspaceTaskConfigProviderDelegateBindingParameterValues; } interface WorkspaceTaskConfigProviderDelegateBindingParameterValues { /** * The root object value, used in custom parameters. */ rootObjectValue: outputs.DataIntegration.WorkspaceTaskConfigProviderDelegateBindingParameterValuesRootObjectValue; /** * A simple value for the parameter. */ simpleValue: string; } interface WorkspaceTaskConfigProviderDelegateBindingParameterValuesRootObjectValue { /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The type of the task. */ modelType: string; /** * (Updatable) The object's model version. */ modelVersion: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface WorkspaceTaskExecuteRestCallConfig { /** * (Updatable) Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.WorkspaceTaskExecuteRestCallConfigConfigValues; /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The REST method to use. */ methodType: string; /** * (Updatable) The type of the task. */ modelType: string; /** * (Updatable) The headers for the REST call. */ requestHeaders: { [key: string]: string; }; } interface WorkspaceTaskExecuteRestCallConfigConfigValues { /** * (Updatable) The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValues; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskExecuteRestCallConfigConfigValuesParentRef; } interface WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValues { requestPayload: outputs.DataIntegration.WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayload; requestUrl: outputs.DataIntegration.WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestUrl; } interface WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayload { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue; } interface WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues; /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The type of the task. */ modelType: string; } interface WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues; } interface WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues { dataParam: outputs.DataIntegration.WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam; } interface WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam { /** * A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskExecuteRestCallConfigConfigValuesConfigParamValuesRequestUrl { /** * A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskExecuteRestCallConfigConfigValuesParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskInputPort { /** * (Updatable) Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.WorkspaceTaskInputPortConfigValues; /** * (Updatable) Detailed description for the object. */ description: string; /** * (Updatable) An array of fields. */ fields: string[]; /** * (Updatable) The key of the object. */ key: string; /** * (Updatable) The type of the types object. */ modelType: string; /** * (Updatable) The model version of an object. */ modelVersion: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskInputPortParentRef; /** * (Updatable) The port details for the data asset.Type. */ portType: string; } interface WorkspaceTaskInputPortConfigValues { /** * (Updatable) The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskInputPortConfigValuesConfigParamValues; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskInputPortConfigValuesParentRef; } interface WorkspaceTaskInputPortConfigValuesConfigParamValues { /** * (Updatable) An integer value of the parameter. */ intValue: number; /** * (Updatable) An object value of the parameter. */ objectValue: string; /** * (Updatable) Reference to the parameter by its key. */ parameterValue: string; /** * (Updatable) The root object reference value. */ refValue: string; /** * (Updatable) The root object value, used in custom parameters. */ rootObjectValue: string; /** * (Updatable) A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskInputPortConfigValuesParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskInputPortParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskMetadata { /** * The owning object's key for this object. */ aggregatorKey: string; /** * A summary type containing information about the object's aggregator including its type, key, name and description. */ aggregators: outputs.DataIntegration.WorkspaceTaskMetadataAggregator[]; /** * A count statistics. */ countStatistics: outputs.DataIntegration.WorkspaceTaskMetadataCountStatistic[]; /** * The user that created the object. */ createdBy: string; /** * The user that created the object. */ createdByName: string; /** * The full path to identify this object. */ identifierPath: string; /** * Information property fields. */ infoFields: { [key: string]: string; }; /** * Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * The registry version. */ registryVersion: number; /** * The date and time that the object was created. */ timeCreated: string; /** * The date and time that the object was updated. */ timeUpdated: string; /** * The user that updated the object. */ updatedBy: string; /** * The user that updated the object. */ updatedByName: string; } interface WorkspaceTaskMetadataAggregator { /** * (Updatable) Detailed description for the object. */ description: string; /** * (Updatable) Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. */ identifier: string; /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * The object type. */ type: string; } interface WorkspaceTaskMetadataCountStatistic { /** * The array of statistics. */ objectTypeCountLists: outputs.DataIntegration.WorkspaceTaskMetadataCountStatisticObjectTypeCountList[]; } interface WorkspaceTaskMetadataCountStatisticObjectTypeCountList { /** * The value for the count statistic object. */ objectCount: string; /** * The type of object for the count statistic object. */ objectType: string; } interface WorkspaceTaskOpConfigValues { /** * (Updatable) The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskOpConfigValuesConfigParamValues; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskOpConfigValuesParentRef; } interface WorkspaceTaskOpConfigValuesConfigParamValues { configParamValue: outputs.DataIntegration.WorkspaceTaskOpConfigValuesConfigParamValuesConfigParamValue; /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; } interface WorkspaceTaskOpConfigValuesConfigParamValuesConfigParamValue { /** * An integer value of the parameter. */ intValue: number; /** * An object value of the parameter. */ objectValue: string; /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.WorkspaceTaskOpConfigValuesConfigParamValuesConfigParamValueRefValue; /** * The root object value, used in custom parameters. */ rootObjectValue: outputs.DataIntegration.WorkspaceTaskOpConfigValuesConfigParamValuesConfigParamValueRootObjectValue; /** * A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskOpConfigValuesConfigParamValuesConfigParamValueRefValue { /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The type of the task. */ modelType: string; /** * (Updatable) The object's model version. */ modelVersion: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface WorkspaceTaskOpConfigValuesConfigParamValuesConfigParamValueRootObjectValue { /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The type of the task. */ modelType: string; /** * (Updatable) The object's model version. */ modelVersion: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface WorkspaceTaskOpConfigValuesParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskOutputPort { /** * (Updatable) Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.WorkspaceTaskOutputPortConfigValues; /** * (Updatable) Detailed description for the object. */ description: string; /** * (Updatable) An array of fields. */ fields: string[]; /** * (Updatable) The key of the object. */ key: string; /** * (Updatable) The type of the types object. */ modelType: string; /** * (Updatable) The model version of an object. */ modelVersion: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskOutputPortParentRef; /** * (Updatable) The port details for the data asset.Type. */ portType: string; } interface WorkspaceTaskOutputPortConfigValues { /** * (Updatable) The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskOutputPortConfigValuesConfigParamValues; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskOutputPortConfigValuesParentRef; } interface WorkspaceTaskOutputPortConfigValuesConfigParamValues { /** * (Updatable) An integer value of the parameter. */ intValue: number; /** * (Updatable) An object value of the parameter. */ objectValue: string; /** * (Updatable) Reference to the parameter by its key. */ parameterValue: string; /** * (Updatable) The root object reference value. */ refValue: string; /** * (Updatable) The root object value, used in custom parameters. */ rootObjectValue: string; /** * (Updatable) A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskOutputPortConfigValuesParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskOutputPortParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskParameter { /** * (Updatable) Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.WorkspaceTaskParameterConfigValues; /** * (Updatable) The default value of the parameter. */ defaultValue: string; /** * (Updatable) Detailed description for the object. */ description: string; /** * (Updatable) Specifies whether the parameter is input value. */ isInput: boolean; /** * (Updatable) Specifies whether the parameter is output value. */ isOutput: boolean; /** * (Updatable) The key of the object. */ key: string; /** * (Updatable) The type of the types object. */ modelType: string; /** * (Updatable) The model version of an object. */ modelVersion: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * (Updatable) The output aggregation type. */ outputAggregationType: string; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskParameterParentRef; /** * (Updatable) The default value of the parameter which can be an object in DIS, such as a data entity. */ rootObjectDefaultValue: string; /** * (Updatable) This can either be a string value referencing the type or a BaseType object. */ type: string; /** * (Updatable) The type of value the parameter was created for. */ typeName: string; /** * (Updatable) The param name for which parameter is created for for eg. driver Shape, Operation etc. */ usedFor: string; } interface WorkspaceTaskParameterConfigValues { /** * (Updatable) The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskParameterConfigValuesConfigParamValues; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskParameterConfigValuesParentRef; } interface WorkspaceTaskParameterConfigValuesConfigParamValues { configParamValue: outputs.DataIntegration.WorkspaceTaskParameterConfigValuesConfigParamValuesConfigParamValue; /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; } interface WorkspaceTaskParameterConfigValuesConfigParamValuesConfigParamValue { /** * An integer value of the parameter. */ intValue: number; /** * An object value of the parameter. */ objectValue: string; /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.WorkspaceTaskParameterConfigValuesConfigParamValuesConfigParamValueRefValue; /** * The root object value, used in custom parameters. */ rootObjectValue: outputs.DataIntegration.WorkspaceTaskParameterConfigValuesConfigParamValuesConfigParamValueRootObjectValue; /** * A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskParameterConfigValuesConfigParamValuesConfigParamValueRefValue { /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The type of the task. */ modelType: string; /** * (Updatable) The object's model version. */ modelVersion: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface WorkspaceTaskParameterConfigValuesConfigParamValuesConfigParamValueRootObjectValue { /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The type of the task. */ modelType: string; /** * (Updatable) The object's model version. */ modelVersion: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; } interface WorkspaceTaskParameterConfigValuesParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskParameterParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskPollRestCallConfig { /** * (Updatable) Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValues; /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The REST method to use. */ methodType: string; /** * (Updatable) The type of the task. */ modelType: string; /** * (Updatable) The headers for the REST call. */ requestHeaders: { [key: string]: string; }; } interface WorkspaceTaskPollRestCallConfigConfigValues { /** * (Updatable) The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValues; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesParentRef; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValues { pollCondition: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollCondition; pollInterval: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollInterval; pollIntervalUnit: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollIntervalUnit; pollMaxDuration: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollMaxDuration; pollMaxDurationUnit: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollMaxDurationUnit; requestPayload: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestPayload; requestUrl: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestUrl; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollCondition { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollConditionRefValue; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollConditionRefValue { /** * The expression string for the object. */ exprString: string; /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The type of the task. */ modelType: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollInterval { /** * An object value of the parameter. */ objectValue: number; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollIntervalUnit { /** * A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollMaxDuration { /** * An object value of the parameter. */ objectValue: number; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesPollMaxDurationUnit { /** * A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestPayload { /** * Reference to the parameter by its key. */ parameterValue: string; /** * The root object reference value. */ refValue: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValue { /** * Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues; /** * (Updatable) Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. */ key: string; /** * (Updatable) The type of the task. */ modelType: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValues { /** * The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValues { dataParam: outputs.DataIntegration.WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestPayloadRefValueConfigValuesConfigParamValuesDataParam { /** * A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskPollRestCallConfigConfigValuesConfigParamValuesRequestUrl { /** * A string value of the parameter. */ stringValue: string; } interface WorkspaceTaskPollRestCallConfigConfigValuesParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskRegistryMetadata { /** * (Updatable) The owning object's key for this object. */ aggregatorKey: string; /** * (Updatable) Specifies whether this object is a favorite or not. */ isFavorite: boolean; /** * (Updatable) The identifying key for the object. */ key: string; /** * (Updatable) Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. */ labels: string[]; /** * (Updatable) The registry version. */ registryVersion: number; } interface WorkspaceTaskTypedExpression { /** * (Updatable) Configuration values can be string, objects, or parameters. */ configValues: outputs.DataIntegration.WorkspaceTaskTypedExpressionConfigValues; /** * (Updatable) Detailed description for the object. */ description: string; /** * (Updatable) The expression string for the object. */ expression: string; /** * (Updatable) The key of the object. */ key: string; /** * (Updatable) The type of the types object. */ modelType: string; /** * (Updatable) The model version of an object. */ modelVersion: string; /** * (Updatable) Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. */ name: string; /** * (Updatable) The status of an object that can be set to value 1 for shallow references across objects, other values reserved. */ objectStatus: number; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskTypedExpressionParentRef; /** * (Updatable) The object type. */ type: string; } interface WorkspaceTaskTypedExpressionConfigValues { /** * (Updatable) The configuration parameter values. */ configParamValues: outputs.DataIntegration.WorkspaceTaskTypedExpressionConfigValuesConfigParamValues; /** * (Updatable) A reference to the object's parent. */ parentRef: outputs.DataIntegration.WorkspaceTaskTypedExpressionConfigValuesParentRef; } interface WorkspaceTaskTypedExpressionConfigValuesConfigParamValues { length: outputs.DataIntegration.WorkspaceTaskTypedExpressionConfigValuesConfigParamValuesLength; scale: outputs.DataIntegration.WorkspaceTaskTypedExpressionConfigValuesConfigParamValuesScale; } interface WorkspaceTaskTypedExpressionConfigValuesConfigParamValuesLength { /** * An integer value of the parameter. */ intValue: number; } interface WorkspaceTaskTypedExpressionConfigValuesConfigParamValuesScale { /** * An integer value of the parameter. */ intValue: number; } interface WorkspaceTaskTypedExpressionConfigValuesParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } interface WorkspaceTaskTypedExpressionParentRef { /** * (Updatable) Key of the parent object. */ parent: string; /** * (Updatable) Key of the root document object. */ rootDocId: string; } } export declare namespace DataLabellingService { interface DatasetDatasetFormatDetails { /** * The format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are TXT files. */ formatType: string; /** * Metadata for files with text content. */ textFileTypeMetadata: outputs.DataLabellingService.DatasetDatasetFormatDetailsTextFileTypeMetadata; } interface DatasetDatasetFormatDetailsTextFileTypeMetadata { /** * A column delimiter */ columnDelimiter: string; /** * The index of a selected column. This is a zero-based index. */ columnIndex: number; /** * The name of a selected column. */ columnName: string; /** * An escape character. */ escapeCharacter: string; /** * It defines the format type of text files. */ formatType: string; /** * A line delimiter. */ lineDelimiter: string; } interface DatasetDatasetSourceDetails { /** * The object storage bucket that contains the dataset data source. */ bucket: string; /** * The namespace of the bucket that contains the dataset data source. */ namespace: string; /** * A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix. */ prefix: string; /** * The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is. */ sourceType: string; } interface DatasetInitialImportDatasetConfiguration { /** * File format details used for importing dataset */ importFormat: outputs.DataLabellingService.DatasetInitialImportDatasetConfigurationImportFormat; /** * Object storage path for the metadata file */ importMetadataPath: outputs.DataLabellingService.DatasetInitialImportDatasetConfigurationImportMetadataPath; } interface DatasetInitialImportDatasetConfigurationImportFormat { /** * Name of import format */ name: string; /** * Version of import format */ version: string; } interface DatasetInitialImportDatasetConfigurationImportMetadataPath { /** * Bucket name */ bucket: string; /** * Bucket namespace name */ namespace: string; /** * Path for the metadata file. */ path: string; /** * The type of data source. OBJECT_STORAGE - The source details for an object storage bucket. */ sourceType: string; } interface DatasetInitialRecordGenerationConfiguration { } interface DatasetLabelSet { /** * An ordered collection of labels that are unique by name. */ items: outputs.DataLabellingService.DatasetLabelSetItem[]; } interface DatasetLabelSetItem { /** * An unique name for a label within its dataset. */ name: string; } interface GetAnnotationFormatItem { /** * A unique name for the target AnnotationFormat for the Dataset. */ name: string; } interface GetAnnotationFormatsAnnotationFormatCollection { /** * List of annotation formats. */ items: outputs.DataLabellingService.GetAnnotationFormatsAnnotationFormatCollectionItem[]; } interface GetAnnotationFormatsAnnotationFormatCollectionItem { /** * A unique name for the target AnnotationFormat for the Dataset. */ name: string; } interface GetAnnotationFormatsFilter { /** * A unique name for the target AnnotationFormat for the Dataset. */ name: string; regex?: boolean; values: string[]; } interface GetDatasetDatasetFormatDetail { /** * It defines the format type of text files. */ formatType: string; /** * Metadata for files with text content. */ textFileTypeMetadatas: outputs.DataLabellingService.GetDatasetDatasetFormatDetailTextFileTypeMetadata[]; } interface GetDatasetDatasetFormatDetailTextFileTypeMetadata { /** * A column delimiter */ columnDelimiter: string; /** * The index of a selected column. This is a zero-based index. */ columnIndex: number; /** * The name of a selected column. */ columnName: string; /** * An escape character. */ escapeCharacter: string; /** * It defines the format type of text files. */ formatType: string; /** * A line delimiter. */ lineDelimiter: string; } interface GetDatasetDatasetSourceDetail { /** * Bucket name */ bucket: string; /** * Bucket namespace name */ namespace: string; /** * A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix. */ prefix: string; /** * The type of data source. OBJECT_STORAGE - The source details for an object storage bucket. */ sourceType: string; } interface GetDatasetInitialImportDatasetConfiguration { /** * File format details used for importing dataset */ importFormats: outputs.DataLabellingService.GetDatasetInitialImportDatasetConfigurationImportFormat[]; /** * Object storage path for the metadata file */ importMetadataPaths: outputs.DataLabellingService.GetDatasetInitialImportDatasetConfigurationImportMetadataPath[]; } interface GetDatasetInitialImportDatasetConfigurationImportFormat { /** * An unique name for a label within its dataset. */ name: string; /** * Version of import format */ version: string; } interface GetDatasetInitialImportDatasetConfigurationImportMetadataPath { /** * Bucket name */ bucket: string; /** * Bucket namespace name */ namespace: string; /** * Path for the metadata file. */ path: string; /** * The type of data source. OBJECT_STORAGE - The source details for an object storage bucket. */ sourceType: string; } interface GetDatasetInitialRecordGenerationConfiguration { } interface GetDatasetLabelSet { /** * An ordered collection of labels that are unique by name. */ items: outputs.DataLabellingService.GetDatasetLabelSetItem[]; } interface GetDatasetLabelSetItem { /** * An unique name for a label within its dataset. */ name: string; } interface GetDatasetsDatasetCollection { /** * An ordered collection of labels that are unique by name. */ items: outputs.DataLabellingService.GetDatasetsDatasetCollectionItem[]; } interface GetDatasetsDatasetCollectionItem { /** * 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"}` */ additionalProperties: { [key: string]: string; }; /** * A filter to return only resources that match the entire annotation format given. */ annotationFormat: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT. */ datasetFormatDetails: outputs.DataLabellingService.GetDatasetsDatasetCollectionItemDatasetFormatDetail[]; /** * This allows the customer to specify the source of the dataset. */ datasetSourceDetails: outputs.DataLabellingService.GetDatasetsDatasetCollectionItemDatasetSourceDetail[]; /** * The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * A user provided description of the dataset */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Unique Dataset OCID */ id: string; /** * Initial import dataset configuration. Allows user to create dataset from existing dataset files. */ initialImportDatasetConfigurations: outputs.DataLabellingService.GetDatasetsDatasetCollectionItemInitialImportDatasetConfiguration[]; /** * The initial generate records configuration. It generates records from the dataset's source. */ initialRecordGenerationConfigurations: outputs.DataLabellingService.GetDatasetsDatasetCollectionItemInitialRecordGenerationConfiguration[]; /** * An ordered collection of labels that are unique by name. */ labelSets: outputs.DataLabellingService.GetDatasetsDatasetCollectionItemLabelSet[]; /** * The labeling instructions for human labelers in rich text format */ labelingInstructions: string; /** * A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state. */ lifecycleDetails: string; /** * The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported. */ lifecycleSubstate: string; /** * A filter to return only resources whose lifecycleState matches this query param. */ state: string; /** * The date and time the resource was created, in the timestamp format defined by RFC3339. */ timeCreated: string; /** * The date and time the resource was last updated, in the timestamp format defined by RFC3339. */ timeUpdated: string; } interface GetDatasetsDatasetCollectionItemDatasetFormatDetail { /** * It defines the format type of text files. */ formatType: string; /** * Metadata for files with text content. */ textFileTypeMetadatas: outputs.DataLabellingService.GetDatasetsDatasetCollectionItemDatasetFormatDetailTextFileTypeMetadata[]; } interface GetDatasetsDatasetCollectionItemDatasetFormatDetailTextFileTypeMetadata { /** * A column delimiter */ columnDelimiter: string; /** * The index of a selected column. This is a zero-based index. */ columnIndex: number; /** * The name of a selected column. */ columnName: string; /** * An escape character. */ escapeCharacter: string; /** * It defines the format type of text files. */ formatType: string; /** * A line delimiter. */ lineDelimiter: string; } interface GetDatasetsDatasetCollectionItemDatasetSourceDetail { /** * Bucket name */ bucket: string; /** * Bucket namespace name */ namespace: string; /** * A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix. */ prefix: string; /** * The type of data source. OBJECT_STORAGE - The source details for an object storage bucket. */ sourceType: string; } interface GetDatasetsDatasetCollectionItemInitialImportDatasetConfiguration { /** * File format details used for importing dataset */ importFormats: outputs.DataLabellingService.GetDatasetsDatasetCollectionItemInitialImportDatasetConfigurationImportFormat[]; /** * Object storage path for the metadata file */ importMetadataPaths: outputs.DataLabellingService.GetDatasetsDatasetCollectionItemInitialImportDatasetConfigurationImportMetadataPath[]; } interface GetDatasetsDatasetCollectionItemInitialImportDatasetConfigurationImportFormat { /** * An unique name for a label within its dataset. */ name: string; /** * Version of import format */ version: string; } interface GetDatasetsDatasetCollectionItemInitialImportDatasetConfigurationImportMetadataPath { /** * Bucket name */ bucket: string; /** * Bucket namespace name */ namespace: string; /** * Path for the metadata file. */ path: string; /** * The type of data source. OBJECT_STORAGE - The source details for an object storage bucket. */ sourceType: string; } interface GetDatasetsDatasetCollectionItemInitialRecordGenerationConfiguration { } interface GetDatasetsDatasetCollectionItemLabelSet { /** * An ordered collection of labels that are unique by name. */ items: outputs.DataLabellingService.GetDatasetsDatasetCollectionItemLabelSetItem[]; } interface GetDatasetsDatasetCollectionItemLabelSetItem { /** * An unique name for a label within its dataset. */ name: string; } interface GetDatasetsFilter { /** * An unique name for a label within its dataset. */ name: string; regex?: boolean; values: string[]; } } export declare namespace DataSafe { interface AlertPolicyAlertPolicyRuleDetail { /** * Describes the alert policy rule. */ description: string; /** * The display name of the alert policy rule. */ displayName: string; /** * The conditional expression of the alert policy rule which evaluates to boolean value. */ expression: string; } interface AuditPolicyAuditCondition { /** * Indicates the audit policy name. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. */ auditPolicyName: string; /** * Indicates the users/roles in the target database for which the audit policy is enforced, and the success/failure event condition to generate the audit event.. */ enableConditions: outputs.DataSafe.AuditPolicyAuditConditionEnableCondition[]; /** * Indicates whether the Data Safe user activity on the target database will be audited by the policy. */ isDataSafeServiceAccountAudited: boolean; /** * Indicates whether the privileged user list is managed by Data Safe. */ isPrivUsersManagedByDataSafe: boolean; } interface AuditPolicyAuditConditionEnableCondition { /** * List of users or roles that the policy must be enabled for. */ entityNames: string[]; /** * The entity include or exclude selection. */ entitySelection: string; /** * The entity type that the policy must be enabled for. */ entityType: string; /** * The operation status that the policy must be enabled for. */ operationStatus: string; } interface AuditPolicyAuditSpecification { /** * The category to which the audit policy belongs. */ auditPolicyCategory: string; /** * Indicates the audit policy name. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. */ auditPolicyName: string; /** * Indicates the names of corresponding database policy ( or policies) in the target database. */ databasePolicyNames: string[]; /** * Indicates whether the policy has been enabled, disabled or partially enabled in the target database. The status is PARTIALLY_ENABLED if any of the constituent database audit policies is not enabled. */ enableStatus: string; /** * Indicates on whom the audit policy is enabled. */ enabledEntities: string; /** * Indicates whether the policy is already created on the target database. */ isCreated: boolean; /** * Indicates whether the policy by default is enabled for all users with no flexibility to alter the enablement conditions. */ isEnabledForAllUsers: boolean; /** * Indicates whether the audit policy is one of the seeded policies provided by Oracle Data Safe. */ isSeededInDataSafe: boolean; /** * Indicates whether the audit policy is one of the predefined policies provided by Oracle Database. */ isSeededInTarget: boolean; /** * Indicates whether the audit policy is available for provisioning/ de-provisioning from Oracle Data Safe, or is only available for displaying the current provisioning status from the target. */ isViewOnly: boolean; /** * Provides information about the policy that has been only partially enabled. */ partiallyEnabledMsg: string; } interface AuditPolicyManagementAuditCondition { /** * Indicates the audit policy name. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. */ auditPolicyName: string; /** * Indicates the users/roles in the target database for which the audit policy is enforced, and the success/failure event condition to generate the audit event.. */ enableConditions: outputs.DataSafe.AuditPolicyManagementAuditConditionEnableCondition[]; /** * Indicates whether the Data Safe user activity on the target database will be audited by the policy. */ isDataSafeServiceAccountAudited: boolean; /** * Indicates whether the policy has to be enabled or disabled in the target database. Set this to true if you want the audit policy to be enabled in the target database. If the seeded audit policy is not already created in the database, the provisioning creates and enables them. If this is set to false, the policy will be disabled in the target database. */ isEnabled: boolean; /** * Indicates whether the privileged user list is managed by Data Safe. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ isPrivUsersManagedByDataSafe: boolean; } interface AuditPolicyManagementAuditConditionEnableCondition { /** * List of users or roles that the policy must be enabled for. */ entityNames: string[]; /** * The entity include or exclude selection. */ entitySelection: string; /** * The entity type that the policy must be enabled for. */ entityType: string; /** * The operation status that the policy must be enabled for. */ operationStatus: string; } interface AuditPolicyManagementAuditSpecification { /** * The category to which the audit policy belongs. */ auditPolicyCategory: string; /** * Indicates the audit policy name. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. */ auditPolicyName: string; /** * Indicates the names of corresponding database policy ( or policies) in the target database. */ databasePolicyNames: string[]; /** * Indicates whether the policy has been enabled, disabled or partially enabled in the target database. The status is PARTIALLY_ENABLED if any of the constituent database audit policies is not enabled. */ enableStatus: string; /** * Indicates on whom the audit policy is enabled. */ enabledEntities: string; /** * Indicates whether the policy is already created on the target database. */ isCreated: boolean; /** * Indicates whether the policy by default is enabled for all users with no flexibility to alter the enablement conditions. */ isEnabledForAllUsers: boolean; /** * Indicates whether the audit policy is one of the seeded policies provided by Oracle Data Safe. */ isSeededInDataSafe: boolean; /** * Indicates whether the audit policy is one of the predefined policies provided by Oracle Database. */ isSeededInTarget: boolean; /** * Indicates whether the audit policy is available for provisioning/ de-provisioning from Oracle Data Safe, or is only available for displaying the current provisioning status from the target. */ isViewOnly: boolean; /** * Provides information about the policy that has been only partially enabled. */ partiallyEnabledMsg: string; } interface AuditProfileAuditTrail { /** * The date from which the audit trail must start collecting data, in the format defined by RFC3339. */ auditCollectionStartTime: string; /** * The OCID of the parent audit. */ auditProfileId: string; /** * Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true. */ canUpdateLastArchiveTimeOnTarget: boolean; /** * (Updatable) The OCID of the compartment where you want to create the audit profile. */ compartmentId: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) The description of the audit profile. */ description: string; /** * (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable. */ displayName: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the audit profile. */ id: string; /** * Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large. */ isAutoPurgeEnabled: boolean; /** * Details about the current state of the audit profile in Data Safe. */ lifecycleDetails: string; /** * The secondary id assigned for the peer database registered with Data Safe. */ peerTargetDatabaseKey: number; /** * The details of the audit trail purge job that ran on the "purgeJobTime". */ purgeJobDetails: string; /** * The current status of the audit trail purge job. */ purgeJobStatus: string; /** * The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339. */ purgeJobTime: string; /** * The current state of the audit profile. */ state: string; /** * The current sub-state of the audit trail. */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of the target database or target database group for which the audit profile is created. */ targetId: string; /** * The date and time the audit profile was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339. */ timeLastCollected: string; /** * The date and time the audit profile was updated, in the format defined by RFC3339. */ timeUpdated: string; /** * An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. */ trailLocation: string; /** * The underlying source of unified audit trail. */ trailSource: string; /** * The OCID of the workrequest for audit trail which collects audit records. */ workRequestId: string; } interface AuditProfileManagementAuditTrail { /** * The date from which the audit trail must start collecting data, in the format defined by RFC3339. */ auditCollectionStartTime: string; /** * The OCID of the parent audit. */ auditProfileId: string; /** * Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true. */ canUpdateLastArchiveTimeOnTarget: boolean; /** * (Updatable) The OCID of the compartment where you want to create the audit profile. */ compartmentId: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) The description of the audit profile. */ description: string; /** * (Updatable) The display name of the audit profile. The name does not have to be unique, and it's updatable. */ displayName: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the audit profile. */ id: string; /** * Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large. */ isAutoPurgeEnabled: boolean; /** * Details about the current state of the audit profile in Data Safe. */ lifecycleDetails: string; /** * The secondary id assigned for the peer database registered with Data Safe. */ peerTargetDatabaseKey: number; /** * The details of the audit trail purge job that ran on the "purgeJobTime". */ purgeJobDetails: string; /** * The current status of the audit trail purge job. */ purgeJobStatus: string; /** * The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339. */ purgeJobTime: string; /** * The current state of the audit profile. */ state: string; /** * The current sub-state of the audit trail. */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of the target database or target database group for which the audit profile is created. */ targetId: string; /** * The date and time the audit profile was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339. */ timeLastCollected: string; /** * The date and time the audit profile was updated, in the format defined by RFC3339. */ timeUpdated: string; /** * An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. */ trailLocation: string; /** * The underlying source of unified audit trail. */ trailSource: string; /** * The OCID of the workrequest for audit trail which collects audit records. */ workRequestId: string; } interface CalculateAuditVolumeAvailableAvailableAuditVolume { /** * The OCID of the audit. */ auditProfileId: string; monthInConsideration: string; trailLocation: string; volume: string; } interface CalculateAuditVolumeCollectedCollectedAuditVolume { archivedVolume: string; /** * The OCID of the audit. */ auditProfileId: string; monthInConsideration: string; onlineVolume: string; } interface DataSafeConfigurationGlobalSetting { /** * The paid usage option chosen by the customer admin. */ isPaidUsage: boolean; /** * The offline retention period in months. */ offlineRetentionPeriod: number; /** * The online retention period in months. */ onlineRetentionPeriod: number; } interface DatabaseSecurityConfigManagementSqlFirewallConfig { /** * (Updatable) Specifies whether the firewall should include or exclude the database internal job activities. */ excludeJob: string; /** * (Updatable) Specifies whether the firewall is enabled or disabled on the target database. */ status: string; /** * The most recent time when the firewall status is updated, in the format defined by RFC3339. */ timeStatusUpdated: string; /** * (Updatable) Specifies whether Data Safe should automatically purge the violation logs from the database after collecting the violation logs and persisting on Data Safe. */ violationLogAutoPurge: string; } interface DatabaseSecurityConfigSqlFirewallConfig { /** * (Updatable) Specifies whether the firewall should include or exclude the database internal job activities. */ excludeJob: string; /** * (Updatable) Specifies whether the firewall is enabled or disabled on the target database. */ status: string; /** * The most recent time when the firewall status is updated, in the format defined by RFC3339. */ timeStatusUpdated: string; /** * (Updatable) Specifies whether Data Safe should automatically purge the violation logs from the database after collecting the violation logs and persisting on Data Safe. */ violationLogAutoPurge: string; } interface DiscoveryJobsResultConfidenceLevelDetail { doesColumnLeadToPiiInNonTables: boolean; doesColumnLeadToPiiInSameRelatedTables: boolean; hasCommentPatternMatched: boolean; hasDataPatternMatched: boolean; hasNamePatternMatched: boolean; isSensitiveTypeFromSameContextFoundInSameOrRelatedTables: boolean; } interface DiscoveryJobsResultModifiedAttribute { /** * Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. */ appDefinedChildColumnKeys: string[]; /** * Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. */ dbDefinedChildColumnKeys: string[]; } interface DiscoveryModTablesForDiscovery { /** * This contains the name of the schema. */ schemaName: string; /** * This contains an optional list of the table names. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ tableNames: string[]; } interface GetAlertAnalyticItem { /** * Total count of aggregated values. */ count: string; /** * Details of aggregation dimension summarizing alerts. */ dimensions: outputs.DataSafe.GetAlertAnalyticItemDimension[]; /** * The name of the aggregation. */ metricName: string; /** * An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeEnded: string; /** * An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStarted: string; } interface GetAlertAnalyticItemDimension { /** * A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter. */ groupBy: { [key: string]: string; }; } interface GetAlertPoliciesAlertPolicyCollection { items: outputs.DataSafe.GetAlertPoliciesAlertPolicyCollectionItem[]; } interface GetAlertPoliciesAlertPolicyCollectionItem { alertPolicyRuleDetails: outputs.DataSafe.GetAlertPoliciesAlertPolicyCollectionItemAlertPolicyRuleDetail[]; /** * Indicates the Data Safe feature to which the alert policy belongs. */ alertPolicyType: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the alert policy. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the alert policy. */ id: string; /** * An optional filter to return only alert policies that are user-defined or not. */ isUserDefined: boolean; /** * Details about the current state of the alert policy. */ lifecycleDetails: string; /** * Severity level of the alert raised by this policy. */ severity: string; /** * An optional filter to return only alert policies that have the given life-cycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Creation date and time of the alert policy, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * Last date and time the alert policy was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetAlertPoliciesAlertPolicyCollectionItemAlertPolicyRuleDetail { /** * The description of the alert policy. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; expression: string; } interface GetAlertPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetAlertPolicyAlertPolicyRuleDetail { /** * The description of the alert policy. */ description: string; /** * The display name of the alert policy. */ displayName: string; expression: string; } interface GetAlertPolicyRulesAlertPolicyRuleCollection { items: outputs.DataSafe.GetAlertPolicyRulesAlertPolicyRuleCollectionItem[]; } interface GetAlertPolicyRulesAlertPolicyRuleCollectionItem { /** * The OCID of the alert policy. */ alertPolicyId: string; /** * Describes the alert policy rule. */ description: string; /** * The display name of the alert policy rule. */ displayName: string; /** * The conditional expression of the alert policy rule which evaluates to boolean value. */ expression: string; /** * The unique key of the alert policy rule. */ key: string; /** * The current state of the alert policy rule. */ state: string; /** * Creation date and time of the alert policy rule, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; } interface GetAlertPolicyRulesFilter { name: string; regex?: boolean; values: string[]; } interface GetAlertsAlertCollection { items: outputs.DataSafe.GetAlertsAlertCollectionItem[]; } interface GetAlertsAlertCollectionItem { alertId: string; /** * The key of the rule of alert policy that triggered alert. */ alertPolicyRuleKey: string; /** * The display name of the rule of alert policy that triggered alert. */ alertPolicyRuleName: string; /** * Type of the alert. Indicates the Data Safe feature triggering the alert. */ alertType: string; /** * A comment for the alert. Entered by the user. */ comment: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the alert. */ description: string; /** * The display name of the alert. */ displayName: string; /** * Map that contains maps of values. Example: `{"Operations": {"CostCenter": "42"}}` */ featureDetails: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return alert by it's OCID. */ id: string; /** * The operation (event) that triggered alert. */ operation: string; /** * The result of the operation (event) that triggered alert. */ operationStatus: string; /** * Creation date and time of the operation that triggered alert, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ operationTime: string; /** * The OCID of the policy that triggered alert. */ policyId: string; /** * The resource endpoint that triggered the alert. */ resourceName: string; /** * Severity level of the alert. */ severity: string; /** * The current state of the alert. */ state: string; /** * The status of the alert. */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Array of OCIDs of the target database which are associated with the alert. */ targetIds: string[]; /** * Array of names of the target database. */ targetNames: string[]; /** * Creation date and time of the alert, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * Last date and time the alert was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetAlertsFilter { name: string; regex?: boolean; values: string[]; } interface GetAttributeSetAssociatedResourcesAssociatedResourceCollection { /** * Array of associated resources. */ items: outputs.DataSafe.GetAttributeSetAssociatedResourcesAssociatedResourceCollectionItem[]; } interface GetAttributeSetAssociatedResourcesAssociatedResourceCollectionItem { /** * A filter to return attribute set associated resource that matches the specified associated resource id query param. */ associatedResourceId: string; /** * The display name of the resource that is associated with the attribute set. The name does not have to be unique, and is changeable. */ associatedResourceName: string; /** * A filter to return attribute set associated resources that matches the specified resource type query param. */ associatedResourceType: string; /** * The date and time when associated started between resource and the attribute set, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time when associated is removed between resources and the attribute set, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetAttributeSetAssociatedResourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetAttributeSetsAttributeSetCollection { items: outputs.DataSafe.GetAttributeSetsAttributeSetCollectionItem[]; } interface GetAttributeSetsAttributeSetCollectionItem { /** * A filter to return only attribute set resources that matches the specified attribute set type query param. */ attributeSetType: string; /** * The list of values in an attribute set */ attributeSetValues: string[]; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of an attribute set. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of an attribute set. */ id: string; /** * A filter to return attribute set resources that are in use by other associated resources. */ inUse: string; /** * A filter to return user defined or seeded attribute set resources that matches the specified is user defined query param. A true value indicates user defined attribute set. */ isUserDefined: boolean; /** * The current state of an attribute set. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time an attribute set was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time an attribute set was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetAttributeSetsFilter { name: string; regex?: boolean; values: string[]; } interface GetAuditArchiveRetrievalsAuditArchiveRetrievalCollection { items: outputs.DataSafe.GetAuditArchiveRetrievalsAuditArchiveRetrievalCollectionItem[]; } interface GetAuditArchiveRetrievalsAuditArchiveRetrievalCollectionItem { /** * Total count of audit events to be retrieved from the archive for the specified date range. */ auditEventCount: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of the archive retrieval. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * End month of the archive retrieval, in the format defined by RFC3339. */ endDate: string; /** * The Error details of a failed archive retrieval. */ errorInfo: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the archive retrieval. */ id: string; /** * Details about the current state of the archive retrieval. */ lifecycleDetails: string; /** * Start month of the archive retrieval, in the format defined by RFC3339. */ startDate: string; /** * A filter to return only resources that matches the specified lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of the target associated with the archive retrieval. */ targetId: string; /** * The date time when archive retrieval request was fulfilled, in the format defined by RFC3339. */ timeCompleted: string; /** * The date time when retrieved archive data will be deleted from Data Safe and unloaded back into archival. */ timeOfExpiry: string; /** * The date time when archive retrieval was requested, in the format defined by RFC3339. */ timeRequested: string; } interface GetAuditArchiveRetrievalsFilter { name: string; regex?: boolean; values: string[]; } interface GetAuditEventAnalyticItem { /** * Total count of aggregated value. */ count: string; /** * Details of aggregation dimensions used for summarizing audit events. */ dimensions: outputs.DataSafe.GetAuditEventAnalyticItemDimension[]; /** * Display Name of aggregation field. */ displayName: string; /** * Name of the aggregation. */ metricName: string; /** * An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeEnded: string; /** * An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStarted: string; } interface GetAuditEventAnalyticItemDimension { /** * Time of audit event occurrence in the target database. */ auditEventTimes: string[]; /** * Type of auditing. */ auditTypes: string[]; /** * Name of the host machine from which the session was spawned. */ clientHostnames: string[]; /** * The client identifier in each Oracle session. */ clientIds: string[]; /** * The application from which the audit event was generated. Examples SQL Plus or SQL Developer. */ clientPrograms: string[]; /** * Name of the database user whose actions were audited. */ dbUserNames: string[]; /** * Name of the detail action executed by the user on the target database. i.e ALTER SEQUENCE, CREATE TRIGGER, CREATE INDEX. */ eventNames: string[]; /** * Type of object in the source database affected by the action. i.e PL/SQL, SYNONYM, PACKAGE BODY. */ objectTypes: string[]; /** * Class of the target that was audited. */ targetClasses: string[]; /** * The OCID of the target database that was audited. */ targetIds: string[]; /** * The name of the target database that was audited. */ targetNames: string[]; } interface GetAuditEventItem { /** * The action taken for this audit event. */ actionTaken: string; /** * Time of audit event occurrence in the target database. */ auditEventTime: string; /** * The location of the audit. Currently the value is audit table. */ auditLocation: string; /** * Comma-seperated list of audit policies that caused the current audit event. */ auditPolicies: string; /** * The OCID of the audit trail that generated this audit event. To be noted, this field has been deprecated. */ auditTrailId: string; /** * Type of auditing. */ auditType: string; /** * Name of the host machine from which the session was spawned. */ clientHostname: string; /** * The client identifier in each Oracle session. */ clientId: string; /** * IP address of the host from which the session was spawned. */ clientIp: string; /** * The application from which the audit event was generated. Examples SQL Plus or SQL Developer. */ clientProgram: string; /** * List of bind variables associated with the command text. */ commandParam: string; /** * The SQL associated with the audit event. */ commandText: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * The type of the target database that was audited. Allowed values are * * DATABASE_CLOUD_SERVICE - Represents Oracle Database Cloud Services. * * AUTONOMOUS_DATABASE - Represents Oracle Autonomous Databases. * * INSTALLED_DATABASE - Represents databases running on-premises or on compute instances. */ databaseType: string; /** * Name of the database user whose actions were audited. */ dbUserName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Oracle Error code generated by the action. Zero indicates the action was successful. */ errorCode: string; /** * Detailed message on why the Error occurred. */ errorMessage: string; /** * Name of the detail action executed by the user on the target database. i.e ALTER SEQUENCE, CREATE TRIGGER, CREATE INDEX. */ eventName: string; /** * List of all other attributes of the audit event seperated by a colon other than the one returned in audit record. */ extendedEventAttributes: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the audit event. */ id: string; /** * Indicates whether an alert was raised for this audit event. */ isAlerted: boolean; /** * Name of the object affected by the action. */ object: string; /** * Schema name of object affected but the action. */ objectOwner: string; /** * Type of object in the source database affected by the action. i.e PL/SQL, SYNONYM, PACKAGE BODY. */ objectType: string; /** * Name of the action executed by the user on the target database. i.e ALTER, CREATE, DROP. */ operation: string; /** * Indicates whether the operation was a success or a failure. */ operationStatus: string; /** * The operating system terminal of the user session. */ osTerminal: string; /** * Name of the operating system user for the database session. */ osUserName: string; /** * Class of the target that was audited. */ targetClass: string; /** * The OCID of the target database that was audited. */ targetId: string; /** * The name of the target database that was audited. */ targetName: string; /** * Timestamp when this audit event was collected from the target database by Data Safe. */ timeCollected: string; } interface GetAuditEventsAuditEventCollection { /** * Array of audit event summary. */ items: outputs.DataSafe.GetAuditEventsAuditEventCollectionItem[]; } interface GetAuditEventsAuditEventCollectionItem { /** * The action taken for this audit event. */ actionTaken: string; /** * Semicolon-seperated list of application context namespace, attribute, value information in (APPCTX_NSPACE,APPCTX_ATTRIBUTE=) format. */ applicationContexts: string; /** * The time that the audit event occurs in the target database. */ auditEventTime: string; /** * The location of the audit. Currently the value is audit table. */ auditLocation: string; /** * Comma-seperated list of audit policies that caused the current audit event. */ auditPolicies: string; /** * The OCID of the audit trail that generated this audit event. To be noted, this field has been deprecated. */ auditTrailId: string; /** * The type of the auditing. */ auditType: string; /** * The name of the host machine from which the session was spawned. */ clientHostname: string; /** * The client identifier in each Oracle session. */ clientId: string; /** * The IP address of the host machine from which the session was spawned. */ clientIp: string; /** * The application from which the audit event was generated. For example SQL Plus or SQL Developer. */ clientProgram: string; /** * List of bind variables associated with the command text. */ commandParam: string; /** * The SQL associated with the audit event. */ commandText: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * The type of the target database that was audited. Allowed values are * * DATABASE_CLOUD_SERVICE - Represents Oracle Database Cloud Services. * * AUTONOMOUS_DATABASE - Represents Oracle Autonomous Databases. * * INSTALLED_DATABASE - Represents databases running on-premises or on compute instances. */ databaseType: string; /** * Unique name of the database associated to the peer target database. */ databaseUniqueName: string; /** * The name of the database user whose actions were audited. */ dbUserName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Oracle Error code generated by the action. Zero indicates the action was successful. */ errorCode: string; /** * The detailed message on why the error occurred. */ errorMessage: string; /** * The name of the detail action executed by the user on the target database. For example ALTER SEQUENCE, CREATE TRIGGER or CREATE INDEX. */ eventName: string; /** * List of all other attributes of the audit event seperated by a colon other than the one returned in audit record. */ extendedEventAttributes: string; /** * The user ID of the external user of the audit event. */ externalUserId: string; /** * Fine-grained auditing (FGA) policy name that generated this audit record. */ fgaPolicyName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the audit event. */ id: string; /** * Indicates whether an alert was raised for this audit event. */ isAlerted: boolean; /** * The name of the object affected by the action. */ object: string; /** * The schema name of the object affected by the action. */ objectOwner: string; /** * The type of the object in the source database affected by the action. For example PL/SQL, SYNONYM or PACKAGE BODY. */ objectType: string; /** * The name of the action executed by the user on the target database. For example ALTER, CREATE or DROP. */ operation: string; /** * Indicates whether the operation was a success or a failure. */ operationStatus: string; /** * The operating system terminal of the user session. */ osTerminal: string; /** * The name of the operating system user for the database session. */ osUserName: string; /** * The secondary id assigned for the peer database registered with Data Safe. */ peerTargetDatabaseKey: number; /** * The class of the target that was audited. */ targetClass: string; /** * The OCID of the target database that was audited. */ targetId: string; /** * The name of the target database that was audited. */ targetName: string; /** * The user on whom the GRANT/REVOKE/AUDIT/NOAUDIT statement was executed. */ targetUser: string; /** * The timestamp when this audit event was collected from the target database by Data Safe. */ timeCollected: string; /** * The underlying source of unified audit trail. */ trailSource: string; } interface GetAuditEventsFilter { name: string; regex?: boolean; values: string[]; } interface GetAuditPoliciesAuditPolicyCollection { items: outputs.DataSafe.GetAuditPoliciesAuditPolicyCollectionItem[]; } interface GetAuditPoliciesAuditPolicyCollectionItem { /** * Lists the audit policy provisioning conditions for the target database. */ auditConditions: outputs.DataSafe.GetAuditPoliciesAuditPolicyCollectionItemAuditCondition[]; /** * An optional filter to return only resources that match the specified id. */ auditPolicyId: string; /** * Represents all available audit policy specifications relevant for the target database. For more details on available audit polcies, refer to [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827). */ auditSpecifications: outputs.DataSafe.GetAuditPoliciesAuditPolicyCollectionItemAuditSpecification[]; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of the audit policy. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the audit policy. */ id: string; /** * Option provided to users at the target to indicate whether the Data Safe service account has to be excluded while provisioning the audit policies. */ isDataSafeServiceAccountExcluded: boolean; /** * Details about the current state of the audit policy in Data Safe. */ lifecycleDetails: string; provisionTrigger: number; retrieveFromTargetTrigger: number; /** * The current state of the audit policy. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The time the the audit policy was created, in the format defined by RFC3339. */ timeCreated: string; /** * Indicates the last provisioning time of audit policies on the target, in the format defined by RFC3339. */ timeLastProvisioned: string; /** * The time when the audit policies was last retrieved from this target, in the format defined by RFC3339. */ timeLastRetrieved: string; /** * The last date and time the audit policy was updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetAuditPoliciesAuditPolicyCollectionItemAuditCondition { /** * Indicates the audit policy name. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. */ auditPolicyName: string; /** * Indicates the users/roles in the target database for which the audit policy is enforced, and the success/failure event condition to generate the audit event.. */ enableConditions: outputs.DataSafe.GetAuditPoliciesAuditPolicyCollectionItemAuditConditionEnableCondition[]; /** * Indicates whether the Data Safe user activity on the target database will be audited by the policy. */ isDataSafeServiceAccountAudited: boolean; /** * Indicates whether the privileged user list is managed by Data Safe. */ isPrivUsersManagedByDataSafe: boolean; } interface GetAuditPoliciesAuditPolicyCollectionItemAuditConditionEnableCondition { /** * List of users or roles that the policy must be enabled for. */ entityNames: string[]; /** * The entity include or exclude selection. */ entitySelection: string; /** * The entity type that the policy must be enabled for. */ entityType: string; /** * The operation status that the policy must be enabled for. */ operationStatus: string; } interface GetAuditPoliciesAuditPolicyCollectionItemAuditSpecification { /** * The category to which the audit policy belongs. */ auditPolicyCategory: string; /** * Indicates the audit policy name. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. */ auditPolicyName: string; /** * Indicates the names of corresponding database policy ( or policies) in the target database. */ databasePolicyNames: string[]; /** * Indicates whether the policy has been enabled, disabled or partially enabled in the target database. The status is PARTIALLY_ENABLED if any of the constituent database audit policies is not enabled. */ enableStatus: string; /** * Indicates on whom the audit policy is enabled. */ enabledEntities: string; /** * Indicates whether the policy is already created on the target database. */ isCreated: boolean; /** * Indicates whether the policy by default is enabled for all users with no flexibility to alter the enablement conditions. */ isEnabledForAllUsers: boolean; /** * Indicates whether the audit policy is one of the seeded policies provided by Oracle Data Safe. */ isSeededInDataSafe: boolean; /** * Indicates whether the audit policy is one of the predefined policies provided by Oracle Database. */ isSeededInTarget: boolean; /** * Indicates whether the audit policy is available for provisioning/ de-provisioning from Oracle Data Safe, or is only available for displaying the current provisioning status from the target. */ isViewOnly: boolean; /** * Provides information about the policy that has been only partially enabled. */ partiallyEnabledMsg: string; } interface GetAuditPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetAuditPolicyAuditCondition { /** * Indicates the audit policy name. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. */ auditPolicyName: string; /** * Indicates the users/roles in the target database for which the audit policy is enforced, and the success/failure event condition to generate the audit event.. */ enableConditions: outputs.DataSafe.GetAuditPolicyAuditConditionEnableCondition[]; /** * Indicates whether the Data Safe user activity on the target database will be audited by the policy. */ isDataSafeServiceAccountAudited: boolean; /** * Indicates whether the privileged user list is managed by Data Safe. */ isPrivUsersManagedByDataSafe: boolean; } interface GetAuditPolicyAuditConditionEnableCondition { /** * List of users or roles that the policy must be enabled for. */ entityNames: string[]; /** * The entity include or exclude selection. */ entitySelection: string; /** * The entity type that the policy must be enabled for. */ entityType: string; /** * The operation status that the policy must be enabled for. */ operationStatus: string; } interface GetAuditPolicyAuditSpecification { /** * The category to which the audit policy belongs. */ auditPolicyCategory: string; /** * Indicates the audit policy name. Refer to the [documentation](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/audit-policies.html#GUID-361A9A9A-7C21-4F5A-8945-9B3A0C472827) for seeded audit policy names. For custom policies, refer to the user-defined policy name created in the target database. */ auditPolicyName: string; /** * Indicates the names of corresponding database policy ( or policies) in the target database. */ databasePolicyNames: string[]; /** * Indicates whether the policy has been enabled, disabled or partially enabled in the target database. The status is PARTIALLY_ENABLED if any of the constituent database audit policies is not enabled. */ enableStatus: string; /** * Indicates on whom the audit policy is enabled. */ enabledEntities: string; /** * Indicates whether the policy is already created on the target database. */ isCreated: boolean; /** * Indicates whether the policy by default is enabled for all users with no flexibility to alter the enablement conditions. */ isEnabledForAllUsers: boolean; /** * Indicates whether the audit policy is one of the seeded policies provided by Oracle Data Safe. */ isSeededInDataSafe: boolean; /** * Indicates whether the audit policy is one of the predefined policies provided by Oracle Database. */ isSeededInTarget: boolean; /** * Indicates whether the audit policy is available for provisioning/ de-provisioning from Oracle Data Safe, or is only available for displaying the current provisioning status from the target. */ isViewOnly: boolean; /** * Provides information about the policy that has been only partially enabled. */ partiallyEnabledMsg: string; } interface GetAuditProfileAnalyticItem { /** * Total count of aggregated metric. */ count: string; /** * Details of aggregation dimensions used for summarizing audit profiles. */ dimensions: outputs.DataSafe.GetAuditProfileAnalyticItemDimension[]; } interface GetAuditProfileAnalyticItemDimension { /** * Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level. */ isPaidUsageEnabled: boolean; } interface GetAuditProfileAuditTrail { /** * The date from which the audit trail must start collecting data, in the format defined by RFC3339. */ auditCollectionStartTime: string; /** * The OCID of the audit. */ auditProfileId: string; /** * Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true. */ canUpdateLastArchiveTimeOnTarget: boolean; /** * The OCID of the compartment that contains the audit profile. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the audit profile. */ description: string; /** * The display name of the audit profile. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the audit profile. */ id: string; /** * Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large. */ isAutoPurgeEnabled: boolean; /** * Details about the current state of the audit profile in Data Safe. */ lifecycleDetails: string; /** * The secondary id assigned for the peer database registered with Data Safe. */ peerTargetDatabaseKey: number; /** * The details of the audit trail purge job that ran on the "purgeJobTime". */ purgeJobDetails: string; /** * The current status of the audit trail purge job. */ purgeJobStatus: string; /** * The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339. */ purgeJobTime: string; /** * The current state of the audit profile. */ state: string; /** * The current sub-state of the audit trail. */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of the target database or target database group for which the audit profile is created. */ targetId: string; /** * The date and time the audit profile was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339. */ timeLastCollected: string; /** * The date and time the audit profile was updated, in the format defined by RFC3339. */ timeUpdated: string; /** * An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. */ trailLocation: string; /** * The underlying source of unified audit trail. */ trailSource: string; /** * The OCID of the workrequest for audit trail which collects audit records. */ workRequestId: string; } interface GetAuditProfileAvailableAuditVolumeItem { /** * The OCID of the audit. */ auditProfileId: string; /** * Represents the month under consideration for which aggregated audit data volume available at the target is computed. This field will be the UTC start of the day of the first day of the month for which the aggregate count corresponds to, in the format defined by RFC3339.. For instance, the value of 01-01-2021T00:00:00Z represents Jan 2021. */ monthInConsideration: string; /** * The audit trail location. */ trailLocation: string; /** * Represents the aggregated audit data volume available in the audit trails on the target database which is yet to be collected by Data Safe for the specified month. */ volume: string; } interface GetAuditProfileAvailableAuditVolumesAvailableAuditVolumeCollection { /** * Array of available audit volume summary. */ items: outputs.DataSafe.GetAuditProfileAvailableAuditVolumesAvailableAuditVolumeCollectionItem[]; } interface GetAuditProfileAvailableAuditVolumesAvailableAuditVolumeCollectionItem { /** * The OCID of the audit. */ auditProfileId: string; /** * The OCID of the audit trail. */ auditTrailId: string; /** * Unique name of the database associated to the peer target database. */ databaseUniqueName: string; /** * Represents the month under consideration for which aggregated audit data volume available at the target is computed. This field will be the UTC start of the day of the first day of the month for which the aggregate count corresponds to, in the format defined by RFC3339.. For instance, the value of 01-01-2021T00:00:00Z represents Jan 2021. */ monthInConsideration: string; /** * The audit trail location. */ trailLocation: string; /** * Represents the aggregated audit data volume available in the audit trails on the target database which is yet to be collected by Data Safe for the specified month. */ volume: string; } interface GetAuditProfileAvailableAuditVolumesFilter { name: string; regex?: boolean; values: string[]; } interface GetAuditProfileCollectedAuditVolumeItem { /** * The audit data volume collected by Data Safe and is available in archive storage. */ archivedVolume: string; /** * The OCID of the audit. */ auditProfileId: string; /** * Represents the month under consideration in which the aggregated audit data volume collected by Data Safe is displayed. This field will be the UTC start of the day of the first day of the month for which the aggregate count corresponds to, in the format defined by RFC3339.. For instance, the value of 01-01-2021T00:00:00Z represents Jan 2021. */ monthInConsideration: string; /** * The audit data volume collected by Data Safe and is available online in repository. */ onlineVolume: string; } interface GetAuditProfileCollectedAuditVolumesCollectedAuditVolumeCollection { /** * Array of collected audit volume summary. */ items: outputs.DataSafe.GetAuditProfileCollectedAuditVolumesCollectedAuditVolumeCollectionItem[]; } interface GetAuditProfileCollectedAuditVolumesCollectedAuditVolumeCollectionItem { /** * The audit data volume collected by Data Safe and is available in archive storage. */ archivedVolume: string; /** * The OCID of the audit. */ auditProfileId: string; /** * Represents the month under consideration in which the aggregated audit data volume collected by Data Safe is displayed. This field will be the UTC start of the day of the first day of the month for which the aggregate count corresponds to, in the format defined by RFC3339.. For instance, the value of 01-01-2021T00:00:00Z represents Jan 2021. */ monthInConsideration: string; /** * The audit data volume collected by Data Safe and is available online in repository. */ onlineVolume: string; } interface GetAuditProfileCollectedAuditVolumesFilter { name: string; regex?: boolean; values: string[]; } interface GetAuditProfileTargetOverridesFilter { name: string; regex?: boolean; values: string[]; } interface GetAuditProfileTargetOverridesTargetOverrideCollection { /** * Array of target database override summary. */ items: outputs.DataSafe.GetAuditProfileTargetOverridesTargetOverrideCollectionItem[]; /** * Number of target databases within the target database group that conform with the audit profile of the target database group. */ targetsConformingCount: number; /** * Number of target databases within the target database group. */ targetsCount: number; /** * Number of target databases within the target database group that override the audit profile of the target database group. */ targetsOverridingCount: number; /** * Number of target databases within the group that override the offline retention setting of the audit profile for the target database group. */ targetsOverridingOfflineMonthsCount: number; /** * Number of target databases within the group that override the online retention setting of the audit profile for the target database group. */ targetsOverridingOnlineMonthsCount: number; /** * Number of target databases within the group that override the paid usage setting of the audit profile for the target database group. */ targetsOverridingPaidUsageCount: number; } interface GetAuditProfileTargetOverridesTargetOverrideCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level. */ isPaidUsageEnabled: boolean; /** * Number of months the audit records will be stored offline in the offline archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer (up to 168 months) in the offline archive, please contact the Oracle Support. */ offlineMonths: number; /** * The name or the OCID of the resource from which the offline month retention setting is sourced. For example a target database group OCID or global. */ offlineMonthsSource: string; /** * Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months */ onlineMonths: number; /** * The name or the OCID of the resource from which the online month retention setting is sourced. For example a target database group OCID or global. */ onlineMonthsSource: string; /** * The name or the OCID of the resource from which the paid usage setting is sourced. For example a target database group OCID or global. */ paidUsageSource: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of the target database that overrides from the audit profile of the target database group. */ targetDatabaseId: string; } interface GetAuditProfilesAuditProfileCollection { items: outputs.DataSafe.GetAuditProfilesAuditProfileCollectionItem[]; } interface GetAuditProfilesAuditProfileCollectionItem { /** * Number of audit records collected in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit. */ auditCollectedVolume: string; /** * Contains the list of available audit trails on the target database. */ auditTrails: outputs.DataSafe.GetAuditProfilesAuditProfileCollectionItemAuditTrail[]; changeRetentionTrigger: number; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the audit profile. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the audit profile. */ id: string; /** * Indicates whether audit paid usage settings specified at the target database level override both the global settings and the target group level paid usage settings. Enabling paid usage continues the collection of audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. For more information, see [Data Safe Price List](https://www.oracle.com/cloud/price-list/#data-safe). */ isOverrideGlobalPaidUsage: boolean; /** * A optional filter to return only resources that match the specified retention configured value. */ isOverrideGlobalRetentionSetting: boolean; /** * Indicates if you want to continue audit record collection beyond the free limit of one million audit records per month per target database, incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level. */ isPaidUsageEnabled: boolean; /** * Details about the current state of the audit profile in Data Safe. */ lifecycleDetails: string; /** * Number of months the audit records will be stored offline in the offline archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in the offline archive, please contact the Oracle Support. */ offlineMonths: number; /** * The name or the OCID of the resource from which the offline month retention setting is sourced. For example, a global setting or a target database group OCID. */ offlineMonthsSource: string; /** * Number of months the audit records will be stored online in the audit repository for immediate reporting and analysis. Minimum: 1; Maximum: 12 months */ onlineMonths: number; /** * The name or the OCID of the resource from which the online month retention setting is sourced. For example, a global setting or a target database group OCID. */ onlineMonthsSource: string; /** * The name or the OCID of the resource from which the paid usage setting is sourced. For example, a global setting or a target database group OCID. */ paidUsageSource: string; /** * A optional filter to return only resources that match the specified lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * A optional filter to return only resources that belong to the specified audit profile type. */ targetType: string; /** * The date and time the audit profile was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the audit profile was updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetAuditProfilesAuditProfileCollectionItemAuditTrail { /** * The date from which the audit trail must start collecting data, in the format defined by RFC3339. */ auditCollectionStartTime: string; /** * A optional filter to return only resources that match the specified id. */ auditProfileId: string; /** * Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true. */ canUpdateLastArchiveTimeOnTarget: boolean; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the audit profile. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the audit profile. */ id: string; /** * Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large. */ isAutoPurgeEnabled: boolean; /** * Details about the current state of the audit profile in Data Safe. */ lifecycleDetails: string; /** * The secondary id assigned for the peer database registered with Data Safe. */ peerTargetDatabaseKey: number; /** * The details of the audit trail purge job that ran on the "purgeJobTime". */ purgeJobDetails: string; /** * The current status of the audit trail purge job. */ purgeJobStatus: string; /** * The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339. */ purgeJobTime: string; /** * A optional filter to return only resources that match the specified lifecycle state. */ state: string; /** * The current sub-state of the audit trail. */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the audit profile was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339. */ timeLastCollected: string; /** * The date and time the audit profile was updated, in the format defined by RFC3339. */ timeUpdated: string; /** * An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. */ trailLocation: string; /** * The underlying source of unified audit trail. */ trailSource: string; /** * The OCID of the workrequest for audit trail which collects audit records. */ workRequestId: string; } interface GetAuditProfilesFilter { name: string; regex?: boolean; values: string[]; } interface GetAuditTrailAnalyticItem { /** * Total count of aggregated metric. */ count: string; /** * Details of aggregation dimensions used for summarizing audit trails. */ dimensions: outputs.DataSafe.GetAuditTrailAnalyticItemDimension[]; } interface GetAuditTrailAnalyticItemDimension { /** * The location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. */ location: string; /** * The current state of the audit trail. */ state: string; /** * The current sub-state of the audit trail.. */ status: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; } interface GetAuditTrailsAuditTrailCollection { items: outputs.DataSafe.GetAuditTrailsAuditTrailCollectionItem[]; } interface GetAuditTrailsAuditTrailCollectionItem { /** * The date from which the audit trail must start collecting data, in the format defined by RFC3339. */ auditCollectionStartTime: string; /** * The OCID of the parent audit. */ auditProfileId: string; /** * A optional filter to return only resources that match the specified id. */ auditTrailId: string; /** * Indicates if the Datasafe updates last archive time on target database. If isAutoPurgeEnabled field is enabled, this field must be true. */ canUpdateLastArchiveTimeOnTarget: boolean; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the audit trail. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the audit trail. */ id: string; /** * Indicates if auto purge is enabled on the target database, which helps delete audit data in the target database every seven days so that the database's audit trail does not become too large. */ isAutoPurgeEnabled: boolean; /** * Details about the current state of the audit trail in Data Safe. */ lifecycleDetails: string; /** * The secondary id assigned for the peer database registered with Data Safe. */ peerTargetDatabaseKey: number; /** * The details of the audit trail purge job that ran on the "purgeJobTime". */ purgeJobDetails: string; /** * The current status of the audit trail purge job. */ purgeJobStatus: string; /** * The date and time of the last purge job, which deletes audit data in the target database every seven days so that the database's audit trail does not become too large. In the format defined by RFC3339. */ purgeJobTime: string; resumeTrigger: number; /** * A optional filter to return only resources that match the specified lifecycle state. */ state: string; /** * A optional filter to return only resources that match the specified sub-state of audit trail. */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the audit trail was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time until when the audit events were collected from the target database by the Data Safe audit trail collection process, in the format defined by RFC3339. */ timeLastCollected: string; /** * The date and time the audit trail was updated, in the format defined by RFC3339. */ timeUpdated: string; /** * An audit trail location represents the source of audit records that provides documentary evidence of the sequence of activities in the target database. */ trailLocation: string; /** * The underlying source of unified audit trail. */ trailSource: string; /** * The OCID of the workrequest for audit trail which collects audit records. */ workRequestId: string; } interface GetAuditTrailsFilter { name: string; regex?: boolean; values: string[]; } interface GetCompatibleFormatsForDataTypeFormatsForDataType { /** * The data type category, which can be one of the following - Character - Includes CHAR, NCHAR, VARCHAR2, and NVARCHAR2 Numeric - Includes NUMBER, FLOAT, RAW, BINARY_FLOAT, and BINARY_DOUBLE Date - Includes DATE and TIMESTAMP LOB - Includes BLOB, CLOB, and NCLOB All - Includes all the supported data types */ dataType: string; /** * An array of the basic masking formats compatible with the data type category. */ maskingFormats: outputs.DataSafe.GetCompatibleFormatsForDataTypeFormatsForDataTypeMaskingFormat[]; } interface GetCompatibleFormatsForDataTypeFormatsForDataTypeMaskingFormat { /** * The description of the masking format. */ description: string; /** * The OCID of the masking format. */ id: string; /** * The name of the masking format. */ name: string; } interface GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveType { /** * An array of the library masking formats compatible with the sensitive type. */ maskingFormats: outputs.DataSafe.GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveTypeMaskingFormat[]; /** * The OCID of the sensitive type. */ sensitiveTypeId: string; } interface GetCompatibleFormatsForSensitiveTypeFormatsForSensitiveTypeMaskingFormat { /** * The description of the masking format. */ description: string; /** * The OCID of the masking format. */ id: string; /** * The name of the masking format. */ name: string; } interface GetDataSafeConfigurationGlobalSetting { /** * The paid usage option chosen by the customer admin. */ isPaidUsage: boolean; /** * The offline retention period in months. */ offlineRetentionPeriod: number; /** * The online retention period in months. */ onlineRetentionPeriod: number; } interface GetDataSafePrivateEndpointsDataSafePrivateEndpoint { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the private endpoint. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN. */ endpointFqdn: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Data Safe private endpoint. */ id: string; /** * The OCIDs of the network security groups that the private endpoint belongs to. */ nsgIds: string[]; /** * The OCID of the underlying private endpoint. */ privateEndpointId: string; /** * The private IP address of the private endpoint. */ privateEndpointIp: string; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * A filter to return only resources that match the specified lifecycle state. */ state: string; /** * The OCID of the subnet. */ subnetId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the private endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * A filter to return only resources that match the specified VCN OCID. */ vcnId: string; } interface GetDataSafePrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabaseSecurityConfigSqlFirewallConfig { /** * Specifies whether the firewall should include or exclude the database internal job activities. */ excludeJob: string; /** * Specifies if the firewall is enabled or disabled on the target database. */ status: string; /** * The most recent time when the firewall status is updated, in the format defined by RFC3339. */ timeStatusUpdated: string; /** * Specifies whether Data Safe should automatically purge the violation logs from the database after collecting the violation logs and persisting on Data Safe. */ violationLogAutoPurge: string; } interface GetDatabaseSecurityConfigsDatabaseSecurityConfigCollection { items: outputs.DataSafe.GetDatabaseSecurityConfigsDatabaseSecurityConfigCollectionItem[]; } interface GetDatabaseSecurityConfigsDatabaseSecurityConfigCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * An optional filter to return only resources that match the specified OCID of the database security configuration resource. */ databaseSecurityConfigId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the database security config. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the database security config. */ id: string; /** * Details about the current state of the database security config in Data Safe. */ lifecycleDetails: string; refreshTrigger: number; /** * The SQL Firewall related configurations. */ sqlFirewallConfigs: outputs.DataSafe.GetDatabaseSecurityConfigsDatabaseSecurityConfigCollectionItemSqlFirewallConfig[]; /** * The current state of the database security configuration. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The time that the database security config was created, in the format defined by RFC3339. */ timeCreated: string; /** * The last date and time the database security config was refreshed, in the format defined by RFC3339. */ timeLastRefreshed: string; /** * The date and time the database security configuration was last updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetDatabaseSecurityConfigsDatabaseSecurityConfigCollectionItemSqlFirewallConfig { /** * Specifies whether the firewall should include or exclude the database internal job activities. */ excludeJob: string; /** * Specifies if the firewall is enabled or disabled on the target database. */ status: string; /** * The most recent time when the firewall status is updated, in the format defined by RFC3339. */ timeStatusUpdated: string; /** * Specifies whether Data Safe should automatically purge the violation logs from the database after collecting the violation logs and persisting on Data Safe. */ violationLogAutoPurge: string; } interface GetDatabaseSecurityConfigsFilter { name: string; regex?: boolean; values: string[]; } interface GetDiscoveryAnalyticItem { /** * The total count for the aggregation metric. */ count: string; /** * The scope of analytics data. */ dimensions: outputs.DataSafe.GetDiscoveryAnalyticItemDimension[]; /** * The name of the aggregation metric. */ metricName: string; } interface GetDiscoveryAnalyticItemDimension { /** * A filter to return only the resources that match the specified sensitive data model OCID. */ sensitiveDataModelId: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; } interface GetDiscoveryAnalyticsDiscoveryAnalyticsCollection { /** * An array of discovery analytics summary objects. */ items: outputs.DataSafe.GetDiscoveryAnalyticsDiscoveryAnalyticsCollectionItem[]; } interface GetDiscoveryAnalyticsDiscoveryAnalyticsCollectionItem { /** * The total count for the aggregation metric. */ count: string; /** * The scope of analytics data. */ dimensions: outputs.DataSafe.GetDiscoveryAnalyticsDiscoveryAnalyticsCollectionItemDimension[]; /** * The name of the aggregation metric. */ metricName: string; /** * The date and time when data discovery was last done on the target database, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeLastDiscovered: string; } interface GetDiscoveryAnalyticsDiscoveryAnalyticsCollectionItemDimension { /** * A filter to return only the resources that match the specified sensitive data model OCID. */ sensitiveDataModelId: string; /** * A filter to return only items related to a specific sensitive type OCID. */ sensitiveTypeId: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; } interface GetDiscoveryAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetDiscoveryJobTablesForDiscovery { /** * This contains the name of the schema. */ schemaName: string; /** * This contains an optional list of the table names. */ tableNames: string[]; } interface GetDiscoveryJobsResultConfidenceLevelDetail { doesColumnLeadToPiiInNonTables: boolean; doesColumnLeadToPiiInSameRelatedTables: boolean; hasCommentPatternMatched: boolean; hasDataPatternMatched: boolean; hasNamePatternMatched: boolean; isSensitiveTypeFromSameContextFoundInSameOrRelatedTables: boolean; } interface GetDiscoveryJobsResultModifiedAttribute { /** * Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. */ appDefinedChildColumnKeys: string[]; /** * Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. */ dbDefinedChildColumnKeys: string[]; } interface GetDiscoveryJobsResultsDiscoveryJobResultCollection { items: outputs.DataSafe.GetDiscoveryJobsResultsDiscoveryJobResultCollectionItem[]; } interface GetDiscoveryJobsResultsDiscoveryJobResultCollectionItem { /** * Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. */ appDefinedChildColumnKeys: string[]; /** * The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed. */ appName: string; /** * A filter to return only a specific column based on column name. */ columnName: string; /** * A filter to return the discovery job results with the specified confidence level. Confidence level of discovery job result associated with a seeded sensitive type can either be HIGH or LOW. While the confidence level of discovery job result associated with a user defined sensitive will be NONE. */ confidenceLevel: string; /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ confidenceLevelDetails: outputs.DataSafe.GetDiscoveryJobsResultsDiscoveryJobResultCollectionItemConfidenceLevelDetail[]; /** * The data type of the sensitive column. */ dataType: string; /** * Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. */ dbDefinedChildColumnKeys: string[]; /** * The OCID of the discovery job. * * @deprecated The 'oci_data_safe_discovery_jobs_result' resource has been deprecated. It is no longer supported. */ discoveryJobId: string; /** * A filter to return only the resources that match the specified discovery type. * * @deprecated The 'oci_data_safe_discovery_jobs_result' resource has been deprecated. It is no longer supported. */ discoveryType: string; /** * The estimated number of data values the column has in the associated database. */ estimatedDataValueCount: string; /** * A filter to return the discovery result resources based on the value of their isResultApplied attribute. */ isResultApplied: boolean; /** * The unique key that identifies the discovery result. * * @deprecated The 'oci_data_safe_discovery_jobs_result' resource has been deprecated. It is no longer supported. */ key: string; /** * The attributes of a sensitive column that have been modified in the target database. It's populated only in the case of MODIFIED discovery results and shows the new values of the modified attributes. */ modifiedAttributes: outputs.DataSafe.GetDiscoveryJobsResultsDiscoveryJobResultCollectionItemModifiedAttribute[]; /** * A filter to return only items related to a specific object name. */ object: string; /** * The type of the database object that contains the sensitive column. */ objectType: string; /** * Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only. */ parentColumnKeys: string[]; /** * A filter to return only the resources that match the specified planned action. */ plannedAction: string; /** * The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary. */ relationType: string; /** * Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column. */ sampleDataValues: string[]; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * The unique key that identifies the sensitive column represented by the discovery result. */ sensitiveColumnkey: string; /** * The OCID of the sensitive type associated with the sensitive column. */ sensitiveTypeId: string; } interface GetDiscoveryJobsResultsDiscoveryJobResultCollectionItemConfidenceLevelDetail { doesColumnLeadToPiiInNonTables: boolean; doesColumnLeadToPiiInSameRelatedTables: boolean; hasCommentPatternMatched: boolean; hasDataPatternMatched: boolean; hasNamePatternMatched: boolean; isSensitiveTypeFromSameContextFoundInSameOrRelatedTables: boolean; } interface GetDiscoveryJobsResultsDiscoveryJobResultCollectionItemModifiedAttribute { /** * Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. */ appDefinedChildColumnKeys: string[]; /** * Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. */ dbDefinedChildColumnKeys: string[]; } interface GetDiscoveryJobsResultsFilter { name: string; regex?: boolean; values: string[]; } interface GetLibraryMaskingFormatFormatEntry { /** * The name of the substitution column. */ columnName: string; /** * The description of the format entry. */ description: string; /** * The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date. */ endDate: string; /** * The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length. */ endLength: number; /** * The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type. */ endValue: number; /** * The constant number to be used for masking. */ fixedNumber: number; /** * The constant string to be used for masking. */ fixedString: string; /** * One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table. */ groupingColumns: string[]; /** * The number of characters that should be there in the substring. It should be an integer and greater than zero. */ length: number; /** * The OCID of the library masking format. */ libraryMaskingFormatId: string; /** * The pattern that should be used to mask data. */ pattern: string; /** * The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ postProcessingFunction: string; /** * A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999. */ randomLists: string[]; /** * The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found. */ regularExpression: string; /** * The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value. */ replaceWith: string; /** * The name of the schema that contains the substitution column. */ schemaName: string; /** * The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols. */ sqlExpression: string; /** * The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date. */ startDate: string; /** * The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length. */ startLength: number; /** * The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string. */ startPosition: number; /** * The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type. */ startValue: number; /** * The name of the table that contains the substitution column. */ tableName: string; /** * The type of the format entry. */ type: string; /** * The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ userDefinedFunction: string; } interface GetLibraryMaskingFormatsFilter { name: string; regex?: boolean; values: string[]; } interface GetLibraryMaskingFormatsLibraryMaskingFormatCollection { items: outputs.DataSafe.GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItem[]; } interface GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the format entry. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * An array of format entries. The combined output of all the format entries is used for masking. */ formatEntries: outputs.DataSafe.GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItemFormatEntry[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the library masking format. */ id: string; /** * An array of OCIDs of the sensitive types compatible with the library masking format. */ sensitiveTypeIds: string[]; /** * Specifies whether the library masking format is user-defined or predefined. */ source: string; /** * A filter to return only the resources that match the specified lifecycle states. */ state: string; /** * The date and time the library masking format was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) */ timeCreated: string; /** * The date and time the library masking format was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) */ timeUpdated: string; } interface GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItemFormatEntry { /** * The name of the substitution column. */ columnName: string; /** * The description of the format entry. */ description: string; /** * The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date. */ endDate: string; /** * The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length. */ endLength: number; /** * The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type. */ endValue: number; /** * The constant number to be used for masking. */ fixedNumber: number; /** * The constant string to be used for masking. */ fixedString: string; /** * One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table. */ groupingColumns: string[]; /** * The number of characters that should be there in the substring. It should be an integer and greater than zero. */ length: number; /** * A filter to return only the resources that match the specified library masking format OCID. */ libraryMaskingFormatId: string; /** * The pattern that should be used to mask data. */ pattern: string; /** * The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ postProcessingFunction: string; /** * A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999. */ randomLists: string[]; /** * The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found. */ regularExpression: string; /** * The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value. */ replaceWith: string; /** * The name of the schema that contains the substitution column. */ schemaName: string; /** * The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols. */ sqlExpression: string; /** * The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date. */ startDate: string; /** * The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length. */ startLength: number; /** * The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string. */ startPosition: number; /** * The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type. */ startValue: number; /** * The name of the table that contains the substitution column. */ tableName: string; /** * The type of the format entry. */ type: string; /** * The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ userDefinedFunction: string; } interface GetListUserGrantsFilter { name: string; regex?: boolean; values: string[]; } interface GetListUserGrantsGrant { /** * A filter to return only items that match the specified user grant depth level. */ depthLevel: number; /** * A filter to return only items that match the specified user grant name. */ grantName: string; /** * The unique key of a user grant. */ key: string; /** * A filter to return only items that match the specified user privilege category. */ privilegeCategory: string; /** * A filter to return only items that match the specified privilege grant type. */ privilegeType: string; } interface GetMaskingAnalyticItem { /** * The total count for the aggregation metric. */ count: string; /** * The scope of analytics data. */ dimensions: outputs.DataSafe.GetMaskingAnalyticItemDimension[]; /** * The name of the aggregation metric. */ metricName: string; } interface GetMaskingAnalyticItemDimension { /** * The OCID of the masking policy.. */ policyId: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; } interface GetMaskingAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingAnalyticsMaskingAnalyticsCollection { /** * An array of masking analytics summary objects. */ items: outputs.DataSafe.GetMaskingAnalyticsMaskingAnalyticsCollectionItem[]; } interface GetMaskingAnalyticsMaskingAnalyticsCollectionItem { /** * The total count for the aggregation metric. */ count: string; /** * The scope of analytics data. */ dimensions: outputs.DataSafe.GetMaskingAnalyticsMaskingAnalyticsCollectionItemDimension[]; /** * The name of the aggregation metric. */ metricName: string; /** * The date and time the target database was last masked using a masking policy, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeLastMasked: string; } interface GetMaskingAnalyticsMaskingAnalyticsCollectionItemDimension { /** * The OCID of the masking policy. */ policyId: string; /** * A filter to return only items related to a specific sensitive type OCID. */ sensitiveTypeId: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; } interface GetMaskingPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingPoliciesMaskingColumnMaskingFormat { /** * A condition that must be true for applying the masking format. It can be any valid SQL construct that can be used in a SQL predicate. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions. */ condition: string; /** * The description of the format entry. */ description: string; /** * An array of format entries. The combined output of all the format entries is used for masking the column data values. */ formatEntries: outputs.DataSafe.GetMaskingPoliciesMaskingColumnMaskingFormatFormatEntry[]; } interface GetMaskingPoliciesMaskingColumnMaskingFormatFormatEntry { /** * The name of the substitution column. */ columnName: string; /** * The description of the format entry. */ description: string; /** * The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date. */ endDate: string; /** * The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length. */ endLength: number; /** * The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type. */ endValue: number; /** * The constant number to be used for masking. */ fixedNumber: number; /** * The constant string to be used for masking. */ fixedString: string; /** * One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table. */ groupingColumns: string[]; /** * The number of characters that should be there in the substring. It should be an integer and greater than zero. */ length: number; /** * The OCID of the library masking format. */ libraryMaskingFormatId: string; /** * The pattern that should be used to mask data. */ pattern: string; /** * The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ postProcessingFunction: string; /** * A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999. */ randomLists: string[]; /** * The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found. */ regularExpression: string; /** * The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value. */ replaceWith: string; /** * The name of the schema that contains the database column. */ schemaName: string; /** * The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols. */ sqlExpression: string; /** * The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date. */ startDate: string; /** * The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length. */ startLength: number; /** * The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string. */ startPosition: number; /** * The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type. */ startValue: number; /** * The name of the table that contains the substitution column. */ tableName: string; /** * The type of the format entry. */ type: string; /** * The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ userDefinedFunction: string; } interface GetMaskingPoliciesMaskingColumnsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingPoliciesMaskingColumnsMaskingColumnCollection { items: outputs.DataSafe.GetMaskingPoliciesMaskingColumnsMaskingColumnCollectionItem[]; } interface GetMaskingPoliciesMaskingColumnsMaskingColumnCollectionItem { /** * An array of child columns that are in referential relationship with the masking column. */ childColumns: string[]; /** * A filter to return only a specific column based on column name. */ columnName: string; /** * A filter to return only resources that match the specified data types. */ dataType: string; /** * A filter to return the masking column resources based on the value of their isMaskingEnabled attribute. A value of true returns only those columns for which masking is enabled. A value of false returns only those columns for which masking is disabled. Omitting this parameter returns all the masking columns in a masking policy. */ isMaskingEnabled: boolean; /** * The unique key that identifies the masking column. It's numeric and unique within a masking policy. */ key: string; /** * Details about the current state of the masking column. */ lifecycleDetails: string; /** * A filter to return only the resources that match the specified masking column group. */ maskingColumnGroup: string; /** * An array of masking formats assigned to the masking column. */ maskingFormats: outputs.DataSafe.GetMaskingPoliciesMaskingColumnsMaskingColumnCollectionItemMaskingFormat[]; /** * The OCID of the masking policy. */ maskingPolicyId: string; /** * A filter to return only items related to a specific object name. */ object: string; /** * A filter to return only items related to a specific object type. */ objectType: string; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * A filter to return only items related to a specific sensitive type OCID. */ sensitiveTypeId: string; /** * The current state of the masking column. */ state: string; /** * The date and time the masking column was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the masking column was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetMaskingPoliciesMaskingColumnsMaskingColumnCollectionItemMaskingFormat { /** * A condition that must be true for applying the masking format. It can be any valid SQL construct that can be used in a SQL predicate. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions. */ condition: string; /** * The description of the format entry. */ description: string; /** * An array of format entries. The combined output of all the format entries is used for masking the column data values. */ formatEntries: outputs.DataSafe.GetMaskingPoliciesMaskingColumnsMaskingColumnCollectionItemMaskingFormatFormatEntry[]; } interface GetMaskingPoliciesMaskingColumnsMaskingColumnCollectionItemMaskingFormatFormatEntry { /** * A filter to return only a specific column based on column name. */ columnName: string; /** * The description of the format entry. */ description: string; /** * The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date. */ endDate: string; /** * The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length. */ endLength: number; /** * The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type. */ endValue: number; /** * The constant number to be used for masking. */ fixedNumber: number; /** * The constant string to be used for masking. */ fixedString: string; /** * One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table. */ groupingColumns: string[]; /** * The number of characters that should be there in the substring. It should be an integer and greater than zero. */ length: number; /** * The OCID of the library masking format. */ libraryMaskingFormatId: string; /** * The pattern that should be used to mask data. */ pattern: string; /** * The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ postProcessingFunction: string; /** * A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999. */ randomLists: string[]; /** * The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found. */ regularExpression: string; /** * The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value. */ replaceWith: string; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols. */ sqlExpression: string; /** * The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date. */ startDate: string; /** * The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length. */ startLength: number; /** * The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string. */ startPosition: number; /** * The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type. */ startValue: number; /** * The name of the table that contains the substitution column. */ tableName: string; /** * The type of the format entry. */ type: string; /** * The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ userDefinedFunction: string; } interface GetMaskingPoliciesMaskingPolicyCollection { items: outputs.DataSafe.GetMaskingPoliciesMaskingPolicyCollectionItem[]; } interface GetMaskingPoliciesMaskingPolicyCollectionItem { addMaskingColumnsFromSdmTrigger: number; /** * Specifies whether target database credentials are required to perform masking with this policy */ areTargetCredentialsRequired: boolean; /** * The source of masking columns. */ columnSources: outputs.DataSafe.GetMaskingPoliciesMaskingPolicyCollectionItemColumnSource[]; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the masking policy. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; generateHealthReportTrigger: number; /** * The OCID of the masking policy. */ id: string; /** * Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users. */ isDropTempTablesEnabled: boolean; /** * Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to enable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked. */ isRedoLoggingEnabled: boolean; /** * Indicates if statistics gathering is enabled. It's enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes. */ isRefreshStatsEnabled: boolean; /** * Specifies options to enable parallel execution when running data masking. Allowed values are 'NONE' (no parallelism), 'DEFAULT' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism. */ parallelDegree: string; /** * A post-masking script, which can contain SQL and PL/SQL statements. It's executed after the core masking script generated using the masking policy. It's usually used to perform additional transformation or cleanup work after masking. */ postMaskingScript: string; /** * A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before the core masking script generated using the masking policy. It's usually used to perform any preparation or prerequisite work before masking data. */ preMaskingScript: string; /** * Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), 'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree attribute is used. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes. */ recompile: string; /** * A filter to return only the resources that match the specified lifecycle states. */ state: string; /** * The date and time the masking policy was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the masking policy was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) */ timeUpdated: string; } interface GetMaskingPoliciesMaskingPolicyCollectionItemColumnSource { /** * The source of masking columns. */ columnSource: string; /** * A filter to return only the resources that match the specified sensitive data model OCID. */ sensitiveDataModelId: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; } interface GetMaskingPolicyColumnSource { /** * The source of masking columns. */ columnSource: string; /** * The OCID of the sensitive data model that's used as the source of masking columns. */ sensitiveDataModelId: string; /** * The OCID of the target database that's used as the source of masking columns. */ targetId: string; } interface GetMaskingPolicyHealthReportLogsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingPolicyHealthReportLogsMaskingPolicyHealthReportLogCollection { /** * An array of masking policy health report objects. */ items: outputs.DataSafe.GetMaskingPolicyHealthReportLogsMaskingPolicyHealthReportLogCollectionItem[]; } interface GetMaskingPolicyHealthReportLogsMaskingPolicyHealthReportLogCollectionItem { /** * A human-readable description for the log entry. */ description: string; /** * An enum type entry for each health check in the masking policy. Each enum describes a type of health check. INVALID_OBJECT_CHECK checks if there exist any invalid objects in the masking tables. PRIVILEGE_CHECK checks if the masking user has sufficient privilege to run masking. TABLESPACE_CHECK checks if the user has sufficient default and TEMP tablespace. Also verifies that the specified tablespace by the user is valid, if user has provided one DATABASE_OR_SYSTEM_TRIGGERS_CHECK checks if there exist any database/system triggers available. UNDO_TABLESPACE_CHECK checks if for all the instances of undo tablespace the AUTOEXTEND feature is enabled. If it's not enabled, it further checks if the undo tablespace has any space remaining. STATE_STATS_CHECK checks if all the statistics of the masking table is upto date or not. OLS_POLICY_CHECK , VPD_POLICY_CHECK and REDACTION_POLICY_CHECK checks if the masking tables has Oracle Label Security (OLS) or Virtual Private Database (VPD) or Redaction policies enabled. DV_ENABLE_CHECK checks if database has Database Vault(DV) enabled DE_COL_SIZE_CHECK checks if any masking column with DETERMINISTIC ENCRYPTION as masking format has average column size greater than 27 or not. ACTIVE_MASK_JOB_CHECK checks if there is any active masking job running on the target database. DETERMINISTIC_ENCRYPTION_FORMAT_CHECK checks if any masking column has deterministic encryption masking format. COLUMN_EXIST_CHECK checks if the masking columns are available in the target database. TIME_TRAVEL_CHECK checks if the masking tables have Time Travel enabled. SYSTEM_OBJECTS_CHECK checks if the masking tables have dependent objects present in SYS schema. INVALID_PACKAGE_CHECK checks if any of the required packages are in invalid state. AUDIT_POLICY_CHECK checks if the masking tables have Audit policies enabled. USER_CREDENTIALS_CHECK checks if target database user credentials are required to run masking using the policy */ healthCheckType: string; /** * A human-readable log entry. */ message: string; /** * A filter to return only the resources that match the specified log message type. */ messageType: string; /** * A human-readable log entry to remedy any error or warnings in the masking policy. */ remediation: string; /** * The date and time the log entry was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timestamp: string; } interface GetMaskingPolicyHealthReportsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingPolicyHealthReportsMaskingPolicyHealthReportCollection { items: outputs.DataSafe.GetMaskingPolicyHealthReportsMaskingPolicyHealthReportCollectionItem[]; } interface GetMaskingPolicyHealthReportsMaskingPolicyHealthReportCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the masking health report. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * The count of errors in the masking health report. */ errorCount: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the health report. */ id: string; /** * A filter to return only the resources that match the specified masking policy OCID. */ maskingPolicyId: string; /** * A filter to return only the resources that match the specified lifecycle states. */ state: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the report was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the report was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) */ timeUpdated: string; /** * The count of warnings in the masking health report. */ warningCount: string; } interface GetMaskingPolicyMaskingObjectsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingPolicyMaskingObjectsMaskingObjectCollection { /** * An array of masking object summary objects. */ items: outputs.DataSafe.GetMaskingPolicyMaskingObjectsMaskingObjectCollectionItem[]; } interface GetMaskingPolicyMaskingObjectsMaskingObjectCollectionItem { /** * A filter to return only items related to a specific object name. */ object: string; /** * A filter to return only items related to a specific object type. */ objectType: string; /** * A filter to return only items related to specific schema name. */ schemaName: string; } interface GetMaskingPolicyMaskingSchemasFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingPolicyMaskingSchemasMaskingSchemaCollection { /** * An array of masking schema summary objects. */ items: outputs.DataSafe.GetMaskingPolicyMaskingSchemasMaskingSchemaCollectionItem[]; } interface GetMaskingPolicyMaskingSchemasMaskingSchemaCollectionItem { /** * A filter to return only items related to specific schema name. */ schemaName: string; } interface GetMaskingPolicyReferentialRelationsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingPolicyReferentialRelationsMaskingPolicyReferentialRelationCollection { /** * An array of referential relation summary objects. */ items: outputs.DataSafe.GetMaskingPolicyReferentialRelationsMaskingPolicyReferentialRelationCollectionItem[]; } interface GetMaskingPolicyReferentialRelationsMaskingPolicyReferentialRelationCollectionItem { /** * maskingPolicyColumnsInfo object has details of column group with schema details. */ children: outputs.DataSafe.GetMaskingPolicyReferentialRelationsMaskingPolicyReferentialRelationCollectionItemChild[]; /** * The masking format associated with the parent column. */ maskingFormats: string[]; /** * The OCID of the masking policy. */ maskingPolicyId: string; /** * maskingPolicyColumnsInfo object has details of column group with schema details. */ parents: outputs.DataSafe.GetMaskingPolicyReferentialRelationsMaskingPolicyReferentialRelationCollectionItemParent[]; /** * A filter to return columns based on their relationship with their parent columns. If set to NONE, it returns the columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents. */ relationType: string; } interface GetMaskingPolicyReferentialRelationsMaskingPolicyReferentialRelationCollectionItemChild { /** * A filter to return only items related to a specific object name. */ object: string; /** * The type of the database object that contains the masking policy. */ objectType: string; /** * Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. */ referentialColumnGroups: string[]; /** * A filter to return only items related to specific schema name. */ schemaName: string; } interface GetMaskingPolicyReferentialRelationsMaskingPolicyReferentialRelationCollectionItemParent { /** * A filter to return only items related to a specific object name. */ object: string; /** * The type of the database object that contains the masking policy. */ objectType: string; /** * Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. */ referentialColumnGroups: string[]; /** * A filter to return only items related to specific schema name. */ schemaName: string; } interface GetMaskingReportMaskedColumnsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingReportMaskedColumnsMaskedColumnCollection { /** * An array of masking column summary objects. */ items: outputs.DataSafe.GetMaskingReportMaskedColumnsMaskedColumnCollectionItem[]; } interface GetMaskingReportMaskedColumnsMaskedColumnCollectionItem { /** * A filter to return only a specific column based on column name. */ columnName: string; /** * The unique key that identifies the masked column. It's numeric and unique within a masking policy. */ key: string; /** * A filter to return only the resources that match the specified masking column group. */ maskingColumnGroup: string; /** * The masking format used for masking the column. */ maskingFormatUsed: string; /** * A filter to return only items related to a specific object name. */ object: string; /** * A filter to return only items related to a specific object type. */ objectType: string; /** * The unique key that identifies the parent column of the masked column. */ parentColumnKey: string; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * A filter to return only items related to a specific sensitive type OCID. */ sensitiveTypeId: string; /** * The total number of values masked in the column. */ totalMaskedValues: string; } interface GetMaskingReportMaskingErrorsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingReportMaskingErrorsMaskingErrorCollection { /** * An array of masking error objects. */ items: outputs.DataSafe.GetMaskingReportMaskingErrorsMaskingErrorCollectionItem[]; } interface GetMaskingReportMaskingErrorsMaskingErrorCollectionItem { /** * The text of the masking error. */ error: string; /** * The statement resulting into the error. */ failedStatement: string; /** * A filter to return only masking errors that match the specified step name. */ stepName: string; /** * The date and time the error entry was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; } interface GetMaskingReportsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaskingReportsMaskedColumnItem { /** * A filter to return only a specific column based on column name. */ columnName: string; /** * The unique key that identifies the masked column. It's numeric and unique within a masking policy. */ key: string; /** * A filter to return only the resources that match the specified masking column group. */ maskingColumnGroup: string; /** * The masking format used for masking the column. */ maskingFormatUsed: string; /** * A filter to return only items related to a specific object name. */ object: string; /** * A filter to return only items related to a specific object type. */ objectType: string; /** * The unique key that identifies the parent column of the masked column. */ parentColumnKey: string; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * A filter to return only items related to a specific sensitive type OCID. */ sensitiveTypeId: string; /** * The total number of values masked in the column. */ totalMaskedValues: string; } interface GetMaskingReportsMaskingReportCollection { items: outputs.DataSafe.GetMaskingReportsMaskingReportCollectionItem[]; } interface GetMaskingReportsMaskingReportCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * The OCID of the masking report. */ id: string; /** * Indicates if the temporary tables created during the masking operation were dropped after masking. */ isDropTempTablesEnabled: boolean; /** * Indicates if redo logging was enabled during the masking operation. */ isRedoLoggingEnabled: boolean; /** * Indicates if statistics gathering was enabled during the masking operation. */ isRefreshStatsEnabled: boolean; /** * A filter to return only the resources that match the specified masking policy OCID. */ maskingPolicyId: string; /** * The status of the masking job. */ maskingStatus: string; /** * The OCID of the masking work request that resulted in this masking report. */ maskingWorkRequestId: string; /** * Indicates if parallel execution was enabled during the masking operation. */ parallelDegree: string; /** * Indicates how invalid objects were recompiled post the masking operation. */ recompile: string; /** * The current state of the masking report. */ state: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the masking report was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time data masking finished, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) */ timeMaskingFinished: string; /** * The date and time data masking started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339) */ timeMaskingStarted: string; /** * The total number of masked columns. */ totalMaskedColumns: string; /** * The total number of unique objects (tables and editioning views) that contain the masked columns. */ totalMaskedObjects: string; /** * The total number of unique schemas that contain the masked columns. */ totalMaskedSchemas: string; /** * The total number of unique sensitive types associated with the masked columns. */ totalMaskedSensitiveTypes: string; /** * The total number of masked values. */ totalMaskedValues: string; /** * The total number of errors in post-masking script. */ totalPostMaskingScriptErrors: string; /** * The total number of errors in pre-masking script. */ totalPreMaskingScriptErrors: string; } interface GetOnpremConnectorsFilter { name: string; regex?: boolean; values: string[]; } interface GetOnpremConnectorsOnPremConnector { /** * Latest available version of the on-premises connector. */ availableVersion: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * Created version of the on-premises connector. */ createdVersion: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the on-premises connector. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the on-premises connector. */ id: string; /** * Details about the current state of the on-premises connector. */ lifecycleDetails: string; /** * A filter to return only on-premises connector resources that match the specified lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the on-premises connector was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; } interface GetReportDefinitionColumnFilter { /** * An array of expressions based on the operator type. A filter may have one or more expressions. */ expressions: string[]; /** * Name of the column that must be sorted. */ fieldName: string; /** * Indicates whether the filter is enabled. Values can either be 'true' or 'false'. */ isEnabled: boolean; /** * Indicates if the summary is hidden. Values can either be 'true' or 'false'. */ isHidden: boolean; /** * Specifies the type of operator that must be applied for example in, eq etc. */ operator: string; } interface GetReportDefinitionColumnInfo { /** * An array of operators that can be supported by column fieldName. */ applicableOperators: string[]; /** * Specifies the data type of the column. */ dataType: string; /** * Name of the report definition. */ displayName: string; /** * Specifies the order in which the summary must be displayed. */ displayOrder: number; /** * Name of the column that must be sorted. */ fieldName: string; /** * Indicates if the summary is hidden. Values can either be 'true' or 'false'. */ isHidden: boolean; /** * Specifies if column is virtual and can only be used as column filter. */ isVirtual: boolean; } interface GetReportDefinitionColumnSorting { /** * Name of the column that must be sorted. */ fieldName: string; /** * Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'. */ isAscending: boolean; /** * Indicates the order at which column must be sorted. */ sortingOrder: number; } interface GetReportDefinitionSummary { /** * Name of the key or count of object. */ countOf: string; /** * Specifies the order in which the summary must be displayed. */ displayOrder: number; /** * A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary. */ groupByFieldName: string; /** * Indicates if the summary is hidden. Values can either be 'true' or 'false'. */ isHidden: boolean; /** * Name of the report summary. */ name: string; /** * Additional scim filters used to get the specific summary. */ scimFilter: string; } interface GetReportDefinitionsFilter { /** * Name of the report summary. */ name: string; regex?: boolean; values: string[]; } interface GetReportDefinitionsReportDefinitionCollection { items: outputs.DataSafe.GetReportDefinitionsReportDefinitionCollectionItem[]; } interface GetReportDefinitionsReportDefinitionCollectionItem { /** * An optional filter to return only resources that match the specified category. */ category: string; /** * An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden. */ columnFilters: outputs.DataSafe.GetReportDefinitionsReportDefinitionCollectionItemColumnFilter[]; /** * An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user). */ columnInfos: outputs.DataSafe.GetReportDefinitionsReportDefinitionCollectionItemColumnInfo[]; /** * An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc. */ columnSortings: outputs.DataSafe.GetReportDefinitionsReportDefinitionCollectionItemColumnSorting[]; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * The list of the data protection regulations/standards used in the report that will help demonstrate compliance. */ complianceStandards: string[]; /** * Specifies the name of a resource that provides data for the report. For example alerts, events. */ dataSource: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A description of the report definition. */ description: string; /** * The name of the report definition to query. */ displayName: string; /** * Specifies the order in which the summary must be displayed. */ displayOrder: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the report definition. */ id: string; /** * Indicates if the reports being generated should be paginated. If set to true, multiple reports can be generated and the details of next and previous report are present in Report. Values can either be 'true' or 'false'. */ isSchedulePaginationEnabled: boolean; /** * A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions. */ isSeeded: boolean; /** * Details about the current state of the report definition in Data Safe. */ lifecycleDetails: string; /** * The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID. */ parentId: string; /** * The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1) */ recordTimeSpan: string; /** * The schedule to generate the report periodically in the specified format: ; */ schedule: string; /** * The OCID of the compartment in which the scheduled resource will be created. */ scheduledReportCompartmentId: string; /** * Specifies the format of the report ( either .xls or .pdf or .json) */ scheduledReportMimeType: string; /** * The name of the report to be scheduled. */ scheduledReportName: string; /** * Specifies the limit on the number of rows in the report. */ scheduledReportRowLimit: number; /** * Additional scim filters used to get the specific summary. */ scimFilter: string; /** * An optional filter to return only resources that match the specified lifecycle state. */ state: string; /** * An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user). */ summaries: outputs.DataSafe.GetReportDefinitionsReportDefinitionCollectionItemSummary[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Specifies the date and time the report definition was created. */ timeCreated: string; /** * The date and time the report definition was updated. */ timeUpdated: string; } interface GetReportDefinitionsReportDefinitionCollectionItemColumnFilter { /** * An array of expressions based on the operator type. A filter may have one or more expressions. */ expressions: string[]; /** * Name of the column that must be sorted. */ fieldName: string; /** * Indicates whether the filter is enabled. Values can either be 'true' or 'false'. */ isEnabled: boolean; /** * Indicates if the summary is hidden. Values can either be 'true' or 'false'. */ isHidden: boolean; /** * Specifies the type of operator that must be applied for example in, eq etc. */ operator: string; } interface GetReportDefinitionsReportDefinitionCollectionItemColumnInfo { /** * An array of operators that can be supported by column fieldName. */ applicableOperators: string[]; /** * Specifies the data type of the column. */ dataType: string; /** * The name of the report definition to query. */ displayName: string; /** * Specifies the order in which the summary must be displayed. */ displayOrder: number; /** * Name of the column that must be sorted. */ fieldName: string; /** * Indicates if the summary is hidden. Values can either be 'true' or 'false'. */ isHidden: boolean; /** * Specifies if column is virtual and can only be used as column filter. */ isVirtual: boolean; } interface GetReportDefinitionsReportDefinitionCollectionItemColumnSorting { /** * Name of the column that must be sorted. */ fieldName: string; /** * Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'. */ isAscending: boolean; /** * Indicates the order at which column must be sorted. */ sortingOrder: number; } interface GetReportDefinitionsReportDefinitionCollectionItemSummary { /** * Name of the key or count of object. */ countOf: string; /** * Specifies the order in which the summary must be displayed. */ displayOrder: number; /** * A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary. */ groupByFieldName: string; /** * Indicates if the summary is hidden. Values can either be 'true' or 'false'. */ isHidden: boolean; /** * Name of the report summary. */ name: string; /** * Additional scim filters used to get the specific summary. */ scimFilter: string; } interface GetReportsFilter { name: string; regex?: boolean; values: string[]; } interface GetReportsReportCollection { items: outputs.DataSafe.GetReportsReportCollectionItem[]; } interface GetReportsReportCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * Specifies the name of a resource that provides data for the report. For example alerts, events. */ dataSource: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Specifies a description of the report. */ description: string; /** * The name of the report definition to query. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the report. */ id: string; /** * Details about the current state of the report in Data Safe. */ lifecycleDetails: string; /** * An optional filter to return only resources that match the specified mime type. */ mimeType: string; /** * The OCID of the next report generated. */ nextReportId: string; /** * The OCID of the previous report generated. */ previousReportId: string; /** * The ID of the report definition to filter the list of reports */ reportDefinitionId: string; reportId: string; /** * An optional filter to return only resources that match the specified lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Specifies the time at which the report was created. */ timeCreated: string; /** * Specifies the date and time the report was generated. */ timeGenerated: string; /** * The date and time of the report update in Data Safe. */ timeUpdated: string; /** * An optional filter to return only resources that match the specified type. */ type: string; } interface GetSdmMaskingPolicyDifferenceDifferenceColumnsFilter { name: string; regex?: boolean; values: string[]; } interface GetSdmMaskingPolicyDifferenceDifferenceColumnsSdmMaskingPolicyDifferenceColumnCollection { items: outputs.DataSafe.GetSdmMaskingPolicyDifferenceDifferenceColumnsSdmMaskingPolicyDifferenceColumnCollectionItem[]; } interface GetSdmMaskingPolicyDifferenceDifferenceColumnsSdmMaskingPolicyDifferenceColumnCollectionItem { /** * A filter to return only a specific column based on column name. */ columnName: string; /** * A filter to return only the SDM masking policy difference columns that match the specified difference type */ differenceType: string; /** * The unique key that identifies the SDM masking policy difference column. */ key: string; /** * The unique key that identifies the masking column represented by the SDM masking policy difference column. */ maskingColumnkey: string; /** * A filter to return only items related to a specific object name. */ object: string; /** * A filter to return only the SDM masking policy difference columns that match the specified planned action. */ plannedAction: string; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * The unique key that identifies the sensitive column represented by the SDM masking policy difference column. */ sensitiveColumnkey: string; /** * The OCID of the sensitive type associated with the difference column. */ sensitiveTypeId: string; /** * A filter to return the SDM masking policy difference columns based on the value of their syncStatus attribute. */ syncStatus: string; /** * The date and time the SDM masking policy difference column was last synced, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeLastSynced: string; } interface GetSdmMaskingPolicyDifferencesFilter { name: string; regex?: boolean; values: string[]; } interface GetSdmMaskingPolicyDifferencesSdmMaskingPolicyDifferenceCollection { items: outputs.DataSafe.GetSdmMaskingPolicyDifferencesSdmMaskingPolicyDifferenceCollectionItem[]; } interface GetSdmMaskingPolicyDifferencesSdmMaskingPolicyDifferenceCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The type of the SDM masking policy difference. It defines the difference scope. NEW identifies new sensitive columns in the sensitive data model that are not in the masking policy. DELETED identifies columns that are present in the masking policy but have been deleted from the sensitive data model. MODIFIED identifies columns that are present in the sensitive data model as well as the masking policy but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns. */ differenceType: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Sensitive data model and masking policy difference resource. */ id: string; /** * A filter to return only the resources that match the specified masking policy OCID. */ maskingPolicyId: string; /** * A filter to return only the resources that match the specified sensitive data model OCID. */ sensitiveDataModelId: string; /** * A filter to return only the resources that match the specified lifecycle states. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the SDM masking policy difference was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the SDM masking policy difference creation started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreationStarted: string; } interface GetSecurityAssessmentCheck { /** * The category to which the check belongs to. */ category: string; /** * A unique identifier for the check. */ key: string; /** * Provides a recommended approach to take to remediate the check reported. */ oneline: string; /** * Provides information on whether the check is related to a CIS Oracle Database Benchmark recommendation, STIG rule, GDPR Article/Recital or related to the Oracle Best Practice. */ references: outputs.DataSafe.GetSecurityAssessmentCheckReference[]; /** * The explanation of the issue in this check. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of the check as suggested by Data Safe security assessment. This will be the default severity in the template baseline security assessment. */ suggestedSeverity: string; /** * The short title for the check. */ title: string; } interface GetSecurityAssessmentCheckReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentChecksCheck { /** * The category to which the check belongs to. */ category: string; /** * Each check in security assessment has an associated key (think of key as a check's name). For a given check, the key will be the same across targets. The user can use these keys to filter the checks. */ key: string; /** * Provides a recommended approach to take to remediate the check reported. */ oneline: string; patchOperations?: outputs.DataSafe.GetSecurityAssessmentChecksCheckPatchOperation[]; /** * Provides information on whether the check is related to a CIS Oracle Database Benchmark recommendation, STIG rule, GDPR Article/Recital or related to the Oracle Best Practice. */ references: outputs.DataSafe.GetSecurityAssessmentChecksCheckReference[]; /** * The explanation of the issue in this check. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The OCID of the security assessment. */ securityAssessmentId: string; /** * A filter to return only checks of a particular risk level. */ suggestedSeverity: string; /** * The short title for the check. */ title: string; } interface GetSecurityAssessmentChecksCheckPatchOperation { operation: string; selection: string; value: { [key: string]: string; }; } interface GetSecurityAssessmentChecksCheckReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentChecksFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityAssessmentComparisonTarget { /** * A comparison between findings belonging to Auditing category. */ auditings: outputs.DataSafe.GetSecurityAssessmentComparisonTargetAuditing[]; /** * A comparison between findings belonging to Authorization Control category. */ authorizationControls: outputs.DataSafe.GetSecurityAssessmentComparisonTargetAuthorizationControl[]; /** * The OCID of the target that is used as a baseline in this comparison. */ baselineTargetId: string; /** * The OCID of the target to be compared against the baseline target. */ currentTargetId: string; /** * Comparison between findings belonging to Data Encryption category. */ dataEncryptions: outputs.DataSafe.GetSecurityAssessmentComparisonTargetDataEncryption[]; /** * Comparison between findings belonging to Database Configuration category. */ dbConfigurations: outputs.DataSafe.GetSecurityAssessmentComparisonTargetDbConfiguration[]; /** * Comparison between findings belonging to Fine-Grained Access Control category. */ fineGrainedAccessControls: outputs.DataSafe.GetSecurityAssessmentComparisonTargetFineGrainedAccessControl[]; /** * Comparison between findings belonging to Privileges and Roles category. */ privilegesAndRoles: outputs.DataSafe.GetSecurityAssessmentComparisonTargetPrivilegesAndRole[]; /** * Comparison between findings belonging to User Accounts category. */ userAccounts: outputs.DataSafe.GetSecurityAssessmentComparisonTargetUserAccount[]; } interface GetSecurityAssessmentComparisonTargetAuditing { /** * This array identifies the items that are present in the current assessment, but are missing from the baseline. */ addedItems: string[]; /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentComparisonTargetAuditingBaseline[]; /** * The particular finding reported by the security assessment. */ currents: outputs.DataSafe.GetSecurityAssessmentComparisonTargetAuditingCurrent[]; /** * This array contains the items that are present in both the current assessment and the baseline, but are different in the two assessments. */ modifiedItems: string[]; /** * This array identifies the items that are present in the baseline, but are missing from the current assessment. */ removedItems: string[]; /** * The severity of this diff. */ severity: string; } interface GetSecurityAssessmentComparisonTargetAuditingBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetAuditingBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetAuditingBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetAuditingCurrent { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetAuditingCurrentReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetAuditingCurrentReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetAuthorizationControl { /** * This array identifies the items that are present in the current assessment, but are missing from the baseline. */ addedItems: string[]; /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentComparisonTargetAuthorizationControlBaseline[]; /** * The particular finding reported by the security assessment. */ currents: outputs.DataSafe.GetSecurityAssessmentComparisonTargetAuthorizationControlCurrent[]; /** * This array contains the items that are present in both the current assessment and the baseline, but are different in the two assessments. */ modifiedItems: string[]; /** * This array identifies the items that are present in the baseline, but are missing from the current assessment. */ removedItems: string[]; /** * The severity of this diff. */ severity: string; } interface GetSecurityAssessmentComparisonTargetAuthorizationControlBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetAuthorizationControlBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetAuthorizationControlBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetAuthorizationControlCurrent { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetAuthorizationControlCurrentReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetAuthorizationControlCurrentReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetDataEncryption { /** * This array identifies the items that are present in the current assessment, but are missing from the baseline. */ addedItems: string[]; /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentComparisonTargetDataEncryptionBaseline[]; /** * The particular finding reported by the security assessment. */ currents: outputs.DataSafe.GetSecurityAssessmentComparisonTargetDataEncryptionCurrent[]; /** * This array contains the items that are present in both the current assessment and the baseline, but are different in the two assessments. */ modifiedItems: string[]; /** * This array identifies the items that are present in the baseline, but are missing from the current assessment. */ removedItems: string[]; /** * The severity of this diff. */ severity: string; } interface GetSecurityAssessmentComparisonTargetDataEncryptionBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetDataEncryptionBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetDataEncryptionBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetDataEncryptionCurrent { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetDataEncryptionCurrentReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetDataEncryptionCurrentReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetDbConfiguration { /** * This array identifies the items that are present in the current assessment, but are missing from the baseline. */ addedItems: string[]; /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentComparisonTargetDbConfigurationBaseline[]; /** * The particular finding reported by the security assessment. */ currents: outputs.DataSafe.GetSecurityAssessmentComparisonTargetDbConfigurationCurrent[]; /** * This array contains the items that are present in both the current assessment and the baseline, but are different in the two assessments. */ modifiedItems: string[]; /** * This array identifies the items that are present in the baseline, but are missing from the current assessment. */ removedItems: string[]; /** * The severity of this diff. */ severity: string; } interface GetSecurityAssessmentComparisonTargetDbConfigurationBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetDbConfigurationBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetDbConfigurationBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetDbConfigurationCurrent { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetDbConfigurationCurrentReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetDbConfigurationCurrentReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetFineGrainedAccessControl { /** * This array identifies the items that are present in the current assessment, but are missing from the baseline. */ addedItems: string[]; /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentComparisonTargetFineGrainedAccessControlBaseline[]; /** * The particular finding reported by the security assessment. */ currents: outputs.DataSafe.GetSecurityAssessmentComparisonTargetFineGrainedAccessControlCurrent[]; /** * This array contains the items that are present in both the current assessment and the baseline, but are different in the two assessments. */ modifiedItems: string[]; /** * This array identifies the items that are present in the baseline, but are missing from the current assessment. */ removedItems: string[]; /** * The severity of this diff. */ severity: string; } interface GetSecurityAssessmentComparisonTargetFineGrainedAccessControlBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetFineGrainedAccessControlBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetFineGrainedAccessControlBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetFineGrainedAccessControlCurrent { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetFineGrainedAccessControlCurrentReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetFineGrainedAccessControlCurrentReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetPrivilegesAndRole { /** * This array identifies the items that are present in the current assessment, but are missing from the baseline. */ addedItems: string[]; /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentComparisonTargetPrivilegesAndRoleBaseline[]; /** * The particular finding reported by the security assessment. */ currents: outputs.DataSafe.GetSecurityAssessmentComparisonTargetPrivilegesAndRoleCurrent[]; /** * This array contains the items that are present in both the current assessment and the baseline, but are different in the two assessments. */ modifiedItems: string[]; /** * This array identifies the items that are present in the baseline, but are missing from the current assessment. */ removedItems: string[]; /** * The severity of this diff. */ severity: string; } interface GetSecurityAssessmentComparisonTargetPrivilegesAndRoleBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetPrivilegesAndRoleBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetPrivilegesAndRoleBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetPrivilegesAndRoleCurrent { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetPrivilegesAndRoleCurrentReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetPrivilegesAndRoleCurrentReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetUserAccount { /** * This array identifies the items that are present in the current assessment, but are missing from the baseline. */ addedItems: string[]; /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentComparisonTargetUserAccountBaseline[]; /** * The particular finding reported by the security assessment. */ currents: outputs.DataSafe.GetSecurityAssessmentComparisonTargetUserAccountCurrent[]; /** * This array contains the items that are present in both the current assessment and the baseline, but are different in the two assessments. */ modifiedItems: string[]; /** * This array identifies the items that are present in the baseline, but are missing from the current assessment. */ removedItems: string[]; /** * The severity of this diff. */ severity: string; } interface GetSecurityAssessmentComparisonTargetUserAccountBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetUserAccountBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetUserAccountBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentComparisonTargetUserAccountCurrent { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentComparisonTargetUserAccountCurrentReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentComparisonTargetUserAccountCurrentReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentFindingAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityAssessmentFindingAnalyticsFindingAnalyticsCollection { /** * The array of the summary objects of the analytics data of findings or top findings. */ items: outputs.DataSafe.GetSecurityAssessmentFindingAnalyticsFindingAnalyticsCollectionItem[]; } interface GetSecurityAssessmentFindingAnalyticsFindingAnalyticsCollectionItem { /** * The scope of analytics data. */ dimensions: outputs.DataSafe.GetSecurityAssessmentFindingAnalyticsFindingAnalyticsCollectionItemDimension[]; /** * The name of the aggregation metric. */ metricName: string; /** * The total count for the aggregation metric. */ securityAssessmentFindingAnalyticCount: string; } interface GetSecurityAssessmentFindingAnalyticsFindingAnalyticsCollectionItemDimension { /** * Each finding in security assessment has an associated key (think of key as a finding's name). For a given finding, the key will be the same across targets. The user can use these keys to filter the findings. */ key: string; /** * A filter to return only findings of a particular risk level. */ severity: string; /** * The OCID of the target database. */ targetId: string; /** * The short title of the finding. */ title: string; /** * The category of the top finding. */ topFindingCategory: string; /** * An optional filter to return only the top finding that match the specified status. */ topFindingStatus: string; } interface GetSecurityAssessmentFindingFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityAssessmentFindingFinding { assessmentId: string; category: string; details: string[]; doclink: string; hasTargetDbRiskLevelChanged: boolean; isRiskModified: boolean; isTopFinding: boolean; justification: string; key: string; lifecycleDetails: string; oneline: string; oracleDefinedSeverity: string; references: outputs.DataSafe.GetSecurityAssessmentFindingFindingReference[]; remarks: string; severity: string; state: string; summary: string; targetId: string; timeUpdated: string; timeValidUntil: string; title: string; } interface GetSecurityAssessmentFindingFindingReference { cis: string; gdpr: string; obp: string; orp: string; stig: string; } interface GetSecurityAssessmentFindingsChangeAuditLogsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityAssessmentFindingsChangeAuditLogsFindingsChangeAuditLogCollection { /** * An array of finding risk change audit log summary objects. */ items: outputs.DataSafe.GetSecurityAssessmentFindingsChangeAuditLogsFindingsChangeAuditLogCollectionItem[]; } interface GetSecurityAssessmentFindingsChangeAuditLogsFindingsChangeAuditLogCollectionItem { /** * The OCID of the latest security assessment. */ assessmentId: string; /** * The unique key that identifies the finding. It is a string and unique within a security assessment. */ findingKey: string; /** * The unique title that identifies the finding. It is a string and unique within a security assessment. */ findingTitle: string; /** * A filter to check findings whose risks were deferred by the user. */ isRiskDeferred: boolean; /** * The justification given by the user for accepting or modifying the risk level. */ justification: string; /** * The unique key that identifies the finding risk change. */ key: string; /** * A filter to check which user modified the risk level of the finding. */ modifiedBy: string; /** * The severity of the finding as determined by security assessment by Oracle. */ oracleDefinedSeverity: string; /** * If the risk level is changed more than once, the previous modified value. */ previousSeverity: string; /** * A filter to return only findings of a particular risk level. */ severity: string; /** * The OCID of the target database. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339), the risk level change as updated by user is valid until. After this date passes, the risk level will be that of what is determined by the latest security assessment. */ timeValidUntil: string; } interface GetSecurityAssessmentFindingsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityAssessmentFindingsFinding { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The category of the finding. */ category: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Documentation link provided by Oracle that explains a specific security finding or check. */ doclink: string; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * A filter to return only the findings that are marked as top findings. */ isTopFinding: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * The unique finding key. This is a system-generated identifier. To get the finding key for a finding, use ListFindings. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * Provides a recommended approach to take to remediate the finding reported. */ oneline: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * An optional filter to return only findings that match the specified reference. */ references: outputs.DataSafe.GetSecurityAssessmentFindingsFindingReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * A filter to return only findings of a particular risk level. */ severity: string; /** * A filter to return only the findings that match the specified lifecycle states. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred / modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentFindingsFindingReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from ORP. */ orp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentSecurityFeatureAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollection { /** * The array of database security feature analytics summary. */ items: outputs.DataSafe.GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollectionItem[]; } interface GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollectionItem { /** * The scope of analytics data. */ dimensions: outputs.DataSafe.GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollectionItemDimension[]; /** * The name of the aggregation metric. */ metricName: string; /** * The total count for the aggregation metric. */ securityAssessmentSecurityFeatureAnalyticCount: string; } interface GetSecurityAssessmentSecurityFeatureAnalyticsSecurityFeatureAnalyticsCollectionItemDimension { /** * The name of the security feature. */ securityFeature: string; } interface GetSecurityAssessmentSecurityFeaturesFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityAssessmentSecurityFeaturesSecurityFeatureCollection { /** * Array of database security feature summary. */ items: outputs.DataSafe.GetSecurityAssessmentSecurityFeaturesSecurityFeatureCollectionItem[]; } interface GetSecurityAssessmentSecurityFeaturesSecurityFeatureCollectionItem { /** * The OCID of the assessment that generates this security feature usage result. */ assessmentId: string; /** * The usage of security feature - Column Encryption. */ columnEncryption: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * The usage of security feature - Database Vault. */ databaseVault: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The usage of security feature - External Authentication. */ externalAuthentication: string; /** * The usage of security feature - Fine Grained Audit. */ fineGrainedAudit: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The usage of security feature - Global Authentication. */ globalAuthentication: string; /** * The usage of security feature - Network Encryption. */ networkEncryption: string; /** * The usage of security feature - Password Authentication. */ passwordAuthentication: string; /** * The usage of security feature - Privilege Analysis. */ privilegeAnalysis: string; /** * The usage of security feature - Tablespace Encryption. */ tablespaceEncryption: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The usage of security feature - Traditional Audit. */ traditionalAudit: string; /** * The usage of security feature - Unified Audit. */ unifiedAudit: string; } interface GetSecurityAssessmentStatistic { /** * Statistics showing the number of findings with a particular risk level for each category. */ advisories: outputs.DataSafe.GetSecurityAssessmentStatisticAdvisory[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ deferreds: outputs.DataSafe.GetSecurityAssessmentStatisticDeferred[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ evaluates: outputs.DataSafe.GetSecurityAssessmentStatisticEvaluate[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ highRisks: outputs.DataSafe.GetSecurityAssessmentStatisticHighRisk[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ lowRisks: outputs.DataSafe.GetSecurityAssessmentStatisticLowRisk[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ mediumRisks: outputs.DataSafe.GetSecurityAssessmentStatisticMediumRisk[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ passes: outputs.DataSafe.GetSecurityAssessmentStatisticPass[]; /** * The total number of targets in this security assessment. */ targetsCount: number; } interface GetSecurityAssessmentStatisticAdvisory { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentStatisticDeferred { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentStatisticEvaluate { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentStatisticHighRisk { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentStatisticLowRisk { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentStatisticMediumRisk { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentStatisticPass { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentTemplateAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityAssessmentTemplateAnalyticsTemplateAnalyticsCollection { /** * The array of template analytics summary. */ items: outputs.DataSafe.GetSecurityAssessmentTemplateAnalyticsTemplateAnalyticsCollectionItem[]; } interface GetSecurityAssessmentTemplateAnalyticsTemplateAnalyticsCollectionItem { /** * The scope of analytics data. */ dimensions: outputs.DataSafe.GetSecurityAssessmentTemplateAnalyticsTemplateAnalyticsCollectionItemDimension[]; /** * The name of the aggregation metric. */ metricName: string; /** * The total count for the aggregation metric. */ securityAssessmentTemplateAnalyticCount: string; } interface GetSecurityAssessmentTemplateAnalyticsTemplateAnalyticsCollectionItemDimension { /** * A filter to return only the statistics where the comparison between the latest assessment and the template baseline assessment is done. */ isCompared: boolean; /** * A filter to return only the statistics where the latest assessment is compliant with the template baseline assessment. */ isCompliant: boolean; /** * A filter to return only the target group related information if the OCID belongs to a target group. */ isGroup: boolean; /** * A filter to return the target database group that matches the specified OCID. */ targetDatabaseGroupId: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The OCID of the security assessment of type TEMPLATE. */ templateAssessmentId: string; /** * The OCID of the security assessment of type TEMPLATE_BASELINE. */ templateBaselineAssessmentId: string; /** * The date and time when the comparison was made upon the template baseline. Conforms to the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeLastCompared: string; /** * The number of checks inside the template assessment. */ totalChecks: number; /** * Indicates how many checks in the template have drifts in the comparison report. This field is only present if isCompliant is false. */ totalChecksFailed: number; /** * The number of the target(s) that have drifts in the comparison report. This field is only present if isCompared is true. */ totalNonCompliantTargets: number; /** * The number of the target(s) inside the target group for which the template baseline assessment was created for. If the isGroup field is false, the value will be 1, representing the single target. */ totalTargets: number; } interface GetSecurityAssessmentTemplateAssociationAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityAssessmentTemplateAssociationAnalyticsTemplateAssociationAnalyticsCollection { /** * The array of template association analytics summary. */ items: outputs.DataSafe.GetSecurityAssessmentTemplateAssociationAnalyticsTemplateAssociationAnalyticsCollectionItem[]; } interface GetSecurityAssessmentTemplateAssociationAnalyticsTemplateAssociationAnalyticsCollectionItem { /** * The scope of template association analytics data. */ dimensions: outputs.DataSafe.GetSecurityAssessmentTemplateAssociationAnalyticsTemplateAssociationAnalyticsCollectionItemDimension[]; /** * The name of the aggregation metric. */ metricName: string; /** * The total count for the aggregation metric. */ securityAssessmentTemplateAssociationAnalyticCount: string; } interface GetSecurityAssessmentTemplateAssociationAnalyticsTemplateAssociationAnalyticsCollectionItemDimension { /** * A filter to return the target database group that matches the specified OCID. */ targetDatabaseGroupId: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The OCID of the security assessment of type TEMPLATE. */ templateAssessmentId: string; /** * The OCID of the security assessment of type TEMPLATE_BASELINE. */ templateBaselineAssessmentId: string; } interface GetSecurityAssessmentTemplateBaselineComparisonAuditing { /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonAuditingBaseline[]; /** * A target-based comparison between two security assessments. */ targets: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonAuditingTarget[]; } interface GetSecurityAssessmentTemplateBaselineComparisonAuditingBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonAuditingBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonAuditingBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentTemplateBaselineComparisonAuditingTarget { /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * The severity of this diff. */ severity: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonAuthorizationControl { /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonAuthorizationControlBaseline[]; /** * A target-based comparison between two security assessments. */ targets: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonAuthorizationControlTarget[]; } interface GetSecurityAssessmentTemplateBaselineComparisonAuthorizationControlBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonAuthorizationControlBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonAuthorizationControlBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentTemplateBaselineComparisonAuthorizationControlTarget { /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * The severity of this diff. */ severity: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonDataEncryption { /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonDataEncryptionBaseline[]; /** * A target-based comparison between two security assessments. */ targets: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonDataEncryptionTarget[]; } interface GetSecurityAssessmentTemplateBaselineComparisonDataEncryptionBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonDataEncryptionBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonDataEncryptionBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentTemplateBaselineComparisonDataEncryptionTarget { /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * The severity of this diff. */ severity: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonDbConfiguration { /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonDbConfigurationBaseline[]; /** * A target-based comparison between two security assessments. */ targets: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonDbConfigurationTarget[]; } interface GetSecurityAssessmentTemplateBaselineComparisonDbConfigurationBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonDbConfigurationBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonDbConfigurationBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentTemplateBaselineComparisonDbConfigurationTarget { /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * The severity of this diff. */ severity: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonFineGrainedAccessControl { /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonFineGrainedAccessControlBaseline[]; /** * A target-based comparison between two security assessments. */ targets: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonFineGrainedAccessControlTarget[]; } interface GetSecurityAssessmentTemplateBaselineComparisonFineGrainedAccessControlBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonFineGrainedAccessControlBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonFineGrainedAccessControlBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentTemplateBaselineComparisonFineGrainedAccessControlTarget { /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * The severity of this diff. */ severity: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonPrivilegesAndRole { /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonPrivilegesAndRoleBaseline[]; /** * A target-based comparison between two security assessments. */ targets: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonPrivilegesAndRoleTarget[]; } interface GetSecurityAssessmentTemplateBaselineComparisonPrivilegesAndRoleBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonPrivilegesAndRoleBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonPrivilegesAndRoleBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentTemplateBaselineComparisonPrivilegesAndRoleTarget { /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * The severity of this diff. */ severity: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonUserAccount { /** * The particular finding reported by the security assessment. */ baselines: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonUserAccountBaseline[]; /** * A target-based comparison between two security assessments. */ targets: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonUserAccountTarget[]; } interface GetSecurityAssessmentTemplateBaselineComparisonUserAccountBaseline { /** * The OCID of the assessment that generated this finding. */ assessmentId: string; /** * The details of the finding. Provides detailed information to explain the finding summary, typically results from the assessed database, followed by any recommendations for changes. */ details: string[]; /** * Determines if this risk level has changed on the target database since the last time 'severity' was modified by user. */ hasTargetDbRiskLevelChanged: boolean; /** * Determines if this risk level was modified by user. */ isRiskModified: boolean; /** * User provided reason for accepting or modifying this finding if they choose to do so. */ justification: string; /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * Details about the current state of the finding. */ lifecycleDetails: string; /** * The severity of the finding as determined by security assessment. This cannot be modified by user. */ oracleDefinedSeverity: string; /** * Provides information on whether the finding is related to a CIS Oracle Database Benchmark recommendation, STIG rule, or related to a GDPR Article/Recital. */ references: outputs.DataSafe.GetSecurityAssessmentTemplateBaselineComparisonUserAccountBaselineReference[]; /** * The explanation of the issue in this finding. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of this diff. */ severity: string; /** * The current state of the finding. */ state: string; /** * The brief summary of the finding. When the finding is informational, the summary typically reports only the number of data elements that were examined. */ summary: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the risk level of finding was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The time until which the change in severity(deferred/modified) of this finding is valid. */ timeValidUntil: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentTemplateBaselineComparisonUserAccountBaselineReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentTemplateBaselineComparisonUserAccountTarget { /** * A unique identifier for the finding. This is common for the finding across targets. */ key: string; /** * The severity of this diff. */ severity: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The short title for the finding. */ title: string; } interface GetSecurityAssessmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityAssessmentsSecurityAssessment { applyTemplateTrigger: number; baseSecurityAssessmentId: string; /** * The ocid of a security assessment which is of type TEMPLATE_BASELINE, this will be null or empty when type is TEMPLATE_BASELINE. */ baselineAssessmentId: string; /** * The security checks to be evaluated for type template. */ checks: outputs.DataSafe.GetSecurityAssessmentsSecurityAssessmentCheck[]; compareToTemplateBaselineTrigger: number; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the security assessment. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the security assessment. */ id: string; /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ ignoredAssessmentIds: string[]; /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ ignoredTargets: string[]; /** * Indicates whether the assessment is scheduled to run. */ isAssessmentScheduled: boolean; /** * A filter to return only the security assessments that are set as a baseline. */ isBaseline: boolean; /** * Indicates whether or not the security assessment deviates from the baseline. */ isDeviatedFromBaseline: boolean; /** * The OCID of the baseline against which the latest security assessment was compared. */ lastComparedBaselineId: string; /** * Details about the current state of the security assessment. */ lifecycleDetails: string; /** * The summary of findings for the security assessment. */ link: string; removeTemplateTrigger: number; /** * Schedule of the assessment that runs periodically in the specified format: - ; */ schedule: string; /** * The OCID of the security assessment that is responsible for creating this scheduled save assessment. */ scheduleSecurityAssessmentId: string; /** * A filter to return only resources that match the specified lifecycle state. */ state: string; /** * Statistics showing the number of findings for each category grouped by risk levels for all the targets in the specified security assessment. */ statistics: outputs.DataSafe.GetSecurityAssessmentsSecurityAssessmentStatistic[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return the target database group that matches the specified OCID. */ targetDatabaseGroupId: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * Array of database target OCIDs. */ targetIds: string[]; /** * A filter to return only only target database resources or target database group resources. */ targetType: string; /** * The version of the target database. */ targetVersion: string; /** * The OCID of the security assessment of type TEMPLATE. */ templateAssessmentId: string; /** * The date and time the security assessment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the security assessment was last executed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeLastAssessed: string; /** * The date and time the security assessment was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * A filter to return only security assessments that were created by either user or system. */ triggeredBy: string; /** * A filter to return only items that match the specified security assessment type. */ type: string; } interface GetSecurityAssessmentsSecurityAssessmentCheck { /** * The category to which the check belongs to. */ category: string; /** * A unique identifier for the check. */ key: string; /** * Provides a recommended approach to take to remediate the check reported. */ oneline: string; /** * Provides information on whether the check is related to a CIS Oracle Database Benchmark recommendation, STIG rule, GDPR Article/Recital or related to the Oracle Best Practice. */ references: outputs.DataSafe.GetSecurityAssessmentsSecurityAssessmentCheckReference[]; /** * The explanation of the issue in this check. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of the check as suggested by Data Safe security assessment. This will be the default severity in the template baseline security assessment. */ suggestedSeverity: string; /** * The short title for the check. */ title: string; } interface GetSecurityAssessmentsSecurityAssessmentCheckReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface GetSecurityAssessmentsSecurityAssessmentStatistic { /** * Statistics showing the number of findings with a particular risk level for each category. */ advisories: outputs.DataSafe.GetSecurityAssessmentsSecurityAssessmentStatisticAdvisory[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ deferreds: outputs.DataSafe.GetSecurityAssessmentsSecurityAssessmentStatisticDeferred[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ evaluates: outputs.DataSafe.GetSecurityAssessmentsSecurityAssessmentStatisticEvaluate[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ highRisks: outputs.DataSafe.GetSecurityAssessmentsSecurityAssessmentStatisticHighRisk[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ lowRisks: outputs.DataSafe.GetSecurityAssessmentsSecurityAssessmentStatisticLowRisk[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ mediumRisks: outputs.DataSafe.GetSecurityAssessmentsSecurityAssessmentStatisticMediumRisk[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ passes: outputs.DataSafe.GetSecurityAssessmentsSecurityAssessmentStatisticPass[]; /** * The total number of targets in this security assessment. */ targetsCount: number; } interface GetSecurityAssessmentsSecurityAssessmentStatisticAdvisory { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentsSecurityAssessmentStatisticDeferred { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentsSecurityAssessmentStatisticEvaluate { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentsSecurityAssessmentStatisticHighRisk { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentsSecurityAssessmentStatisticLowRisk { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentsSecurityAssessmentStatisticMediumRisk { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityAssessmentsSecurityAssessmentStatisticPass { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface GetSecurityPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityPoliciesSecurityPolicyCollection { items: outputs.DataSafe.GetSecurityPoliciesSecurityPolicyCollectionItem[]; } interface GetSecurityPoliciesSecurityPolicyCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the security policy. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the security policy. */ id: string; /** * Details about the current state of the security policy in Data Safe. */ lifecycleDetails: string; /** * The type of the security policy. */ securityPolicyType: string; /** * The current state of the security policy. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time that the security policy was created, in the format defined by RFC3339. */ timeCreated: string; /** * The last date and time the security policy was updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetSecurityPolicyConfigFirewallConfig { /** * Specifies whether the firewall should include or exclude the database internal job activities. */ excludeJob: string; /** * Specifies if the firewall is enabled or disabled. */ status: string; /** * The date and time the firewall configuration was last updated, in the format defined by RFC3339. */ timeStatusUpdated: string; /** * Specifies whether Data Safe should automatically purge the violation logs from the database after collecting the violation logs and persisting on Data Safe. */ violationLogAutoPurge: string; } interface GetSecurityPolicyConfigUnifiedAuditPolicyConfig { /** * Specifies whether the Data Safe service account on the target database should be excluded in the unified audit policy. */ excludeDatasafeUser: string; } interface GetSecurityPolicyConfigsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityPolicyConfigsSecurityPolicyConfigCollection { items: outputs.DataSafe.GetSecurityPolicyConfigsSecurityPolicyConfigCollectionItem[]; } interface GetSecurityPolicyConfigsSecurityPolicyConfigCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the security policy configuration. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * The SQL Firewall related configurations. */ firewallConfigs: outputs.DataSafe.GetSecurityPolicyConfigsSecurityPolicyConfigCollectionItemFirewallConfig[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the security policy configuration. */ id: string; /** * Details about the current state of the security policy configuration. */ lifecycleDetails: string; /** * An optional filter to return only resources that match the specified OCID of the security policy resource. */ securityPolicyId: string; /** * The current state of the security policy configuration resource. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the security policy configuration was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the security policy configuration was last updated, in the format defined by RFC3339. */ timeUpdated: string; /** * The unified audit policy related configurations. */ unifiedAuditPolicyConfigs: outputs.DataSafe.GetSecurityPolicyConfigsSecurityPolicyConfigCollectionItemUnifiedAuditPolicyConfig[]; } interface GetSecurityPolicyConfigsSecurityPolicyConfigCollectionItemFirewallConfig { /** * Specifies whether the firewall should include or exclude the database internal job activities. */ excludeJob: string; /** * Specifies if the firewall is enabled or disabled. */ status: string; /** * The date and time the firewall configuration was last updated, in the format defined by RFC3339. */ timeStatusUpdated: string; /** * Specifies whether Data Safe should automatically purge the violation logs from the database after collecting the violation logs and persisting on Data Safe. */ violationLogAutoPurge: string; } interface GetSecurityPolicyConfigsSecurityPolicyConfigCollectionItemUnifiedAuditPolicyConfig { /** * Specifies whether the Data Safe service account on the target database should be excluded in the unified audit policy. */ excludeDatasafeUser: string; } interface GetSecurityPolicyDeploymentSecurityPolicyEntryStateEntryDetail { /** * The status of Data Safe user exclusion in the audit policy. */ datasafeUserExclusionStatus: string; /** * The security policy entry type. Allowed values: * * FIREWALL_POLICY - The SQL Firewall policy entry type. * * AUDIT_POLICY - The audit policy entry type. * * CONFIG - Config changes deployment. */ entryType: string; /** * Specifies why exclusion of the Data Safe user did not succeed. */ excludeDatasafeUserFailureMsg: string; /** * The time the the SQL Firewall policy was generated on the target database, in the format defined by RFC3339. */ timeGenerated: string; /** * The last date and time the status of the SQL Firewall policy was updated on the target database, in the format defined by RFC3339. */ timeStatusUpdated: string; } interface GetSecurityPolicyDeploymentSecurityPolicyEntryStatesFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityPolicyDeploymentSecurityPolicyEntryStatesSecurityPolicyEntryStateCollection { items: outputs.DataSafe.GetSecurityPolicyDeploymentSecurityPolicyEntryStatesSecurityPolicyEntryStateCollectionItem[]; } interface GetSecurityPolicyDeploymentSecurityPolicyEntryStatesSecurityPolicyEntryStateCollectionItem { /** * The current state of the security policy deployment. */ deploymentStatus: string; /** * Details about the current deployment status. */ deploymentStatusDetails: string; /** * Details specific to the security policy entry. */ entryDetails: outputs.DataSafe.GetSecurityPolicyDeploymentSecurityPolicyEntryStatesSecurityPolicyEntryStateCollectionItemEntryDetail[]; /** * The security policy entry type. Allowed values: * * FIREWALL_POLICY - The SQL Firewall policy entry type. * * AUDIT_POLICY - The audit policy entry type. * * CONFIG - Config changes deployment. */ entryType: string; /** * Unique id of the security policy entry state. */ id: string; /** * The OCID of the security policy deployment resource. */ securityPolicyDeploymentId: string; /** * An optional filter to return only resources that match the specified security policy entry OCID. */ securityPolicyEntryId: string; /** * An optional filter to return only resources that match the specified target id. */ targetId: string; } interface GetSecurityPolicyDeploymentSecurityPolicyEntryStatesSecurityPolicyEntryStateCollectionItemEntryDetail { /** * The status of Data Safe user exclusion in the audit policy. */ datasafeUserExclusionStatus: string; /** * The security policy entry type. Allowed values: * * FIREWALL_POLICY - The SQL Firewall policy entry type. * * AUDIT_POLICY - The audit policy entry type. * * CONFIG - Config changes deployment. */ entryType: string; /** * Specifies why exclusion of the Data Safe user did not succeed. */ excludeDatasafeUserFailureMsg: string; /** * The time the the SQL Firewall policy was generated on the target database, in the format defined by RFC3339. */ timeGenerated: string; /** * The last date and time the status of the SQL Firewall policy was updated on the target database, in the format defined by RFC3339. */ timeStatusUpdated: string; } interface GetSecurityPolicyDeploymentsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityPolicyDeploymentsSecurityPolicyDeploymentCollection { items: outputs.DataSafe.GetSecurityPolicyDeploymentsSecurityPolicyDeploymentCollectionItem[]; } interface GetSecurityPolicyDeploymentsSecurityPolicyDeploymentCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; deployTrigger: number; /** * The description of the security policy deployment. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the security policy deployment. */ id: string; /** * Details about the current state of the security policy deployment in Data Safe. */ lifecycleDetails: string; refreshTrigger: number; /** * An optional filter to return only resources that match the specified OCID of the security policy resource. */ securityPolicyId: string; /** * The current state of the security policy deployment. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * A optional filter to return only resources that belong to the specified target type. */ targetType: string; /** * The time that the security policy deployment was created, in the format defined by RFC3339. */ timeCreated: string; /** * The last date and time the security policy was deployed, in the format defined by RFC3339. */ timeDeployed: string; /** * The last date and time the security policy deployment was updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetSecurityPolicyReportDatabaseTableAccessEntriesDatabaseTableAccessEntryCollection { items: outputs.DataSafe.GetSecurityPolicyReportDatabaseTableAccessEntriesDatabaseTableAccessEntryCollectionItem[]; } interface GetSecurityPolicyReportDatabaseTableAccessEntriesDatabaseTableAccessEntryCollectionItem { /** * A non-null value in this field indicates the object through which user has access to table, possible values could be table or view. */ accessThroughObject: string; /** * The type of the access the user has on the table, there can be one or more from SELECT, UPDATE, INSERT, OWNER or DELETE. */ accessType: string; /** * Indicates whether the user has access to all the tables in the schema. */ areAllTablesAccessible: boolean; /** * If there are column level privileges on a table or view. */ columnName: string; /** * This can be empty in case of direct grant, in case of indirect grant, this attribute displays the name of the role which is granted to the user though which the user has access to the table. */ grantFromRole: string; /** * Grantee is the user who can access the table */ grantee: string; /** * The one who granted this privilege. */ grantor: string; /** * Indicates whether the table access is constrained via Oracle Database Vault. */ isAccessConstrainedByDatabaseVault: boolean; /** * Indicates whether the table access is constrained via Oracle Label Security. */ isAccessConstrainedByLabelSecurity: boolean; /** * Indicates whether the table access is constrained via Real Application Security. */ isAccessConstrainedByRealApplicationSecurity: boolean; /** * Indicates whether the table access is constrained via Oracle Data Redaction. */ isAccessConstrainedByRedaction: boolean; /** * Indicates whether the table access is constrained via Oracle Database SQL Firewall. */ isAccessConstrainedBySqlFirewall: boolean; /** * Indicates whether the access is constrained on a table via a view. */ isAccessConstrainedByView: boolean; /** * Indicates whether the table access is constrained via Virtual Private Database. */ isAccessConstrainedByVirtualPrivateDatabase: boolean; /** * Indicates whether the table is marked as sensitive. */ isSensitive: boolean; /** * The unique key that identifies the table access report. It is numeric and unique within a security policy report. */ key: string; /** * Name of the privilege. */ privilege: string; /** * Indicates whether the grantee can grant this privilege to other users. Privileges can be granted to a user or role with GRANT_OPTION or ADMIN_OPTION */ privilegeGrantable: string; /** * Type of the privilege user has, this includes System Privilege, Schema Privilege, Object Privilege, Column Privilege, Owner or Schema Privilege on a schema. */ privilegeType: string; /** * The name of the database table the user has access to. */ tableName: string; /** * The name of the schema the table belongs to. */ tableSchema: string; /** * The OCID of the of the target database. */ targetId: string; } interface GetSecurityPolicyReportDatabaseTableAccessEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityPolicyReportDatabaseViewAccessEntriesDatabaseViewAccessEntryCollection { items: outputs.DataSafe.GetSecurityPolicyReportDatabaseViewAccessEntriesDatabaseViewAccessEntryCollectionItem[]; } interface GetSecurityPolicyReportDatabaseViewAccessEntriesDatabaseViewAccessEntryCollectionItem { /** * The type of the access the user has on the table, there can be one or more from SELECT, UPDATE, INSERT or DELETE. */ accessType: string; /** * If there are column level privileges on a table or view. */ columnName: string; /** * This can be empty in case of direct grant, in case of indirect grant, this attribute displays the name of the role which is granted to the user though which the user has access to the table. */ grantFromRole: string; /** * Grantee is the user who can access the table or view */ grantee: string; /** * The user who granted the privilege. */ grantor: string; /** * Indicates whether the table access is constrained via Oracle Database Vault. */ isAccessConstrainedByDatabaseVault: boolean; /** * Indicates whether the view access is constrained via Real Application Security. */ isAccessConstrainedByRealApplicationSecurity: boolean; /** * Indicates whether the view access is constrained via Oracle Data Redaction. */ isAccessConstrainedByRedaction: boolean; /** * Indicates whether the view access is constrained via Oracle Database SQL Firewall. */ isAccessConstrainedBySqlFirewall: boolean; /** * Indicates whether the view access is constrained via Virtual Private Database. */ isAccessConstrainedByVirtualPrivateDatabase: boolean; /** * The unique key that identifies the table access report. It is numeric and unique within a security policy report. */ key: string; /** * The name of the privilege. */ privilege: string; /** * Indicates whether the grantee can grant this privilege to other users. Privileges can be granted to a user or role with GRANT_OPTION or ADMIN_OPTION */ privilegeGrantable: string; /** * Type of the privilege user has, this includes System Privilege, Schema Privilege, Object Privilege, Column Privilege, Owner or Schema Privilege on a schema. */ privilegeType: string; /** * The name of the database table the user has access to. */ tableName: string; /** * The name of the schema the table belongs to. */ tableSchema: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The name of the view. */ viewName: string; /** * The name of the schema. */ viewSchema: string; /** * Definition of the view. */ viewText: string; } interface GetSecurityPolicyReportDatabaseViewAccessEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityPolicyReportRoleGrantPathsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityPolicyReportRoleGrantPathsRoleGrantPathCollection { /** * An array of grant path summary objects. */ items: outputs.DataSafe.GetSecurityPolicyReportRoleGrantPathsRoleGrantPathCollectionItem[]; } interface GetSecurityPolicyReportRoleGrantPathsRoleGrantPathCollectionItem { /** * The grant depth level of the indirect grant. An indirectly granted role/privilege is granted to the user through another role. The depth level indicates how deep a privilege is within the grant hierarchy. */ depthLevel: number; /** * A filter to return only items that match the specified role. */ grantedRole: string; /** * A filter to return only items that match the specified grantee. */ grantee: string; /** * The unique key of a role grant. */ key: string; } interface GetSecurityPolicyReportsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecurityPolicyReportsSecurityPolicyReportCollection { items: outputs.DataSafe.GetSecurityPolicyReportsSecurityPolicyReportCollectionItem[]; } interface GetSecurityPolicyReportsSecurityPolicyReportCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the security policy report. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the security policy report. */ id: string; /** * Details about the current state of the security policy report. */ lifecycleDetails: string; /** * The current state of the security policy report. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the security policy report was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the security policy report was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetSensitiveColumnAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveColumnAnalyticsSensitiveColumnAnalyticsCollection { /** * An array of sensitive column analytics summary objects. */ items: outputs.DataSafe.GetSensitiveColumnAnalyticsSensitiveColumnAnalyticsCollectionItem[]; } interface GetSensitiveColumnAnalyticsSensitiveColumnAnalyticsCollectionItem { /** * The dimensions available for sensitive column analytics. */ dimensions: outputs.DataSafe.GetSensitiveColumnAnalyticsSensitiveColumnAnalyticsCollectionItemDimension[]; /** * The total count for the aggregation metric. */ sensitiveColumnAnalyticCount: string; } interface GetSensitiveColumnAnalyticsSensitiveColumnAnalyticsCollectionItemDimension { /** * A filter to return only a specific column based on column name. */ columnName: string; /** * A filter to return only items related to a specific object name. */ object: string; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * A filter to return only the resources that match the specified sensitive data model OCID. */ sensitiveDataModelId: string; /** * A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs. */ sensitiveTypeId: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; } interface GetSensitiveDataModelReferentialRelationChild { /** * The application name. */ appName: string; /** * Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. */ columnGroups: string[]; /** * The database object that contains the columns. */ object: string; /** * The type of the database object that contains the sensitive column. */ objectType: string; /** * The schema name. */ schemaName: string; /** * Sensitive type ocids of each column groups. Order needs to be maintained with the parent column group. For the DB defined referential relations identified during SDM creation, we cannot add sensitive types. Instead use the sensitiveColumn POST API to mark the columns sensitive. */ sensitiveTypeIds: string[]; } interface GetSensitiveDataModelReferentialRelationParent { /** * The application name. */ appName: string; /** * Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. */ columnGroups: string[]; /** * The database object that contains the columns. */ object: string; /** * The type of the database object that contains the sensitive column. */ objectType: string; /** * The schema name. */ schemaName: string; /** * Sensitive type ocids of each column groups. Order needs to be maintained with the parent column group. For the DB defined referential relations identified during SDM creation, we cannot add sensitive types. Instead use the sensitiveColumn POST API to mark the columns sensitive. */ sensitiveTypeIds: string[]; } interface GetSensitiveDataModelReferentialRelationsFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveDataModelReferentialRelationsReferentialRelationCollection { items: outputs.DataSafe.GetSensitiveDataModelReferentialRelationsReferentialRelationCollectionItem[]; } interface GetSensitiveDataModelReferentialRelationsReferentialRelationCollectionItem { /** * columnsInfo object has details of column group with schema details. */ child: outputs.DataSafe.GetSensitiveDataModelReferentialRelationsReferentialRelationCollectionItemChild; /** * Returns referential relations containing sensitive columns when true. Returns referential relations containing non sensitive columns when false. */ isSensitive: boolean; /** * The unique key that identifies the referential relation. It's numeric and unique within a sensitive data model. */ key: string; /** * columnsInfo object has details of column group with schema details. */ parent: outputs.DataSafe.GetSensitiveDataModelReferentialRelationsReferentialRelationCollectionItemParent; /** * A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, it returns the sensitive columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents. */ relationType: string; /** * The OCID of the sensitive data model. */ sensitiveDataModelId: string; /** * The current state of the referential relation. */ state: string; } interface GetSensitiveDataModelReferentialRelationsReferentialRelationCollectionItemChild { /** * The application name. */ appName: string; /** * Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. */ columnGroups: string[]; /** * A filter to return only items related to a specific object name. */ object: string; /** * The type of the database object that contains the sensitive column. */ objectType: string; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * Sensitive type ocids of each column groups. Order needs to be maintained with the parent column group. For the DB defined referential relations identified during SDM creation, we cannot add sensitive types. Instead use the sensitiveColumn POST API to mark the columns sensitive. */ sensitiveTypeIds: string[]; } interface GetSensitiveDataModelReferentialRelationsReferentialRelationCollectionItemParent { /** * The application name. */ appName: string; /** * Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. */ columnGroups: string[]; /** * A filter to return only items related to a specific object name. */ object: string; /** * The type of the database object that contains the sensitive column. */ objectType: string; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * Sensitive type ocids of each column groups. Order needs to be maintained with the parent column group. For the DB defined referential relations identified during SDM creation, we cannot add sensitive types. Instead use the sensitiveColumn POST API to mark the columns sensitive. */ sensitiveTypeIds: string[]; } interface GetSensitiveDataModelSensitiveObjectsFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveDataModelSensitiveObjectsSensitiveObjectCollection { /** * An array of sensitive object summary objects. */ items: outputs.DataSafe.GetSensitiveDataModelSensitiveObjectsSensitiveObjectCollectionItem[]; } interface GetSensitiveDataModelSensitiveObjectsSensitiveObjectCollectionItem { /** * A filter to return only items related to a specific object name. */ object: string; /** * A filter to return only items related to a specific object type. */ objectType: string; /** * A filter to return only items related to specific schema name. */ schemaName: string; } interface GetSensitiveDataModelSensitiveSchemasFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveDataModelSensitiveSchemasSensitiveSchemaCollection { /** * An array of sensitive schema summary objects. */ items: outputs.DataSafe.GetSensitiveDataModelSensitiveSchemasSensitiveSchemaCollectionItem[]; } interface GetSensitiveDataModelSensitiveSchemasSensitiveSchemaCollectionItem { /** * A filter to return only items related to specific schema name. */ schemaName: string; } interface GetSensitiveDataModelSensitiveTypesFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveDataModelSensitiveTypesSensitiveDataModelSensitiveTypeCollection { /** * An array of sensitive types summary objects present in a sensitive data model. */ items: outputs.DataSafe.GetSensitiveDataModelSensitiveTypesSensitiveDataModelSensitiveTypeCollectionItem[]; } interface GetSensitiveDataModelSensitiveTypesSensitiveDataModelSensitiveTypeCollectionItem { /** * The total number of sensitive columns linked to this specific sensitive type . */ sensitiveDataModelSensitiveTypeCount: string; /** * A filter to return only items related to a specific sensitive type OCID. */ sensitiveTypeId: string; } interface GetSensitiveDataModelTablesForDiscovery { /** * This contains the name of the schema. */ schemaName: string; /** * This contains an optional list of the table names. */ tableNames: string[]; } interface GetSensitiveDataModelsFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveDataModelsSensitiveColumnConfidenceLevelDetail { doesColumnLeadToPiiInNonTables: boolean; doesColumnLeadToPiiInSameRelatedTables: boolean; hasCommentPatternMatched: boolean; hasDataPatternMatched: boolean; hasNamePatternMatched: boolean; isSensitiveTypeFromSameContextFoundInSameOrRelatedTables: boolean; } interface GetSensitiveDataModelsSensitiveColumnsFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveDataModelsSensitiveColumnsSensitiveColumnCollection { items: outputs.DataSafe.GetSensitiveDataModelsSensitiveColumnsSensitiveColumnCollectionItem[]; } interface GetSensitiveDataModelsSensitiveColumnsSensitiveColumnCollectionItem { /** * Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. */ appDefinedChildColumnKeys: string[]; /** * The name of the application associated with the sensitive column. It's useful when the application name is different from the schema name. Otherwise, it can be ignored. */ appName: string; /** * The composite key groups to which the sensitive column belongs. If the column is part of a composite key, it's assigned a column group. It helps identify and manage referential relationships that involve composite keys. */ columnGroups: string[]; /** * A filter to return only a specific column based on column name. */ columnName: string; /** * A filter to return the sensitive columns with the specified confidence level. Confidence level of sensitive column associated with a seeded sensitive type can either be HIGH or LOW. While the confidence level of sensitive column associated with a user defined sensitive will be NONE. For sensitive columns added manually the confidence level will also be NONE. */ confidenceLevel: string; /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ confidenceLevelDetails: outputs.DataSafe.GetSensitiveDataModelsSensitiveColumnsSensitiveColumnCollectionItemConfidenceLevelDetail[]; /** * A filter to return only the resources that match the specified data types. */ dataType: string; /** * Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. */ dbDefinedChildColumnKeys: string[]; /** * The estimated number of data values the column has in the associated database. */ estimatedDataValueCount: string; /** * The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model. */ key: string; /** * Details about the current state of the sensitive column. */ lifecycleDetails: string; /** * A filter to return only items related to a specific object name. */ object: string; /** * A filter to return only items related to a specific object type. */ objectType: string; /** * Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only. */ parentColumnKeys: string[]; /** * A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, it returns the sensitive columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents. */ relationType: string; /** * Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column. */ sampleDataValues: string[]; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * The OCID of the sensitive data model. */ sensitiveDataModelId: string; /** * A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs. */ sensitiveTypeId: string; /** * The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually. */ source: string; /** * The current state of the sensitive column. */ state: string; /** * A filter to return only the sensitive columns that match the specified status. */ status: string; /** * The date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339), the sensitive column was created in the sensitive data model. */ timeCreated: string; /** * The date and time, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339), the sensitive column was last updated in the sensitive data model. */ timeUpdated: string; } interface GetSensitiveDataModelsSensitiveColumnsSensitiveColumnCollectionItemConfidenceLevelDetail { doesColumnLeadToPiiInNonTables: boolean; doesColumnLeadToPiiInSameRelatedTables: boolean; hasCommentPatternMatched: boolean; hasDataPatternMatched: boolean; hasNamePatternMatched: boolean; isSensitiveTypeFromSameContextFoundInSameOrRelatedTables: boolean; } interface GetSensitiveDataModelsSensitiveDataModelCollection { items: outputs.DataSafe.GetSensitiveDataModelsSensitiveDataModelCollectionItem[]; } interface GetSensitiveDataModelsSensitiveDataModelCollectionItem { /** * The application suite name identifying a collection of applications. The default value is GENERIC. It's useful only if maintaining a sensitive data model for a suite of applications. */ appSuiteName: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the sensitive data model. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the sensitive data model. */ id: string; /** * Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships. */ isAppDefinedRelationDiscoveryEnabled: boolean; /** * Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). */ isIncludeAllSchemas: boolean; /** * Indicates if all the existing sensitive types should be used by data discovery jobs.If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. */ isIncludeAllSensitiveTypes: boolean; /** * Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE. */ isSampleDataCollectionEnabled: boolean; /** * The schemas to be scanned by data discovery jobs. */ schemasForDiscoveries: string[]; /** * The OCIDs of the sensitive type groups to be used by data discovery jobs. */ sensitiveTypeGroupIdsForDiscoveries: string[]; /** * The OCIDs of the sensitive types to be used by data discovery jobs. */ sensitiveTypeIdsForDiscoveries: string[]; /** * A filter to return only the resources that match the specified lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}]. */ tablesForDiscoveries: outputs.DataSafe.GetSensitiveDataModelsSensitiveDataModelCollectionItemTablesForDiscovery[]; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the sensitive data model was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the sensitive data model was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetSensitiveDataModelsSensitiveDataModelCollectionItemTablesForDiscovery { /** * This contains the name of the schema. */ schemaName: string; /** * This contains an optional list of the table names. */ tableNames: string[]; } interface GetSensitiveTypeGroupGroupedSensitiveTypesFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveTypeGroupGroupedSensitiveTypesGroupedSensitiveTypeCollection { /** * List of sensitive type id summary objects present in the sensitive type group. */ items: outputs.DataSafe.GetSensitiveTypeGroupGroupedSensitiveTypesGroupedSensitiveTypeCollectionItem[]; } interface GetSensitiveTypeGroupGroupedSensitiveTypesGroupedSensitiveTypeCollectionItem { /** * List of sensitive type id summary objects present in the sensitive type group. */ items: outputs.DataSafe.GetSensitiveTypeGroupGroupedSensitiveTypesGroupedSensitiveTypeCollectionItemItem[]; patchOperations?: outputs.DataSafe.GetSensitiveTypeGroupGroupedSensitiveTypesGroupedSensitiveTypeCollectionItemPatchOperation[]; /** * The OCID of the sensitive type group. */ sensitiveTypeGroupId: string; } interface GetSensitiveTypeGroupGroupedSensitiveTypesGroupedSensitiveTypeCollectionItemItem { /** * A filter to return only items related to a specific sensitive type OCID. */ sensitiveTypeId: string; } interface GetSensitiveTypeGroupGroupedSensitiveTypesGroupedSensitiveTypeCollectionItemPatchOperation { operation: string; selection: string; value: { [key: string]: string; }; } interface GetSensitiveTypeGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveTypeGroupsSensitiveTypeGroupCollection { items: outputs.DataSafe.GetSensitiveTypeGroupsSensitiveTypeGroupCollectionItem[]; } interface GetSensitiveTypeGroupsSensitiveTypeGroupCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the sensitive type group. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the sensitive type group. */ id: string; /** * The number of sensitive types in the specified sensitive type group. */ sensitiveTypeCount: number; /** * A filter to return only the resources that match the specified lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the sensitive type group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the sensitive type group was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetSensitiveTypesExportsFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveTypesExportsSensitiveTypesExportCollection { items: outputs.DataSafe.GetSensitiveTypesExportsSensitiveTypesExportCollectionItem[]; } interface GetSensitiveTypesExportsSensitiveTypesExportCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the sensitive types export. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the sensitive types export. */ id: string; /** * Indicates if all the existing user-defined sensitive types are used for export. If it's set to true, the sensitiveTypeIdsForExport attribute is ignored and all user-defined sensitive types are exported. */ isIncludeAllSensitiveTypes: boolean; /** * The OCIDs of the sensitive types used to create sensitive types export. */ sensitiveTypeIdsForExports: string[]; /** * A filter to return only the resources that match the specified lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the sensitive types export was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the sensitive types export was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetSensitiveTypesFilter { name: string; regex?: boolean; values: string[]; } interface GetSensitiveTypesSensitiveTypeCollection { items: outputs.DataSafe.GetSensitiveTypesSensitiveTypeCollectionItem[]; } interface GetSensitiveTypesSensitiveTypeCollectionItem { /** * A regular expression to be used by data discovery for matching column comments. */ commentPattern: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * A regular expression to be used by data discovery for matching column data values. */ dataPattern: string; /** * A filter to return only the sensitive types that have the default masking format identified by the specified OCID. */ defaultMaskingFormatId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the sensitive type. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * A filter to return the sensitive type resources based on the value of their entityType attribute. */ entityType: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the sensitive type. */ id: string; /** * A filter to return only the common sensitive type resources. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery. */ isCommon: boolean; /** * A regular expression to be used by data discovery for matching column names. */ namePattern: string; /** * A filter to return only the sensitive types that are children of the sensitive category identified by the specified OCID. */ parentCategoryId: string; /** * The search type indicating how the column name, comment and data patterns should be used by data discovery. [Learn more](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/sensitive-types.html#GUID-1D1AD98E-B93F-4FF2-80AE-CB7D8A14F6CC). */ searchType: string; /** * The short name of the sensitive type. */ shortName: string; /** * Specifies whether the sensitive type is user-defined or predefined. */ source: string; /** * A filter to return only the resources that match the specified lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the sensitive type was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the sensitive type was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetSqlCollectionAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetSqlCollectionAnalyticsSqlCollectionAnalyticsCollection { /** * The aggregated data point items. */ items: outputs.DataSafe.GetSqlCollectionAnalyticsSqlCollectionAnalyticsCollectionItem[]; } interface GetSqlCollectionAnalyticsSqlCollectionAnalyticsCollectionItem { /** * The dimensions available for SQL collection analytics. */ dimensions: outputs.DataSafe.GetSqlCollectionAnalyticsSqlCollectionAnalyticsCollectionItemDimension[]; /** * The total count of the aggregated metric. */ sqlCollectionAnalyticCount: string; } interface GetSqlCollectionAnalyticsSqlCollectionAnalyticsCollectionItemDimension { /** * The current state of the SQL collection. */ state: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; } interface GetSqlCollectionLogInsightsFilter { name: string; regex?: boolean; values: string[]; } interface GetSqlCollectionLogInsightsSqlCollectionLogInsightsCollection { /** * The aggregated data point items. */ items: outputs.DataSafe.GetSqlCollectionLogInsightsSqlCollectionLogInsightsCollectionItem[]; } interface GetSqlCollectionLogInsightsSqlCollectionLogInsightsCollectionItem { /** * The dimensions available for SQL collection analytics. */ dimensions: outputs.DataSafe.GetSqlCollectionLogInsightsSqlCollectionLogInsightsCollectionItemDimension[]; /** * Name of the aggregation. */ metricName: string; /** * Total count of aggregated value. */ sqlCollectionLogInsightCount: string; /** * An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeEnded: string; /** * An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStarted: string; } interface GetSqlCollectionLogInsightsSqlCollectionLogInsightsCollectionItemDimension { /** * The IP addresses for the SQL collection. */ clientIp: string; /** * The operating system user names for the SQL collection. */ clientOsUserName: string; /** * The allowed client programs for the SQL collection. */ clientProgram: string; } interface GetSqlCollectionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSqlCollectionsSqlCollectionCollection { items: outputs.DataSafe.GetSqlCollectionsSqlCollectionCollectionItem[]; } interface GetSqlCollectionsSqlCollectionCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * A filter to return only items that match the specified user name. */ dbUserName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the SQL collection. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; generateSqlFirewallPolicyTrigger: boolean; /** * The OCID of the SQL collection. */ id: string; /** * Details about the current state of the SQL collection in Data Safe. */ lifecycleDetails: string; purgeLogsTrigger: boolean; refreshLogInsightsTrigger: boolean; /** * Specifies the level of SQL that will be collected. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. */ sqlLevel: string; startTrigger: boolean; /** * The current state of the SQL collection. */ state: string; /** * Specifies if the status of the SqlCollection. Enabled indicates that the collecting is in progress. */ status: string; stopTrigger: boolean; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The time that the SQL collection was created, in the format defined by RFC3339. */ timeCreated: string; /** * The timestamp of the most recent SqlCollection start operation, in the format defined by RFC3339. */ timeLastStarted: string; /** * The timestamp of the most recent SqlCollection stop operation, in the format defined by RFC3339. */ timeLastStopped: string; /** * The last date and time the SQL collection was updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetSqlFirewallAllowedSqlAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetSqlFirewallAllowedSqlAnalyticsSqlFirewallAllowedSqlAnalyticsCollection { /** * The aggregated data point items. */ items: outputs.DataSafe.GetSqlFirewallAllowedSqlAnalyticsSqlFirewallAllowedSqlAnalyticsCollectionItem[]; } interface GetSqlFirewallAllowedSqlAnalyticsSqlFirewallAllowedSqlAnalyticsCollectionItem { /** * The dimensions available for SQL Firewall allow SQL analytics. */ dimensions: outputs.DataSafe.GetSqlFirewallAllowedSqlAnalyticsSqlFirewallAllowedSqlAnalyticsCollectionItemDimension[]; /** * The total count of the aggregated metric. */ sqlFirewallAllowedSqlAnalyticCount: string; } interface GetSqlFirewallAllowedSqlAnalyticsSqlFirewallAllowedSqlAnalyticsCollectionItemDimension { /** * The database user name. */ dbUserName: string; /** * The OCID of the SQL Firewall policy corresponding to the SQL Firewall allowed SQL. */ sqlFirewallPolicyId: string; /** * Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. */ sqlLevel: string; /** * The current state of the SQL Firewall allowed SQL. */ state: string; } interface GetSqlFirewallAllowedSqlsFilter { name: string; regex?: boolean; values: string[]; } interface GetSqlFirewallAllowedSqlsSqlFirewallAllowedSqlCollection { items: outputs.DataSafe.GetSqlFirewallAllowedSqlsSqlFirewallAllowedSqlCollectionItem[]; } interface GetSqlFirewallAllowedSqlsSqlFirewallAllowedSqlCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * The name of the user that SQL was executed as. */ currentUser: string; /** * The database user name. */ dbUserName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the SQL Firewall allowed SQL. */ description: string; /** * The display name of the SQL Firewall allowed SQL. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the SQL Firewall allowed SQL. */ id: string; /** * The objects accessed by the SQL. */ sqlAccessedObjects: string[]; /** * The OCID of the SQL Firewall policy corresponding to the SQL Firewall allowed SQL. */ sqlFirewallPolicyId: string; /** * Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. */ sqlLevel: string; /** * The SQL text of the SQL Firewall allowed SQL. */ sqlText: string; /** * The current state of the SQL Firewall allowed SQL. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the SQL Firewall allowed SQL was collected from the target database, in the format defined by RFC3339. */ timeCollected: string; /** * The last date and time the SQL Firewall allowed SQL was updated, in the format defined by RFC3339. */ timeUpdated: string; /** * Version of the associated SQL Firewall policy. This identifies whether the allowed SQLs were added in the same batch or not. */ version: number; } interface GetSqlFirewallPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetSqlFirewallPoliciesSqlFirewallPolicyCollection { items: outputs.DataSafe.GetSqlFirewallPoliciesSqlFirewallPolicyCollectionItem[]; } interface GetSqlFirewallPoliciesSqlFirewallPolicyCollectionItem { /** * The list of allowed ip addresses for the SQL Firewall policy. */ allowedClientIps: string[]; /** * The list of allowed operating system user names for the SQL Firewall policy. */ allowedClientOsUsernames: string[]; /** * The list of allowed client programs for the SQL Firewall policy. */ allowedClientPrograms: string[]; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * A filter to return only items that match the specified user name. */ dbUserName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the SQL Firewall policy. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * Specifies the SQL Firewall policy enforcement option. */ enforcementScope: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the SQL Firewall policy. */ id: string; /** * Details about the current state of the SQL Firewall policy in Data Safe. */ lifecycleDetails: string; /** * An optional filter to return only resources that match the specified OCID of the security policy resource. */ securityPolicyId: string; /** * An optional filter to return only resources that match the specified OCID of the SQL Firewall policy resource. */ sqlFirewallPolicyId: string; /** * Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. */ sqlLevel: string; /** * The current state of the SQL Firewall policy. */ state: string; /** * Specifies whether the SQL Firewall policy is enabled or disabled. */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time that the SQL Firewall policy was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the SQL Firewall policy was last updated, in the format defined by RFC3339. */ timeUpdated: string; /** * An optional filter to return only resources that match the specified violation action. */ violationAction: string; /** * Specifies whether a unified audit policy should be enabled for auditing the SQL Firewall policy violations. */ violationAudit: string; } interface GetSqlFirewallPolicyAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetSqlFirewallPolicyAnalyticsSqlFirewallPolicyAnalyticsCollection { /** * The aggregated data point items. */ items: outputs.DataSafe.GetSqlFirewallPolicyAnalyticsSqlFirewallPolicyAnalyticsCollectionItem[]; } interface GetSqlFirewallPolicyAnalyticsSqlFirewallPolicyAnalyticsCollectionItem { /** * The dimensions available for SQL Firewall policy analytics. */ dimensions: outputs.DataSafe.GetSqlFirewallPolicyAnalyticsSqlFirewallPolicyAnalyticsCollectionItemDimension[]; /** * The total count of the aggregated metric. */ sqlFirewallPolicyAnalyticCount: string; } interface GetSqlFirewallPolicyAnalyticsSqlFirewallPolicyAnalyticsCollectionItemDimension { /** * Specifies the SQL Firewall policy enforcement option. */ enforcementScope: string; /** * An optional filter to return only resources that match the specified OCID of the security policy resource. */ securityPolicyId: string; /** * The current state of the SQL Firewall policy. */ state: string; /** * Specifies the mode in which the SQL Firewall policy is enabled. */ violationAction: string; } interface GetSqlFirewallViolationAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetSqlFirewallViolationAnalyticsSqlFirewallViolationAnalyticsCollection { /** * The aggregated data point items. */ items: outputs.DataSafe.GetSqlFirewallViolationAnalyticsSqlFirewallViolationAnalyticsCollectionItem[]; } interface GetSqlFirewallViolationAnalyticsSqlFirewallViolationAnalyticsCollectionItem { /** * The details of the aggregation dimensions used for summarizing SQL violations. */ dimensions: outputs.DataSafe.GetSqlFirewallViolationAnalyticsSqlFirewallViolationAnalyticsCollectionItemDimension[]; /** * The display name of aggregation field. */ displayName: string; /** * The name of the aggregation. */ metricName: string; /** * Total count of aggregated value. */ sqlFirewallViolationAnalyticCount: string; /** * An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeEnded: string; /** * An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStarted: string; } interface GetSqlFirewallViolationAnalyticsSqlFirewallViolationAnalyticsCollectionItemDimension { /** * The IP address of the host from which the session was spawned. */ clientIps: string[]; /** * The name of the operating system user for the database session. */ clientOsUserNames: string[]; /** * The application from which the SQL violation was generated. Examples SQL Plus or SQL Developer. */ clientPrograms: string[]; /** * The name of the database user. */ dbUserNames: string[]; /** * The time of the SQL violation occurrence in the target database. */ operationTimes: string[]; /** * The name of the action executed by the user on the target database, for example, ALTER, CREATE, DROP. */ operations: string[]; /** * Specifies the level of SQL included for this SQL Firewall policy. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. */ sqlLevels: string[]; /** * The OCID of the target database. */ targetIds: string[]; /** * The name of the target database. */ targetNames: string[]; /** * The action taken for this SQL violation. */ violationActions: string[]; /** * Indicates whether SQL or context violation. */ violationCauses: string[]; } interface GetSqlFirewallViolationsFilter { name: string; regex?: boolean; values: string[]; } interface GetSqlFirewallViolationsSqlFirewallViolationsCollection { /** * Array of SQL violation summary. */ items: outputs.DataSafe.GetSqlFirewallViolationsSqlFirewallViolationsCollectionItem[]; } interface GetSqlFirewallViolationsSqlFirewallViolationsCollectionItem { /** * The IP address of the host machine from which the session was generated. */ clientIp: string; /** * The name of the operating system user for the database session. */ clientOsUserName: string; /** * The application from which the SQL violation was generated. Examples include SQL Plus or SQL Developer. */ clientProgram: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * The name of the user that SQL was executed as. */ currentDbUserName: string; /** * The name of the database user. */ dbUserName: string; /** * The OCID of the SQL violation. */ id: string; /** * The name of the action executed by the user on the target database. For example, ALTER, CREATE, DROP. */ operation: string; /** * The time of the SQL violation occurrence in the target database. */ operationTime: string; /** * The objects accessed by the SQL. */ sqlAccessedObjects: string; /** * Specifies the level of SQL for this violation. USER_ISSUED_SQL - User issued SQL statements only. ALL_SQL - Includes all SQL statements including SQL statement issued inside PL/SQL units. */ sqlLevel: string; /** * The SQL text caught by the firewall. */ sqlText: string; /** * The OCID of the target database. */ targetId: string; /** * The name of the target database. */ targetName: string; /** * The timestamp when this SQL violation was collected from the target database by Data Safe. */ timeCollected: string; /** * The action taken for this SQL violation. */ violationAction: string; /** * Indicates whether SQL or context violation. */ violationCause: string; } interface GetTargetAlertPolicyAssociationUnassociatedTargetMembersFilter { name: string; regex?: boolean; values: string[]; } interface GetTargetAlertPolicyAssociationUnassociatedTargetMembersTargetAlertPolicyUnassociatedCollection { /** * Array of unassociated target alert policy association summary. */ items: outputs.DataSafe.GetTargetAlertPolicyAssociationUnassociatedTargetMembersTargetAlertPolicyUnassociatedCollectionItem[]; } interface GetTargetAlertPolicyAssociationUnassociatedTargetMembersTargetAlertPolicyUnassociatedCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Indicates if the target-alert policy association is enabled or disabled by user. */ isEnabled: boolean; /** * Details on why policy is not applied on target. */ notAppliedReason: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of the target database that differs from the alert policy association of the target database group. */ targetDatabaseId: string; } interface GetTargetAlertPolicyAssociationsFilter { name: string; regex?: boolean; values: string[]; } interface GetTargetAlertPolicyAssociationsTargetAlertPolicyAssociationCollection { items: outputs.DataSafe.GetTargetAlertPolicyAssociationsTargetAlertPolicyAssociationCollectionItem[]; } interface GetTargetAlertPolicyAssociationsTargetAlertPolicyAssociationCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Describes the target-alert policy association. */ description: string; /** * The display name of the target-alert policy association. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the target-alert policy association. */ id: string; /** * Indicates if the target-alert policy association is enabled or disabled by user. */ isEnabled: boolean; /** * Details about the current state of the target-alert policy association. */ lifecycleDetails: string; /** * The OCID of the alert policy. */ policyId: string; /** * An optional filter to return only alert policies that have the given life-cycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * A optional filter to return only resources that belong to the specified alert policy association type. */ targetType: string; /** * Creation date and time of the alert policy, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * Last date and time the alert policy was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetTargetDatabaseConnectionOption { /** * The connection type used to connect to the database. Allowed values: * * PRIVATE_ENDPOINT - Represents connection through private endpoint in Data Safe. * * ONPREM_CONNECTOR - Represents connection through on-premises connector in Data Safe. */ connectionType: string; /** * The OCID of the Data Safe private endpoint. */ datasafePrivateEndpointId: string; /** * The OCID of the on-premises connector. */ onPremConnectorId: string; } interface GetTargetDatabaseCredential { /** * The password of the database user. */ password: string; /** * The database user name. */ userName: string; } interface GetTargetDatabaseDatabaseDetail { /** * The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * The database type. */ databaseType: string; /** * The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * The infrastructure type the database is running on. */ infrastructureType: string; /** * The OCID of the compute instance on which the database is running. */ instanceId: string; /** * The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * The port number of the database listener. */ listenerPort: number; /** * The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * The service name of the database registered as target database. */ serviceName: string; /** * The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface GetTargetDatabaseGroupMatchingCriteria { /** * Criteria to exclude certain target databases from the target database group. */ excludes: outputs.DataSafe.GetTargetDatabaseGroupMatchingCriteriaExclude[]; /** * Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseIds, freeformTags, or definedTags criteria, it qualifies for inclusion in the target database group */ includes: outputs.DataSafe.GetTargetDatabaseGroupMatchingCriteriaInclude[]; } interface GetTargetDatabaseGroupMatchingCriteriaExclude { /** * The list of target database OCIDs to be included in the target database group. */ targetDatabaseIds: string[]; } interface GetTargetDatabaseGroupMatchingCriteriaInclude { /** * List of compartment objects, each containing the OCID of the compartment and a boolean value that indicates whether the target databases in the compartments and sub-compartments should also be included in the target database group. */ compartments: outputs.DataSafe.GetTargetDatabaseGroupMatchingCriteriaIncludeCompartment[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The list of target database OCIDs to be included in the target database group. */ targetDatabaseIds: string[]; } interface GetTargetDatabaseGroupMatchingCriteriaIncludeCompartment { /** * The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group. */ id: string; /** * This indicates whether the target databases of sub-compartments should also be included in the target database group. By default, this parameter is set to false. */ isIncludeSubtree: boolean; } interface GetTargetDatabaseGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetTargetDatabaseGroupsTargetDatabaseGroupCollection { items: outputs.DataSafe.GetTargetDatabaseGroupsTargetDatabaseGroupCollectionItem[]; } interface GetTargetDatabaseGroupsTargetDatabaseGroupCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of the target database group. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group. */ id: string; /** * Details for the lifecycle status of the target database group. */ lifecycleDetails: string; /** * Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria). */ matchingCriterias: outputs.DataSafe.GetTargetDatabaseGroupsTargetDatabaseGroupCollectionItemMatchingCriteria[]; /** * The number of target databases in the specified target database group. */ membershipCount: number; /** * Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed. */ membershipUpdateTime: string; /** * A filter to retrieve resources that exclusively align with the designated lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the target database group was created. */ timeCreated: string; /** * Time when the target database group was last updated. */ timeUpdated: string; } interface GetTargetDatabaseGroupsTargetDatabaseGroupCollectionItemMatchingCriteria { /** * Criteria to exclude certain target databases from the target database group. */ excludes: outputs.DataSafe.GetTargetDatabaseGroupsTargetDatabaseGroupCollectionItemMatchingCriteriaExclude[]; /** * Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseIds, freeformTags, or definedTags criteria, it qualifies for inclusion in the target database group */ includes: outputs.DataSafe.GetTargetDatabaseGroupsTargetDatabaseGroupCollectionItemMatchingCriteriaInclude[]; } interface GetTargetDatabaseGroupsTargetDatabaseGroupCollectionItemMatchingCriteriaExclude { /** * The list of target database OCIDs to be included in the target database group. */ targetDatabaseIds: string[]; } interface GetTargetDatabaseGroupsTargetDatabaseGroupCollectionItemMatchingCriteriaInclude { /** * List of compartment objects, each containing the OCID of the compartment and a boolean value that indicates whether the target databases in the compartments and sub-compartments should also be included in the target database group. */ compartments: outputs.DataSafe.GetTargetDatabaseGroupsTargetDatabaseGroupCollectionItemMatchingCriteriaIncludeCompartment[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The list of target database OCIDs to be included in the target database group. */ targetDatabaseIds: string[]; } interface GetTargetDatabaseGroupsTargetDatabaseGroupCollectionItemMatchingCriteriaIncludeCompartment { /** * The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group. */ id: string; /** * This indicates whether the target databases of sub-compartments should also be included in the target database group. By default, this parameter is set to false. */ isIncludeSubtree: boolean; } interface GetTargetDatabasePeerTargetDatabase { /** * Details of the database for the registration in Data Safe. */ databaseDetails: outputs.DataSafe.GetTargetDatabasePeerTargetDatabaseDatabaseDetail[]; /** * Unique name of the database associated to the peer target database. */ databaseUniqueName: string; /** * The OCID of the Data Guard Association resource in which the database associated to the peer target database is considered as peer database to the primary database. */ dataguardAssociationId: string; /** * The description of the peer target database in Data Safe. */ description: string; /** * The display name of the peer target database in Data Safe. */ displayName: string; /** * The secondary key assigned for the peer target database in Data Safe. */ key: number; /** * Details about the current state of the peer target database in Data Safe. */ lifecycleDetails: string; /** * Role of the database associated to the peer target database. */ role: string; /** * The current state of the target database in Data Safe. */ state: string; /** * The date and time the database was registered in Data Safe and created as a target database in Data Safe. */ timeCreated: string; /** * The details required to establish a TLS enabled connection. */ tlsConfigs: outputs.DataSafe.GetTargetDatabasePeerTargetDatabaseTlsConfig[]; } interface GetTargetDatabasePeerTargetDatabaseDatabaseDetail { /** * The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * The database type. */ databaseType: string; /** * The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * The infrastructure type the database is running on. */ infrastructureType: string; /** * The OCID of the compute instance on which the database is running. */ instanceId: string; /** * The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * The port number of the database listener. */ listenerPort: number; /** * The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * The service name of the database registered as target database. */ serviceName: string; /** * The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface GetTargetDatabasePeerTargetDatabaseDetail { /** * Details of the database for the registration in Data Safe. */ databaseDetails: outputs.DataSafe.GetTargetDatabasePeerTargetDatabaseDetailDatabaseDetail[]; /** * The OCID of the Data Guard Association resource in which the database associated to the peer target database is considered as peer database to the primary database. */ dataguardAssociationId: string; /** * The description of the peer target database in Data Safe. */ description: string; /** * The display name of the peer target database in Data Safe. */ displayName: string; /** * The details required to establish a TLS enabled connection. */ tlsConfigs: outputs.DataSafe.GetTargetDatabasePeerTargetDatabaseDetailTlsConfig[]; } interface GetTargetDatabasePeerTargetDatabaseDetailDatabaseDetail { /** * The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * The database type. */ databaseType: string; /** * The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * The infrastructure type the database is running on. */ infrastructureType: string; /** * The OCID of the compute instance on which the database is running. */ instanceId: string; /** * The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * The port number of the database listener. */ listenerPort: number; /** * The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * The service name of the database registered as target database. */ serviceName: string; /** * The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface GetTargetDatabasePeerTargetDatabaseDetailTlsConfig { /** * The format of the certificate store. */ certificateStoreType: string; /** * Base64 encoded string of key store file content. */ keyStoreContent: string; /** * Status to represent whether the database connection is TLS enabled or not. */ status: string; /** * The password to read the trust store and key store files, if they are password protected. */ storePassword: string; /** * Base64 encoded string of trust store file content. */ trustStoreContent: string; } interface GetTargetDatabasePeerTargetDatabaseTlsConfig { /** * The format of the certificate store. */ certificateStoreType: string; /** * Base64 encoded string of key store file content. */ keyStoreContent: string; /** * Status to represent whether the database connection is TLS enabled or not. */ status: string; /** * The password to read the trust store and key store files, if they are password protected. */ storePassword: string; /** * Base64 encoded string of trust store file content. */ trustStoreContent: string; } interface GetTargetDatabasePeerTargetDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetTargetDatabasePeerTargetDatabasesPeerTargetDatabaseCollection { compartmentId: string; items: outputs.DataSafe.GetTargetDatabasePeerTargetDatabasesPeerTargetDatabaseCollectionItem[]; } interface GetTargetDatabasePeerTargetDatabasesPeerTargetDatabaseCollectionItem { /** * Details of the database for the registration in Data Safe. */ databaseDetails: outputs.DataSafe.GetTargetDatabasePeerTargetDatabasesPeerTargetDatabaseCollectionItemDatabaseDetails; /** * Unique name of the database associated to the peer target database. */ databaseUniqueName: string; /** * The OCID of the Data Guard Association resource in which the database associated to the peer target database is considered as peer database to the primary database. */ dataguardAssociationId: string; /** * The description of the peer target database in Data Safe. */ description: string; /** * The display name of the peer target database in Data Safe. */ displayName: string; /** * The secondary key assigned for the peer target database in Data Safe. */ key: number; /** * Details about the current state of the peer target database in Data Safe. */ lifecycleDetails: string; /** * Role of the database associated to the peer target database. */ role: string; /** * The current state of the peer target database in Data Safe. */ state: string; /** * The OCID of the Data Safe target database. */ targetDatabaseId: string; /** * The date and time of the peer target database registration in Data Safe. */ timeCreated: string; /** * The details required to establish a TLS enabled connection. */ tlsConfig: outputs.DataSafe.GetTargetDatabasePeerTargetDatabasesPeerTargetDatabaseCollectionItemTlsConfig; } interface GetTargetDatabasePeerTargetDatabasesPeerTargetDatabaseCollectionItemDatabaseDetails { /** * The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * The database type. */ databaseType: string; /** * The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * The infrastructure type the database is running on. */ infrastructureType: string; /** * The OCID of the compute instance on which the database is running. */ instanceId: string; /** * The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * The port number of the database listener. */ listenerPort: number; /** * The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * The service name of the database registered as target database. */ serviceName: string; /** * The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface GetTargetDatabasePeerTargetDatabasesPeerTargetDatabaseCollectionItemTlsConfig { /** * The format of the certificate store. */ certificateStoreType: string; /** * Base64 encoded string of key store file content. */ keyStoreContent: string; /** * Status to represent whether the database connection is TLS enabled or not. */ status: string; /** * The password to read the trust store and key store files, if they are password protected. */ storePassword: string; /** * Base64 encoded string of trust store file content. */ trustStoreContent: string; } interface GetTargetDatabaseRoleFilter { name: string; regex?: boolean; values: string[]; } interface GetTargetDatabaseRoleRole { authenticationType: string; isCommon: boolean; isImplicit: boolean; isInherited: boolean; isOracleMaintained: boolean; isPasswordRequired: boolean; roleName: string; } interface GetTargetDatabaseRolesFilter { name: string; regex?: boolean; values: string[]; } interface GetTargetDatabaseRolesRole { /** * A filter to return roles based on authentication type. */ authenticationType: string; /** * Is the role common. */ isCommon: boolean; /** * Is the role implicit. */ isImplicit: boolean; /** * Is the role inherited. */ isInherited: boolean; /** * A filter to return roles based on whether they are maintained by oracle or not. */ isOracleMaintained: boolean; /** * Is password required. */ isPasswordRequired: boolean; /** * A filter to return only a specific role based on role name. */ roleName: string; } interface GetTargetDatabaseTlsConfig { /** * The format of the certificate store. */ certificateStoreType: string; /** * Base64 encoded string of key store file content. */ keyStoreContent: string; /** * Status to represent whether the database connection is TLS enabled or not. */ status: string; /** * The password to read the trust store and key store files, if they are password protected. */ storePassword: string; /** * Base64 encoded string of trust store file content. */ trustStoreContent: string; } interface GetTargetDatabasesColumnsColumn { /** * Character length. */ characterLength: number; /** * A filter to return only a specific column based on column name. */ columnName: string; /** * Data type of the column. */ dataType: string; /** * Length of the data represented by the column. */ length: string; /** * Precision of the column. */ precision: number; /** * Scale of the column. */ scale: number; /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * A filter to return only items related to specific table name. */ tableName: string; } interface GetTargetDatabasesColumnsFilter { name: string; regex?: boolean; values: string[]; } interface GetTargetDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetTargetDatabasesSchemasFilter { name: string; regex?: boolean; values: string[]; } interface GetTargetDatabasesSchemasSchema { /** * A filter to return only items related to specific type of schema. */ isOracleMaintained: boolean; /** * A filter to return only items related to specific schema name. */ schemaName: string; } interface GetTargetDatabasesTablesFilter { name: string; regex?: boolean; values: string[]; } interface GetTargetDatabasesTablesTable { /** * A filter to return only items related to specific schema name. */ schemaName: string; /** * A filter to return only items related to specific table name. */ tableName: string; } interface GetTargetDatabasesTargetDatabase { /** * The OCIDs of associated resources like database, Data Safe private endpoint etc. */ associatedResourceIds: string[]; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * Types of connection supported by Data Safe. */ connectionOptions: outputs.DataSafe.GetTargetDatabasesTargetDatabaseConnectionOption[]; /** * The database credentials required for Data Safe to connect to the database. */ credentials: outputs.DataSafe.GetTargetDatabasesTargetDatabaseCredential[]; /** * Details of the database for the registration in Data Safe. */ databaseDetails: outputs.DataSafe.GetTargetDatabasesTargetDatabaseDatabaseDetail[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the peer target database in Data Safe. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Data Safe target database. */ id: string; /** * Details about the current state of the peer target database in Data Safe. */ lifecycleDetails: string; peerTargetDatabaseDetails: outputs.DataSafe.GetTargetDatabasesTargetDatabasePeerTargetDatabaseDetail[]; /** * The OCIDs of associated resources like Database, Data Safe private endpoint etc. */ peerTargetDatabases: outputs.DataSafe.GetTargetDatabasesTargetDatabasePeerTargetDatabase[]; /** * A filter to return only target databases that match the specified lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the database was registered in Data Safe and created as a target database in Data Safe. */ timeCreated: string; /** * The date and time of the target database update in Data Safe. */ timeUpdated: string; /** * The details required to establish a TLS enabled connection. */ tlsConfigs: outputs.DataSafe.GetTargetDatabasesTargetDatabaseTlsConfig[]; } interface GetTargetDatabasesTargetDatabaseConnectionOption { /** * The connection type used to connect to the database. Allowed values: * * PRIVATE_ENDPOINT - Represents connection through private endpoint in Data Safe. * * ONPREM_CONNECTOR - Represents connection through on-premises connector in Data Safe. */ connectionType: string; /** * The OCID of the Data Safe private endpoint. */ datasafePrivateEndpointId: string; /** * The OCID of the on-premises connector. */ onPremConnectorId: string; } interface GetTargetDatabasesTargetDatabaseCredential { /** * The password of the database user. */ password: string; /** * The database user name. */ userName: string; } interface GetTargetDatabasesTargetDatabaseDatabaseDetail { /** * The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * A filter to return only target databases that match the specified database type. */ databaseType: string; /** * The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * A filter to return only target databases that match the specified infrastructure type. */ infrastructureType: string; /** * The OCID of the compute instance on which the database is running. */ instanceId: string; /** * The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * The port number of the database listener. */ listenerPort: number; /** * The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * The service name of the database registered as target database. */ serviceName: string; /** * The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface GetTargetDatabasesTargetDatabasePeerTargetDatabase { /** * Details of the database for the registration in Data Safe. */ databaseDetails: outputs.DataSafe.GetTargetDatabasesTargetDatabasePeerTargetDatabaseDatabaseDetail[]; /** * Unique name of the database associated to the peer target database. */ databaseUniqueName: string; /** * The OCID of the Data Guard Association resource in which the database associated to the peer target database is considered as peer database to the primary database. */ dataguardAssociationId: string; /** * The description of the peer target database in Data Safe. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * The secondary key assigned for the peer target database in Data Safe. */ key: number; /** * Details about the current state of the peer target database in Data Safe. */ lifecycleDetails: string; /** * Role of the database associated to the peer target database. */ role: string; /** * A filter to return only target databases that match the specified lifecycle state. */ state: string; /** * The date and time the database was registered in Data Safe and created as a target database in Data Safe. */ timeCreated: string; /** * The details required to establish a TLS enabled connection. */ tlsConfigs: outputs.DataSafe.GetTargetDatabasesTargetDatabasePeerTargetDatabaseTlsConfig[]; } interface GetTargetDatabasesTargetDatabasePeerTargetDatabaseDatabaseDetail { /** * The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * A filter to return only target databases that match the specified database type. */ databaseType: string; /** * The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * A filter to return only target databases that match the specified infrastructure type. */ infrastructureType: string; /** * The OCID of the compute instance on which the database is running. */ instanceId: string; /** * The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * The port number of the database listener. */ listenerPort: number; /** * The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * The service name of the database registered as target database. */ serviceName: string; /** * The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface GetTargetDatabasesTargetDatabasePeerTargetDatabaseDetail { /** * Details of the database for the registration in Data Safe. */ databaseDetails: outputs.DataSafe.GetTargetDatabasesTargetDatabasePeerTargetDatabaseDetailDatabaseDetail[]; /** * The OCID of the Data Guard Association resource in which the database associated to the peer target database is considered as peer database to the primary database. */ dataguardAssociationId: string; /** * The description of the peer target database in Data Safe. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * The details required to establish a TLS enabled connection. */ tlsConfigs: outputs.DataSafe.GetTargetDatabasesTargetDatabasePeerTargetDatabaseDetailTlsConfig[]; } interface GetTargetDatabasesTargetDatabasePeerTargetDatabaseDetailDatabaseDetail { /** * The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * A filter to return only target databases that match the specified database type. */ databaseType: string; /** * The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * A filter to return only target databases that match the specified infrastructure type. */ infrastructureType: string; /** * The OCID of the compute instance on which the database is running. */ instanceId: string; /** * The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * The port number of the database listener. */ listenerPort: number; /** * The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * The service name of the database registered as target database. */ serviceName: string; /** * The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface GetTargetDatabasesTargetDatabasePeerTargetDatabaseDetailTlsConfig { /** * The format of the certificate store. */ certificateStoreType: string; /** * Base64 encoded string of key store file content. */ keyStoreContent: string; /** * Status to represent whether the database connection is TLS enabled or not. */ status: string; /** * The password to read the trust store and key store files, if they are password protected. */ storePassword: string; /** * Base64 encoded string of trust store file content. */ trustStoreContent: string; } interface GetTargetDatabasesTargetDatabasePeerTargetDatabaseTlsConfig { /** * The format of the certificate store. */ certificateStoreType: string; /** * Base64 encoded string of key store file content. */ keyStoreContent: string; /** * Status to represent whether the database connection is TLS enabled or not. */ status: string; /** * The password to read the trust store and key store files, if they are password protected. */ storePassword: string; /** * Base64 encoded string of trust store file content. */ trustStoreContent: string; } interface GetTargetDatabasesTargetDatabaseTlsConfig { /** * The format of the certificate store. */ certificateStoreType: string; /** * Base64 encoded string of key store file content. */ keyStoreContent: string; /** * Status to represent whether the database connection is TLS enabled or not. */ status: string; /** * The password to read the trust store and key store files, if they are password protected. */ storePassword: string; /** * Base64 encoded string of trust store file content. */ trustStoreContent: string; } interface GetUnifiedAuditPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetUnifiedAuditPoliciesUnifiedAuditPolicyCollection { items: outputs.DataSafe.GetUnifiedAuditPoliciesUnifiedAuditPolicyCollectionItem[]; } interface GetUnifiedAuditPoliciesUnifiedAuditPolicyCollectionItem { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * Lists the audit policy provisioning conditions. */ conditions: outputs.DataSafe.GetUnifiedAuditPoliciesUnifiedAuditPolicyCollectionItemCondition[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the unified audit policy. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * Indicates on whom the audit policy is enabled. */ enabledEntities: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the unified audit policy. */ id: string; /** * A boolean flag indicating to list seeded unified audit policies. Set this parameter to get list of seeded unified audit policies. */ isSeeded: boolean; /** * The details of the current state of the unified audit policy in Data Safe. */ lifecycleDetails: string; /** * An optional filter to return only resources that match the specified OCID of the security policy resource. */ securityPolicyId: string; /** * The current state of the Unified Audit policy. */ state: string; /** * Indicates whether the policy has been enabled or disabled. */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the unified audit policy was created, in the format defined by RFC3339. */ timeCreated: string; /** * The last date and time the unified audit policy was updated, in the format defined by RFC3339. */ timeUpdated: string; /** * An optional filter to return only resources that match the specified OCID of the unified audit policy definition resource. */ unifiedAuditPolicyDefinitionId: string; } interface GetUnifiedAuditPoliciesUnifiedAuditPolicyCollectionItemCondition { /** * The OCID of the attribute set. */ attributeSetId: string; /** * Specifies whether to include or exclude the specified users or roles. */ entitySelection: string; /** * The type of users or roles that the unified audit policy is applied to. */ entityType: string; /** * The operation status that the policy must be enabled for. */ operationStatus: string; /** * List of roles that the policy must be enabled for. */ roleNames: string[]; /** * The list of users that the unified audit policy is enabled for. */ userNames: string[]; } interface GetUnifiedAuditPolicyCondition { /** * The OCID of the attribute set. */ attributeSetId: string; /** * Specifies whether to include or exclude the specified users or roles. */ entitySelection: string; /** * The type of users or roles that the unified audit policy is applied to. */ entityType: string; /** * The operation status that the policy must be enabled for. */ operationStatus: string; /** * List of roles that the policy must be enabled for. */ roleNames: string[]; /** * The list of users that the unified audit policy is enabled for. */ userNames: string[]; } interface GetUnifiedAuditPolicyDefinitionsFilter { name: string; regex?: boolean; values: string[]; } interface GetUnifiedAuditPolicyDefinitionsUnifiedAuditPolicyDefinitionCollection { items: outputs.DataSafe.GetUnifiedAuditPolicyDefinitionsUnifiedAuditPolicyDefinitionCollectionItem[]; } interface GetUnifiedAuditPolicyDefinitionsUnifiedAuditPolicyDefinitionCollectionItem { /** * The category to which the unified audit policy belongs in the target database. */ auditPolicyCategory: string; /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the unified audit policy definition. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the unified audit policy definition. */ id: string; /** * A boolean flag indicating to list seeded unified audit policy definitions. Set this parameter to get list of seeded unified audit policy definitions. */ isSeeded: boolean; /** * Details about the current state of the unified audit policy definition. */ lifecycleDetails: string; /** * The definition of the unified audit policy to be provisioned in the target database. */ policyDefinitionStatement: string; /** * The unified audit policy name in the target database. */ policyName: string; /** * The current state of the unified audit policy definition. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the unified audit policy was created, in the format defined by RFC3339. */ timeCreated: string; /** * The last date and time the unified audit policy was updated, in the format defined by RFC3339. */ timeUpdated: string; /** * An optional filter to return only resources that match the specified OCID of the unified audit policy definition resource. */ unifiedAuditPolicyDefinitionId: string; } interface GetUserAssessmentComparisonSummary { baselines: outputs.DataSafe.GetUserAssessmentComparisonSummaryBaseline[]; currents: outputs.DataSafe.GetUserAssessmentComparisonSummaryCurrent[]; status: string; } interface GetUserAssessmentComparisonSummaryBaseline { targetId: string; /** * The OCID of the user assessment. */ userAssessmentId: string; } interface GetUserAssessmentComparisonSummaryCurrent { targetId: string; /** * The OCID of the user assessment. */ userAssessmentId: string; } interface GetUserAssessmentIgnoredTarget { lifecycleState: string; targetId: string; /** * The OCID of the user assessment. */ userAssessmentId: string; } interface GetUserAssessmentPasswordExpiryDateAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetUserAssessmentPasswordExpiryDateAnalyticsUserAggregation { /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ items: outputs.DataSafe.GetUserAssessmentPasswordExpiryDateAnalyticsUserAggregationItem[]; } interface GetUserAssessmentPasswordExpiryDateAnalyticsUserAggregationItem { } interface GetUserAssessmentProfileAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetUserAssessmentProfileAnalyticsProfileAggregation { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The array of profile aggregation data. */ items: any[]; } interface GetUserAssessmentProfilesFilter { name: string; regex?: boolean; values: string[]; } interface GetUserAssessmentProfilesProfile { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * Specify the total resource cost for a session, expressed in service units. Oracle Database calculates the total service units as a weighted sum of CPU_PER_SESSION, CONNECT_TIME, LOGICAL_READS_PER_SESSION, and PRIVATE_SGA. */ compositeLimit: string; /** * Specify the total elapsed time limit for a session, expressed in minutes. */ connectTime: string; /** * Specify the CPU time limit for a call (a parse, execute, or fetch), expressed in hundredths of seconds. */ cpuPerCall: string; /** * Specify the CPU time limit for a session, expressed in hundredth of seconds. */ cpuPerSession: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Maximum times the user is allowed in fail login before the user account is locked. */ failedLoginAttempts: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Specify the permitted periods of continuous inactive time during a session, expressed in minutes. */ idleTime: string; /** * The permitted periods of continuous inactive time during a session, expressed in minutes. Long-running queries and other operations are not subjected to this limit. */ inactiveAccountTime: string; /** * An optional filter to return the user created profiles. */ isUserCreated: boolean; /** * Specify the permitted the number of data blocks read for a call to process a SQL statement (a parse, execute, or fetch). */ logicalReadsPerCall: string; /** * Specify the permitted number of data blocks read in a session, including blocks read from memory and disk. */ logicalReadsPerSession: string; /** * Number of grace days for user to change password. */ passwordGraceTime: string; /** * Number of days the password is valid before expiry. */ passwordLifeTime: string; /** * Number of days the user account remains locked after failed login. */ passwordLockTime: string; /** * Number of day after the user can use the already used password. */ passwordReuseMax: string; /** * Number of days before which a password cannot be reused. */ passwordReuseTime: string; /** * Number of days the password rollover is allowed. Minimum value can be 1/24 day (1 hour) to 60 days. */ passwordRolloverTime: string; /** * An optional filter to filter the profiles based on password verification function. */ passwordVerificationFunction: string; /** * Details about the PL/SQL that can be used for password verification. */ passwordVerificationFunctionDetails: string; /** * Specify the amount of private space a session can allocate in the shared pool of the system global area (SGA), expressed in bytes. */ privateSga: string; /** * A filter to return only items that match the specified profile name. */ profileName: string; /** * Specify the number of concurrent sessions to which you want to limit the user. */ sessionsPerUser: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The OCID of the user assessment. */ userAssessmentId: string; /** * The number of users that have a given profile. */ userCount: number; } interface GetUserAssessmentUserAccessAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetUserAssessmentUserAccessAnalyticsUserAccessAnalyticsCollection { /** * An array of user access analytics summary objects. */ items: outputs.DataSafe.GetUserAssessmentUserAccessAnalyticsUserAccessAnalyticsCollectionItem[]; } interface GetUserAssessmentUserAccessAnalyticsUserAccessAnalyticsCollectionItem { /** * The total count of schemas a user can access */ userAssessmentUserAccessAnalyticCount: string; /** * Name of the user. */ userName: string; } interface GetUserAssessmentUserAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetUserAssessmentUserAnalyticsUserAggregation { /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ items: outputs.DataSafe.GetUserAssessmentUserAnalyticsUserAggregationItem[]; } interface GetUserAssessmentUserAnalyticsUserAggregationItem { } interface GetUserAssessmentUsersFilter { name: string; regex?: boolean; values: string[]; } interface GetUserAssessmentUsersUser { /** * A filter to return only items that match the specified account status. */ accountStatus: string; /** * The admin roles granted to the user. */ adminRoles: string[]; /** * A filter to return only items that match the criteria that all schemas can be accessed by a user. */ areAllSchemasAccessible: boolean; /** * A filter to return only items that match the specified authentication type. */ authenticationType: string; /** * The unique user key. This is a system-generated identifier. Use ListUsers to get the user key for a user. */ key: string; /** * A filter to return items that contain the specified schema list. */ schemaLists: string[]; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * The date and time the user last logged in, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeLastLogin: string; /** * The date and time the user password was last changed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timePasswordChanged: string; /** * The date and time the user's password will expire, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timePasswordExpiry: string; /** * The date and time the user was created in the database, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUserCreated: string; /** * A filter to return only items that match the specified user category. */ userCategory: string; /** * A filter to return only items that match the specified user name. */ userName: string; /** * A filter to return only items that match the specified user profile. */ userProfile: string; /** * The user type, which can be a combination of the following: */ userTypes: string[]; } interface GetUserAssessmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetUserAssessmentsIgnoredTarget { lifecycleState: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; userAssessmentId: string; } interface GetUserAssessmentsUserAssessment { /** * A filter to return only resources that match the specified compartment OCID. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the user assessment. */ description: string; /** * A filter to return only resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the user assessment. */ id: string; /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ ignoredAssessmentIds: string[]; /** * List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }` */ ignoredTargets: outputs.DataSafe.GetUserAssessmentsUserAssessmentIgnoredTarget[]; /** * Indicates whether the assessment is scheduled to run. */ isAssessmentScheduled: boolean; /** * A filter to return only user assessments that are set as baseline. */ isBaseline: boolean; /** * Indicates if the user assessment deviates from the baseline. */ isDeviatedFromBaseline: boolean; /** * The OCID of the last user assessment baseline against which the latest assessment was compared. */ lastComparedBaselineId: string; /** * Details about the current state of the user assessment. */ lifecycleDetails: string; /** * Schedule of the assessment that runs periodically in this specified format: ; */ schedule: string; /** * The OCID of the user assessment that is responsible for creating this scheduled save assessment. */ scheduleAssessmentId: string; /** * The current state of the user assessment. */ state: string; /** * Map that contains maps of values. Example: `{"Operations": {"CostCenter": "42"}}` */ statistics: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A filter to return the target database group that matches the specified OCID. */ targetDatabaseGroupId: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; /** * Array of database target OCIDs. */ targetIds: string[]; /** * A filter to return only only target database resources or target database group resources. */ targetType: string; /** * The date and time the user assessment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the user assessment was last executed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeLastAssessed: string; /** * The date and time the user assessment was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * A filter to return user assessments that were created by either the system or by a user only. */ triggeredBy: string; /** * A filter to return only items that match the specified assessment type. */ type: string; } interface GetUserAssessmentsUserAssessmentIgnoredTarget { lifecycleState: string; /** * A filter to return only items related to a specific target OCID. */ targetId: string; userAssessmentId: string; } interface LibraryMasingFormatFormatEntry { /** * (Updatable) The name of the substitution column. */ columnName: string; /** * (Updatable) The description of the format entry. */ description: string; /** * (Updatable) The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date. */ endDate: string; /** * (Updatable) The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length. */ endLength: number; /** * (Updatable) The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type. */ endValue: number; /** * (Updatable) The constant number to be used for masking. */ fixedNumber: number; /** * (Updatable) The constant string to be used for masking. */ fixedString: string; /** * (Updatable) One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table. */ groupingColumns: string[]; /** * (Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero. */ length: number; /** * (Updatable) The OCID of the library masking format. */ libraryMaskingFormatId: string; /** * (Updatable) The pattern that should be used to mask data. */ pattern: string; /** * (Updatable) The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ postProcessingFunction: string; /** * (Updatable) A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999. */ randomLists: string[]; /** * (Updatable) The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found. * * In the case of ASCII characters, if a regular expression is not provided, Deterministic Encryption can encrypt variable-length column values while preserving their original format. * * If a regular expression is provided, the column values in all the rows must match the regular expression. Deterministic Encryption supports a subset of the regular expression language. It supports encryption of fixed-length strings, and does not support * or + syntax of regular expressions. The encrypted values also match the regular expression, which helps to ensure that the original format is preserved. If an original value does not match the regular expression, Deterministic Encryption might not produce a one-to-one mapping. All non-confirming values are mapped to a single encrypted value, thereby producing a many-to-one mapping. */ regularExpression: string; /** * (Updatable) The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value. */ replaceWith: string; /** * (Updatable) The name of the schema that contains the substitution column. */ schemaName: string; /** * (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols. */ sqlExpression: string; /** * (Updatable) The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date. */ startDate: string; /** * (Updatable) The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length. */ startLength: number; /** * (Updatable) The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string. */ startPosition: number; /** * (Updatable) The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type. */ startValue: number; /** * (Updatable) The name of the table that contains the substitution column. */ tableName: string; /** * (Updatable) The type of the format entry. */ type: string; /** * (Updatable) The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ userDefinedFunction: string; } interface MaskDataTargetCredentials { password: string; userName: string; } interface MaskingPoliciesMaskingColumnMaskingFormat { /** * (Updatable) A condition that must be true for applying the masking format. It can be any valid SQL construct that can be used in a SQL predicate. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions. */ condition: string; /** * (Updatable) The description of the masking format. */ description: string; /** * (Updatable) An array of format entries. The combined output of all the format entries is used for masking the column data values. */ formatEntries: outputs.DataSafe.MaskingPoliciesMaskingColumnMaskingFormatFormatEntry[]; } interface MaskingPoliciesMaskingColumnMaskingFormatFormatEntry { /** * (Updatable) The name of the substitution column. */ columnName: string; /** * (Updatable) The description of the format entry. */ description: string; /** * (Updatable) The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date. */ endDate: string; /** * (Updatable) The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length. */ endLength: number; /** * (Updatable) The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type. */ endValue: number; /** * (Updatable) The constant number to be used for masking. */ fixedNumber: number; /** * (Updatable) The constant string to be used for masking. */ fixedString: string; /** * (Updatable) One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table. */ groupingColumns: string[]; /** * (Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero. */ length: number; /** * (Updatable) The OCID of the library masking format. */ libraryMaskingFormatId: string; /** * (Updatable) The pattern that should be used to mask data. */ pattern: string; /** * (Updatable) The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ postProcessingFunction: string; /** * (Updatable) A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999. */ randomLists: string[]; /** * (Updatable) The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found. * * In the case of ASCII characters, if a regular expression is not provided, Deterministic Encryption can encrypt variable-length column values while preserving their original format. * * If a regular expression is provided, the column values in all the rows must match the regular expression. Deterministic Encryption supports a subset of the regular expression language. It supports encryption of fixed-length strings, and does not support * or + syntax of regular expressions. The encrypted values also match the regular expression, which helps to ensure that the original format is preserved. If an original value does not match the regular expression, Deterministic Encryption might not produce a one-to-one mapping. All non-confirming values are mapped to a single encrypted value, thereby producing a many-to-one mapping. */ regularExpression: string; /** * (Updatable) The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value. */ replaceWith: string; /** * (Updatable) The name of the schema that contains the substitution column. */ schemaName: string; /** * (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols. */ sqlExpression: string; /** * (Updatable) The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date. */ startDate: string; /** * (Updatable) The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length. */ startLength: number; /** * (Updatable) The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string. */ startPosition: number; /** * (Updatable) The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type. */ startValue: number; /** * (Updatable) The name of the table that contains the substitution column. */ tableName: string; /** * (Updatable) The type of the format entry. */ type: string; /** * (Updatable) The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional. */ userDefinedFunction: string; } interface MaskingPolicyColumnSource { /** * (Updatable) The source of masking columns. */ columnSource: string; /** * (Updatable) The OCID of the sensitive data model to be associated as the column source with the masking policy. */ sensitiveDataModelId: string; /** * (Updatable) The OCID of the target database to be associated as the column source with the masking policy. */ targetId: string; } interface ReportDefinitionColumnFilter { /** * (Updatable) An array of expressions based on the operator type. A filter may have one or more expressions. */ expressions: string[]; /** * (Updatable) Name of the column on which the filter must be applied. */ fieldName: string; /** * (Updatable) Indicates whether the filter is enabled. Values can either be 'true' or 'false'. */ isEnabled: boolean; /** * (Updatable) Indicates whether the filter is hidden. Values can either be 'true' or 'false'. */ isHidden: boolean; /** * (Updatable) Specifies the type of operator that must be applied for example in, eq etc. */ operator: string; } interface ReportDefinitionColumnInfo { /** * (Updatable) An array of operators that can be supported by column fieldName. */ applicableOperators: string[]; /** * (Updatable) Specifies the data type of the column. */ dataType: string; /** * (Updatable) Name of the column displayed on UI. */ displayName: string; /** * (Updatable) Specifies the display order of the column. */ displayOrder: number; /** * (Updatable) Specifies the corresponding field name in the data source. */ fieldName: string; /** * (Updatable) Indicates if the column is hidden. Values can either be 'true' or 'false'. */ isHidden: boolean; /** * (Updatable) Specifies if column is virtual and can only be used as column filter. */ isVirtual: boolean; } interface ReportDefinitionColumnSorting { /** * (Updatable) Name of the column that must be sorted. */ fieldName: string; /** * (Updatable) Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'. */ isAscending: boolean; /** * (Updatable) Indicates the order at which column must be sorted. */ sortingOrder: number; } interface ReportDefinitionSummary { /** * (Updatable) Name of the key or count of object. */ countOf: string; /** * (Updatable) Specifies the order in which the summary must be displayed. */ displayOrder: number; /** * (Updatable) A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary. */ groupByFieldName: string; /** * (Updatable) Indicates if the summary is hidden. Values can either be 'true' or 'false'. */ isHidden: boolean; /** * (Updatable) Name of the report summary. */ name: string; /** * (Updatable) Additional scim filters used to get the specific summary. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ scimFilter: string; } interface SecurityAssessmentCheck { /** * The category to which the check belongs to. */ category: string; /** * A unique identifier for the check. */ key: string; /** * Provides a recommended approach to take to remediate the check reported. */ oneline: string; /** * Provides information on whether the check is related to a CIS Oracle Database Benchmark recommendation, STIG rule, GDPR Article/Recital or related to the Oracle Best Practice. */ references: outputs.DataSafe.SecurityAssessmentCheckReference[]; /** * The explanation of the issue in this check. It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation. */ remarks: string; /** * The severity of the check as suggested by Data Safe security assessment. This will be the default severity in the template baseline security assessment. */ suggestedSeverity: string; /** * The short title for the check. */ title: string; } interface SecurityAssessmentCheckPatchOperation { /** * (Updatable) The operation can be one of these values: `INSERT`, `MERGE`, `REMOVE` */ operation: string; /** * (Updatable) */ selection: string; /** * (Updatable) */ value: { [key: string]: string; }; } interface SecurityAssessmentCheckReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface SecurityAssessmentFindingPatchOperation { /** * (Updatable) The operation can be one of these values: `INSERT`, `MERGE`, `REMOVE` */ operation: string; /** * (Updatable) */ selection: string; /** * (Updatable) */ value: { [key: string]: string; }; } interface SecurityAssessmentFindingReference { /** * Relevant section from CIS. */ cis: string; /** * Relevant section from GDPR. */ gdpr: string; /** * Relevant section from OBP. */ obp: string; /** * Relevant section from STIG. */ stig: string; } interface SecurityAssessmentStatistic { /** * Statistics showing the number of findings with a particular risk level for each category. */ advisories: outputs.DataSafe.SecurityAssessmentStatisticAdvisory[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ deferreds: outputs.DataSafe.SecurityAssessmentStatisticDeferred[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ evaluates: outputs.DataSafe.SecurityAssessmentStatisticEvaluate[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ highRisks: outputs.DataSafe.SecurityAssessmentStatisticHighRisk[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ lowRisks: outputs.DataSafe.SecurityAssessmentStatisticLowRisk[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ mediumRisks: outputs.DataSafe.SecurityAssessmentStatisticMediumRisk[]; /** * Statistics showing the number of findings with a particular risk level for each category. */ passes: outputs.DataSafe.SecurityAssessmentStatisticPass[]; /** * The total number of targets in this security assessment. */ targetsCount: number; } interface SecurityAssessmentStatisticAdvisory { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface SecurityAssessmentStatisticDeferred { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface SecurityAssessmentStatisticEvaluate { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface SecurityAssessmentStatisticHighRisk { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface SecurityAssessmentStatisticLowRisk { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface SecurityAssessmentStatisticMediumRisk { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface SecurityAssessmentStatisticPass { /** * The number of findings in the Auditing category. */ auditingFindingsCount: number; /** * The number of findings in the Authorization Control category. */ authorizationControlFindingsCount: number; /** * The number of findings in the Data Encryption category. */ dataEncryptionFindingsCount: number; /** * The number of findings in the Database Configuration category. */ dbConfigurationFindingsCount: number; /** * The number of findings in the Fine-Grained Access Control category. */ fineGrainedAccessControlFindingsCount: number; /** * The number of findings in the Privileges and Roles category. */ privilegesAndRolesFindingsCount: number; /** * The total number of targets in this security assessment. */ targetsCount: number; /** * The number of findings in the User Accounts category. */ userAccountsFindingsCount: number; } interface SecurityPolicyConfigFirewallConfig { /** * (Updatable) Specifies whether the firewall should include or exclude the database internal job activities. */ excludeJob: string; /** * (Updatable) Specifies whether the firewall is enabled or disabled. */ status: string; /** * The date and time the firewall configuration was last updated, in the format defined by RFC3339. */ timeStatusUpdated: string; /** * (Updatable) Specifies whether Data Safe should automatically purge the violation logs from the database after collecting the violation logs and persisting them in Data Safe. */ violationLogAutoPurge: string; } interface SecurityPolicyConfigUnifiedAuditPolicyConfig { /** * (Updatable) Specifies whether the Data Safe service account on the target database should be excluded in the unified audit policy. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ excludeDatasafeUser: string; } interface SensitiveDataModelReferentialRelationChild { /** * The application name. */ appName: string; /** * Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. */ columnGroups: string[]; /** * The database object that contains the columns. */ object: string; /** * The type of the database object that contains the sensitive column. */ objectType: string; /** * The schema name. */ schemaName: string; /** * Sensitive type ocids of each column groups. Order needs to be maintained with the parent column group. For the DB defined referential relations identified during SDM creation, we cannot add sensitive types. Instead use the sensitiveColumn POST API to mark the columns sensitive. */ sensitiveTypeIds: string[]; } interface SensitiveDataModelReferentialRelationParent { /** * The application name. */ appName: string; /** * Group of columns in referential relation. Order needs to be maintained in the elements of the parent/child array listing. */ columnGroups: string[]; /** * The database object that contains the columns. */ object: string; /** * The type of the database object that contains the sensitive column. */ objectType: string; /** * The schema name. */ schemaName: string; /** * Sensitive type ocids of each column groups. Order needs to be maintained with the parent column group. For the DB defined referential relations identified during SDM creation, we cannot add sensitive types. Instead use the sensitiveColumn POST API to mark the columns sensitive. */ sensitiveTypeIds: string[]; } interface SensitiveDataModelTablesForDiscovery { /** * (Updatable) This contains the name of the schema. */ schemaName: string; /** * (Updatable) This contains an optional list of the table names. */ tableNames: string[]; } interface SensitiveDataModelsSensitiveColumnConfidenceLevelDetail { doesColumnLeadToPiiInNonTables: boolean; doesColumnLeadToPiiInSameRelatedTables: boolean; hasCommentPatternMatched: boolean; hasDataPatternMatched: boolean; hasNamePatternMatched: boolean; isSensitiveTypeFromSameContextFoundInSameOrRelatedTables: boolean; } interface SensitiveTypeGroupGroupedSensitiveTypeItem { /** * The OCID of the sensitive type. */ sensitiveTypeId: string; } interface SensitiveTypeGroupGroupedSensitiveTypePatchOperation { /** * (Updatable) The operation can be one of these values: `INSERT`, `MERGE`, `REMOVE` */ operation: string; /** * (Updatable) */ selection: string; /** * (Updatable) */ value: { [key: string]: string; }; } interface TargetDatabaseConnectionOption { /** * (Updatable) The connection type used to connect to the database. Allowed values: * * PRIVATE_ENDPOINT - Represents connection through private endpoint in Data Safe. * * ONPREM_CONNECTOR - Represents connection through on-premises connector in Data Safe. */ connectionType: string; /** * (Updatable) The OCID of the Data Safe private endpoint. */ datasafePrivateEndpointId: string; /** * (Updatable) The OCID of the on-premises connector. */ onPremConnectorId: string; } interface TargetDatabaseCredentials { /** * (Updatable) The password of the database user. */ password: string; /** * (Updatable) The database user name. */ userName: string; } interface TargetDatabaseDatabaseDetails { /** * (Updatable) The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * (Updatable) The database type. */ databaseType: string; /** * (Updatable) The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * (Updatable) The infrastructure type the database is running on. */ infrastructureType: string; /** * (Updatable) The OCID of the compute instance on which the database is running. */ instanceId: string; /** * (Updatable) The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * (Updatable) The port number of the database listener. */ listenerPort: number; /** * (Updatable) The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * (Updatable) The service name of the database registered as target database. */ serviceName: string; /** * (Updatable) The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface TargetDatabaseGroupMatchingCriteria { /** * (Updatable) Criteria to exclude certain target databases from the target database group. */ exclude: outputs.DataSafe.TargetDatabaseGroupMatchingCriteriaExclude; /** * (Updatable) Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseIds, freeformTags, or definedTags criteria, it qualifies for inclusion in the target database group */ include: outputs.DataSafe.TargetDatabaseGroupMatchingCriteriaInclude; } interface TargetDatabaseGroupMatchingCriteriaExclude { /** * (Updatable) The list of target database OCIDS, that should be excluded from the target database group (even if they match some of the other criteria). */ targetDatabaseIds: string[]; } interface TargetDatabaseGroupMatchingCriteriaInclude { /** * (Updatable) List of compartment objects, each containing the OCID of the compartment and a boolean value that indicates whether the target databases in the compartments and sub-compartments should also be included in the target database group. */ compartments: outputs.DataSafe.TargetDatabaseGroupMatchingCriteriaIncludeCompartment[]; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * (Updatable) The list of target database OCIDs to be included in the target database group. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ targetDatabaseIds: string[]; } interface TargetDatabaseGroupMatchingCriteriaIncludeCompartment { /** * (Updatable) The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group. */ id: string; /** * (Updatable) This indicates whether the target databases of sub-compartments should also be included in the target database group. By default, this parameter is set to false. */ isIncludeSubtree: boolean; } interface TargetDatabasePeerTargetDatabase { /** * (Updatable) Details of the database for the registration in Data Safe. */ databaseDetails: outputs.DataSafe.TargetDatabasePeerTargetDatabaseDatabaseDetail[]; /** * Unique name of the database associated to the peer target database. */ databaseUniqueName: string; /** * The OCID of the Data Guard Association resource in which the database associated to the peer target database is considered as peer database to the primary database. */ dataguardAssociationId: string; /** * (Updatable) The description of the target database in Data Safe. */ description: string; /** * (Updatable) The display name of the target database in Data Safe. The name is modifiable and does not need to be unique. */ displayName: string; /** * The secondary key assigned for the peer target database in Data Safe. */ key: number; /** * Details about the current state of the peer target database in Data Safe. */ lifecycleDetails: string; /** * Role of the database associated to the peer target database. */ role: string; /** * The current state of the target database in Data Safe. */ state: string; /** * The date and time the database was registered in Data Safe and created as a target database in Data Safe. */ timeCreated: string; /** * (Updatable) The details required to establish a TLS enabled connection. */ tlsConfigs: outputs.DataSafe.TargetDatabasePeerTargetDatabaseTlsConfig[]; } interface TargetDatabasePeerTargetDatabaseDatabaseDetail { /** * (Updatable) The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * (Updatable) The database type. */ databaseType: string; /** * (Updatable) The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * (Updatable) The infrastructure type the database is running on. */ infrastructureType: string; /** * (Updatable) The OCID of the compute instance on which the database is running. */ instanceId: string; /** * (Updatable) The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * (Updatable) The port number of the database listener. */ listenerPort: number; /** * (Updatable) The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * (Updatable) The service name of the database registered as target database. */ serviceName: string; /** * (Updatable) The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface TargetDatabasePeerTargetDatabaseDatabaseDetails { /** * (Updatable) The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * (Updatable) The database type. */ databaseType: string; /** * (Updatable) The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * (Updatable) The infrastructure type the database is running on. */ infrastructureType: string; /** * (Updatable) The OCID of the compute instance on which the database is running. */ instanceId: string; /** * (Updatable) The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * (Updatable) The port number of the database listener. */ listenerPort: number; /** * (Updatable) The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * (Updatable) The service name of the database registered as target database. */ serviceName: string; /** * (Updatable) The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface TargetDatabasePeerTargetDatabaseDetail { /** * Details of the database for the registration in Data Safe. */ databaseDetails: outputs.DataSafe.TargetDatabasePeerTargetDatabaseDetailDatabaseDetails; /** * The OCID of the Data Guard Association resource in which the database being registered is considered as peer database to the primary database. */ dataguardAssociationId: string; /** * The description of the peer target database in Data Safe. */ description: string; /** * The display name of the peer target database in Data Safe. The name is modifiable and does not need to be unique. */ displayName: string; /** * The details required to establish a TLS enabled connection. */ tlsConfig: outputs.DataSafe.TargetDatabasePeerTargetDatabaseDetailTlsConfig; } interface TargetDatabasePeerTargetDatabaseDetailDatabaseDetails { /** * The OCID of the Autonomous Database registered as a target database in Data Safe. */ autonomousDatabaseId: string; /** * The database type. */ databaseType: string; /** * The OCID of the cloud database registered as a target database in Data Safe. */ dbSystemId: string; /** * The infrastructure type the database is running on. */ infrastructureType: string; /** * The OCID of the compute instance on which the database is running. */ instanceId: string; /** * The list of database host IP Addresses. Fully qualified domain names can be used if connectionType is 'ONPREM_CONNECTOR'. */ ipAddresses: string[]; /** * The port number of the database listener. */ listenerPort: number; /** * The OCID of the pluggable database registered as a target database in Data Safe. */ pluggableDatabaseId: string; /** * The service name of the database registered as target database. */ serviceName: string; /** * The OCID of the VM cluster in which the database is running. */ vmClusterId: string; } interface TargetDatabasePeerTargetDatabaseDetailTlsConfig { /** * The format of the certificate store. */ certificateStoreType: string; /** * Base64 encoded string of key store file content. */ keyStoreContent: string; /** * Status to represent whether the database connection is TLS enabled or not. */ status: string; /** * The password to read the trust store and key store files, if they are password protected. */ storePassword: string; /** * Base64 encoded string of trust store file content. */ trustStoreContent: string; } interface TargetDatabasePeerTargetDatabaseTlsConfig { /** * (Updatable) The format of the certificate store. */ certificateStoreType: string; /** * (Updatable) Base64 encoded string of key store file content. */ keyStoreContent: string; /** * (Updatable) Status to represent whether the database connection is TLS enabled or not. */ status: string; /** * (Updatable) The password to read the trust store and key store files, if they are password protected. */ storePassword: string; /** * (Updatable) Base64 encoded string of trust store file content. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ trustStoreContent: string; } interface TargetDatabaseTlsConfig { /** * (Updatable) The format of the certificate store. */ certificateStoreType: string; /** * (Updatable) Base64 encoded string of key store file content. */ keyStoreContent: string; /** * (Updatable) Status to represent whether the database connection is TLS enabled or not. */ status: string; /** * (Updatable) The password to read the trust store and key store files, if they are password protected. */ storePassword: string; /** * (Updatable) Base64 encoded string of trust store file content. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ trustStoreContent: string; } interface UnifiedAuditPolicyCondition { /** * (Updatable) The OCID of the attribute set. */ attributeSetId: string; /** * (Updatable) Specifies whether to include or exclude the specified users or roles. */ entitySelection: string; /** * (Updatable) The type of users or roles that the unified audit policy is applied to. */ entityType: string; /** * (Updatable) The operation status that the policy must be enabled for. */ operationStatus: string; /** * (Updatable) List of roles that the policy must be enabled for. */ roleNames: string[]; /** * (Updatable) The list of users that the unified audit policy is enabled for. */ userNames: string[]; } interface UserAssessmentIgnoredTarget { lifecycleState: string; /** * The OCID of the target database or target database group on which user assessment is to be run. */ targetId: string; userAssessmentId: string; } } export declare namespace DataScience { interface ComputeTargetComputeConfigurationDetails { /** * (Updatable) The type of compute. */ computeType: string; /** * (Updatable) The compute target instance configuration details for managed compute cluster type compute target. */ instanceConfiguration: outputs.DataScience.ComputeTargetComputeConfigurationDetailsInstanceConfiguration; /** * (Updatable) The scaling policy to apply to managed compute cluster type compute target. */ scalingPolicy: outputs.DataScience.ComputeTargetComputeConfigurationDetailsScalingPolicy; } interface ComputeTargetComputeConfigurationDetailsInstanceConfiguration { /** * (Updatable) The size of the boot volume to attach to the instance. */ bootVolumeSizeInGbs: number; /** * (Updatable) The shape used to launch the instances in compute target. Supported shapes can be retrieved using compute target shapes api. */ instanceShape: string; /** * (Updatable) Instance shape configuration for managed compute cluster type compute target. Specify only when a flex shape is selected. */ instanceShapeDetails: outputs.DataScience.ComputeTargetComputeConfigurationDetailsInstanceConfigurationInstanceShapeDetails; } interface ComputeTargetComputeConfigurationDetailsInstanceConfigurationInstanceShapeDetails { /** * (Updatable) The total amount of memory allocated to the instance, in gigabytes. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs allocated to the instance. */ ocpus: number; } interface ComputeTargetComputeConfigurationDetailsScalingPolicy { /** * (Updatable) The list of autoscaling policy details. */ autoScalingPolicies: outputs.DataScience.ComputeTargetComputeConfigurationDetailsScalingPolicyAutoScalingPolicy[]; /** * (Updatable) 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 managed compute cluster type compute target becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * (Updatable) The number of instances for the managed compute cluster type compute target. */ instanceCount: number; /** * (Updatable) Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * (Updatable) The type of scaling policy. */ policyType: string; } interface ComputeTargetComputeConfigurationDetailsScalingPolicyAutoScalingPolicy { /** * (Updatable) The type of autoscaling policy. */ autoScalingPolicyType: string; /** * (Updatable) For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the managed compute cluster type compute target immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. 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. */ initialInstanceCount: number; /** * (Updatable) For a threshold-based autoscaling policy, this value is the maximum number of instances the managed compute cluster type compute target is allowed to increase to (scale out). */ maximumInstanceCount: number; /** * (Updatable) For a threshold-based autoscaling policy, this value is the minimum number of instances the managed compute cluster type compute target is allowed to decrease to (scale in). */ minimumInstanceCount: number; /** * (Updatable) The list of autoscaling policy rules. */ rules: outputs.DataScience.ComputeTargetComputeConfigurationDetailsScalingPolicyAutoScalingPolicyRule[]; } interface ComputeTargetComputeConfigurationDetailsScalingPolicyAutoScalingPolicyRule { /** * (Updatable) The metric expression for creating the alarm used to trigger autoscaling actions on the managed compute cluster type compute target . */ metricExpressionRuleType: string; /** * (Updatable) Metric type */ metricType: string; /** * (Updatable) The scaling configuration for the predefined metric expression rule. */ scaleInConfiguration: outputs.DataScience.ComputeTargetComputeConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleInConfiguration; /** * (Updatable) The scaling configuration for the predefined metric expression rule. */ scaleOutConfiguration: outputs.DataScience.ComputeTargetComputeConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration; } interface ComputeTargetComputeConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleInConfiguration { /** * (Updatable) The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * (Updatable) 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." The 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. */ pendingDuration: string; /** * (Updatable) 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: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). Example of threshold alarm: ```CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() < 25 CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() > 75``` */ query: string; /** * (Updatable) The type of scaling configuration. */ scalingConfigurationType: string; /** * (Updatable) A metric value at which the scaling operation will be triggered. */ threshold: number; } interface ComputeTargetComputeConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration { /** * (Updatable) The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * (Updatable) 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." The 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. */ pendingDuration: string; /** * (Updatable) 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: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). Example of threshold alarm: ```CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() < 25 CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() > 75``` */ query: string; /** * (Updatable) The type of scaling configuration. */ scalingConfigurationType: string; /** * (Updatable) A metric value at which the scaling operation will be triggered. */ threshold: number; } interface ComputeTargetComputeTargetSystemData { /** * Type of compute target. */ computeType: string; /** * Current count of the instances in managed compute cluster type compute target. */ currentInstanceCount: number; } interface GetComputeTargetComputeConfigurationDetail { /** * Type of compute target. */ computeType: string; /** * The compute target instance configuration details for managed compute cluster type compute target. */ instanceConfigurations: outputs.DataScience.GetComputeTargetComputeConfigurationDetailInstanceConfiguration[]; /** * The scaling policy to apply to managed compute cluster type compute target. */ scalingPolicies: outputs.DataScience.GetComputeTargetComputeConfigurationDetailScalingPolicy[]; } interface GetComputeTargetComputeConfigurationDetailInstanceConfiguration { /** * The size of the boot volume to attach to the instance. */ bootVolumeSizeInGbs: number; /** * The shape used to launch the instances in compute target. Supported shapes can be retrieved using compute target shapes api. */ instanceShape: string; /** * Instance shape configuration for managed compute cluster type compute target. Specify only when a flex shape is selected. */ instanceShapeDetails: outputs.DataScience.GetComputeTargetComputeConfigurationDetailInstanceConfigurationInstanceShapeDetail[]; } interface GetComputeTargetComputeConfigurationDetailInstanceConfigurationInstanceShapeDetail { /** * The total amount of memory allocated to the instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs allocated to the instance. */ ocpus: number; } interface GetComputeTargetComputeConfigurationDetailScalingPolicy { /** * The list of autoscaling policy details. */ autoScalingPolicies: outputs.DataScience.GetComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicy[]; /** * 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 600 seconds, which is also the default. The cooldown period starts when the managed compute cluster type compute target becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The number of instances for the managed compute cluster type compute target. */ instanceCount: number; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The type of scaling policy. */ policyType: string; } interface GetComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicy { /** * The type of autoscaling policy. */ autoScalingPolicyType: string; /** * For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the managed compute cluster type compute target immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. 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. */ initialInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the maximum number of instances the managed compute cluster type compute target is allowed to increase to (scale out). */ maximumInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the minimum number of instances the managed compute cluster type compute target is allowed to decrease to (scale in). */ minimumInstanceCount: number; /** * The list of autoscaling policy rules. */ rules: outputs.DataScience.GetComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRule[]; } interface GetComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRule { /** * The metric expression for creating the alarm used to trigger autoscaling actions on the managed compute cluster type compute target . */ metricExpressionRuleType: string; /** * Metric type */ metricType: string; /** * The scaling configuration for the predefined metric expression rule. */ scaleInConfigurations: outputs.DataScience.GetComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration[]; /** * The scaling configuration for the predefined metric expression rule. */ scaleOutConfigurations: outputs.DataScience.GetComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration[]; } interface GetComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." The 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. */ pendingDuration: string; /** * 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: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). Example of threshold alarm: ```CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() < 25 CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() > 75``` */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." The 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. */ pendingDuration: string; /** * 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: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). Example of threshold alarm: ```CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() < 25 CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() > 75``` */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetComputeTargetComputeTargetSystemData { /** * Type of compute target. */ computeType: string; /** * Current count of the instances in managed compute cluster type compute target. */ currentInstanceCount: number; } interface GetComputeTargetShapesComputeTargetShape { /** * The number of cores associated with this compute target shape. */ coreCount: number; /** * The amount of memory in GBs associated with this compute target shape. */ memoryInGbs: number; /** * The name of the compute target shape. */ name: string; /** * The family that the compute shape belongs to. */ shapeSeries: string; } interface GetComputeTargetShapesFilter { /** * The name of the compute target shape. */ name: string; regex?: boolean; values: string[]; } interface GetComputeTargetsComputeTarget { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Configuration details of the targeted compute. */ computeConfigurationDetails: outputs.DataScience.GetComputeTargetsComputeTargetComputeConfigurationDetail[]; /** * System data of the compute target. */ computeTargetSystemDatas: outputs.DataScience.GetComputeTargetsComputeTargetComputeTargetSystemData[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the compute target. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A short description of the compute target. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * Details about the state of the compute target. */ lifecycleDetails: string; /** * Metadata for the compute target. The size of metadata must be less than 2048 bytes. Key should be under 32 characters. Key should contain only letters, digits and underscore (_) Key should start with a letter. Key should have at least 2 characters. Key should not end with underscore eg. `TEST_` Key if added cannot be empty. Value can be empty. No specific size limits on individual Values. But overall metadata is limited to 2048 bytes. Key can't be reserved Compute Target metadata. */ metadata: { [key: string]: string; }; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z */ timeCreated: string; } interface GetComputeTargetsComputeTargetComputeConfigurationDetail { /** * Type of compute target. */ computeType: string; /** * The compute target instance configuration details for managed compute cluster type compute target. */ instanceConfigurations: outputs.DataScience.GetComputeTargetsComputeTargetComputeConfigurationDetailInstanceConfiguration[]; /** * The scaling policy to apply to managed compute cluster type compute target. */ scalingPolicies: outputs.DataScience.GetComputeTargetsComputeTargetComputeConfigurationDetailScalingPolicy[]; } interface GetComputeTargetsComputeTargetComputeConfigurationDetailInstanceConfiguration { /** * The size of the boot volume to attach to the instance. */ bootVolumeSizeInGbs: number; /** * The shape used to launch the instances in compute target. Supported shapes can be retrieved using compute target shapes api. */ instanceShape: string; /** * Instance shape configuration for managed compute cluster type compute target. Specify only when a flex shape is selected. */ instanceShapeDetails: outputs.DataScience.GetComputeTargetsComputeTargetComputeConfigurationDetailInstanceConfigurationInstanceShapeDetail[]; } interface GetComputeTargetsComputeTargetComputeConfigurationDetailInstanceConfigurationInstanceShapeDetail { /** * The total amount of memory allocated to the instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs allocated to the instance. */ ocpus: number; } interface GetComputeTargetsComputeTargetComputeConfigurationDetailScalingPolicy { /** * The list of autoscaling policy details. */ autoScalingPolicies: outputs.DataScience.GetComputeTargetsComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicy[]; /** * 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 600 seconds, which is also the default. The cooldown period starts when the managed compute cluster type compute target becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The number of instances for the managed compute cluster type compute target. */ instanceCount: number; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The type of scaling policy. */ policyType: string; } interface GetComputeTargetsComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicy { /** * The type of autoscaling policy. */ autoScalingPolicyType: string; /** * For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the managed compute cluster type compute target immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. 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. */ initialInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the maximum number of instances the managed compute cluster type compute target is allowed to increase to (scale out). */ maximumInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the minimum number of instances the managed compute cluster type compute target is allowed to decrease to (scale in). */ minimumInstanceCount: number; /** * The list of autoscaling policy rules. */ rules: outputs.DataScience.GetComputeTargetsComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRule[]; } interface GetComputeTargetsComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRule { /** * The metric expression for creating the alarm used to trigger autoscaling actions on the managed compute cluster type compute target . */ metricExpressionRuleType: string; /** * Metric type */ metricType: string; /** * The scaling configuration for the predefined metric expression rule. */ scaleInConfigurations: outputs.DataScience.GetComputeTargetsComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration[]; /** * The scaling configuration for the predefined metric expression rule. */ scaleOutConfigurations: outputs.DataScience.GetComputeTargetsComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration[]; } interface GetComputeTargetsComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." The 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. */ pendingDuration: string; /** * 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: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). Example of threshold alarm: ```CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() < 25 CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() > 75``` */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetComputeTargetsComputeTargetComputeConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." The 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. */ pendingDuration: string; /** * 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: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. Supported grouping functions: grouping(), groupBy(). Example of threshold alarm: ```CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() < 25 CPUUtilization[1m]{resourceId = "Compute_Target_OCID"}.grouping().mean() > 75``` */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetComputeTargetsComputeTargetComputeTargetSystemData { /** * Type of compute target. */ computeType: string; /** * Current count of the instances in managed compute cluster type compute target. */ currentInstanceCount: number; } interface GetComputeTargetsFilter { name: string; regex?: boolean; values: string[]; } interface GetContainersContainer { /** * Filter results by the container name. */ containerName: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Description of the container. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; /** * The family name of the container. */ familyName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * if true, this returns latest version of container. */ isLatest: boolean; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * Container Tag. */ tag: string; /** * An array of defined metadata details for the model. */ tagConfigurationLists: outputs.DataScience.GetContainersContainerTagConfigurationList[]; /** * The list of target workload. This Container can be used with given data science resources. */ targetWorkloads: string[]; /** * The list of usages of this container. This Container can be used for given use-cases. */ usages: string[]; /** * workload configuration of the container. */ workloadConfigurationDetailsLists: outputs.DataScience.GetContainersContainerWorkloadConfigurationDetailsList[]; } interface GetContainersContainerTagConfigurationList { /** * Key of the container tag Metadata */ key: string; /** * Value of the container tag Metadata */ value: string; } interface GetContainersContainerWorkloadConfigurationDetailsList { /** * The additional configurations */ additionalConfigurations: { [key: string]: string; }; /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmd: string; /** * The port on which the container [HEALTHCHECK](https://docs.docker.com/engine/reference/builder/#healthcheck) would listen. The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. */ healthCheckPort: number; /** * The port on which the web server serving the inference is running. The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. */ serverPort: number; /** * The use-case configuration details */ useCaseConfigurations: outputs.DataScience.GetContainersContainerWorkloadConfigurationDetailsListUseCaseConfiguration[]; /** * The workload use case. */ workloadType: string; } interface GetContainersContainerWorkloadConfigurationDetailsListUseCaseConfiguration { /** * The additional configurations */ additionalConfigurations: { [key: string]: string; }; /** * The job-run use-case. */ useCaseType: string; } interface GetContainersFilter { name: string; regex?: boolean; values: string[]; } interface GetFastLaunchJobConfigsFastLaunchJobConfig { /** * The number of cores associated with this fast launch job shape. */ coreCount: number; /** * The managed egress support */ managedEgressSupport: string; /** * The number of cores associated with this fast launch job shape. */ memoryInGbs: number; /** * The name of the fast launch job config */ name: string; /** * The name of the fast launch job shape. */ shapeName: string; /** * The family that the compute shape belongs to. */ shapeSeries: string; } interface GetFastLaunchJobConfigsFilter { /** * The name of the fast launch job config */ name: string; regex?: boolean; values: string[]; } interface GetJobJobConfigurationDetail { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.GetJobJobConfigurationDetailStartupProbeDetail[]; } interface GetJobJobConfigurationDetailStartupProbeDetail { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface GetJobJobEnvironmentConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface GetJobJobInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.GetJobJobInfrastructureConfigurationDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.GetJobJobInfrastructureConfigurationDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobJobInfrastructureConfigurationDetailJobShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobJobInfrastructureConfigurationDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.GetJobJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.GetJobJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration[]; } interface GetJobJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobJobLogConfigurationDetail { /** * If automatic on-behalf-of log object creation is enabled for job runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for job runs. */ enableLogging: boolean; /** * The log group id for where log objects are for job runs. */ logGroupId: string; /** * The log id the job run will push logs too. */ logId: string; } interface GetJobJobNodeConfigurationDetail { /** * The job network configuration details */ jobNetworkConfigurations: outputs.DataScience.GetJobJobNodeConfigurationDetailJobNetworkConfiguration[]; /** * List of JobNodeGroupConfigurationDetails */ jobNodeGroupConfigurationDetailsLists: outputs.DataScience.GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsList[]; /** * The node type used for job run. */ jobNodeType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The execution order of node groups */ startupOrder: string; } interface GetJobJobNodeConfigurationDetailJobNetworkConfiguration { /** * job network type */ jobNetworkType: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsList { /** * The job configuration details */ jobConfigurationDetails: outputs.DataScience.GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetail[]; /** * Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationDetails: outputs.DataScience.GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetail[]; /** * The job infrastructure configuration details (shape, block storage, etc.) */ jobInfrastructureConfigurationDetails: outputs.DataScience.GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetail[]; /** * The minimum threshold of successful replicas for node group to be successful. All replicas need to succeed if this is not specified. */ minimumSuccessReplicas: number; /** * node group name. */ name: string; /** * The number of nodes. */ replicas: number; } interface GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetail { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetailStartupProbeDetail[]; } interface GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetailStartupProbeDetail { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailJobShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration[]; } interface GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobJobStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetJobRunJobConfigurationOverrideDetail { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.GetJobRunJobConfigurationOverrideDetailStartupProbeDetail[]; } interface GetJobRunJobConfigurationOverrideDetailStartupProbeDetail { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface GetJobRunJobEnvironmentConfigurationOverrideDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface GetJobRunJobInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.GetJobRunJobInfrastructureConfigurationDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.GetJobRunJobInfrastructureConfigurationDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobRunJobInfrastructureConfigurationDetailJobShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunJobInfrastructureConfigurationDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.GetJobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.GetJobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration[]; } interface GetJobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunJobInfrastructureConfigurationOverrideDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.GetJobRunJobInfrastructureConfigurationOverrideDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.GetJobRunJobInfrastructureConfigurationOverrideDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobRunJobInfrastructureConfigurationOverrideDetailJobShapeConfigDetail { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunJobInfrastructureConfigurationOverrideDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.GetJobRunJobInfrastructureConfigurationOverrideDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.GetJobRunJobInfrastructureConfigurationOverrideDetailResourceConfigurationResourceRequestConfiguration[]; } interface GetJobRunJobInfrastructureConfigurationOverrideDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunJobInfrastructureConfigurationOverrideDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunJobLogConfigurationOverrideDetail { /** * If automatic on-behalf-of log object creation is enabled for job runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for job runs. */ enableLogging: boolean; /** * The log group id for where log objects will be for job runs. */ logGroupId: string; /** * The log id of the log object the job run logs will be shipped to. */ logId: string; } interface GetJobRunJobNodeConfigurationOverrideDetail { /** * The job network configuration details */ jobNetworkConfigurations: outputs.DataScience.GetJobRunJobNodeConfigurationOverrideDetailJobNetworkConfiguration[]; /** * List of JobNodeGroupConfigurationDetails */ jobNodeGroupConfigurationDetailsLists: outputs.DataScience.GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsList[]; /** * The node type used for job run. */ jobNodeType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The execution order of node groups */ startupOrder: string; } interface GetJobRunJobNodeConfigurationOverrideDetailJobNetworkConfiguration { /** * job network type */ jobNetworkType: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsList { /** * The job configuration details */ jobConfigurationDetails: outputs.DataScience.GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetail[]; /** * Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationDetails: outputs.DataScience.GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetail[]; /** * The job infrastructure configuration details (shape, block storage, etc.) */ jobInfrastructureConfigurationDetails: outputs.DataScience.GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetail[]; /** * The minimum threshold of successful replicas for node group to be successful. All replicas need to succeed if this is not specified. */ minimumSuccessReplicas: number; /** * node group name. */ name: string; /** * The number of nodes. */ replicas: number; } interface GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetail { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetailStartupProbeDetail[]; } interface GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetailStartupProbeDetail { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailJobShapeConfigDetail { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration[]; } interface GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunJobStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetJobRunLogDetail { /** * The log group id for where log objects will be for job runs. */ logGroupId: string; /** * The log id of the log object the job run logs will be shipped to. */ logId: string; } interface GetJobRunNodeGroupDetailsList { /** * The state details of the node group. */ lifecycleDetails: string; /** * node group name. */ name: string; /** * The state of the job run. */ state: string; } interface GetJobRunsFilter { /** * node group name. */ name: string; regex?: boolean; values: string[]; } interface GetJobRunsJobRun { asynchronous: boolean; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * The job configuration details */ jobConfigurationOverrideDetails: outputs.DataScience.GetJobRunsJobRunJobConfigurationOverrideDetail[]; /** * Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationOverrideDetails: outputs.DataScience.GetJobRunsJobRunJobEnvironmentConfigurationOverrideDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job. */ jobId: string; /** * The job infrastructure configuration details (shape, block storage, etc.) */ jobInfrastructureConfigurationDetails: outputs.DataScience.GetJobRunsJobRunJobInfrastructureConfigurationDetail[]; /** * The job infrastructure configuration details (shape, block storage, etc.) */ jobInfrastructureConfigurationOverrideDetails: outputs.DataScience.GetJobRunsJobRunJobInfrastructureConfigurationOverrideDetail[]; /** * Logging configuration for resource. */ jobLogConfigurationOverrideDetails: outputs.DataScience.GetJobRunsJobRunJobLogConfigurationOverrideDetail[]; /** * The job node configuration details */ jobNodeConfigurationOverrideDetails: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetail[]; /** * Collection of JobStorageMountConfigurationDetails. */ jobStorageMountConfigurationDetailsLists: outputs.DataScience.GetJobRunsJobRunJobStorageMountConfigurationDetailsList[]; /** * The state details of the node group. */ lifecycleDetails: string; /** * Customer logging details for job run. */ logDetails: outputs.DataScience.GetJobRunsJobRunLogDetail[]; /** * Collection of NodeGroupDetails */ nodeGroupDetailsLists: outputs.DataScience.GetJobRunsJobRunNodeGroupDetailsList[]; opcParentRptUrl: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the job run with. */ projectId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * The date and time the job run was accepted in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeAccepted: string; /** * The date and time the job run request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeFinished: string; /** * The date and time the job run request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStarted: string; } interface GetJobRunsJobRunJobConfigurationOverrideDetail { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.GetJobRunsJobRunJobConfigurationOverrideDetailStartupProbeDetail[]; } interface GetJobRunsJobRunJobConfigurationOverrideDetailStartupProbeDetail { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface GetJobRunsJobRunJobEnvironmentConfigurationOverrideDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface GetJobRunsJobRunJobInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.GetJobRunsJobRunJobInfrastructureConfigurationDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.GetJobRunsJobRunJobInfrastructureConfigurationDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobRunsJobRunJobInfrastructureConfigurationDetailJobShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunsJobRunJobInfrastructureConfigurationDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.GetJobRunsJobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.GetJobRunsJobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration[]; } interface GetJobRunsJobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunsJobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunsJobRunJobInfrastructureConfigurationOverrideDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.GetJobRunsJobRunJobInfrastructureConfigurationOverrideDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.GetJobRunsJobRunJobInfrastructureConfigurationOverrideDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobRunsJobRunJobInfrastructureConfigurationOverrideDetailJobShapeConfigDetail { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunsJobRunJobInfrastructureConfigurationOverrideDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.GetJobRunsJobRunJobInfrastructureConfigurationOverrideDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.GetJobRunsJobRunJobInfrastructureConfigurationOverrideDetailResourceConfigurationResourceRequestConfiguration[]; } interface GetJobRunsJobRunJobInfrastructureConfigurationOverrideDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunsJobRunJobInfrastructureConfigurationOverrideDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunsJobRunJobLogConfigurationOverrideDetail { /** * If automatic on-behalf-of log object creation is enabled for job runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for job runs. */ enableLogging: boolean; /** * The log group id for where log objects will be for job runs. */ logGroupId: string; /** * The log id of the log object the job run logs will be shipped to. */ logId: string; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetail { /** * The job network configuration details */ jobNetworkConfigurations: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNetworkConfiguration[]; /** * List of JobNodeGroupConfigurationDetails */ jobNodeGroupConfigurationDetailsLists: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsList[]; /** * The node type used for job run. */ jobNodeType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The execution order of node groups */ startupOrder: string; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNetworkConfiguration { /** * job network type */ jobNetworkType: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsList { /** * The job configuration details */ jobConfigurationDetails: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetail[]; /** * Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationDetails: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetail[]; /** * The job infrastructure configuration details (shape, block storage, etc.) */ jobInfrastructureConfigurationDetails: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetail[]; /** * The minimum threshold of successful replicas for node group to be successful. All replicas need to succeed if this is not specified. */ minimumSuccessReplicas: number; /** * node group name. */ name: string; /** * The number of nodes. */ replicas: number; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetail { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetailStartupProbeDetail[]; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetailStartupProbeDetail { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailJobShapeConfigDetail { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration[]; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunsJobRunJobNodeConfigurationOverrideDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobRunsJobRunJobStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetJobRunsJobRunLogDetail { /** * The log group id for where log objects will be for job runs. */ logGroupId: string; /** * The log id of the log object the job run logs will be shipped to. */ logId: string; } interface GetJobRunsJobRunNodeGroupDetailsList { /** * The state details of the node group. */ lifecycleDetails: string; /** * node group name. */ name: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; } interface GetJobShapesFilter { /** * The name of the job shape. */ name: string; regex?: boolean; values: string[]; } interface GetJobShapesJobShape { /** * The number of cores associated with this job run shape. */ coreCount: number; /** * The number of cores associated with this job shape. */ memoryInGbs: number; /** * The name of the job shape. */ name: string; /** * The family that the compute shape belongs to. */ shapeSeries: string; } interface GetJobsFilter { /** * node group name. */ name: string; regex?: boolean; values: string[]; } interface GetJobsJob { artifactContentDisposition: string; artifactContentLength: string; artifactContentMd5: string; artifactLastModified: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; deleteRelatedJobRuns: boolean; /** * A short description of the job. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; emptyArtifact: boolean; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; jobArtifact: string; /** * The job configuration details */ jobConfigurationDetails: outputs.DataScience.GetJobsJobJobConfigurationDetail[]; /** * Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationDetails: outputs.DataScience.GetJobsJobJobEnvironmentConfigurationDetail[]; /** * The job infrastructure configuration details (shape, block storage, etc.) */ jobInfrastructureConfigurationDetails: outputs.DataScience.GetJobsJobJobInfrastructureConfigurationDetail[]; /** * Logging configuration for resource. */ jobLogConfigurationDetails: outputs.DataScience.GetJobsJobJobLogConfigurationDetail[]; /** * The job node configuration details */ jobNodeConfigurationDetails: outputs.DataScience.GetJobsJobJobNodeConfigurationDetail[]; /** * Collection of JobStorageMountConfigurationDetails. */ jobStorageMountConfigurationDetailsLists: outputs.DataScience.GetJobsJobJobStorageMountConfigurationDetailsList[]; /** * The state of the job. */ lifecycleDetails: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z */ timeCreated: string; } interface GetJobsJobJobConfigurationDetail { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.GetJobsJobJobConfigurationDetailStartupProbeDetail[]; } interface GetJobsJobJobConfigurationDetailStartupProbeDetail { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface GetJobsJobJobEnvironmentConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface GetJobsJobJobInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.GetJobsJobJobInfrastructureConfigurationDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.GetJobsJobJobInfrastructureConfigurationDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobsJobJobInfrastructureConfigurationDetailJobShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobsJobJobInfrastructureConfigurationDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.GetJobsJobJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.GetJobsJobJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration[]; } interface GetJobsJobJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobsJobJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobsJobJobLogConfigurationDetail { /** * If automatic on-behalf-of log object creation is enabled for job runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for job runs. */ enableLogging: boolean; /** * The log group id for where log objects are for job runs. */ logGroupId: string; /** * The log id the job run will push logs too. */ logId: string; } interface GetJobsJobJobNodeConfigurationDetail { /** * The job network configuration details */ jobNetworkConfigurations: outputs.DataScience.GetJobsJobJobNodeConfigurationDetailJobNetworkConfiguration[]; /** * List of JobNodeGroupConfigurationDetails */ jobNodeGroupConfigurationDetailsLists: outputs.DataScience.GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsList[]; /** * The node type used for job run. */ jobNodeType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The execution order of node groups */ startupOrder: string; } interface GetJobsJobJobNodeConfigurationDetailJobNetworkConfiguration { /** * job network type */ jobNetworkType: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsList { /** * The job configuration details */ jobConfigurationDetails: outputs.DataScience.GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetail[]; /** * Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationDetails: outputs.DataScience.GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetail[]; /** * The job infrastructure configuration details (shape, block storage, etc.) */ jobInfrastructureConfigurationDetails: outputs.DataScience.GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetail[]; /** * The minimum threshold of successful replicas for node group to be successful. All replicas need to succeed if this is not specified. */ minimumSuccessReplicas: number; /** * node group name. */ name: string; /** * The number of nodes. */ replicas: number; } interface GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetail { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetailStartupProbeDetail[]; } interface GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobConfigurationDetailStartupProbeDetail { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailJobShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration[]; } interface GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobsJobJobNodeConfigurationDetailJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface GetJobsJobJobStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetMlApplicationImplementationApplicationComponent { /** * OCID of Data Flow Application */ applicationId: string; /** * Name of application component */ componentName: string; /** * The OCID of the MlApplicationImplementation. Unique identifier that is immutable after creation. */ id: string; /** * OCID of Data Science Job */ jobId: string; /** * OCID of Data Science Model */ modelId: string; /** * ML Application Implementation name which is unique for given ML Application. */ name: string; /** * OCID of Data Science Pipeline */ pipelineId: string; /** * Type of the resource */ resourceType: string; /** * type of the argument */ type: string; } interface GetMlApplicationImplementationConfigurationSchema { /** * The default value for the optional configuration property (it must not be specified for mandatory configuration properties) */ defaultValue: string; /** * short description of the argument */ description: string; /** * argument is mandatory or not */ isMandatory: boolean; /** * Name of key (parameter name) */ keyName: string; /** * Sample property value (it must match validationRegexp if it is specified) */ sampleValue: string; /** * A regular expression will be used for the validation of property value. */ validationRegexp: string; /** * Type of value */ valueType: string; } interface GetMlApplicationImplementationLogging { /** * Log configuration details for particular areas of ML Application Implementation. */ aggregatedInstanceViewLogs: outputs.DataScience.GetMlApplicationImplementationLoggingAggregatedInstanceViewLog[]; /** * Log configuration details for particular areas of ML Application Implementation. */ implementationLogs: outputs.DataScience.GetMlApplicationImplementationLoggingImplementationLog[]; /** * Log configuration details for particular areas of ML Application Implementation. */ triggerLogs: outputs.DataScience.GetMlApplicationImplementationLoggingTriggerLog[]; } interface GetMlApplicationImplementationLoggingAggregatedInstanceViewLog { /** * If logging is enabled. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetMlApplicationImplementationLoggingImplementationLog { /** * If logging is enabled. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetMlApplicationImplementationLoggingTriggerLog { /** * If logging is enabled. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetMlApplicationImplementationMlApplicationPackageArgument { /** * Array of the ML Application package arguments */ arguments: outputs.DataScience.GetMlApplicationImplementationMlApplicationPackageArgumentArgument[]; } interface GetMlApplicationImplementationMlApplicationPackageArgumentArgument { /** * short description of the argument */ description: string; /** * argument is mandatory or not */ isMandatory: boolean; /** * ML Application Implementation name which is unique for given ML Application. */ name: string; /** * type of the argument */ type: string; /** * Argument value */ value: string; } interface GetMlApplicationImplementationVersionApplicationComponent { /** * OCID of Data Flow Application */ applicationId: string; /** * Name of application component */ componentName: string; /** * The OCID of the MlApplicationImplementationVersion. Unique identifier that is immutable after creation. */ id: string; /** * OCID of Data Science Job */ jobId: string; /** * OCID of Data Science Model */ modelId: string; /** * ML Application Implementation name which is unique for given ML Application. */ name: string; /** * OCID of Data Science Pipeline */ pipelineId: string; /** * Type of the resource */ resourceType: string; /** * type of the argument */ type: string; } interface GetMlApplicationImplementationVersionConfigurationSchema { /** * The default value for the optional configuration property (it must not be specified for mandatory configuration properties) */ defaultValue: string; /** * short description of the argument */ description: string; /** * argument is mandatory or not */ isMandatory: boolean; /** * Name of key (parameter name) */ keyName: string; /** * Sample property value (it must match validationRegexp if it is specified) */ sampleValue: string; /** * A regular expression will be used for the validation of property value. */ validationRegexp: string; /** * Type of value */ valueType: string; } interface GetMlApplicationImplementationVersionMlApplicationPackageArgument { /** * Array of the ML Application package arguments */ arguments: outputs.DataScience.GetMlApplicationImplementationVersionMlApplicationPackageArgumentArgument[]; } interface GetMlApplicationImplementationVersionMlApplicationPackageArgumentArgument { /** * short description of the argument */ description: string; /** * argument is mandatory or not */ isMandatory: boolean; /** * ML Application Implementation name which is unique for given ML Application. */ name: string; /** * type of the argument */ type: string; /** * Argument value */ value: string; } interface GetMlApplicationImplementationVersionsFilter { /** * ML Application Implementation name which is unique for given ML Application. */ name: string; regex?: boolean; values: string[]; } interface GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollection { items: outputs.DataScience.GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollectionItem[]; } interface GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollectionItem { /** * List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed. */ allowedMigrationDestinations: string[]; /** * List of application components (OCI resources shared for all MlApplicationInstances). These have been created automatically based on their definitions in the ML Application package. */ applicationComponents: outputs.DataScience.GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollectionItemApplicationComponent[]; /** * Schema of configuration which needs to be provided for each ML Application Instance. It is defined in the ML Application package descriptor. */ configurationSchemas: outputs.DataScience.GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollectionItemConfigurationSchema[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * short description of the argument */ description: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the MlApplicationImplementationVersion. Unique identifier that is immutable after creation. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * The OCID of the ML Application implemented by this ML Application Implementation. */ mlApplicationId: string; /** * unique MlApplicationImplementation identifier */ mlApplicationImplementationId: string; /** * The name of ML Application (based on mlApplicationId) */ mlApplicationName: string; /** * List of ML Application package arguments provided during ML Application package upload. */ mlApplicationPackageArguments: outputs.DataScience.GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollectionItemMlApplicationPackageArgument[]; /** * ML Application Implementation name which is unique for given ML Application. */ name: string; /** * The version of ML Application Package (e.g. "1.2" or "2.0.4") defined in ML Application package descriptor. Value is not mandatory only for CREATING state otherwise it must be always presented. */ packageVersion: string; /** * A filter to return only resources matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Creation time of MlApplicationImplementationVersion in the format defined by RFC 3339. */ timeCreated: string; } interface GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollectionItemApplicationComponent { /** * OCID of Data Flow Application */ applicationId: string; /** * Name of application component */ componentName: string; /** * The OCID of the MlApplicationImplementationVersion. Unique identifier that is immutable after creation. */ id: string; /** * OCID of Data Science Job */ jobId: string; /** * OCID of Data Science Model */ modelId: string; /** * ML Application Implementation name which is unique for given ML Application. */ name: string; /** * OCID of Data Science Pipeline */ pipelineId: string; /** * Type of the resource */ resourceType: string; /** * type of the argument */ type: string; } interface GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollectionItemConfigurationSchema { /** * The default value for the optional configuration property (it must not be specified for mandatory configuration properties) */ defaultValue: string; /** * short description of the argument */ description: string; /** * argument is mandatory or not */ isMandatory: boolean; /** * Name of key (parameter name) */ keyName: string; /** * Sample property value (it must match validationRegexp if it is specified) */ sampleValue: string; /** * A regular expression will be used for the validation of property value. */ validationRegexp: string; /** * Type of value */ valueType: string; } interface GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollectionItemMlApplicationPackageArgument { /** * Array of the ML Application package arguments */ arguments: outputs.DataScience.GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollectionItemMlApplicationPackageArgumentArgument[]; } interface GetMlApplicationImplementationVersionsMlApplicationImplementationVersionCollectionItemMlApplicationPackageArgumentArgument { /** * short description of the argument */ description: string; /** * argument is mandatory or not */ isMandatory: boolean; /** * ML Application Implementation name which is unique for given ML Application. */ name: string; /** * type of the argument */ type: string; /** * Argument value */ value: string; } interface GetMlApplicationImplementationsFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetMlApplicationImplementationsMlApplicationImplementationCollection { items: outputs.DataScience.GetMlApplicationImplementationsMlApplicationImplementationCollectionItem[]; } interface GetMlApplicationImplementationsMlApplicationImplementationCollectionItem { /** * List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed. */ allowedMigrationDestinations: string[]; /** * List of application components (OCI resources shared for all MlApplicationInstances). These have been created automatically based on their definitions in the ML Application package. */ applicationComponents: outputs.DataScience.GetMlApplicationImplementationsMlApplicationImplementationCollectionItemApplicationComponent[]; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Schema of configuration which needs to be provided for each ML Application Instance. It is defined in the ML Application package descriptor. */ configurationSchemas: outputs.DataScience.GetMlApplicationImplementationsMlApplicationImplementationCollectionItemConfigurationSchema[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * short description of the argument */ description: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the MlApplicationImplementation. Unique identifier that is immutable after creation. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Configuration of Logging for ML Application Implementation. */ loggings: outputs.DataScience.GetMlApplicationImplementationsMlApplicationImplementationCollectionItemLogging[]; /** * unique MlApplication identifier */ mlApplicationId: string; /** * The name of ML Application (based on mlApplicationId) */ mlApplicationName: string; /** * Specifies the ML application package as a map of key-value pairs. Valid keys include 'source_type', 'path', and 'uri'. Use 'file://' for local paths or 'https://' for object storage URIs. */ mlApplicationPackage: { [key: string]: string; }; /** * List of ML Application package arguments provided during ML Application package upload. */ mlApplicationPackageArguments: outputs.DataScience.GetMlApplicationImplementationsMlApplicationImplementationCollectionItemMlApplicationPackageArgument[]; /** * A filter to return only resources that match the entire name given. */ name: string; opcMlAppPackageArgs: { [key: string]: string; }; /** * The version of ML Application Package (e.g. "1.2" or "2.0.4") defined in ML Application package descriptor. Value is not mandatory only for CREATING state otherwise it must be always presented. */ packageVersion: string; /** * A filter to return only resources with lifecycleState matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Creation time of MlApplicationImplementation creation in the format defined by RFC 3339. */ timeCreated: string; /** * Time of last MlApplicationImplementation update in the format defined by RFC 3339. */ timeUpdated: string; } interface GetMlApplicationImplementationsMlApplicationImplementationCollectionItemApplicationComponent { /** * OCID of Data Flow Application */ applicationId: string; /** * Name of application component */ componentName: string; /** * The OCID of the MlApplicationImplementation. Unique identifier that is immutable after creation. */ id: string; /** * OCID of Data Science Job */ jobId: string; /** * OCID of Data Science Model */ modelId: string; /** * A filter to return only resources that match the entire name given. */ name: string; /** * OCID of Data Science Pipeline */ pipelineId: string; /** * Type of the resource */ resourceType: string; /** * type of the argument */ type: string; } interface GetMlApplicationImplementationsMlApplicationImplementationCollectionItemConfigurationSchema { /** * The default value for the optional configuration property (it must not be specified for mandatory configuration properties) */ defaultValue: string; /** * short description of the argument */ description: string; /** * argument is mandatory or not */ isMandatory: boolean; /** * Name of key (parameter name) */ keyName: string; /** * Sample property value (it must match validationRegexp if it is specified) */ sampleValue: string; /** * A regular expression will be used for the validation of property value. */ validationRegexp: string; /** * Type of value */ valueType: string; } interface GetMlApplicationImplementationsMlApplicationImplementationCollectionItemLogging { /** * Log configuration details for particular areas of ML Application Implementation. */ aggregatedInstanceViewLogs: outputs.DataScience.GetMlApplicationImplementationsMlApplicationImplementationCollectionItemLoggingAggregatedInstanceViewLog[]; /** * Log configuration details for particular areas of ML Application Implementation. */ implementationLogs: outputs.DataScience.GetMlApplicationImplementationsMlApplicationImplementationCollectionItemLoggingImplementationLog[]; /** * Log configuration details for particular areas of ML Application Implementation. */ triggerLogs: outputs.DataScience.GetMlApplicationImplementationsMlApplicationImplementationCollectionItemLoggingTriggerLog[]; } interface GetMlApplicationImplementationsMlApplicationImplementationCollectionItemLoggingAggregatedInstanceViewLog { /** * If logging is enabled. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetMlApplicationImplementationsMlApplicationImplementationCollectionItemLoggingImplementationLog { /** * If logging is enabled. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetMlApplicationImplementationsMlApplicationImplementationCollectionItemLoggingTriggerLog { /** * If logging is enabled. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetMlApplicationImplementationsMlApplicationImplementationCollectionItemMlApplicationPackageArgument { /** * Array of the ML Application package arguments */ arguments: outputs.DataScience.GetMlApplicationImplementationsMlApplicationImplementationCollectionItemMlApplicationPackageArgumentArgument[]; } interface GetMlApplicationImplementationsMlApplicationImplementationCollectionItemMlApplicationPackageArgumentArgument { /** * short description of the argument */ description: string; /** * argument is mandatory or not */ isMandatory: boolean; /** * A filter to return only resources that match the entire name given. */ name: string; /** * type of the argument */ type: string; /** * Argument value */ value: string; } interface GetMlApplicationInstanceAuthConfiguration { /** * Type of AuthN/Z */ type: string; } interface GetMlApplicationInstanceConfiguration { /** * Key of configuration property */ key: string; /** * Value of configuration property */ value: string; } interface GetMlApplicationInstancePredictionEndpointDetail { /** * Base URI of prediction router. */ basePredictionUri: string; /** * Array of all prediction URIs per use-case. */ predictionUris: outputs.DataScience.GetMlApplicationInstancePredictionEndpointDetailPredictionUri[]; } interface GetMlApplicationInstancePredictionEndpointDetailPredictionUri { /** * Prediction URI. */ uri: string; /** * Prediction use-case. */ useCase: string; } interface GetMlApplicationInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetMlApplicationInstancesMlApplicationInstanceCollection { items: outputs.DataScience.GetMlApplicationInstancesMlApplicationInstanceCollectionItem[]; } interface GetMlApplicationInstancesMlApplicationInstanceCollectionItem { /** * AuthN/Z configuration for online prediction */ authConfigurations: outputs.DataScience.GetMlApplicationInstancesMlApplicationInstanceCollectionItemAuthConfiguration[]; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Data that are used for provisioning of the given MlApplicationInstance. These are validated against configurationSchema defined in referenced MlApplicationImplementation. */ configurations: outputs.DataScience.GetMlApplicationInstancesMlApplicationInstanceCollectionItemConfiguration[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the MlApplicationInstance. Unique identifier that is immutable after creation */ id: string; /** * States whether the MlApplicationInstance is supposed to be in ACTIVE lifecycle state. */ isEnabled: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * The current substate of the MlApplicationInstance. The substate has MlApplicationInstance specific values in comparison with lifecycleState which has standard values common for all Oracle Cloud Infrastructure resources. The NEEDS_ATTENTION and FAILED substates are deprecated in favor of (NON_)?RECOVERABLE_(PROVIDER|SERVICE)_ISSUE and will be removed in next release. */ lifecycleSubstate: string; /** * unique MlApplication identifier */ mlApplicationId: string; /** * The OCID of ML Application Implementation selected as a certain solution for a given ML problem (ML Application) */ mlApplicationImplementationId: string; /** * The name of Ml Application Implementation (based on mlApplicationImplementationId) */ mlApplicationImplementationName: string; /** * The name of ML Application (based on mlApplicationId). */ mlApplicationName: string; /** * Prediction endpoint related information. */ predictionEndpointDetails: outputs.DataScience.GetMlApplicationInstancesMlApplicationInstanceCollectionItemPredictionEndpointDetail[]; /** * A filter to return only resources matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the MlApplication was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * Time of last MlApplicationInstance update in the format defined by RFC 3339. */ timeUpdated: string; } interface GetMlApplicationInstancesMlApplicationInstanceCollectionItemAuthConfiguration { /** * Type of AuthN/Z */ type: string; } interface GetMlApplicationInstancesMlApplicationInstanceCollectionItemConfiguration { /** * Key of configuration property */ key: string; /** * Value of configuration property */ value: string; } interface GetMlApplicationInstancesMlApplicationInstanceCollectionItemPredictionEndpointDetail { /** * Base URI of prediction router. */ basePredictionUri: string; /** * Array of all prediction URIs per use-case. */ predictionUris: outputs.DataScience.GetMlApplicationInstancesMlApplicationInstanceCollectionItemPredictionEndpointDetailPredictionUri[]; } interface GetMlApplicationInstancesMlApplicationInstanceCollectionItemPredictionEndpointDetailPredictionUri { /** * Prediction URI. */ uri: string; /** * Prediction use-case. */ useCase: string; } interface GetMlApplicationsFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetMlApplicationsMlApplicationCollection { items: outputs.DataScience.GetMlApplicationsMlApplicationCollectionItem[]; } interface GetMlApplicationsMlApplicationCollectionItem { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Optional description of the ML Application */ description: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the MlApplication. Unique identifier that is immutable after creation. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter to return only resources that match the entire name given. */ name: string; /** * A filter to return only resources with lifecycleState matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Creation time of MlApplication in the format defined by RFC 3339. */ timeCreated: string; /** * Time of last MlApplication update in the format defined by RFC 3339. */ timeUpdated: string; } interface GetModelBackupOperationDetail { /** * The backup status of the model. */ backupState: string; /** * The backup execution status details of the model. */ backupStateDetails: string; /** * The last backup execution time of the model. */ timeLastBackup: string; } interface GetModelBackupSetting { /** * Oracle Cloud Infrastructure backup region for the model. */ backupRegion: string; /** * Customer notification options on success/failure of archival, deletion events. */ customerNotificationType: string; /** * Boolean flag representing whether backup needs to be enabled/disabled for the model. */ isBackupEnabled: boolean; } interface GetModelCustomMetadataList { /** * Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other". */ category: string; /** * A short description of the model. */ description: string; /** * Is there any artifact present for the metadata. */ hasArtifact: boolean; /** * Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys: * * useCaseType * * libraryName * * libraryVersion * * estimatorClass * * hyperParameters * * testArtifactresults * * fineTuningConfiguration * * deploymentConfiguration * * readme * * license * * evaluationConfiguration */ key: string; /** * list of keywords for searching */ keywords: string[]; /** * Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other */ value: string; } interface GetModelDefinedMetadataList { /** * Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other". */ category: string; /** * A short description of the model. */ description: string; /** * Is there any artifact present for the metadata. */ hasArtifact: boolean; /** * Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys: * * useCaseType * * libraryName * * libraryVersion * * estimatorClass * * hyperParameters * * testArtifactresults * * fineTuningConfiguration * * deploymentConfiguration * * readme * * license * * evaluationConfiguration */ key: string; /** * list of keywords for searching */ keywords: string[]; /** * Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other */ value: string; } interface GetModelDeploymentCategoryLogDetail { /** * The log details. */ accesses: outputs.DataScience.GetModelDeploymentCategoryLogDetailAccess[]; /** * The log details. */ predicts: outputs.DataScience.GetModelDeploymentCategoryLogDetailPredict[]; } interface GetModelDeploymentCategoryLogDetailAccess { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log group to work with. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log to work with. */ logId: string; } interface GetModelDeploymentCategoryLogDetailPredict { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log group to work with. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log to work with. */ logId: string; } interface GetModelDeploymentModelDeploymentConfigurationDetail { /** * The type of the model deployment. */ deploymentType: string; /** * The configuration to carry the environment details thats used in Model Deployment creation */ environmentConfigurationDetails: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailEnvironmentConfigurationDetail[]; /** * The infrastructure configuration details. */ infrastructureConfigurationDetails: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetail[]; /** * The model configuration details. */ modelConfigurationDetails: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetail[]; /** * The model group configuration details. */ modelGroupConfigurationDetails: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailModelGroupConfigurationDetail[]; } interface GetModelDeploymentModelDeploymentConfigurationDetailEnvironmentConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * List of custom inference HTTP endpoints configured on the model deployment instance for inferencing. */ customHttpEndpoints: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailEnvironmentConfigurationDetailCustomHttpEndpoint[]; /** * Service injected Environment variables set for the web server container and can not be set or modified by user. */ defaultEnvironmentVariables: { [key: string]: string; }; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The environment configuration type */ environmentConfigurationType: string; /** * Environment variables to set for the web server container. The size of envVars must be less than 2048 bytes. Key should be under 32 characters. Key should contain only letters, digits and underscore (_) Key should start with a letter. Key should have at least 2 characters. Key should not end with underscore eg. `TEST_` Key if added cannot be empty. Value can be empty. No specific size limits on individual Values. But overall environment variables is limited to 2048 bytes. Key can't be reserved Model Deployment environment variables. */ environmentVariables: { [key: string]: string; }; /** * The port on which the container [HEALTHCHECK](https://docs.docker.com/engine/reference/builder/#healthcheck) would listen. The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. */ healthCheckPort: number; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. The container image is optional while using service managed open source foundation model. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The chosen specification from predefined set of endpoints a user can access. For example, if the value is 'openai', the user can access OpenAI-compliant endpoints like /v1/completions, /v1/chat/completions, /v1/models, etc., for inference. */ predictApiSpecification: string; /** * The port on which the web server serving the inference is running. The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. */ serverPort: number; } interface GetModelDeploymentModelDeploymentConfigurationDetailEnvironmentConfigurationDetailCustomHttpEndpoint { /** * The suffix part of the endpoint that will be allowed for invocation. */ endpointUriSuffix: string; /** * List of HTTP methods acceptable by the URI. */ httpMethods: string[]; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetail { /** * The minimum network bandwidth for the model deployment. */ bandwidthMbps: number; computeTargetId: string; /** * The type of the model deployment infrastructure. */ infrastructureType: string; /** * The model deployment instance configuration. */ instanceConfigurations: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailInstanceConfiguration[]; /** * The maximum network bandwidth for the model deployment. */ maximumBandwidthMbps: number; modelDeploymentResourceConfigurations: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfiguration[]; /** * The scaling policy to apply to each model of the deployment. */ scalingPolicies: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicy[]; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailInstanceConfiguration { /** * The shape used to launch the model deployment instances. When using service managed open source foundation model, the supported shapes can be retrieved using get model api /models/{modelId}/definedMetadata/deploymentConfiguration/artifact/content. */ instanceShapeName: string; /** * Details for the model-deployment instance shape configuration. */ modelDeploymentInstanceShapeConfigDetails: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailInstanceConfigurationModelDeploymentInstanceShapeConfigDetail[]; /** * Network Access type of model deployment. */ networkAccessType: string; /** * The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * A model deployment instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT/SGW gateway for egress. */ subnetId: string; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailInstanceConfigurationModelDeploymentInstanceShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfiguration { resourceLimitConfigurations: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfigurationResourceLimitConfiguration[]; resourceRequestConfigurations: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfigurationResourceRequestConfiguration[]; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfigurationResourceLimitConfiguration { /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfigurationResourceRequestConfiguration { gpus: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicy { /** * The list of autoscaling policy details. */ autoScalingPolicies: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicy[]; /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The number of instances for the model deployment. */ instanceCount: number; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The type of scaling policy. */ policyType: string; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicy { /** * The type of autoscaling policy. */ autoScalingPolicyType: string; /** * For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the model deployment immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. 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. */ initialInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the maximum number of instances the model deployment is allowed to increase to (scale out). */ maximumInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the minimum number of instances the model deployment is allowed to decrease to (scale in). */ minimumInstanceCount: number; /** * The list of autoscaling policy rules. */ rules: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRule[]; scaleInPolicies: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyScaleInPolicy[]; scaleOutPolicies: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyScaleOutPolicy[]; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRule { /** * The metric expression for creating the alarm used to trigger autoscaling actions on the model deployment. */ metricExpressionRuleType: string; /** * Metric type */ metricType: string; scaleConfigurations: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleConfiguration[]; /** * The scaling configuration for the predefined metric expression rule. */ scaleInConfigurations: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration[]; /** * The scaling configuration for the predefined metric expression rule. */ scaleOutConfigurations: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration[]; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleConfiguration { metricNamespace: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; targetScalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyScaleInPolicy { /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; } interface GetModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyScaleOutPolicy { /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; } interface GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetail { /** * The minimum network bandwidth for the model deployment. */ bandwidthMbps: number; /** * The model deployment instance configuration. */ instanceConfigurations: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailInstanceConfiguration[]; /** * The maximum network bandwidth for the model deployment. */ maximumBandwidthMbps: number; /** * The OCID of the model you want to deploy. */ modelId: string; /** * The scaling policy to apply to each model of the deployment. */ scalingPolicies: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicy[]; } interface GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailInstanceConfiguration { /** * The shape used to launch the model deployment instances. When using service managed open source foundation model, the supported shapes can be retrieved using get model api /models/{modelId}/definedMetadata/deploymentConfiguration/artifact/content. */ instanceShapeName: string; /** * Details for the model-deployment instance shape configuration. */ modelDeploymentInstanceShapeConfigDetails: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailInstanceConfigurationModelDeploymentInstanceShapeConfigDetail[]; /** * Network Access type of model deployment. */ networkAccessType: string; /** * The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * A model deployment instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT/SGW gateway for egress. */ subnetId: string; } interface GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailInstanceConfigurationModelDeploymentInstanceShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicy { /** * The list of autoscaling policy details. */ autoScalingPolicies: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicy[]; /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The number of instances for the model deployment. */ instanceCount: number; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The type of scaling policy. */ policyType: string; } interface GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicy { /** * The type of autoscaling policy. */ autoScalingPolicyType: string; /** * For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the model deployment immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. 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. */ initialInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the maximum number of instances the model deployment is allowed to increase to (scale out). */ maximumInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the minimum number of instances the model deployment is allowed to decrease to (scale in). */ minimumInstanceCount: number; /** * The list of autoscaling policy rules. */ rules: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRule[]; } interface GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRule { /** * The metric expression for creating the alarm used to trigger autoscaling actions on the model deployment. */ metricExpressionRuleType: string; /** * Metric type */ metricType: string; /** * The scaling configuration for the predefined metric expression rule. */ scaleInConfigurations: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration[]; /** * The scaling configuration for the predefined metric expression rule. */ scaleOutConfigurations: outputs.DataScience.GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration[]; } interface GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetModelDeploymentModelDeploymentConfigurationDetailModelGroupConfigurationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model group you want to deploy. */ modelGroupId: string; } interface GetModelDeploymentModelDeploymentSystemData { /** * This value is the current count of the model deployment instances. */ currentInstanceCount: number; /** * The type of the deployed model. */ modelType: string; /** * The infrastructure type of the model deployment. */ systemInfraType: string; } interface GetModelDeploymentModelStatesFilter { name: string; regex?: boolean; values: string[]; } interface GetModelDeploymentModelStatesModelDeploymentModelState { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by the inference key. */ inferenceKey: string; /** * Filter results by the model ocid. */ modelId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * The state of the deployed model in model deployment. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetModelDeploymentShapesFilter { /** * The name of the model deployment shape. */ name: string; regex?: boolean; values: string[]; } interface GetModelDeploymentShapesModelDeploymentShape { /** * The number of cores associated with this model deployment shape. */ coreCount: number; /** * The amount of memory in GBs associated with this model deployment shape. */ memoryInGbs: number; /** * The name of the model deployment shape. */ name: string; /** * The family that the compute shape belongs to. */ shapeSeries: string; } interface GetModelDeploymentsFilter { name: string; regex?: boolean; values: string[]; } interface GetModelDeploymentsModelDeployment { /** * The log details for each category. */ categoryLogDetails: outputs.DataScience.GetModelDeploymentsModelDeploymentCategoryLogDetail[]; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A short description of the model deployment. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * Details about the state of the model deployment. */ lifecycleDetails: string; /** * The model deployment configuration details. */ modelDeploymentConfigurationDetails: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetail[]; /** * Model deployment system data. */ modelDeploymentSystemDatas: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentSystemData[]; /** * The URL to interact with the model deployment. */ modelDeploymentUrl: string; opcParentRptUrl: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * The date and time the resource was created, in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeCreated: string; } interface GetModelDeploymentsModelDeploymentCategoryLogDetail { /** * The log details. */ accesses: outputs.DataScience.GetModelDeploymentsModelDeploymentCategoryLogDetailAccess[]; /** * The log details. */ predicts: outputs.DataScience.GetModelDeploymentsModelDeploymentCategoryLogDetailPredict[]; } interface GetModelDeploymentsModelDeploymentCategoryLogDetailAccess { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log group to work with. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log to work with. */ logId: string; } interface GetModelDeploymentsModelDeploymentCategoryLogDetailPredict { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log group to work with. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log to work with. */ logId: string; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetail { /** * The type of the model deployment. */ deploymentType: string; /** * The configuration to carry the environment details thats used in Model Deployment creation */ environmentConfigurationDetails: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailEnvironmentConfigurationDetail[]; /** * The infrastructure configuration details. */ infrastructureConfigurationDetails: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetail[]; /** * The model configuration details. */ modelConfigurationDetails: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetail[]; /** * The model group configuration details. */ modelGroupConfigurationDetails: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelGroupConfigurationDetail[]; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailEnvironmentConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * List of custom inference HTTP endpoints configured on the model deployment instance for inferencing. */ customHttpEndpoints: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailEnvironmentConfigurationDetailCustomHttpEndpoint[]; /** * Service injected Environment variables set for the web server container and can not be set or modified by user. */ defaultEnvironmentVariables: { [key: string]: string; }; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The environment configuration type */ environmentConfigurationType: string; /** * Environment variables to set for the web server container. The size of envVars must be less than 2048 bytes. Key should be under 32 characters. Key should contain only letters, digits and underscore (_) Key should start with a letter. Key should have at least 2 characters. Key should not end with underscore eg. `TEST_` Key if added cannot be empty. Value can be empty. No specific size limits on individual Values. But overall environment variables is limited to 2048 bytes. Key can't be reserved Model Deployment environment variables. */ environmentVariables: { [key: string]: string; }; /** * The port on which the container [HEALTHCHECK](https://docs.docker.com/engine/reference/builder/#healthcheck) would listen. The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. */ healthCheckPort: number; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. The container image is optional while using service managed open source foundation model. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The chosen specification from predefined set of endpoints a user can access. For example, if the value is 'openai', the user can access OpenAI-compliant endpoints like /v1/completions, /v1/chat/completions, /v1/models, etc., for inference. */ predictApiSpecification: string; /** * The port on which the web server serving the inference is running. The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. */ serverPort: number; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailEnvironmentConfigurationDetailCustomHttpEndpoint { /** * The suffix part of the endpoint that will be allowed for invocation. */ endpointUriSuffix: string; /** * List of HTTP methods acceptable by the URI. */ httpMethods: string[]; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetail { /** * The minimum network bandwidth for the model deployment. */ bandwidthMbps: number; computeTargetId: string; /** * The type of the model deployment infrastructure. */ infrastructureType: string; /** * The model deployment instance configuration. */ instanceConfigurations: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailInstanceConfiguration[]; /** * The maximum network bandwidth for the model deployment. */ maximumBandwidthMbps: number; modelDeploymentResourceConfigurations: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfiguration[]; /** * The scaling policy to apply to each model of the deployment. */ scalingPolicies: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicy[]; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailInstanceConfiguration { /** * The shape used to launch the model deployment instances. When using service managed open source foundation model, the supported shapes can be retrieved using get model api /models/{modelId}/definedMetadata/deploymentConfiguration/artifact/content. */ instanceShapeName: string; /** * Details for the model-deployment instance shape configuration. */ modelDeploymentInstanceShapeConfigDetails: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailInstanceConfigurationModelDeploymentInstanceShapeConfigDetail[]; /** * Network Access type of model deployment. */ networkAccessType: string; /** * The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * A model deployment instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT/SGW gateway for egress. */ subnetId: string; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailInstanceConfigurationModelDeploymentInstanceShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfiguration { resourceLimitConfigurations: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfigurationResourceLimitConfiguration[]; resourceRequestConfigurations: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfigurationResourceRequestConfiguration[]; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfigurationResourceLimitConfiguration { /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailModelDeploymentResourceConfigurationResourceRequestConfiguration { gpus: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicy { /** * The list of autoscaling policy details. */ autoScalingPolicies: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicy[]; /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The number of instances for the model deployment. */ instanceCount: number; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The type of scaling policy. */ policyType: string; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicy { /** * The type of autoscaling policy. */ autoScalingPolicyType: string; /** * For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the model deployment immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. 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. */ initialInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the maximum number of instances the model deployment is allowed to increase to (scale out). */ maximumInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the minimum number of instances the model deployment is allowed to decrease to (scale in). */ minimumInstanceCount: number; /** * The list of autoscaling policy rules. */ rules: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRule[]; scaleInPolicies: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyScaleInPolicy[]; scaleOutPolicies: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyScaleOutPolicy[]; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRule { /** * The metric expression for creating the alarm used to trigger autoscaling actions on the model deployment. */ metricExpressionRuleType: string; /** * Metric type */ metricType: string; scaleConfigurations: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleConfiguration[]; /** * The scaling configuration for the predefined metric expression rule. */ scaleInConfigurations: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration[]; /** * The scaling configuration for the predefined metric expression rule. */ scaleOutConfigurations: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration[]; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleConfiguration { metricNamespace: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; targetScalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyScaleInPolicy { /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailInfrastructureConfigurationDetailScalingPolicyAutoScalingPolicyScaleOutPolicy { /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetail { /** * The minimum network bandwidth for the model deployment. */ bandwidthMbps: number; /** * The model deployment instance configuration. */ instanceConfigurations: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailInstanceConfiguration[]; /** * The maximum network bandwidth for the model deployment. */ maximumBandwidthMbps: number; /** * The OCID of the model you want to deploy. */ modelId: string; /** * The scaling policy to apply to each model of the deployment. */ scalingPolicies: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicy[]; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailInstanceConfiguration { /** * The shape used to launch the model deployment instances. When using service managed open source foundation model, the supported shapes can be retrieved using get model api /models/{modelId}/definedMetadata/deploymentConfiguration/artifact/content. */ instanceShapeName: string; /** * Details for the model-deployment instance shape configuration. */ modelDeploymentInstanceShapeConfigDetails: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailInstanceConfigurationModelDeploymentInstanceShapeConfigDetail[]; /** * Network Access type of model deployment. */ networkAccessType: string; /** * The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * A model deployment instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT/SGW gateway for egress. */ subnetId: string; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailInstanceConfigurationModelDeploymentInstanceShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicy { /** * The list of autoscaling policy details. */ autoScalingPolicies: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicy[]; /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The number of instances for the model deployment. */ instanceCount: number; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The type of scaling policy. */ policyType: string; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicy { /** * The type of autoscaling policy. */ autoScalingPolicyType: string; /** * For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the model deployment immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. 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. */ initialInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the maximum number of instances the model deployment is allowed to increase to (scale out). */ maximumInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the minimum number of instances the model deployment is allowed to decrease to (scale in). */ minimumInstanceCount: number; /** * The list of autoscaling policy rules. */ rules: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRule[]; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRule { /** * The metric expression for creating the alarm used to trigger autoscaling actions on the model deployment. */ metricExpressionRuleType: string; /** * Metric type */ metricType: string; /** * The scaling configuration for the predefined metric expression rule. */ scaleInConfigurations: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration[]; /** * The scaling configuration for the predefined metric expression rule. */ scaleOutConfigurations: outputs.DataScience.GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration[]; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleInConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelConfigurationDetailScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface GetModelDeploymentsModelDeploymentModelDeploymentConfigurationDetailModelGroupConfigurationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model group you want to deploy. */ modelGroupId: string; } interface GetModelDeploymentsModelDeploymentModelDeploymentSystemData { /** * This value is the current count of the model deployment instances. */ currentInstanceCount: number; /** * The type of the deployed model. */ modelType: string; /** * The infrastructure type of the model deployment. */ systemInfraType: string; } interface GetModelGroupMemberModelEntry { /** * Each List item contains inference key and model ocid. */ memberModelDetails: outputs.DataScience.GetModelGroupMemberModelEntryMemberModelDetail[]; } interface GetModelGroupMemberModelEntryMemberModelDetail { /** * SaaS friendly name of the model. */ inferenceKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model. */ modelId: string; } interface GetModelGroupModelGroupCloneSourceDetail { modelGroupCloneSourceType: string; modifyModelGroupDetails: outputs.DataScience.GetModelGroupModelGroupCloneSourceDetailModifyModelGroupDetail[]; patchModelGroupMemberModelDetails: outputs.DataScience.GetModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetail[]; sourceId: string; } interface GetModelGroupModelGroupCloneSourceDetailModifyModelGroupDetail { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Description of model metadata. */ description: string; /** * A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The model group details. */ modelGroupDetails: outputs.DataScience.GetModelGroupModelGroupCloneSourceDetailModifyModelGroupDetailModelGroupDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model group version history to which the modelGroup is associated. */ modelGroupVersionHistoryId: string; /** * An additional description of the lifecycle state of the model group. */ versionLabel: string; } interface GetModelGroupModelGroupCloneSourceDetailModifyModelGroupDetailModelGroupDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model in the group that represents the base model for stacked deployment. */ baseModelId: string; /** * An array of custom metadata details for the model group. */ customMetadataLists: outputs.DataScience.GetModelGroupModelGroupCloneSourceDetailModifyModelGroupDetailModelGroupDetailCustomMetadataList[]; /** * The type of the model group. */ type: string; } interface GetModelGroupModelGroupCloneSourceDetailModifyModelGroupDetailModelGroupDetailCustomMetadataList { /** * Category of the metadata. */ category: string; /** * Description of model metadata. */ description: string; /** * Key of the metadata. */ key: string; /** * Value of the metadata. */ value: string; } interface GetModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetail { items: outputs.DataScience.GetModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetailItem[]; } interface GetModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetailItem { operation: string; values: outputs.DataScience.GetModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetailItemValue[]; } interface GetModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetailItemValue { /** * SaaS friendly name of the model. */ inferenceKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model. */ modelId: string; } interface GetModelGroupModelGroupDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model in the group that represents the base model for stacked deployment. */ baseModelId: string; /** * An array of custom metadata details for the model group. */ customMetadataLists: outputs.DataScience.GetModelGroupModelGroupDetailCustomMetadataList[]; /** * The type of the model group. */ type: string; } interface GetModelGroupModelGroupDetailCustomMetadataList { /** * Category of the metadata. */ category: string; /** * Description of model metadata. */ description: string; /** * Key of the metadata. */ key: string; /** * Value of the metadata. */ value: string; } interface GetModelGroupModelsFilter { name: string; regex?: boolean; values: string[]; } interface GetModelGroupModelsModelGroupModel { /** * The category of the model. */ category: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * SaaS friendly name of the model. */ inferenceKey: string; /** * Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy. */ isModelByReference: boolean; /** * Details about the lifecycle state of the model. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model. */ modelId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the model. */ projectId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeCreated: string; /** * The date and time the resource was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeUpdated: string; } interface GetModelGroupVersionHistoriesFilter { name: string; regex?: boolean; values: string[]; } interface GetModelGroupVersionHistoriesModelGroupVersionHistory { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A short description of the modelGroupVersionHistory. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the latest version of the model group associated. */ latestModelGroupId: string; /** * Details about the lifecycle state of the model group version history. */ lifecycleDetails: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * A filter to return resources matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeCreated: string; /** * The date and time the resource was last updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeUpdated: string; } interface GetModelGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetModelGroupsModelGroup { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The type of the model group create operation. */ createType: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Description of model metadata. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * Details about the lifecycle state of the model group. */ lifecycleDetails: string; /** * List of member models (inferenceKey & modelId) to be associated with the model group. */ memberModelEntries: outputs.DataScience.GetModelGroupsModelGroupMemberModelEntry[]; modelGroupCloneSourceDetails: outputs.DataScience.GetModelGroupsModelGroupModelGroupCloneSourceDetail[]; /** * The model group details. */ modelGroupDetails: outputs.DataScience.GetModelGroupsModelGroupModelGroupDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory. */ modelGroupVersionHistoryId: string; /** * The name of the model group version history to which the model group is associated. */ modelGroupVersionHistoryName: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model group used for the clone operation. */ sourceModelGroupId: string; /** * A filter to return resources matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeCreated: string; /** * The date and time the resource was last updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeUpdated: string; /** * Unique identifier assigned to each version of the model group. It would be auto-incremented number generated by service. */ versionId: string; /** * An additional description of the lifecycle state of the model group. */ versionLabel: string; } interface GetModelGroupsModelGroupMemberModelEntry { /** * Each List item contains inference key and model ocid. */ memberModelDetails: outputs.DataScience.GetModelGroupsModelGroupMemberModelEntryMemberModelDetail[]; } interface GetModelGroupsModelGroupMemberModelEntryMemberModelDetail { /** * SaaS friendly name of the model. */ inferenceKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model. */ modelId: string; } interface GetModelGroupsModelGroupModelGroupCloneSourceDetail { modelGroupCloneSourceType: string; modifyModelGroupDetails: outputs.DataScience.GetModelGroupsModelGroupModelGroupCloneSourceDetailModifyModelGroupDetail[]; patchModelGroupMemberModelDetails: outputs.DataScience.GetModelGroupsModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetail[]; sourceId: string; } interface GetModelGroupsModelGroupModelGroupCloneSourceDetailModifyModelGroupDetail { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Description of model metadata. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The model group details. */ modelGroupDetails: outputs.DataScience.GetModelGroupsModelGroupModelGroupCloneSourceDetailModifyModelGroupDetailModelGroupDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the modelGroupVersionHistory. */ modelGroupVersionHistoryId: string; /** * An additional description of the lifecycle state of the model group. */ versionLabel: string; } interface GetModelGroupsModelGroupModelGroupCloneSourceDetailModifyModelGroupDetailModelGroupDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model in the group that represents the base model for stacked deployment. */ baseModelId: string; /** * An array of custom metadata details for the model group. */ customMetadataLists: outputs.DataScience.GetModelGroupsModelGroupModelGroupCloneSourceDetailModifyModelGroupDetailModelGroupDetailCustomMetadataList[]; /** * The type of the model group. */ type: string; } interface GetModelGroupsModelGroupModelGroupCloneSourceDetailModifyModelGroupDetailModelGroupDetailCustomMetadataList { /** * Category of the metadata. */ category: string; /** * Description of model metadata. */ description: string; /** * Key of the metadata. */ key: string; /** * Value of the metadata. */ value: string; } interface GetModelGroupsModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetail { items: outputs.DataScience.GetModelGroupsModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetailItem[]; } interface GetModelGroupsModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetailItem { operation: string; values: outputs.DataScience.GetModelGroupsModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetailItemValue[]; } interface GetModelGroupsModelGroupModelGroupCloneSourceDetailPatchModelGroupMemberModelDetailItemValue { /** * SaaS friendly name of the model. */ inferenceKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model. */ modelId: string; } interface GetModelGroupsModelGroupModelGroupDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model in the group that represents the base model for stacked deployment. */ baseModelId: string; /** * An array of custom metadata details for the model group. */ customMetadataLists: outputs.DataScience.GetModelGroupsModelGroupModelGroupDetailCustomMetadataList[]; /** * The type of the model group. */ type: string; } interface GetModelGroupsModelGroupModelGroupDetailCustomMetadataList { /** * Category of the metadata. */ category: string; /** * Description of model metadata. */ description: string; /** * Key of the metadata. */ key: string; /** * Value of the metadata. */ value: string; } interface GetModelRetentionOperationDetail { /** * The archival status of model. */ archiveState: string; /** * The archival state details of the model. */ archiveStateDetails: string; /** * The deletion status of the archived model. */ deleteState: string; /** * The deletion status details of the archived model. */ deleteStateDetails: string; /** * The estimated archival time of the model based on the provided retention setting. */ timeArchivalScheduled: string; /** * The estimated deletion time of the model based on the provided retention setting. */ timeDeletionScheduled: string; } interface GetModelRetentionSetting { /** * Number of days after which the model will be archived. */ archiveAfterDays: number; /** * Customer notification options on success/failure of archival, deletion events. */ customerNotificationType: string; /** * Number of days after which the archived model will be deleted. */ deleteAfterDays: number; } interface GetModelVersionSetsFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetModelVersionSetsModelVersionSet { /** * Specifies the type of model version sets to list. By default, user model version sets are listed. */ category: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A short description of the model version set. */ description: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * A filter to return only resources that match the entire name given. */ name: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time that the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeCreated: string; /** * The date and time that the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeUpdated: string; } interface GetModelsFilter { name: string; regex?: boolean; values: string[]; } interface GetModelsModel { artifactContentDisposition: string; artifactContentLength: string; artifactContentMd5: string; artifactLastModified: string; /** * Backup operation details of the model. */ backupOperationDetails: outputs.DataScience.GetModelsModelBackupOperationDetail[]; /** * Back up setting details of the model. */ backupSettings: outputs.DataScience.GetModelsModelBackupSetting[]; /** * Specifies the type of models to list. By default, user models are listed. */ category: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * An array of custom metadata details for the model. */ customMetadataLists: outputs.DataScience.GetModelsModelCustomMetadataList[]; /** * An array of defined metadata details for the model. */ definedMetadataLists: outputs.DataScience.GetModelsModelDefinedMetadataList[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A short description of the model. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; emptyModel: boolean; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * Input schema file content in String format */ inputSchema: string; /** * Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy. */ isModelByReference: boolean; /** * Details about the lifecycle state of the model. */ lifecycleDetails: string; modelArtifact: string; /** * The OCID of the model version set that the model is associated to. */ modelVersionSetId: string; /** * The name of the model version set that the model is associated to. */ modelVersionSetName: string; /** * Output schema file content in String format */ outputSchema: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * Retention operation details for the model. */ retentionOperationDetails: outputs.DataScience.GetModelsModelRetentionOperationDetail[]; /** * Retention setting details of the model. */ retentionSettings: outputs.DataScience.GetModelsModelRetentionSetting[]; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeCreated: string; versionLabel: string; } interface GetModelsModelBackupOperationDetail { /** * The backup status of the model. */ backupState: string; /** * The backup execution status details of the model. */ backupStateDetails: string; /** * The last backup execution time of the model. */ timeLastBackup: string; } interface GetModelsModelBackupSetting { /** * Oracle Cloud Infrastructure backup region for the model. */ backupRegion: string; /** * Customer notification options on success/failure of archival, deletion events. */ customerNotificationType: string; /** * Boolean flag representing whether backup needs to be enabled/disabled for the model. */ isBackupEnabled: boolean; } interface GetModelsModelCustomMetadataList { /** * Specifies the type of models to list. By default, user models are listed. */ category: string; /** * A short description of the model. */ description: string; /** * Is there any artifact present for the metadata. */ hasArtifact: boolean; /** * Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys: * * useCaseType * * libraryName * * libraryVersion * * estimatorClass * * hyperParameters * * testArtifactresults * * fineTuningConfiguration * * deploymentConfiguration * * readme * * license * * evaluationConfiguration */ key: string; /** * list of keywords for searching */ keywords: string[]; /** * Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other */ value: string; } interface GetModelsModelDefinedMetadataList { /** * Specifies the type of models to list. By default, user models are listed. */ category: string; /** * A short description of the model. */ description: string; /** * Is there any artifact present for the metadata. */ hasArtifact: boolean; /** * Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys: * * useCaseType * * libraryName * * libraryVersion * * estimatorClass * * hyperParameters * * testArtifactresults * * fineTuningConfiguration * * deploymentConfiguration * * readme * * license * * evaluationConfiguration */ key: string; /** * list of keywords for searching */ keywords: string[]; /** * Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other */ value: string; } interface GetModelsModelRetentionOperationDetail { /** * The archival status of model. */ archiveState: string; /** * The archival state details of the model. */ archiveStateDetails: string; /** * The deletion status of the archived model. */ deleteState: string; /** * The deletion status details of the archived model. */ deleteStateDetails: string; /** * The estimated archival time of the model based on the provided retention setting. */ timeArchivalScheduled: string; /** * The estimated deletion time of the model based on the provided retention setting. */ timeDeletionScheduled: string; } interface GetModelsModelRetentionSetting { /** * Number of days after which the model will be archived. */ archiveAfterDays: number; /** * Customer notification options on success/failure of archival, deletion events. */ customerNotificationType: string; /** * Number of days after which the archived model will be deleted. */ deleteAfterDays: number; } interface GetNotebookSessionNotebookSessionConfigDetail { /** * A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs. */ blockStorageSizeInGbs: number; /** * Details for the notebook session shape configuration. */ notebookSessionShapeConfigDetails: outputs.DataScience.GetNotebookSessionNotebookSessionConfigDetailNotebookSessionShapeConfigDetail[]; /** * The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the `ListNotebookSessionShapes` endpoint. */ shape: string; /** * A notebook session instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet. */ subnetId: string; } interface GetNotebookSessionNotebookSessionConfigDetailNotebookSessionShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left bank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the notebook session instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the notebook session instance. */ ocpus: number; } interface GetNotebookSessionNotebookSessionConfigurationDetail { /** * A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs. */ blockStorageSizeInGbs: number; /** * Details for the notebook session shape configuration. */ notebookSessionShapeConfigDetails: outputs.DataScience.GetNotebookSessionNotebookSessionConfigurationDetailNotebookSessionShapeConfigDetail[]; /** * The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the `ListNotebookSessionShapes` endpoint. */ shape: string; /** * A notebook session instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet. */ subnetId: string; } interface GetNotebookSessionNotebookSessionConfigurationDetailNotebookSessionShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left bank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the notebook session instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the notebook session instance. */ ocpus: number; } interface GetNotebookSessionNotebookSessionRuntimeConfigDetail { /** * Custom environment variables for Notebook Session. These key-value pairs will be available for customers in Notebook Sessions. */ customEnvironmentVariables: { [key: string]: string; }; /** * Git configuration Details. */ notebookSessionGitConfigDetails: outputs.DataScience.GetNotebookSessionNotebookSessionRuntimeConfigDetailNotebookSessionGitConfigDetail[]; } interface GetNotebookSessionNotebookSessionRuntimeConfigDetailNotebookSessionGitConfigDetail { /** * A collection of Git repository configurations. */ notebookSessionGitRepoConfigCollections: outputs.DataScience.GetNotebookSessionNotebookSessionRuntimeConfigDetailNotebookSessionGitConfigDetailNotebookSessionGitRepoConfigCollection[]; } interface GetNotebookSessionNotebookSessionRuntimeConfigDetailNotebookSessionGitConfigDetailNotebookSessionGitRepoConfigCollection { /** * The repository URL */ url: string; } interface GetNotebookSessionNotebookSessionStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetNotebookSessionShapesFilter { /** * The name of the notebook session shape. */ name: string; regex?: boolean; values: string[]; } interface GetNotebookSessionShapesNotebookSessionShape { /** * The number of cores associated with this notebook session shape. */ coreCount: number; /** * The amount of memory in GBs associated with this notebook session shape. */ memoryInGbs: number; /** * The name of the notebook session shape. */ name: string; /** * The family that the compute shape belongs to. */ shapeSeries: string; } interface GetNotebookSessionsFilter { name: string; regex?: boolean; values: string[]; } interface GetNotebookSessionsNotebookSession { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * Details about the state of the notebook session. */ lifecycleDetails: string; /** * Details for the notebook session configuration. */ notebookSessionConfigDetails: outputs.DataScience.GetNotebookSessionsNotebookSessionNotebookSessionConfigDetail[]; /** * Details for the notebook session configuration. */ notebookSessionConfigurationDetails: outputs.DataScience.GetNotebookSessionsNotebookSessionNotebookSessionConfigurationDetail[]; /** * Notebook Session runtime configuration details. */ notebookSessionRuntimeConfigDetails: outputs.DataScience.GetNotebookSessionsNotebookSessionNotebookSessionRuntimeConfigDetail[]; /** * Collection of NotebookSessionStorageMountConfigurationDetails. */ notebookSessionStorageMountConfigurationDetailsLists: outputs.DataScience.GetNotebookSessionsNotebookSessionNotebookSessionStorageMountConfigurationDetailsList[]; /** * The URL to interact with the notebook session. */ notebookSessionUrl: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeCreated: string; } interface GetNotebookSessionsNotebookSessionNotebookSessionConfigDetail { /** * A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs. */ blockStorageSizeInGbs: number; /** * Details for the notebook session shape configuration. */ notebookSessionShapeConfigDetails: outputs.DataScience.GetNotebookSessionsNotebookSessionNotebookSessionConfigDetailNotebookSessionShapeConfigDetail[]; /** * The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the `ListNotebookSessionShapes` endpoint. */ shape: string; /** * A notebook session instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet. */ subnetId: string; } interface GetNotebookSessionsNotebookSessionNotebookSessionConfigDetailNotebookSessionShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left bank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the notebook session instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the notebook session instance. */ ocpus: number; } interface GetNotebookSessionsNotebookSessionNotebookSessionConfigurationDetail { /** * A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs. */ blockStorageSizeInGbs: number; /** * Details for the notebook session shape configuration. */ notebookSessionShapeConfigDetails: outputs.DataScience.GetNotebookSessionsNotebookSessionNotebookSessionConfigurationDetailNotebookSessionShapeConfigDetail[]; /** * The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the `ListNotebookSessionShapes` endpoint. */ shape: string; /** * A notebook session instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet. */ subnetId: string; } interface GetNotebookSessionsNotebookSessionNotebookSessionConfigurationDetailNotebookSessionShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left bank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the notebook session instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the notebook session instance. */ ocpus: number; } interface GetNotebookSessionsNotebookSessionNotebookSessionRuntimeConfigDetail { /** * Custom environment variables for Notebook Session. These key-value pairs will be available for customers in Notebook Sessions. */ customEnvironmentVariables: { [key: string]: string; }; /** * Git configuration Details. */ notebookSessionGitConfigDetails: outputs.DataScience.GetNotebookSessionsNotebookSessionNotebookSessionRuntimeConfigDetailNotebookSessionGitConfigDetail[]; } interface GetNotebookSessionsNotebookSessionNotebookSessionRuntimeConfigDetailNotebookSessionGitConfigDetail { /** * A collection of Git repository configurations. */ notebookSessionGitRepoConfigCollections: outputs.DataScience.GetNotebookSessionsNotebookSessionNotebookSessionRuntimeConfigDetailNotebookSessionGitConfigDetailNotebookSessionGitRepoConfigCollection[]; } interface GetNotebookSessionsNotebookSessionNotebookSessionRuntimeConfigDetailNotebookSessionGitConfigDetailNotebookSessionGitRepoConfigCollection { /** * The repository URL */ url: string; } interface GetNotebookSessionsNotebookSessionNotebookSessionStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetPipelineConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; /** * The type of pipeline. */ type: string; } interface GetPipelineInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.GetPipelineInfrastructureConfigurationDetailShapeConfigDetail[]; /** * The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface GetPipelineInfrastructureConfigurationDetailShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineLogConfigurationDetail { /** * If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetPipelineRunConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; /** * The type of pipeline. */ type: string; } interface GetPipelineRunConfigurationOverrideDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; /** * The type of pipeline. */ type: string; } interface GetPipelineRunInfrastructureConfigurationOverrideDetail { /** * The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.GetPipelineRunInfrastructureConfigurationOverrideDetailShapeConfigDetail[]; /** * The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface GetPipelineRunInfrastructureConfigurationOverrideDetailShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineRunLogConfigurationOverrideDetail { /** * If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * The log group id for where log objects will be for pipeline runs. */ logGroupId: string; /** * The log id of the log object the pipeline run logs will be shipped to. */ logId: string; } interface GetPipelineRunLogDetail { /** * The log group id for where log objects will be for pipeline runs. */ logGroupId: string; /** * The log id of the log object the pipeline run logs will be shipped to. */ logId: string; } interface GetPipelineRunStepOverrideDetail { /** * The configuration details of a step. */ stepConfigurationDetails: outputs.DataScience.GetPipelineRunStepOverrideDetailStepConfigurationDetail[]; /** * Container Details for a step in pipeline. */ stepContainerConfigurationDetails: outputs.DataScience.GetPipelineRunStepOverrideDetailStepContainerConfigurationDetail[]; /** * The configuration details of a Dataflow step. */ stepDataflowConfigurationDetails: outputs.DataScience.GetPipelineRunStepOverrideDetailStepDataflowConfigurationDetail[]; /** * The infrastructure configuration details of a pipeline or a step. */ stepInfrastructureConfigurationDetails: outputs.DataScience.GetPipelineRunStepOverrideDetailStepInfrastructureConfigurationDetail[]; /** * The name of the step. */ stepName: string; /** * The storage mount details to mount to the instance running the pipeline step. */ stepStorageMountConfigurationDetailsLists: outputs.DataScience.GetPipelineRunStepOverrideDetailStepStorageMountConfigurationDetailsList[]; } interface GetPipelineRunStepOverrideDetailStepConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface GetPipelineRunStepOverrideDetailStepContainerConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The type of container. */ containerType: string; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; } interface GetPipelineRunStepOverrideDetailStepDataflowConfigurationDetail { /** * The Spark configuration passed to the running process. */ configuration: { [key: string]: string; }; /** * The VM shape for the driver. */ driverShape: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ driverShapeConfigDetails: outputs.DataScience.GetPipelineRunStepOverrideDetailStepDataflowConfigurationDetailDriverShapeConfigDetail[]; /** * The VM shape for the executors. */ executorShape: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ executorShapeConfigDetails: outputs.DataScience.GetPipelineRunStepOverrideDetailStepDataflowConfigurationDetailExecutorShapeConfigDetail[]; /** * An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. */ logsBucketUri: string; /** * The number of executor VMs requested. */ numExecutors: number; /** * An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. */ warehouseBucketUri: string; } interface GetPipelineRunStepOverrideDetailStepDataflowConfigurationDetailDriverShapeConfigDetail { /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineRunStepOverrideDetailStepDataflowConfigurationDetailExecutorShapeConfigDetail { /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineRunStepOverrideDetailStepInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.GetPipelineRunStepOverrideDetailStepInfrastructureConfigurationDetailShapeConfigDetail[]; /** * The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface GetPipelineRunStepOverrideDetailStepInfrastructureConfigurationDetailShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineRunStepOverrideDetailStepStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetPipelineRunStepRun { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dataflow run triggered for this step run. */ dataflowRunId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run triggered for this step run. */ jobRunId: string; /** * Details of the state of the step run. */ lifecycleDetails: string; /** * The state of the step run. */ state: string; /** * The name of the step. */ stepName: string; /** * Name used when creating the steprun. */ stepRunName: string; /** * The type of step. */ stepType: string; /** * The date and time the pipeline run request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeFinished: string; /** * The date and time the pipeline run request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStarted: string; } interface GetPipelineRunStorageMountConfigurationOverrideDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetPipelineRunsFilter { name: string; regex?: boolean; values: string[]; } interface GetPipelineRunsPipelineRun { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The configuration details of a pipeline. */ configurationDetails: outputs.DataScience.GetPipelineRunsPipelineRunConfigurationDetail[]; /** * The configuration details of a pipeline. */ configurationOverrideDetails: outputs.DataScience.GetPipelineRunsPipelineRunConfigurationOverrideDetail[]; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; deleteRelatedJobRuns: boolean; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * The infrastructure configuration details of a pipeline or a step. */ infrastructureConfigurationOverrideDetails: outputs.DataScience.GetPipelineRunsPipelineRunInfrastructureConfigurationOverrideDetail[]; /** * Details of the state of the step run. */ lifecycleDetails: string; /** * The pipeline log configuration details. */ logConfigurationOverrideDetails: outputs.DataScience.GetPipelineRunsPipelineRunLogConfigurationOverrideDetail[]; /** * Customer logging details for pipeline run. */ logDetails: outputs.DataScience.GetPipelineRunsPipelineRunLogDetail[]; opcParentRptUrl: string; /** * Parameters override used in the pipeline run. */ parametersOverride: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. */ pipelineId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the pipeline run with. */ projectId: string; /** * The current state of the PipelineRun. */ state: string; /** * Array of step override details. Only Step Configuration is allowed to be overridden. */ stepOverrideDetails: outputs.DataScience.GetPipelineRunsPipelineRunStepOverrideDetail[]; /** * Array of StepRun object for each step. */ stepRuns: outputs.DataScience.GetPipelineRunsPipelineRunStepRun[]; /** * The storage mount override details to mount to the instance running the pipeline step. */ storageMountConfigurationOverrideDetailsLists: outputs.DataScience.GetPipelineRunsPipelineRunStorageMountConfigurationOverrideDetailsList[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the pipeline run was accepted in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeAccepted: string; /** * The date and time the pipeline run request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeFinished: string; /** * The date and time the pipeline run request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStarted: string; /** * The date and time the pipeline run was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetPipelineRunsPipelineRunConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; /** * The type of pipeline. */ type: string; } interface GetPipelineRunsPipelineRunConfigurationOverrideDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; /** * The type of pipeline. */ type: string; } interface GetPipelineRunsPipelineRunInfrastructureConfigurationOverrideDetail { /** * The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.GetPipelineRunsPipelineRunInfrastructureConfigurationOverrideDetailShapeConfigDetail[]; /** * The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface GetPipelineRunsPipelineRunInfrastructureConfigurationOverrideDetailShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineRunsPipelineRunLogConfigurationOverrideDetail { /** * If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * The log group id for where log objects will be for pipeline runs. */ logGroupId: string; /** * The log id of the log object the pipeline run logs will be shipped to. */ logId: string; } interface GetPipelineRunsPipelineRunLogDetail { /** * The log group id for where log objects will be for pipeline runs. */ logGroupId: string; /** * The log id of the log object the pipeline run logs will be shipped to. */ logId: string; } interface GetPipelineRunsPipelineRunStepOverrideDetail { /** * The configuration details of a step. */ stepConfigurationDetails: outputs.DataScience.GetPipelineRunsPipelineRunStepOverrideDetailStepConfigurationDetail[]; /** * Container Details for a step in pipeline. */ stepContainerConfigurationDetails: outputs.DataScience.GetPipelineRunsPipelineRunStepOverrideDetailStepContainerConfigurationDetail[]; /** * The configuration details of a Dataflow step. */ stepDataflowConfigurationDetails: outputs.DataScience.GetPipelineRunsPipelineRunStepOverrideDetailStepDataflowConfigurationDetail[]; /** * The infrastructure configuration details of a pipeline or a step. */ stepInfrastructureConfigurationDetails: outputs.DataScience.GetPipelineRunsPipelineRunStepOverrideDetailStepInfrastructureConfigurationDetail[]; /** * The name of the step. */ stepName: string; /** * The storage mount details to mount to the instance running the pipeline step. */ stepStorageMountConfigurationDetailsLists: outputs.DataScience.GetPipelineRunsPipelineRunStepOverrideDetailStepStorageMountConfigurationDetailsList[]; } interface GetPipelineRunsPipelineRunStepOverrideDetailStepConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface GetPipelineRunsPipelineRunStepOverrideDetailStepContainerConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The type of container. */ containerType: string; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; } interface GetPipelineRunsPipelineRunStepOverrideDetailStepDataflowConfigurationDetail { /** * The Spark configuration passed to the running process. */ configuration: { [key: string]: string; }; /** * The VM shape for the driver. */ driverShape: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ driverShapeConfigDetails: outputs.DataScience.GetPipelineRunsPipelineRunStepOverrideDetailStepDataflowConfigurationDetailDriverShapeConfigDetail[]; /** * The VM shape for the executors. */ executorShape: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ executorShapeConfigDetails: outputs.DataScience.GetPipelineRunsPipelineRunStepOverrideDetailStepDataflowConfigurationDetailExecutorShapeConfigDetail[]; /** * An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. */ logsBucketUri: string; /** * The number of executor VMs requested. */ numExecutors: number; /** * An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. */ warehouseBucketUri: string; } interface GetPipelineRunsPipelineRunStepOverrideDetailStepDataflowConfigurationDetailDriverShapeConfigDetail { /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineRunsPipelineRunStepOverrideDetailStepDataflowConfigurationDetailExecutorShapeConfigDetail { /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineRunsPipelineRunStepOverrideDetailStepInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.GetPipelineRunsPipelineRunStepOverrideDetailStepInfrastructureConfigurationDetailShapeConfigDetail[]; /** * The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface GetPipelineRunsPipelineRunStepOverrideDetailStepInfrastructureConfigurationDetailShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineRunsPipelineRunStepOverrideDetailStepStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetPipelineRunsPipelineRunStepRun { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dataflow run triggered for this step run. */ dataflowRunId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run triggered for this step run. */ jobRunId: string; /** * Details of the state of the step run. */ lifecycleDetails: string; /** * The current state of the PipelineRun. */ state: string; /** * The name of the step. */ stepName: string; /** * Name used when creating the steprun. */ stepRunName: string; /** * The type of step. */ stepType: string; /** * The date and time the pipeline run request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeFinished: string; /** * The date and time the pipeline run request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStarted: string; } interface GetPipelineRunsPipelineRunStorageMountConfigurationOverrideDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetPipelineStepArtifact { artifactContentDisposition: string; artifactContentLength: string; artifactContentMd5: string; artifactLastModified: string; pipelineStepArtifact: string; /** * The name of the step. It must be unique within the pipeline. This is used to create the pipeline DAG. */ stepName: string; } interface GetPipelineStepDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dataflow application to be used as a step. */ applicationId: string; /** * The list of step names this current step depends on for execution. */ dependsOns: string[]; /** * A short description of the step. */ description: string; /** * A flag to indicate whether the artifact has been uploaded for this step or not. */ isArtifactUploaded: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job to be used as a step. */ jobId: string; /** * The configuration details of a step. */ stepConfigurationDetails: outputs.DataScience.GetPipelineStepDetailStepConfigurationDetail[]; /** * Container Details for a step in pipeline. */ stepContainerConfigurationDetails: outputs.DataScience.GetPipelineStepDetailStepContainerConfigurationDetail[]; /** * The configuration details of a Dataflow step. */ stepDataflowConfigurationDetails: outputs.DataScience.GetPipelineStepDetailStepDataflowConfigurationDetail[]; /** * The infrastructure configuration details of a pipeline or a step. */ stepInfrastructureConfigurationDetails: outputs.DataScience.GetPipelineStepDetailStepInfrastructureConfigurationDetail[]; /** * The name of the step. It must be unique within the pipeline. This is used to create the pipeline DAG. */ stepName: string; /** * Pipeline step parameter details */ stepParameters: outputs.DataScience.GetPipelineStepDetailStepParameter[]; /** * Name used when creating the steprun. */ stepRunName: string; /** * The storage mount details to mount to the instance running the pipeline step. */ stepStorageMountConfigurationDetailsLists: outputs.DataScience.GetPipelineStepDetailStepStorageMountConfigurationDetailsList[]; /** * The type of step. */ stepType: string; } interface GetPipelineStepDetailStepConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface GetPipelineStepDetailStepContainerConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The type of container. */ containerType: string; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; } interface GetPipelineStepDetailStepDataflowConfigurationDetail { /** * The Spark configuration passed to the running process. */ configuration: { [key: string]: string; }; /** * The VM shape for the driver. */ driverShape: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ driverShapeConfigDetails: outputs.DataScience.GetPipelineStepDetailStepDataflowConfigurationDetailDriverShapeConfigDetail[]; /** * The VM shape for the executors. */ executorShape: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ executorShapeConfigDetails: outputs.DataScience.GetPipelineStepDetailStepDataflowConfigurationDetailExecutorShapeConfigDetail[]; /** * An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. */ logsBucketUri: string; /** * The number of executor VMs requested. */ numExecutors: number; /** * An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. */ warehouseBucketUri: string; } interface GetPipelineStepDetailStepDataflowConfigurationDetailDriverShapeConfigDetail { /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineStepDetailStepDataflowConfigurationDetailExecutorShapeConfigDetail { /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineStepDetailStepInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.GetPipelineStepDetailStepInfrastructureConfigurationDetailShapeConfigDetail[]; /** * The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface GetPipelineStepDetailStepInfrastructureConfigurationDetailShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelineStepDetailStepParameter { /** * Pipeline output parameter details */ outputs: outputs.DataScience.GetPipelineStepDetailStepParameterOutput[]; /** * Type of step parameter */ parameterType: string; } interface GetPipelineStepDetailStepParameterOutput { /** * Output file name */ outputFile: string; /** * Type of output parameters */ outputParameterType: string; /** * The list of parameter names that will be output by this step */ parameterNames: string[]; } interface GetPipelineStepDetailStepStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetPipelineStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetPipelinesFilter { name: string; regex?: boolean; values: string[]; } interface GetPipelinesPipeline { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The configuration details of a pipeline. */ configurationDetails: outputs.DataScience.GetPipelinesPipelineConfigurationDetail[]; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; deleteRelatedPipelineRuns: boolean; /** * A short description of the step. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * The infrastructure configuration details of a pipeline or a step. */ infrastructureConfigurationDetails: outputs.DataScience.GetPipelinesPipelineInfrastructureConfigurationDetail[]; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state. */ lifecycleDetails: string; /** * The pipeline log configuration details. */ logConfigurationDetails: outputs.DataScience.GetPipelinesPipelineLogConfigurationDetail[]; /** * Parameters used in the pipeline. */ parameters: { [key: string]: string; }; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * The current state of the Pipeline. */ state: string; stepArtifacts: outputs.DataScience.GetPipelinesPipelineStepArtifact[]; /** * Array of step details for each step. */ stepDetails: outputs.DataScience.GetPipelinesPipelineStepDetail[]; /** * The storage mount details to mount to the instance running the pipeline step. */ storageMountConfigurationDetailsLists: outputs.DataScience.GetPipelinesPipelineStorageMountConfigurationDetailsList[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z */ timeCreated: string; /** * The date and time the resource was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2020-08-06T21:10:29.41Z */ timeUpdated: string; } interface GetPipelinesPipelineConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; /** * The type of pipeline. */ type: string; } interface GetPipelinesPipelineInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.GetPipelinesPipelineInfrastructureConfigurationDetailShapeConfigDetail[]; /** * The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface GetPipelinesPipelineInfrastructureConfigurationDetailShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelinesPipelineLogConfigurationDetail { /** * If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetPipelinesPipelineStepArtifact { artifactContentDisposition: string; artifactContentLength: string; artifactContentMd5: string; artifactLastModified: string; pipelineStepArtifact: string; /** * The name of the step. It must be unique within the pipeline. This is used to create the pipeline DAG. */ stepName: string; } interface GetPipelinesPipelineStepDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dataflow application to be used as a step. */ applicationId: string; /** * The list of step names this current step depends on for execution. */ dependsOns: string[]; /** * A short description of the step. */ description: string; /** * A flag to indicate whether the artifact has been uploaded for this step or not. */ isArtifactUploaded: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job to be used as a step. */ jobId: string; /** * The configuration details of a step. */ stepConfigurationDetails: outputs.DataScience.GetPipelinesPipelineStepDetailStepConfigurationDetail[]; /** * Container Details for a step in pipeline. */ stepContainerConfigurationDetails: outputs.DataScience.GetPipelinesPipelineStepDetailStepContainerConfigurationDetail[]; /** * The configuration details of a Dataflow step. */ stepDataflowConfigurationDetails: outputs.DataScience.GetPipelinesPipelineStepDetailStepDataflowConfigurationDetail[]; /** * The infrastructure configuration details of a pipeline or a step. */ stepInfrastructureConfigurationDetails: outputs.DataScience.GetPipelinesPipelineStepDetailStepInfrastructureConfigurationDetail[]; /** * The name of the step. It must be unique within the pipeline. This is used to create the pipeline DAG. */ stepName: string; /** * Pipeline step parameter details */ stepParameters: outputs.DataScience.GetPipelinesPipelineStepDetailStepParameter[]; /** * Name used when creating the steprun. */ stepRunName: string; /** * The storage mount details to mount to the instance running the pipeline step. */ stepStorageMountConfigurationDetailsLists: outputs.DataScience.GetPipelinesPipelineStepDetailStepStorageMountConfigurationDetailsList[]; /** * The type of step. */ stepType: string; } interface GetPipelinesPipelineStepDetailStepConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface GetPipelinesPipelineStepDetailStepContainerConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The type of container. */ containerType: string; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; } interface GetPipelinesPipelineStepDetailStepDataflowConfigurationDetail { /** * The Spark configuration passed to the running process. */ configuration: { [key: string]: string; }; /** * The VM shape for the driver. */ driverShape: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ driverShapeConfigDetails: outputs.DataScience.GetPipelinesPipelineStepDetailStepDataflowConfigurationDetailDriverShapeConfigDetail[]; /** * The VM shape for the executors. */ executorShape: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ executorShapeConfigDetails: outputs.DataScience.GetPipelinesPipelineStepDetailStepDataflowConfigurationDetailExecutorShapeConfigDetail[]; /** * An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. */ logsBucketUri: string; /** * The number of executor VMs requested. */ numExecutors: number; /** * An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. */ warehouseBucketUri: string; } interface GetPipelinesPipelineStepDetailStepDataflowConfigurationDetailDriverShapeConfigDetail { /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelinesPipelineStepDetailStepDataflowConfigurationDetailExecutorShapeConfigDetail { /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelinesPipelineStepDetailStepInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.GetPipelinesPipelineStepDetailStepInfrastructureConfigurationDetailShapeConfigDetail[]; /** * The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface GetPipelinesPipelineStepDetailStepInfrastructureConfigurationDetailShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface GetPipelinesPipelineStepDetailStepParameter { /** * Pipeline output parameter details */ outputs: outputs.DataScience.GetPipelinesPipelineStepDetailStepParameterOutput[]; /** * Type of step parameter */ parameterType: string; } interface GetPipelinesPipelineStepDetailStepParameterOutput { /** * Output file name */ outputFile: string; /** * Type of output parameters */ outputParameterType: string; /** * The list of parameter names that will be output by this step */ parameterNames: string[]; } interface GetPipelinesPipelineStepDetailStepStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetPipelinesPipelineStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface GetPrivateEndpointsDataSciencePrivateEndpoint { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Resource types in the Data Science service such as notebooks. */ dataScienceResourceType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A user friendly description. Avoid entering confidential information. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; /** * Accesing the Data Science resource using FQDN. */ fqdn: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of a private endpoint. */ id: string; /** * Details of the state of Data Science private endpoint. */ lifecycleDetails: string; /** * An array of network security group OCIDs. */ nsgIds: string[]; /** * The lifecycle state of the private endpoint. */ state: string; subDomain: string; /** * The OCID of a subnet. */ subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time that the Data Science private endpoint was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeCreated: string; /** * The date and time that the Data Science private endpoint was updated expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeUpdated: string; } interface GetPrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetProjectsFilter { name: string; regex?: boolean; values: string[]; } interface GetProjectsProject { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A short description of the project. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type. */ id: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z */ timeCreated: string; } interface GetScheduleAction { /** * Schedule Http action details */ actionDetails: outputs.DataScience.GetScheduleActionActionDetail[]; /** * The Schedule Action type */ actionType: string; } interface GetScheduleActionActionDetail { /** * Parameters needed to create a new job run. */ createJobRunDetails: outputs.DataScience.GetScheduleActionActionDetailCreateJobRunDetail[]; /** * The information about new PipelineRun. */ createPipelineRunDetails: outputs.DataScience.GetScheduleActionActionDetailCreatePipelineRunDetail[]; /** * The type of http action to trigger. */ httpActionType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule. */ mlApplicationInstanceViewId: string; /** * Payload for trigger request endpoint */ triggerMlApplicationInstanceViewFlowDetails: outputs.DataScience.GetScheduleActionActionDetailTriggerMlApplicationInstanceViewFlowDetail[]; } interface GetScheduleActionActionDetailCreateJobRunDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the schedule. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly display name for the resource. Avoid entering confidential information. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The job configuration details */ jobConfigurationOverrideDetails: outputs.DataScience.GetScheduleActionActionDetailCreateJobRunDetailJobConfigurationOverrideDetail[]; /** * Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationOverrideDetails: outputs.DataScience.GetScheduleActionActionDetailCreateJobRunDetailJobEnvironmentConfigurationOverrideDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job to create a run for. */ jobId: string; /** * Logging configuration for resource. */ jobLogConfigurationOverrideDetails: outputs.DataScience.GetScheduleActionActionDetailCreateJobRunDetailJobLogConfigurationOverrideDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the schedule. */ projectId: string; } interface GetScheduleActionActionDetailCreateJobRunDetailJobConfigurationOverrideDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface GetScheduleActionActionDetailCreateJobRunDetailJobEnvironmentConfigurationOverrideDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface GetScheduleActionActionDetailCreateJobRunDetailJobLogConfigurationOverrideDetail { /** * If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom log to be used for Schedule logging. */ logId: string; } interface GetScheduleActionActionDetailCreatePipelineRunDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the schedule. */ compartmentId: string; /** * The configuration details of a pipeline. */ configurationOverrideDetails: outputs.DataScience.GetScheduleActionActionDetailCreatePipelineRunDetailConfigurationOverrideDetail[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly display name for the resource. Avoid entering confidential information. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The pipeline log configuration details. */ logConfigurationOverrideDetails: outputs.DataScience.GetScheduleActionActionDetailCreatePipelineRunDetailLogConfigurationOverrideDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline for which pipeline run is created. */ pipelineId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the schedule. */ projectId: string; /** * Array of step override details. Only Step Configuration is allowed to be overridden. */ stepOverrideDetails: outputs.DataScience.GetScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetail[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetScheduleActionActionDetailCreatePipelineRunDetailConfigurationOverrideDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; /** * The type of pipeline. */ type: string; } interface GetScheduleActionActionDetailCreatePipelineRunDetailLogConfigurationOverrideDetail { /** * If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom log to be used for Schedule logging. */ logId: string; } interface GetScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetail { /** * The configuration details of a step. */ stepConfigurationDetails: outputs.DataScience.GetScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetailStepConfigurationDetail[]; /** * Container Details for a step in pipeline. */ stepContainerConfigurationDetails: outputs.DataScience.GetScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetailStepContainerConfigurationDetail[]; /** * The name of the step. */ stepName: string; } interface GetScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetailStepConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface GetScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetailStepContainerConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The type of container. */ containerType: string; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; } interface GetScheduleActionActionDetailTriggerMlApplicationInstanceViewFlowDetail { /** * Parameters provided for given trigger invocation (they must match predefined schema) */ parameters: outputs.DataScience.GetScheduleActionActionDetailTriggerMlApplicationInstanceViewFlowDetailParameter[]; /** * Name of trigger */ triggerName: string; } interface GetScheduleActionActionDetailTriggerMlApplicationInstanceViewFlowDetailParameter { /** * Name of trigger parameter */ name: string; /** * Value of trigger parameter */ value: string; } interface GetScheduleLogDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom log to be used for Schedule logging. */ logId: string; } interface GetScheduleTrigger { /** * Schedule cron expression */ cronExpression: string; /** * The type of frequency */ frequency: string; /** * Maximum number of minutes after `timeStart` that the scheduler may use to randomly select the first execution time. This value is considered only when `isRandomStartTime` is true. */ initialJitterInMinutes: number; /** * The interval of frequency. */ interval: number; /** * when true and timeStart is null, system generate a random start time between now and now + interval; isRandomStartTime can be true if timeStart is null. */ isRandomStartTime: boolean; /** * This recurrence field conforms to RFC-5545 formatting */ recurrence: string; /** * The schedule end date time, if null, the schedule will never expire. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeEnd: string; /** * The schedule starting date time, if null, System set the time when schedule is created. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStart: string; /** * The schedule trigger type */ triggerType: string; } interface GetSchedulesFilter { /** * Name of trigger parameter */ name: string; regex?: boolean; values: string[]; } interface GetSchedulesSchedule { /** * The schedule action */ actions: outputs.DataScience.GetSchedulesScheduleAction[]; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the schedule. */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A short description of the schedule. */ description: string; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * unique Schedule identifier */ id: string; /** * Details about the action performed by the last schedule execution. Example: `Invoked ML Application trigger.` */ lastScheduleRunDetails: string; /** * A message describing the current state in more detail. */ lifecycleDetails: string; /** * Custom logging details for schedule execution. */ logDetails: outputs.DataScience.GetSchedulesScheduleLogDetail[]; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the schedule was created. Format is defined by RFC3339. Example: `2022-08-05T01:02:29.600Z` */ timeCreated: string; /** * The last schedule execution time. Format is defined by RFC3339. Example: `2022-08-05T01:02:29.600Z` */ timeLastScheduleRun: string; /** * The next scheduled execution time for the schedule. Format is defined by RFC3339. Example: `2022-08-05T01:02:29.600Z` */ timeNextScheduledRun: string; /** * The date and time the schedule was updated. Format is defined by RFC3339. Example: `2022-09-05T01:02:29.600Z` */ timeUpdated: string; /** * The trigger of the schedule can be UNIX cron or iCal expression or simple interval */ triggers: outputs.DataScience.GetSchedulesScheduleTrigger[]; } interface GetSchedulesScheduleAction { /** * Schedule Http action details */ actionDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetail[]; /** * The Schedule Action type */ actionType: string; } interface GetSchedulesScheduleActionActionDetail { /** * Parameters needed to create a new job run. */ createJobRunDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailCreateJobRunDetail[]; /** * The information about new PipelineRun. */ createPipelineRunDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailCreatePipelineRunDetail[]; /** * The type of http action to trigger. */ httpActionType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule. */ mlApplicationInstanceViewId: string; /** * Payload for trigger request endpoint */ triggerMlApplicationInstanceViewFlowDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailTriggerMlApplicationInstanceViewFlowDetail[]; } interface GetSchedulesScheduleActionActionDetailCreateJobRunDetail { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The job configuration details */ jobConfigurationOverrideDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailCreateJobRunDetailJobConfigurationOverrideDetail[]; /** * Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationOverrideDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailCreateJobRunDetailJobEnvironmentConfigurationOverrideDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job to create a run for. */ jobId: string; /** * Logging configuration for resource. */ jobLogConfigurationOverrideDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailCreateJobRunDetailJobLogConfigurationOverrideDetail[]; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; } interface GetSchedulesScheduleActionActionDetailCreateJobRunDetailJobConfigurationOverrideDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface GetSchedulesScheduleActionActionDetailCreateJobRunDetailJobEnvironmentConfigurationOverrideDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface GetSchedulesScheduleActionActionDetailCreateJobRunDetailJobLogConfigurationOverrideDetail { /** * If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom log to be used for Schedule logging. */ logId: string; } interface GetSchedulesScheduleActionActionDetailCreatePipelineRunDetail { /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The configuration details of a pipeline. */ configurationOverrideDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailCreatePipelineRunDetailConfigurationOverrideDetail[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Filter results by its user-friendly name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The pipeline log configuration details. */ logConfigurationOverrideDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailCreatePipelineRunDetailLogConfigurationOverrideDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline for which pipeline run is created. */ pipelineId: string; /** * Filter results by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project. */ projectId: string; /** * Array of step override details. Only Step Configuration is allowed to be overridden. */ stepOverrideDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetail[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetSchedulesScheduleActionActionDetailCreatePipelineRunDetailConfigurationOverrideDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; /** * The type of pipeline. */ type: string; } interface GetSchedulesScheduleActionActionDetailCreatePipelineRunDetailLogConfigurationOverrideDetail { /** * If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom log to be used for Schedule logging. */ logId: string; } interface GetSchedulesScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetail { /** * The configuration details of a step. */ stepConfigurationDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetailStepConfigurationDetail[]; /** * Container Details for a step in pipeline. */ stepContainerConfigurationDetails: outputs.DataScience.GetSchedulesScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetailStepContainerConfigurationDetail[]; /** * The name of the step. */ stepName: string; } interface GetSchedulesScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetailStepConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface GetSchedulesScheduleActionActionDetailCreatePipelineRunDetailStepOverrideDetailStepContainerConfigurationDetail { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The type of container. */ containerType: string; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; } interface GetSchedulesScheduleActionActionDetailTriggerMlApplicationInstanceViewFlowDetail { /** * Parameters provided for given trigger invocation (they must match predefined schema) */ parameters: outputs.DataScience.GetSchedulesScheduleActionActionDetailTriggerMlApplicationInstanceViewFlowDetailParameter[]; /** * Name of trigger */ triggerName: string; } interface GetSchedulesScheduleActionActionDetailTriggerMlApplicationInstanceViewFlowDetailParameter { /** * Name of trigger parameter */ name: string; /** * Value of trigger parameter */ value: string; } interface GetSchedulesScheduleLogDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom log to be used for Schedule logging. */ logId: string; } interface GetSchedulesScheduleTrigger { /** * Schedule cron expression */ cronExpression: string; /** * The type of frequency */ frequency: string; /** * Maximum number of minutes after `timeStart` that the scheduler may use to randomly select the first execution time. This value is considered only when `isRandomStartTime` is true. */ initialJitterInMinutes: number; /** * The interval of frequency. */ interval: number; /** * when true and timeStart is null, system generate a random start time between now and now + interval; isRandomStartTime can be true if timeStart is null. */ isRandomStartTime: boolean; /** * This recurrence field conforms to RFC-5545 formatting */ recurrence: string; /** * The schedule end date time, if null, the schedule will never expire. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeEnd: string; /** * The schedule starting date time, if null, System set the time when schedule is created. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStart: string; /** * The schedule trigger type */ triggerType: string; } interface JobJobConfigurationDetails { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job. Timer starts when the job becomes active. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.JobJobConfigurationDetailsStartupProbeDetails; } interface JobJobConfigurationDetailsStartupProbeDetails { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold?: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds?: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds?: number; } interface JobJobEnvironmentConfigurationDetails { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds?: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints?: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest?: string; /** * OCID of the container image signature */ imageSignatureId?: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface JobJobInfrastructureConfigurationDetails { /** * (Updatable) The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * (Updatable) The infrastructure type used for job run. */ jobInfrastructureType: string; /** * (Updatable) Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.JobJobInfrastructureConfigurationDetailsJobShapeConfigDetails; /** * (Updatable) Details for the compute target job resource configuration. */ resourceConfiguration: outputs.DataScience.JobJobInfrastructureConfigurationDetailsResourceConfiguration; /** * (Updatable) The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * (Updatable) The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface JobJobInfrastructureConfigurationDetailsJobShapeConfigDetails { /** * (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * (Updatable) The total amount of memory available to the job run instance, in gigabytes. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs available to the job run instance. */ ocpus: number; } interface JobJobInfrastructureConfigurationDetailsResourceConfiguration { /** * (Updatable) Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfiguration: outputs.DataScience.JobJobInfrastructureConfigurationDetailsResourceConfigurationResourceLimitConfiguration; /** * (Updatable) Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfiguration: outputs.DataScience.JobJobInfrastructureConfigurationDetailsResourceConfigurationResourceRequestConfiguration; } interface JobJobInfrastructureConfigurationDetailsResourceConfigurationResourceLimitConfiguration { /** * (Updatable) Burstable limit for memory. */ memoryInGbs: number; /** * (Updatable) Burstable limit for cpu. */ ocpus: number; } interface JobJobInfrastructureConfigurationDetailsResourceConfigurationResourceRequestConfiguration { /** * (Updatable) The total number of gpus required to be allocated to the workload. */ gpus: number; /** * (Updatable) The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * (Updatable) The ocpus required to be allocated to run the workload. */ ocpus: number; } interface JobJobLogConfigurationDetails { /** * If automatic on-behalf-of log object creation is enabled for job runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for job runs. */ enableLogging: boolean; /** * The log group id for where log objects are for job runs. */ logGroupId: string; /** * The log id the job run will push logs too. */ logId: string; } interface JobJobNodeConfigurationDetails { /** * The job network configuration details */ jobNetworkConfiguration: outputs.DataScience.JobJobNodeConfigurationDetailsJobNetworkConfiguration; /** * List of JobNodeGroupConfigurationDetails */ jobNodeGroupConfigurationDetailsLists: outputs.DataScience.JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsList[]; /** * The node type used for job run. */ jobNodeType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The execution order of node groups */ startupOrder: string; } interface JobJobNodeConfigurationDetailsJobNetworkConfiguration { /** * job network type */ jobNetworkType: string; /** * The custom subnet id */ subnetId: string; } interface JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsList { /** * The job configuration details */ jobConfigurationDetails: outputs.DataScience.JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobConfigurationDetails; /** * Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationDetails: outputs.DataScience.JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetails; /** * The job infrastructure configuration details (shape, block storage, etc.) */ jobInfrastructureConfigurationDetails: outputs.DataScience.JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetails; /** * The minimum threshold of successful replicas for node group to be successful. All replicas need to succeed if this is not specified. */ minimumSuccessReplicas: number; /** * node group name. */ name: string; /** * The number of nodes. */ replicas: number; } interface JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobConfigurationDetails { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job. Timer starts when the job becomes active. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobConfigurationDetailsStartupProbeDetails; } interface JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobConfigurationDetailsStartupProbeDetails { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetails { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetails { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsJobShapeConfigDetails; /** * Details for the compute target job resource configuration. */ resourceConfiguration: outputs.DataScience.JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfiguration; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsJobShapeConfigDetails { /** * (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the job run instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the job run instance. */ ocpus: number; } interface JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfiguration: outputs.DataScience.JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfigurationResourceLimitConfiguration; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfiguration: outputs.DataScience.JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfigurationResourceRequestConfiguration; } interface JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfigurationResourceLimitConfiguration { /** * Burstable limit for memory. */ memoryInGbs: number; /** * Burstable limit for cpu. */ ocpus: number; } interface JobJobNodeConfigurationDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface JobJobStorageMountConfigurationDetailsList { /** * (Updatable) The object storage bucket */ bucket: string; /** * (Updatable) The local directory name to be mounted */ destinationDirectoryName: string; /** * (Updatable) The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * (Updatable) OCID of the export */ exportId: string; /** * (Updatable) OCID of the mount target */ mountTargetId: string; /** * (Updatable) The object storage namespace */ namespace: string; /** * (Updatable) Prefix in the bucket to mount */ prefix: string; /** * (Updatable) The type of storage. */ storageType: string; } interface JobRunJobConfigurationOverrideDetails { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job. Timer starts when the job becomes active. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.JobRunJobConfigurationOverrideDetailsStartupProbeDetails; } interface JobRunJobConfigurationOverrideDetailsStartupProbeDetails { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface JobRunJobEnvironmentConfigurationOverrideDetails { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface JobRunJobInfrastructureConfigurationDetail { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.JobRunJobInfrastructureConfigurationDetailJobShapeConfigDetail[]; /** * Details for the compute target job resource configuration. */ resourceConfigurations: outputs.DataScience.JobRunJobInfrastructureConfigurationDetailResourceConfiguration[]; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface JobRunJobInfrastructureConfigurationDetailJobShapeConfigDetail { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface JobRunJobInfrastructureConfigurationDetailResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfigurations: outputs.DataScience.JobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration[]; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfigurations: outputs.DataScience.JobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration[]; } interface JobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceLimitConfiguration { /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface JobRunJobInfrastructureConfigurationDetailResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface JobRunJobInfrastructureConfigurationOverrideDetails { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.JobRunJobInfrastructureConfigurationOverrideDetailsJobShapeConfigDetails; /** * Details for the compute target job resource configuration. */ resourceConfiguration: outputs.DataScience.JobRunJobInfrastructureConfigurationOverrideDetailsResourceConfiguration; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface JobRunJobInfrastructureConfigurationOverrideDetailsJobShapeConfigDetails { /** * The total amount of memory available to the job run instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the job run instance. */ ocpus: number; } interface JobRunJobInfrastructureConfigurationOverrideDetailsResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfiguration: outputs.DataScience.JobRunJobInfrastructureConfigurationOverrideDetailsResourceConfigurationResourceLimitConfiguration; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfiguration: outputs.DataScience.JobRunJobInfrastructureConfigurationOverrideDetailsResourceConfigurationResourceRequestConfiguration; } interface JobRunJobInfrastructureConfigurationOverrideDetailsResourceConfigurationResourceLimitConfiguration { /** * Burstable limit for memory. */ memoryInGbs: number; /** * Burstable limit for cpu. */ ocpus: number; } interface JobRunJobInfrastructureConfigurationOverrideDetailsResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface JobRunJobLogConfigurationOverrideDetails { /** * If automatic on-behalf-of log object creation is enabled for job runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for job runs. */ enableLogging: boolean; /** * The log group id for where log objects are for job runs. */ logGroupId: string; /** * The log id the job run will push logs too. */ logId: string; } interface JobRunJobNodeConfigurationOverrideDetails { /** * The job network configuration details */ jobNetworkConfiguration: outputs.DataScience.JobRunJobNodeConfigurationOverrideDetailsJobNetworkConfiguration; /** * List of JobNodeGroupConfigurationDetails */ jobNodeGroupConfigurationDetailsLists: outputs.DataScience.JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsList[]; /** * The node type used for job run. */ jobNodeType: string; /** * A time bound for the execution of the job run. Timer starts when the job run is in progress. */ maximumRuntimeInMinutes: string; /** * The execution order of node groups */ startupOrder: string; } interface JobRunJobNodeConfigurationOverrideDetailsJobNetworkConfiguration { /** * job network type */ jobNetworkType: string; /** * The custom subnet id */ subnetId: string; } interface JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsList { /** * The job configuration details */ jobConfigurationDetails: outputs.DataScience.JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobConfigurationDetails; /** * Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationDetails: outputs.DataScience.JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetails; /** * The job infrastructure configuration details (shape, block storage, etc.) */ jobInfrastructureConfigurationDetails: outputs.DataScience.JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetails; /** * The minimum threshold of successful replicas for node group to be successful. All replicas need to succeed if this is not specified. */ minimumSuccessReplicas: number; /** * node group name. */ name: string; /** * The number of nodes. */ replicas: number; } interface JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobConfigurationDetails { /** * The arguments to pass to the job. */ commandLineArguments: string; /** * Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * The type of job. */ jobType: string; /** * A time bound for the execution of the job. Timer starts when the job becomes active. */ maximumRuntimeInMinutes: string; /** * The probe indicates whether the application within the job run has started. */ startupProbeDetails: outputs.DataScience.JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobConfigurationDetailsStartupProbeDetails; } interface JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobConfigurationDetailsStartupProbeDetails { /** * The commands to run in the target job run to perform the startup probe */ commands: string[]; /** * How many times the job will try before giving up when a probe fails. */ failureThreshold: number; /** * Number of seconds after the job run has started before a startup probe is initiated. */ initialDelayInSeconds: number; /** * The probe check type to perform the startup probe and specifies the type of health check for a job. */ jobProbeCheckType: string; /** * Number of seconds how often the job run should perform a startup probe */ periodInSeconds: number; } interface JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobEnvironmentConfigurationDetails { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; /** * The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetails { /** * The size of the block storage volume to attach to the instance running the job */ blockStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute target. */ computeTargetId: string; /** * The infrastructure type used for job run. */ jobInfrastructureType: string; /** * Details for the job run shape configuration. Specify only when a flex shape is selected. */ jobShapeConfigDetails: outputs.DataScience.JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsJobShapeConfigDetails; /** * Details for the compute target job resource configuration. */ resourceConfiguration: outputs.DataScience.JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfiguration; /** * The name that corresponds to the JobShapeSummary to use for the job node */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the job */ subnetId: string; } interface JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsJobShapeConfigDetails { /** * The total amount of memory available to the job run instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the job run instance. */ ocpus: number; } interface JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfiguration { /** * Resource limit configuration details for workload on managed compute cluster type compute target */ resourceLimitConfiguration: outputs.DataScience.JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfigurationResourceLimitConfiguration; /** * Resource request configuration to run workload on managed compute cluster type compute target compute target. */ resourceRequestConfiguration: outputs.DataScience.JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfigurationResourceRequestConfiguration; } interface JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfigurationResourceLimitConfiguration { /** * Burstable limit for memory. */ memoryInGbs: number; /** * Burstable limit for cpu. */ ocpus: number; } interface JobRunJobNodeConfigurationOverrideDetailsJobNodeGroupConfigurationDetailsListJobInfrastructureConfigurationDetailsResourceConfigurationResourceRequestConfiguration { /** * The total number of gpus required to be allocated to the workload. */ gpus: number; /** * The memory in Gbs required to be allocated to run the workload. */ memoryInGbs: number; /** * The ocpus required to be allocated to run the workload. */ ocpus: number; } interface JobRunJobStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface JobRunLogDetail { /** * The log group id for where log objects will be for job runs. */ logGroupId: string; /** * The log id of the log object the job run logs will be shipped to. */ logId: string; } interface JobRunNodeGroupDetailsList { /** * The state details of the node group. */ lifecycleDetails: string; /** * node group name. */ name: string; /** * The state of the job run. */ state: string; } interface MlApplicationImplementationApplicationComponent { /** * OCID of Data Flow Application */ applicationId: string; /** * Name of application component */ componentName: string; /** * The OCID of the MlApplicationImplementation. Unique identifier that is immutable after creation. */ id: string; /** * OCID of Data Science Job */ jobId: string; /** * OCID of Data Science Model */ modelId: string; /** * ML Application Implementation name which is unique for given ML Application. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ name: string; /** * OCID of Data Science Pipeline */ pipelineId: string; /** * Type of the resource */ resourceType: string; /** * type of the argument */ type: string; } interface MlApplicationImplementationConfigurationSchema { /** * The default value for the optional configuration property (it must not be specified for mandatory configuration properties) */ defaultValue: string; /** * short description of the argument */ description: string; /** * argument is mandatory or not */ isMandatory: boolean; /** * Name of key (parameter name) */ keyName: string; /** * Sample property value (it must match validationRegexp if it is specified) */ sampleValue: string; /** * A regular expression will be used for the validation of property value. */ validationRegexp: string; /** * Type of value */ valueType: string; } interface MlApplicationImplementationLogging { /** * (Updatable) Log configuration details for particular areas of ML Application Implementation. */ aggregatedInstanceViewLog: outputs.DataScience.MlApplicationImplementationLoggingAggregatedInstanceViewLog; /** * (Updatable) Log configuration details for particular areas of ML Application Implementation. */ implementationLog: outputs.DataScience.MlApplicationImplementationLoggingImplementationLog; /** * (Updatable) Log configuration details for particular areas of ML Application Implementation. */ triggerLog: outputs.DataScience.MlApplicationImplementationLoggingTriggerLog; } interface MlApplicationImplementationLoggingAggregatedInstanceViewLog { /** * (Updatable) If logging is enabled. */ enableLogging: boolean; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface MlApplicationImplementationLoggingImplementationLog { /** * (Updatable) If logging is enabled. */ enableLogging: boolean; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface MlApplicationImplementationLoggingTriggerLog { /** * (Updatable) If logging is enabled. */ enableLogging: boolean; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface MlApplicationImplementationMlApplicationPackageArgument { /** * Array of the ML Application package arguments */ arguments: outputs.DataScience.MlApplicationImplementationMlApplicationPackageArgumentArgument[]; } interface MlApplicationImplementationMlApplicationPackageArgumentArgument { /** * short description of the argument */ description: string; /** * argument is mandatory or not */ isMandatory: boolean; /** * ML Application Implementation name which is unique for given ML Application. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ name: string; /** * type of the argument */ type: string; /** * Argument value */ value: string; } interface MlApplicationInstanceAuthConfiguration { /** * Type of AuthN/Z */ type: string; } interface MlApplicationInstanceConfiguration { /** * (Updatable) Key of configuration property */ key: string; /** * (Updatable) Value of configuration property */ value: string; } interface MlApplicationInstancePredictionEndpointDetail { /** * Base URI of prediction router. */ basePredictionUri: string; /** * Array of all prediction URIs per use-case. */ predictionUris: outputs.DataScience.MlApplicationInstancePredictionEndpointDetailPredictionUri[]; } interface MlApplicationInstancePredictionEndpointDetailPredictionUri { /** * Prediction URI. */ uri: string; /** * Prediction use-case. */ useCase: string; } interface ModelBackupOperationDetail { /** * The backup status of the model. */ backupState: string; /** * The backup execution status details of the model. */ backupStateDetails: string; /** * The last backup execution time of the model. */ timeLastBackup: string; } interface ModelBackupSetting { /** * (Updatable) Oracle Cloud Infrastructure backup region for the model. */ backupRegion: string; /** * (Updatable) Customer notification on backup success/failure events. */ customerNotificationType: string; /** * (Updatable) Boolean flag representing whether backup needs to be enabled/disabled for the model. */ isBackupEnabled: boolean; } interface ModelCustomMetadataList { /** * (Updatable) Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other". */ category: string; /** * (Updatable) Description of model metadata */ description: string; /** * (Updatable) Is there any artifact present for the metadata. */ hasArtifact: boolean; /** * (Updatable) Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys: * * useCaseType * * libraryName * * libraryVersion * * estimatorClass * * hyperParameters * * testArtifactresults * * fineTuningConfiguration * * deploymentConfiguration * * readme * * license * * evaluationConfiguration */ key: string; /** * (Updatable) list of keywords for searching */ keywords: string[]; /** * (Updatable) Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other * * Allowed values for libraryName: scikit-learn, xgboost, tensorflow, pytorch, mxnet, keras, lightGBM, pymc3, pyOD, spacy, prophet, sktime, statsmodels, cuml, oracle_automl, h2o, transformers, nltk, emcee, pystan, bert, gensim, flair, word2vec, ensemble, other */ value: string; } interface ModelDefinedMetadataList { /** * (Updatable) Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,Reports,Readme,other". */ category: string; /** * (Updatable) Description of model metadata */ description: string; /** * (Updatable) Is there any artifact present for the metadata. */ hasArtifact: boolean; /** * (Updatable) Key of the model Metadata. The key can either be user defined or Oracle Cloud Infrastructure defined. List of Oracle Cloud Infrastructure defined keys: * * useCaseType * * libraryName * * libraryVersion * * estimatorClass * * hyperParameters * * testArtifactresults * * fineTuningConfiguration * * deploymentConfiguration * * readme * * license * * evaluationConfiguration */ key: string; /** * (Updatable) list of keywords for searching */ keywords: string[]; /** * (Updatable) Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other * * Allowed values for libraryName: scikit-learn, xgboost, tensorflow, pytorch, mxnet, keras, lightGBM, pymc3, pyOD, spacy, prophet, sktime, statsmodels, cuml, oracle_automl, h2o, transformers, nltk, emcee, pystan, bert, gensim, flair, word2vec, ensemble, other */ value: string; } interface ModelDeploymentCategoryLogDetails { /** * (Updatable) The log details. */ access: outputs.DataScience.ModelDeploymentCategoryLogDetailsAccess; /** * (Updatable) The log details. */ predict: outputs.DataScience.ModelDeploymentCategoryLogDetailsPredict; } interface ModelDeploymentCategoryLogDetailsAccess { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log group to work with. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log to work with. */ logId: string; } interface ModelDeploymentCategoryLogDetailsPredict { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log group to work with. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a log to work with. */ logId: string; } interface ModelDeploymentModelDeploymentConfigurationDetails { /** * (Updatable) The type of the model deployment. */ deploymentType: string; /** * (Updatable) The configuration to carry the environment details thats used in Model Deployment creation */ environmentConfigurationDetails: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsEnvironmentConfigurationDetails; /** * The infrastructure configuration details. */ infrastructureConfigurationDetails: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetails; /** * (Updatable) The model configuration details. */ modelConfigurationDetails: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetails; /** * (Updatable) The model group configuration details. */ modelGroupConfigurationDetails: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsModelGroupConfigurationDetails; } interface ModelDeploymentModelDeploymentConfigurationDetailsEnvironmentConfigurationDetails { /** * (Updatable) The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * (Updatable) List of custom inference HTTP endpoints configured on the model deployment instance for inferencing. */ customHttpEndpoints: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsEnvironmentConfigurationDetailsCustomHttpEndpoint[]; /** * Service injected Environment variables set for the web server container and can not be set or modified by user. */ defaultEnvironmentVariables: { [key: string]: string; }; /** * (Updatable) The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * (Updatable) The environment configuration type */ environmentConfigurationType: string; /** * (Updatable) Environment variables to set for the web server container. The size of envVars must be less than 2048 bytes. Key should be under 32 characters. Key should contain only letters, digits and underscore (_) Key should start with a letter. Key should have at least 2 characters. Key should not end with underscore eg. `TEST_` Key if added cannot be empty. Value can be empty. No specific size limits on individual Values. But overall environment variables is limited to 2048 bytes. Key can't be reserved Model Deployment environment variables. */ environmentVariables: { [key: string]: string; }; /** * (Updatable) The port on which the container [HEALTHCHECK](https://docs.docker.com/engine/reference/builder/#healthcheck) would listen. The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. */ healthCheckPort: number; /** * (Updatable) The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. The container image is optional while using service managed open source foundation model. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * (Updatable) The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * (Updatable) OCID of the container image signature */ imageSignatureId: string; /** * (Updatable) The chosen specification from predefined set of endpoints a user can access. For example, if the value is 'openai', the user can access OpenAI-compliant endpoints like /v1/completions, /v1/chat/completions, /v1/models, etc., for inference. */ predictApiSpecification: string; /** * (Updatable) The port on which the web server serving the inference is running. The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`. */ serverPort: number; } interface ModelDeploymentModelDeploymentConfigurationDetailsEnvironmentConfigurationDetailsCustomHttpEndpoint { /** * (Updatable) The suffix part of the endpoint that will be allowed for invocation. */ endpointUriSuffix: string; /** * (Updatable) List of HTTP methods acceptable by the URI. */ httpMethods: string[]; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetails { /** * The minimum network bandwidth for the model deployment. */ bandwidthMbps: number; computeTargetId?: string; /** * The type of the model deployment infrastructure. */ infrastructureType: string; /** * The model deployment instance configuration. */ instanceConfiguration?: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsInstanceConfiguration; /** * The maximum network bandwidth for the model deployment. */ maximumBandwidthMbps: number; modelDeploymentResourceConfiguration: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsModelDeploymentResourceConfiguration; /** * The scaling policy to apply to each model of the deployment. */ scalingPolicy: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicy; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsInstanceConfiguration { /** * The shape used to launch the model deployment instances. When using service managed open source foundation model, the supported shapes can be retrieved using get model api /models/{modelId}/definedMetadata/deploymentConfiguration/artifact/content. */ instanceShapeName: string; /** * Details for the model-deployment instance shape configuration. */ modelDeploymentInstanceShapeConfigDetails: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsInstanceConfigurationModelDeploymentInstanceShapeConfigDetails; /** * Network Access type of model deployment. */ networkAccessType: string; /** * The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * A model deployment instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT/SGW gateway for egress. */ subnetId: string; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsInstanceConfigurationModelDeploymentInstanceShapeConfigDetails { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsModelDeploymentResourceConfiguration { resourceLimitConfiguration: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsModelDeploymentResourceConfigurationResourceLimitConfiguration; resourceRequestConfiguration: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsModelDeploymentResourceConfigurationResourceRequestConfiguration; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsModelDeploymentResourceConfigurationResourceLimitConfiguration { /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsModelDeploymentResourceConfigurationResourceRequestConfiguration { gpus: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicy { /** * The list of autoscaling policy details. */ autoScalingPolicies: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicy[]; /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The number of instances for the model deployment. */ instanceCount: number; /** * Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * The type of scaling policy. */ policyType: string; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicy { /** * The type of autoscaling policy. */ autoScalingPolicyType: string; /** * For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the model deployment immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. 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. */ initialInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the maximum number of instances the model deployment is allowed to increase to (scale out). */ maximumInstanceCount: number; /** * For a threshold-based autoscaling policy, this value is the minimum number of instances the model deployment is allowed to decrease to (scale in). */ minimumInstanceCount: number; /** * The list of autoscaling policy rules. */ rules: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyRule[]; scaleInPolicy: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyScaleInPolicy; scaleOutPolicy: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyScaleOutPolicy; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyRule { /** * The metric expression for creating the alarm used to trigger autoscaling actions on the model deployment. */ metricExpressionRuleType: string; /** * Metric type */ metricType: string; scaleConfiguration?: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleConfiguration; /** * The scaling configuration for the predefined metric expression rule. */ scaleInConfiguration?: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleInConfiguration; /** * The scaling configuration for the predefined metric expression rule. */ scaleOutConfiguration?: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleConfiguration { metricNamespace: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; targetScalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleInConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration { /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; /** * 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. */ query: string; /** * The type of scaling configuration. */ scalingConfigurationType: string; /** * A metric value at which the scaling operation will be triggered. */ threshold: number; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyScaleInPolicy { /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; } interface ModelDeploymentModelDeploymentConfigurationDetailsInfrastructureConfigurationDetailsScalingPolicyAutoScalingPolicyScaleOutPolicy { /** * 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * 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." */ pendingDuration: string; } interface ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetails { /** * (Updatable) The minimum network bandwidth for the model deployment. */ bandwidthMbps: number; /** * (Updatable) The model deployment instance configuration. */ instanceConfiguration: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsInstanceConfiguration; /** * (Updatable) The maximum network bandwidth for the model deployment. */ maximumBandwidthMbps: number; /** * (Updatable) The OCID of the model you want to deploy. */ modelId: string; /** * (Updatable) The scaling policy to apply to each model of the deployment. */ scalingPolicy: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsScalingPolicy; } interface ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsInstanceConfiguration { /** * (Updatable) The shape used to launch the model deployment instances. When using service managed open source foundation model, the supported shapes can be retrieved using get model api /models/{modelId}/definedMetadata/deploymentConfiguration/artifact/content. */ instanceShapeName: string; /** * (Updatable) Details for the model-deployment instance shape configuration. */ modelDeploymentInstanceShapeConfigDetails: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsInstanceConfigurationModelDeploymentInstanceShapeConfigDetails; /** * (Updatable) Network Access type of model deployment. */ networkAccessType: string; /** * (Updatable) The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * (Updatable) A model deployment instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT/SGW gateway for egress. */ subnetId: string; } interface ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsInstanceConfigurationModelDeploymentInstanceShapeConfigDetails { /** * (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * (Updatable) A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the memory to be specified with in the range of 6 to 1024 GB. VM.Standard3.Flex memory range is between 6 to 512 GB and VM.Optimized3.Flex memory range is between 6 to 256 GB. */ memoryInGbs: number; /** * (Updatable) A model-deployment instance of type VM.Standard.E3.Flex or VM.Standard.E4.Flex allows the ocpu count to be specified with in the range of 1 to 64 ocpu. VM.Standard3.Flex OCPU range is between 1 to 32 ocpu and for VM.Optimized3.Flex OCPU range is 1 to 18 ocpu. */ ocpus: number; } interface ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsScalingPolicy { /** * (Updatable) The list of autoscaling policy details. */ autoScalingPolicies: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsScalingPolicyAutoScalingPolicy[]; /** * (Updatable) 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 model deployment becomes ACTIVE after the scaling operation. */ coolDownInSeconds: number; /** * (Updatable) The number of instances for the model deployment. */ instanceCount: number; /** * (Updatable) Whether the autoscaling policy is enabled. */ isEnabled: boolean; /** * (Updatable) The type of scaling policy. */ policyType: string; } interface ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsScalingPolicyAutoScalingPolicy { /** * (Updatable) The type of autoscaling policy. */ autoScalingPolicyType: string; /** * (Updatable) For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the model deployment immediately after autoscaling is enabled. Note that anytime this value is updated, the number of instances will be reset to this value. 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. */ initialInstanceCount: number; /** * (Updatable) For a threshold-based autoscaling policy, this value is the maximum number of instances the model deployment is allowed to increase to (scale out). */ maximumInstanceCount: number; /** * (Updatable) For a threshold-based autoscaling policy, this value is the minimum number of instances the model deployment is allowed to decrease to (scale in). */ minimumInstanceCount: number; /** * (Updatable) The list of autoscaling policy rules. */ rules: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsScalingPolicyAutoScalingPolicyRule[]; } interface ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsScalingPolicyAutoScalingPolicyRule { /** * (Updatable) The metric expression for creating the alarm used to trigger autoscaling actions on the model deployment. * * The following values are supported: * * `PREDEFINED_EXPRESSION`: An expression built using CPU or Memory metrics emitted by the Model Deployment Monitoring. * * `CUSTOM_EXPRESSION`: A custom Monitoring Query Language (MQL) expression. */ metricExpressionRuleType: string; /** * (Updatable) Metric type */ metricType: string; /** * (Updatable) The scaling configuration for the predefined metric expression rule. */ scaleInConfiguration: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleInConfiguration; /** * (Updatable) The scaling configuration for the predefined metric expression rule. */ scaleOutConfiguration: outputs.DataScience.ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration; } interface ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleInConfiguration { /** * (Updatable) The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * (Updatable) 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." * * The 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. */ pendingDuration: string; /** * (Updatable) 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. * * Example of threshold alarm: * * *** * * CPUUtilization[1m]{resourceId = "MODEL_DEPLOYMENT_OCID"}.grouping().mean() < 25 CPUUtilization[1m]{resourceId = "MODEL_DEPLOYMENT_OCID"}.grouping().mean() > 75 * * *** */ query: string; /** * (Updatable) The type of scaling configuration. */ scalingConfigurationType: string; /** * (Updatable) A metric value at which the scaling operation will be triggered. */ threshold: number; } interface ModelDeploymentModelDeploymentConfigurationDetailsModelConfigurationDetailsScalingPolicyAutoScalingPolicyRuleScaleOutConfiguration { /** * (Updatable) The value is used for adjusting the count of instances by. */ instanceCountAdjustment: number; /** * (Updatable) 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." * * The 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. */ pendingDuration: string; /** * (Updatable) 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: `1m`-`60m` (also `1h`). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. * * Example of threshold alarm: * * *** * * CPUUtilization[1m]{resourceId = "MODEL_DEPLOYMENT_OCID"}.grouping().mean() < 25 CPUUtilization[1m]{resourceId = "MODEL_DEPLOYMENT_OCID"}.grouping().mean() > 75 * * *** */ query: string; /** * (Updatable) The type of scaling configuration. */ scalingConfigurationType: string; /** * (Updatable) A metric value at which the scaling operation will be triggered. */ threshold: number; } interface ModelDeploymentModelDeploymentConfigurationDetailsModelGroupConfigurationDetails { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model group you want to deploy. */ modelGroupId: string; } interface ModelDeploymentModelDeploymentSystemData { /** * This value is the current count of the model deployment instances. */ currentInstanceCount: number; /** * The type of the deployed model. */ modelType: string; /** * The infrastructure type of the model deployment. */ systemInfraType: string; } interface ModelGroupMemberModelEntries { /** * Each List item contains inference key and model ocid. */ memberModelDetails: outputs.DataScience.ModelGroupMemberModelEntriesMemberModelDetail[]; } interface ModelGroupMemberModelEntriesMemberModelDetail { /** * SaaS friendly name of the model. */ inferenceKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model. */ modelId: string; } interface ModelGroupModelGroupCloneSourceDetails { /** * Source resource for model group clone operation. */ modelGroupCloneSourceType: string; /** * Overwrites the properties of the source modelGroup. */ modifyModelGroupDetails: outputs.DataScience.ModelGroupModelGroupCloneSourceDetailsModifyModelGroupDetails; /** * Specifies the list of new models to be added and list of models from source model group to be removed for cloning. */ patchModelGroupMemberModelDetails: outputs.DataScience.ModelGroupModelGroupCloneSourceDetailsPatchModelGroupMemberModelDetails; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model group version history. */ sourceId: string; } interface ModelGroupModelGroupCloneSourceDetailsModifyModelGroupDetails { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A short description of the modelGroup. */ description: string; /** * A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: `My ModelGroup` */ displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The model group details. */ modelGroupDetails: outputs.DataScience.ModelGroupModelGroupCloneSourceDetailsModifyModelGroupDetailsModelGroupDetails; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model group version history to which the modelGroup is associated. */ modelGroupVersionHistoryId: string; /** * An additional description of the lifecycle state of the model group. */ versionLabel: string; } interface ModelGroupModelGroupCloneSourceDetailsModifyModelGroupDetailsModelGroupDetails { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model in the group that represents the base model for stacked deployment. */ baseModelId: string; /** * An array of custom metadata details for the model group. */ customMetadataLists: outputs.DataScience.ModelGroupModelGroupCloneSourceDetailsModifyModelGroupDetailsModelGroupDetailsCustomMetadataList[]; /** * The type of the model group. */ type: string; } interface ModelGroupModelGroupCloneSourceDetailsModifyModelGroupDetailsModelGroupDetailsCustomMetadataList { /** * Category of the metadata. */ category: string; /** * Description of model metadata. */ description: string; /** * Key of the metadata. */ key: string; /** * Value of the metadata. */ value: string; } interface ModelGroupModelGroupCloneSourceDetailsPatchModelGroupMemberModelDetails { /** * Array of patch instructions. */ items: outputs.DataScience.ModelGroupModelGroupCloneSourceDetailsPatchModelGroupMemberModelDetailsItem[]; } interface ModelGroupModelGroupCloneSourceDetailsPatchModelGroupMemberModelDetailsItem { /** * A single instruction to be included as part of Patch request content. Enum type (INSERT and REMOVE). */ operation: string; /** * Array of inference key and model OCID. */ values: outputs.DataScience.ModelGroupModelGroupCloneSourceDetailsPatchModelGroupMemberModelDetailsItemValue[]; } interface ModelGroupModelGroupCloneSourceDetailsPatchModelGroupMemberModelDetailsItemValue { /** * SaaS friendly name of the model. */ inferenceKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model. */ modelId: string; } interface ModelGroupModelGroupDetails { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model in the group that represents the base model for stacked deployment. */ baseModelId: string; /** * An array of custom metadata details for the model group. */ customMetadataLists: outputs.DataScience.ModelGroupModelGroupDetailsCustomMetadataList[]; /** * The type of the model group. */ type: string; } interface ModelGroupModelGroupDetailsCustomMetadataList { /** * Category of the metadata. */ category: string; /** * Description of model metadata. */ description: string; /** * Key of the metadata. */ key: string; /** * Value of the metadata. */ value: string; } interface ModelRetentionOperationDetail { /** * The archival status of model. */ archiveState: string; /** * The archival state details of the model. */ archiveStateDetails: string; /** * The deletion status of the archived model. */ deleteState: string; /** * The deletion status details of the archived model. */ deleteStateDetails: string; /** * The estimated archival time of the model based on the provided retention setting. */ timeArchivalScheduled: string; /** * The estimated deletion time of the model based on the provided retention setting. */ timeDeletionScheduled: string; } interface ModelRetentionSetting { /** * (Updatable) Number of days after which the model will be archived. */ archiveAfterDays: number; /** * (Updatable) Customer notification options on success/failure of archival, deletion events. */ customerNotificationType: string; /** * (Updatable) Number of days after which the archived model will be deleted. */ deleteAfterDays: number; } interface NotebookSessionNotebookSessionConfigDetails { /** * A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs. */ blockStorageSizeInGbs: number; /** * Details for the notebook session shape configuration. */ notebookSessionShapeConfigDetails: outputs.DataScience.NotebookSessionNotebookSessionConfigDetailsNotebookSessionShapeConfigDetails; /** * The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the `ListNotebookSessionShapes` endpoint. */ shape: string; /** * A notebook session instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet. */ subnetId: string; } interface NotebookSessionNotebookSessionConfigDetailsNotebookSessionShapeConfigDetails { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left bank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the notebook session instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the notebook session instance. */ ocpus: number; } interface NotebookSessionNotebookSessionConfigurationDetails { /** * (Updatable) A notebook session instance is provided with a block storage volume. This specifies the size of the volume in GBs. */ blockStorageSizeInGbs: number; /** * (Updatable) Details for the notebook session shape configuration. */ notebookSessionShapeConfigDetails: outputs.DataScience.NotebookSessionNotebookSessionConfigurationDetailsNotebookSessionShapeConfigDetails; /** * (Updatable) The OCID of a Data Science private endpoint. */ privateEndpointId: string; /** * (Updatable) The shape used to launch the notebook session compute instance. The list of available shapes in a given compartment can be retrieved using the `ListNotebookSessionShapes` endpoint. */ shape: string; /** * (Updatable) A notebook session instance is provided with a VNIC for network access. This specifies the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create a VNIC in. The subnet should be in a VCN with a NAT gateway for egress to the internet. */ subnetId: string; } interface NotebookSessionNotebookSessionConfigurationDetailsNotebookSessionShapeConfigDetails { /** * (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left bank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * (Updatable) The total amount of memory available to the notebook session instance, in gigabytes. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs available to the notebook session instance. */ ocpus: number; } interface NotebookSessionNotebookSessionRuntimeConfigDetails { /** * (Updatable) Custom environment variables for Notebook Session. These key-value pairs will be available for customers in Notebook Sessions. */ customEnvironmentVariables: { [key: string]: string; }; /** * (Updatable) Git configuration Details. */ notebookSessionGitConfigDetails: outputs.DataScience.NotebookSessionNotebookSessionRuntimeConfigDetailsNotebookSessionGitConfigDetails; } interface NotebookSessionNotebookSessionRuntimeConfigDetailsNotebookSessionGitConfigDetails { /** * (Updatable) A collection of Git repository configurations. */ notebookSessionGitRepoConfigCollections: outputs.DataScience.NotebookSessionNotebookSessionRuntimeConfigDetailsNotebookSessionGitConfigDetailsNotebookSessionGitRepoConfigCollection[]; } interface NotebookSessionNotebookSessionRuntimeConfigDetailsNotebookSessionGitConfigDetailsNotebookSessionGitRepoConfigCollection { /** * (Updatable) The repository URL */ url: string; } interface NotebookSessionNotebookSessionStorageMountConfigurationDetailsList { /** * (Updatable) The object storage bucket */ bucket: string; /** * (Updatable) The local directory name to be mounted */ destinationDirectoryName: string; /** * (Updatable) The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * (Updatable) OCID of the export */ exportId: string; /** * (Updatable) OCID of the mount target */ mountTargetId: string; /** * (Updatable) The object storage namespace */ namespace: string; /** * (Updatable) Prefix in the bucket to mount */ prefix: string; /** * (Updatable) The type of storage. */ storageType: string; } interface PipelineConfigurationDetails { /** * (Updatable) The command line arguments to set for steps in the pipeline. */ commandLineArguments: string; /** * (Updatable) Environment variables to set for steps in the pipeline. */ environmentVariables: { [key: string]: string; }; /** * (Updatable) A time bound for the execution of the entire Pipeline. Timer starts when the Pipeline Run is in progress. */ maximumRuntimeInMinutes: string; /** * (Updatable) The type of pipeline. */ type: string; } interface PipelineInfrastructureConfigurationDetails { /** * (Updatable) The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * (Updatable) The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * (Updatable) Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.PipelineInfrastructureConfigurationDetailsShapeConfigDetails; /** * (Updatable) The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * (Updatable) The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId?: string; } interface PipelineInfrastructureConfigurationDetailsShapeConfigDetails { /** * (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * (Updatable) The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * (Updatable) The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * (Updatable) The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * (Updatable) The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface PipelineLogConfigurationDetails { /** * (Updatable) If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * (Updatable) If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface PipelineRunConfigurationDetail { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; /** * The type of pipeline. */ type: string; } interface PipelineRunConfigurationOverrideDetails { /** * The command line arguments to set for steps in the pipeline. */ commandLineArguments: string; /** * Environment variables to set for steps in the pipeline. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the entire Pipeline. Timer starts when the Pipeline Run is in progress. */ maximumRuntimeInMinutes: string; /** * The type of pipeline. */ type: string; } interface PipelineRunInfrastructureConfigurationOverrideDetails { /** * The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.PipelineRunInfrastructureConfigurationOverrideDetailsShapeConfigDetails; /** * The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface PipelineRunInfrastructureConfigurationOverrideDetailsShapeConfigDetails { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface PipelineRunLogConfigurationOverrideDetails { /** * If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface PipelineRunLogDetail { /** * The log group id for where log objects will be for pipeline runs. */ logGroupId: string; /** * The log id of the log object the pipeline run logs will be shipped to. */ logId: string; } interface PipelineRunStepOverrideDetail { /** * The configuration details of a step. */ stepConfigurationDetails: outputs.DataScience.PipelineRunStepOverrideDetailStepConfigurationDetails; /** * Container Details for a step in pipeline. */ stepContainerConfigurationDetails: outputs.DataScience.PipelineRunStepOverrideDetailStepContainerConfigurationDetails; /** * The configuration details of a Dataflow step. */ stepDataflowConfigurationDetails: outputs.DataScience.PipelineRunStepOverrideDetailStepDataflowConfigurationDetails; /** * The infrastructure configuration details of a pipeline or a step. */ stepInfrastructureConfigurationDetails: outputs.DataScience.PipelineRunStepOverrideDetailStepInfrastructureConfigurationDetails; /** * The name of the step. */ stepName: string; /** * The storage mount details to mount to the instance running the pipeline step. */ stepStorageMountConfigurationDetailsLists: outputs.DataScience.PipelineRunStepOverrideDetailStepStorageMountConfigurationDetailsList[]; } interface PipelineRunStepOverrideDetailStepConfigurationDetails { /** * The command line arguments to set for step. */ commandLineArguments: string; /** * Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface PipelineRunStepOverrideDetailStepContainerConfigurationDetails { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The type of container. */ containerType: string; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; } interface PipelineRunStepOverrideDetailStepDataflowConfigurationDetails { /** * The Spark configuration passed to the running process. */ configuration: { [key: string]: string; }; /** * The VM shape for the driver. */ driverShape: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ driverShapeConfigDetails: outputs.DataScience.PipelineRunStepOverrideDetailStepDataflowConfigurationDetailsDriverShapeConfigDetails; /** * The VM shape for the executors. */ executorShape: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ executorShapeConfigDetails: outputs.DataScience.PipelineRunStepOverrideDetailStepDataflowConfigurationDetailsExecutorShapeConfigDetails; /** * An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. */ logsBucketUri: string; /** * The number of executor VMs requested. */ numExecutors: number; /** * An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. */ warehouseBucketUri: string; } interface PipelineRunStepOverrideDetailStepDataflowConfigurationDetailsDriverShapeConfigDetails { /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface PipelineRunStepOverrideDetailStepDataflowConfigurationDetailsExecutorShapeConfigDetails { /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface PipelineRunStepOverrideDetailStepInfrastructureConfigurationDetails { /** * The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.PipelineRunStepOverrideDetailStepInfrastructureConfigurationDetailsShapeConfigDetails; /** * The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface PipelineRunStepOverrideDetailStepInfrastructureConfigurationDetailsShapeConfigDetails { /** * The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface PipelineRunStepOverrideDetailStepStorageMountConfigurationDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface PipelineRunStepRun { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dataflow run triggered for this step run. */ dataflowRunId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run triggered for this step run. */ jobRunId: string; /** * Details of the state of the step run. */ lifecycleDetails: string; /** * The state of the step run. */ state: string; /** * The name of the step. */ stepName: string; /** * Name used when creating the steprun. */ stepRunName: string; /** * The type of step. */ stepType: string; /** * The date and time the pipeline run request was finished in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeFinished: string; /** * The date and time the pipeline run request was started in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStarted: string; } interface PipelineRunStorageMountConfigurationOverrideDetailsList { /** * The object storage bucket */ bucket: string; /** * The local directory name to be mounted */ destinationDirectoryName: string; /** * The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * OCID of the export */ exportId: string; /** * OCID of the mount target */ mountTargetId: string; /** * The object storage namespace */ namespace: string; /** * Prefix in the bucket to mount */ prefix: string; /** * The type of storage. */ storageType: string; } interface PipelineStepArtifact { artifactContentDisposition?: string; artifactContentLength?: string; artifactContentMd5: string; artifactLastModified: string; pipelineStepArtifact: string; /** * The name of the step. It must be unique within the pipeline. This is used to create the pipeline DAG. */ stepName: string; } interface PipelineStepDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dataflow application to be used as a step. */ applicationId?: string; /** * The list of step names this current step depends on for execution. */ dependsOns?: string[]; /** * (Updatable) A short description of the step. */ description: string; /** * A flag to indicate whether the artifact has been uploaded for this step or not. */ isArtifactUploaded: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job to be used as a step. */ jobId: string; /** * (Updatable) The configuration details of a step. */ stepConfigurationDetails: outputs.DataScience.PipelineStepDetailStepConfigurationDetails; /** * Container Details for a step in pipeline. */ stepContainerConfigurationDetails: outputs.DataScience.PipelineStepDetailStepContainerConfigurationDetails; /** * (Updatable) The configuration details of a Dataflow step. */ stepDataflowConfigurationDetails: outputs.DataScience.PipelineStepDetailStepDataflowConfigurationDetails; /** * (Updatable) The infrastructure configuration details of a pipeline or a step. */ stepInfrastructureConfigurationDetails: outputs.DataScience.PipelineStepDetailStepInfrastructureConfigurationDetails; /** * (Updatable) The name of the step. It must be unique within the pipeline. This is used to create the pipeline DAG. */ stepName: string; /** * (Updatable) Pipeline step parameter details */ stepParameters?: outputs.DataScience.PipelineStepDetailStepParameters; /** * (Updatable) Name used when creating the steprun. */ stepRunName: string; /** * (Updatable) The storage mount details to mount to the instance running the pipeline step. */ stepStorageMountConfigurationDetailsLists: outputs.DataScience.PipelineStepDetailStepStorageMountConfigurationDetailsList[]; /** * (Updatable) The type of step. */ stepType: string; } interface PipelineStepDetailStepConfigurationDetails { /** * (Updatable) The command line arguments to set for step. */ commandLineArguments: string; /** * (Updatable) Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * (Updatable) A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface PipelineStepDetailStepContainerConfigurationDetails { /** * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * The type of container. */ containerType: string; /** * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * OCID of the container image signature */ imageSignatureId: string; } interface PipelineStepDetailStepDataflowConfigurationDetails { /** * (Updatable) The Spark configuration passed to the running process. */ configuration: { [key: string]: string; }; /** * (Updatable) The VM shape for the driver. */ driverShape: string; /** * (Updatable) Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ driverShapeConfigDetails: outputs.DataScience.PipelineStepDetailStepDataflowConfigurationDetailsDriverShapeConfigDetails; /** * (Updatable) The VM shape for the executors. */ executorShape: string; /** * (Updatable) Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ executorShapeConfigDetails: outputs.DataScience.PipelineStepDetailStepDataflowConfigurationDetailsExecutorShapeConfigDetails; /** * (Updatable) An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. */ logsBucketUri: string; /** * (Updatable) The number of executor VMs requested. */ numExecutors: number; /** * (Updatable) An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. */ warehouseBucketUri: string; } interface PipelineStepDetailStepDataflowConfigurationDetailsDriverShapeConfigDetails { /** * (Updatable) The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * (Updatable) The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * (Updatable) The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * (Updatable) The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface PipelineStepDetailStepDataflowConfigurationDetailsExecutorShapeConfigDetails { /** * (Updatable) The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * (Updatable) The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * (Updatable) The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * (Updatable) The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface PipelineStepDetailStepInfrastructureConfigurationDetails { /** * (Updatable) The size of the block storage volume to attach to the instance. */ blockStorageSizeInGbs: number; /** * (Updatable) The size of the block storage volume to attach to the pipeline step run instance specified as a parameter. This overrides the blockStorageSizeInGBs value. The request will fail if the parameters used are null or invalid. */ blockStorageSizeInGbsParameterized: string; /** * (Updatable) Details for the pipeline step run shape configuration. Specify only when a flex shape is selected. */ shapeConfigDetails: outputs.DataScience.PipelineStepDetailStepInfrastructureConfigurationDetailsShapeConfigDetails; /** * (Updatable) The shape used to launch the instance for all step runs in the pipeline. */ shapeName: string; /** * (Updatable) The subnet to create a secondary vnic in to attach to the instance running the pipeline step. */ subnetId: string; } interface PipelineStepDetailStepInfrastructureConfigurationDetailsShapeConfigDetails { /** * (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. If this attribute is left blank, it will default to `BASELINE_1_1`. The following values are supported: BASELINE_1_8 - baseline usage is 1/8 of an OCPU. BASELINE_1_2 - baseline usage is 1/2 of an OCPU. BASELINE_1_1 - baseline usage is an entire OCPU. This represents a non-burstable instance. */ cpuBaseline: string; /** * (Updatable) The total amount of memory available to the pipeline step run instance GBs. */ memoryInGbs: number; /** * (Updatable) The total amount of memory available to the pipeline step run instance in GBs specified as a parameter. This overrides the memoryInGBs value. The request will fail if the parameters used are null or invalid. */ memoryInGbsParameterized: string; /** * (Updatable) The total number of OCPUs available to the pipeline step run instance. */ ocpus: number; /** * (Updatable) The total number of OCPUs available to the pipeline step run instance specified as a parameter. This overrides the ocpus value. The request will fail if the parameters used are null or invalid. */ ocpusParameterized: string; } interface PipelineStepDetailStepParameters { /** * (Updatable) Pipeline output parameter details */ output: outputs.DataScience.PipelineStepDetailStepParametersOutput; /** * (Updatable) Type of step parameter */ parameterType: string; } interface PipelineStepDetailStepParametersOutput { /** * (Updatable) Output file name */ outputFile: string; /** * (Updatable) Type of output parameters */ outputParameterType: string; /** * (Updatable) The list of parameter names that will be output by this step */ parameterNames: string[]; } interface PipelineStepDetailStepStorageMountConfigurationDetailsList { /** * (Updatable) The object storage bucket */ bucket: string; /** * (Updatable) The local directory name to be mounted */ destinationDirectoryName: string; /** * (Updatable) The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * (Updatable) OCID of the export */ exportId: string; /** * (Updatable) OCID of the mount target */ mountTargetId: string; /** * (Updatable) The object storage namespace */ namespace: string; /** * (Updatable) Prefix in the bucket to mount */ prefix: string; /** * (Updatable) The type of storage. */ storageType: string; } interface PipelineStorageMountConfigurationDetailsList { /** * (Updatable) The object storage bucket */ bucket: string; /** * (Updatable) The local directory name to be mounted */ destinationDirectoryName: string; /** * (Updatable) The local path of the mounted directory, excluding directory name. */ destinationPath: string; /** * (Updatable) OCID of the export */ exportId: string; /** * (Updatable) OCID of the mount target */ mountTargetId: string; /** * (Updatable) The object storage namespace */ namespace: string; /** * (Updatable) Prefix in the bucket to mount */ prefix: string; /** * (Updatable) The type of storage. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ storageType: string; } interface ScheduleAction { /** * (Updatable) Schedule Http action details */ actionDetails: outputs.DataScience.ScheduleActionActionDetails; /** * (Updatable) The Schedule Action type */ actionType: string; } interface ScheduleActionActionDetails { /** * (Updatable) Parameters needed to create a new job run. */ createJobRunDetails: outputs.DataScience.ScheduleActionActionDetailsCreateJobRunDetails; /** * (Updatable) The information about new PipelineRun. */ createPipelineRunDetails: outputs.DataScience.ScheduleActionActionDetailsCreatePipelineRunDetails; /** * (Updatable) The type of http action to trigger. */ httpActionType: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule. */ mlApplicationInstanceViewId: string; /** * (Updatable) Payload for trigger request endpoint */ triggerMlApplicationInstanceViewFlowDetails: outputs.DataScience.ScheduleActionActionDetailsTriggerMlApplicationInstanceViewFlowDetails; } interface ScheduleActionActionDetailsCreateJobRunDetails { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job run. */ compartmentId: string; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) A user-friendly display name for the resource. */ displayName: string; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * (Updatable) The job configuration details */ jobConfigurationOverrideDetails: outputs.DataScience.ScheduleActionActionDetailsCreateJobRunDetailsJobConfigurationOverrideDetails; /** * (Updatable) Environment configuration to capture job runtime dependencies. */ jobEnvironmentConfigurationOverrideDetails: outputs.DataScience.ScheduleActionActionDetailsCreateJobRunDetailsJobEnvironmentConfigurationOverrideDetails; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job to create a run for. */ jobId: string; /** * (Updatable) Logging configuration for resource. */ jobLogConfigurationOverrideDetails: outputs.DataScience.ScheduleActionActionDetailsCreateJobRunDetailsJobLogConfigurationOverrideDetails; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the job run with. */ projectId: string; } interface ScheduleActionActionDetailsCreateJobRunDetailsJobConfigurationOverrideDetails { /** * (Updatable) The arguments to pass to the job. */ commandLineArguments: string; /** * (Updatable) Environment variables to set for the job. */ environmentVariables: { [key: string]: string; }; /** * (Updatable) The type of job. */ jobType: string; /** * (Updatable) A time bound for the execution of the job. Timer starts when the job becomes active. */ maximumRuntimeInMinutes: string; } interface ScheduleActionActionDetailsCreateJobRunDetailsJobEnvironmentConfigurationOverrideDetails { /** * (Updatable) The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * (Updatable) The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * (Updatable) The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: `.ocir.io//:` `.ocir.io//:@digest` */ image: string; /** * (Updatable) The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * (Updatable) OCID of the container image signature */ imageSignatureId: string; /** * (Updatable) The environment configuration type used for job runtime. */ jobEnvironmentType: string; } interface ScheduleActionActionDetailsCreateJobRunDetailsJobLogConfigurationOverrideDetails { /** * (Updatable) If automatic on-behalf-of log object creation is enabled for job runs. */ enableAutoLogCreation: boolean; /** * (Updatable) If customer logging is enabled for job runs. */ enableLogging: boolean; /** * (Updatable) The log group id for where log objects are for job runs. */ logGroupId: string; /** * (Updatable) The log id the job run will push logs too. */ logId: string; } interface ScheduleActionActionDetailsCreatePipelineRunDetails { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the pipeline run. */ compartmentId: string; /** * (Updatable) The configuration details of a pipeline. */ configurationOverrideDetails: outputs.DataScience.ScheduleActionActionDetailsCreatePipelineRunDetailsConfigurationOverrideDetails; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) A user-friendly display name for the resource. */ displayName: string; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * (Updatable) The pipeline log configuration details. */ logConfigurationOverrideDetails: outputs.DataScience.ScheduleActionActionDetailsCreatePipelineRunDetailsLogConfigurationOverrideDetails; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline for which pipeline run is created. */ pipelineId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project to associate the pipeline run with. */ projectId: string; /** * (Updatable) Array of step override details. Only Step Configuration is allowed to be overridden. */ stepOverrideDetails: outputs.DataScience.ScheduleActionActionDetailsCreatePipelineRunDetailsStepOverrideDetail[]; /** * (Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface ScheduleActionActionDetailsCreatePipelineRunDetailsConfigurationOverrideDetails { /** * (Updatable) The command line arguments to set for steps in the pipeline. */ commandLineArguments: string; /** * (Updatable) Environment variables to set for steps in the pipeline. */ environmentVariables: { [key: string]: string; }; /** * (Updatable) A time bound for the execution of the entire Pipeline. Timer starts when the Pipeline Run is in progress. */ maximumRuntimeInMinutes: string; /** * (Updatable) The type of pipeline. */ type: string; } interface ScheduleActionActionDetailsCreatePipelineRunDetailsLogConfigurationOverrideDetails { /** * (Updatable) If automatic on-behalf-of log object creation is enabled for pipeline runs. */ enableAutoLogCreation: boolean; /** * (Updatable) If customer logging is enabled for pipeline. */ enableLogging: boolean; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface ScheduleActionActionDetailsCreatePipelineRunDetailsStepOverrideDetail { /** * (Updatable) The configuration details of a step. */ stepConfigurationDetails: outputs.DataScience.ScheduleActionActionDetailsCreatePipelineRunDetailsStepOverrideDetailStepConfigurationDetails; /** * (Updatable) Container Details for a step in pipeline. */ stepContainerConfigurationDetails: outputs.DataScience.ScheduleActionActionDetailsCreatePipelineRunDetailsStepOverrideDetailStepContainerConfigurationDetails; /** * (Updatable) The name of the step. */ stepName: string; } interface ScheduleActionActionDetailsCreatePipelineRunDetailsStepOverrideDetailStepConfigurationDetails { /** * (Updatable) The command line arguments to set for step. */ commandLineArguments: string; /** * (Updatable) Environment variables to set for step. */ environmentVariables: { [key: string]: string; }; /** * (Updatable) A time bound for the execution of the step. */ maximumRuntimeInMinutes: string; } interface ScheduleActionActionDetailsCreatePipelineRunDetailsStepOverrideDetailStepContainerConfigurationDetails { /** * (Updatable) The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings. Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. */ cmds: string[]; /** * (Updatable) The type of container. */ containerType: string; /** * (Updatable) The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings. Accept the `CMD` as extra arguments. The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes. More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). */ entrypoints: string[]; /** * (Updatable) The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. */ image: string; /** * (Updatable) The digest of the container image. For example, `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030` */ imageDigest: string; /** * (Updatable) OCID of the container image signature */ imageSignatureId: string; } interface ScheduleActionActionDetailsTriggerMlApplicationInstanceViewFlowDetails { /** * (Updatable) Parameters provided for given trigger invocation (they must match predefined schema) */ parameters: outputs.DataScience.ScheduleActionActionDetailsTriggerMlApplicationInstanceViewFlowDetailsParameter[]; /** * (Updatable) Name of trigger */ triggerName: string; } interface ScheduleActionActionDetailsTriggerMlApplicationInstanceViewFlowDetailsParameter { /** * (Updatable) Name of trigger parameter */ name: string; /** * (Updatable) Value of trigger parameter */ value: string; } interface ScheduleLogDetails { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom log to be used for Schedule logging. */ logId: string; } interface ScheduleTrigger { /** * (Updatable) Schedule cron expression */ cronExpression?: string; /** * (Updatable) The type of frequency */ frequency?: string; /** * (Updatable) Maximum number of minutes after `timeStart` that the scheduler may use to randomly select the first execution time. This value is considered only when `isRandomStartTime` is true. If omitted and `isRandomStartTime` is true, the service defaults the jitter window to half of the configured interval duration. */ initialJitterInMinutes: number; /** * (Updatable) The interval of frequency. */ interval?: number; /** * (Updatable) when true and timeStart is null, system generate a random start time between now and now + interval; isRandomStartTime can be true if timeStart is null. */ isRandomStartTime?: boolean; /** * (Updatable) This recurrence field conforms to RFC-5545 formatting */ recurrence?: string; /** * (Updatable) The schedule end date time, if null, the schedule will never expire. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeEnd?: string; /** * (Updatable) The schedule starting date time, if null, System set the time when schedule is created. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeStart: string; /** * (Updatable) The schedule trigger type * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ triggerType: string; } } export declare namespace Database { interface AutonomousContainerDatabaseAddStandbyBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.Database.AutonomousContainerDatabaseAddStandbyBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; } interface AutonomousContainerDatabaseAddStandbyBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface AutonomousContainerDatabaseAddStandbyDataguard { /** * The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` */ applyRate: string; /** * Automatically selected by backend when observer is enabled. */ automaticFailoverTarget: string; /** * The Autonomous Container Database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousContainerDatabaseId: string; /** * The domain of the Autonomous Container Database */ availabilityDomain: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association */ isAutomaticFailoverEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * Automatically selected by backend based on the protection mode. */ redoTransportMode: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; /** * The current state of the Autonomous Container Database. */ state: string; /** * The date and time the Autonomous Container Database was created. */ timeCreated: string; /** * Timestamp when the lags were last calculated for a standby. */ timeLagRefreshedOn: string; /** * The date and time when the last role change action happened. */ timeLastRoleChanged: string; /** * The date and time of the last update to the apply lag, apply rate, and transport lag values. */ timeLastSynced: string; /** * The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` */ transportLag: string; } interface AutonomousContainerDatabaseAddStandbyDataguardGroupMember { /** * The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` */ applyRate: string; /** * Automatically selected by backend when observer is enabled. */ automaticFailoverTarget: string; /** * The Autonomous Container Database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousContainerDatabaseId: string; /** * The domain of the Autonomous Container Database */ availabilityDomain: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association */ isAutomaticFailoverEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * Automatically selected by backend based on the protection mode. */ redoTransportMode: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; /** * The current state of the Autonomous Container Database. */ state: string; /** * The date and time the Autonomous Container Database was created. */ timeCreated: string; /** * Timestamp when the lags were last calculated for a standby. */ timeLagRefreshedOn: string; /** * The date and time when the last role change action happened. */ timeLastRoleChanged: string; /** * The date and time of the last update to the apply lag, apply rate, and transport lag values. */ timeLastSynced: string; /** * The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` */ transportLag: string; } interface AutonomousContainerDatabaseAddStandbyEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; azureEncryptionKeyId: string; hsmPassword: string; /** * Use 'AWS' for creating a new database. */ providerType: string; } interface AutonomousContainerDatabaseAddStandbyKeyHistoryEntry { /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The date and time the kms key activated. */ timeActivated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; } interface AutonomousContainerDatabaseAddStandbyMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.AutonomousContainerDatabaseAddStandbyMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.AutonomousContainerDatabaseAddStandbyMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface AutonomousContainerDatabaseAddStandbyMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface AutonomousContainerDatabaseAddStandbyMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface AutonomousContainerDatabaseAddStandbyPeerAutonomousContainerDatabaseBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.Database.AutonomousContainerDatabaseAddStandbyPeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups. */ recoveryWindowInDays: number; } interface AutonomousContainerDatabaseAddStandbyPeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface AutonomousContainerDatabaseAssociatedBackupConfigurationDetail { /** * The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. */ backupDestinationAttachHistories: string[]; /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; /** * The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. */ spaceUtilizedInGbs: number; /** * The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. */ timeAtWhichStorageDetailsAreUpdated: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface AutonomousContainerDatabaseBackupConfig { /** * (Updatable) Backup destination details. */ backupDestinationDetails: outputs.Database.AutonomousContainerDatabaseBackupConfigBackupDestinationDetails; /** * (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups. */ recoveryWindowInDays: number; } interface AutonomousContainerDatabaseBackupConfigBackupDestinationDetails { /** * (Updatable) Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * (Updatable) Proxy URL to connect to object store. */ internetProxy: string; /** * (Updatable) Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * (Updatable) Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * (Updatable) The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * (Updatable) Type of the database backup destination. */ type: string; /** * (Updatable) For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword?: string; /** * (Updatable) For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface AutonomousContainerDatabaseBackupDestinationPropertiesList { /** * The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. */ backupDestinationAttachHistories: string[]; /** * The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. */ spaceUtilizedInGbs: number; /** * The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. */ timeAtWhichStorageDetailsAreUpdated: string; } interface AutonomousContainerDatabaseCustomerContact { /** * (Updatable) The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface AutonomousContainerDatabaseDataguard { /** * The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` */ applyRate: string; /** * Automatically selected by backend when observer is enabled. */ automaticFailoverTarget: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database. Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. */ autonomousContainerDatabaseId: string; /** * The domain of the Autonomous Container Database */ availabilityDomain: string; /** * (Updatable) The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * (Updatable) Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association */ isAutomaticFailoverEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * (Updatable) The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * Automatically selected by backend based on the protection mode. */ redoTransportMode: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; /** * The current state of the Autonomous Container Database. */ state: string; /** * The date and time the Autonomous Container Database was created. */ timeCreated: string; /** * Timestamp when the lags were last calculated for a standby. */ timeLagRefreshedOn: string; /** * The date and time when the last role change action happened. */ timeLastRoleChanged: string; /** * The date and time of the last update to the apply lag, apply rate, and transport lag values. */ timeLastSynced: string; /** * The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` */ transportLag: string; } interface AutonomousContainerDatabaseDataguardAssociationPeerAutonomousContainerDatabaseBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.Database.AutonomousContainerDatabaseDataguardAssociationPeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; } interface AutonomousContainerDatabaseDataguardAssociationPeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface AutonomousContainerDatabaseDataguardGroupMember { /** * The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` */ applyRate: string; /** * Automatically selected by backend when observer is enabled. */ automaticFailoverTarget: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database. Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. */ autonomousContainerDatabaseId: string; /** * The domain of the Autonomous Container Database */ availabilityDomain: string; /** * (Updatable) The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * (Updatable) Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association */ isAutomaticFailoverEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * (Updatable) The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * Automatically selected by backend based on the protection mode. */ redoTransportMode: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; /** * The current state of the Autonomous Container Database. */ state: string; /** * The date and time the Autonomous Container Database was created. */ timeCreated: string; /** * Timestamp when the lags were last calculated for a standby. */ timeLagRefreshedOn: string; /** * The date and time when the last role change action happened. */ timeLastRoleChanged: string; /** * The date and time of the last update to the apply lag, apply rate, and transport lag values. */ timeLastSynced: string; /** * The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` */ transportLag: string; } interface AutonomousContainerDatabaseEncryptionKeyLocationDetails { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; /** * Provide the key OCID of a registered Azure key. */ azureEncryptionKeyId: string; /** * Provide the HSM password as you would in RDBMS for External HSM. */ hsmPassword: string; /** * Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. Use 'AZURE' for creating a new database or migrating a database key to Azure. Use 'AWS' for creating a new database or migrating a database key to Aws. */ providerType: string; } interface AutonomousContainerDatabaseKeyHistoryEntry { /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The date and time the kms key activated. */ timeActivated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; } interface AutonomousContainerDatabaseMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.AutonomousContainerDatabaseMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.AutonomousContainerDatabaseMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface AutonomousContainerDatabaseMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface AutonomousContainerDatabaseMaintenanceWindowDetails { /** * (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * (Updatable) Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.AutonomousContainerDatabaseMaintenanceWindowDetailsDaysOfWeek[]; /** * (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * (Updatable) If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * (Updatable) Months during the year when maintenance should be performed. */ months: outputs.Database.AutonomousContainerDatabaseMaintenanceWindowDetailsMonth[]; /** * (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. * * *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * (Updatable) The maintenance window scheduling preference. */ preference: string; /** * (Updatable) If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface AutonomousContainerDatabaseMaintenanceWindowDetailsDaysOfWeek { /** * (Updatable) Name of the day of the week. */ name: string; } interface AutonomousContainerDatabaseMaintenanceWindowDetailsMonth { /** * (Updatable) Name of the month of the year. */ name: string; } interface AutonomousContainerDatabaseMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface AutonomousContainerDatabasePeerAutonomousContainerDatabaseBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.Database.AutonomousContainerDatabasePeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups. */ recoveryWindowInDays: number; } interface AutonomousContainerDatabasePeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface AutonomousContainerDatabaseRecoveryApplianceDetail { /** * The storage size of the backup destination allocated for an Autonomous Container Database to store backups on the recovery appliance, in GBs, rounded to the nearest integer. */ allocatedStorageSizeInGbs: number; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; /** * The time when the recovery appliance details are updated. */ timeRecoveryApplianceDetailsUpdated: string; } interface AutonomousDatabaseApexDetail { /** * The Oracle APEX AI Application Development version. */ apexVersion: string; /** * The Oracle REST Data Services (ORDS) version. */ ordsVersion: string; } interface AutonomousDatabaseAutonomousDatabaseMaintenanceWindow { /** * (Updatable) Day of the week. */ dayOfWeek: outputs.Database.AutonomousDatabaseAutonomousDatabaseMaintenanceWindowDayOfWeek; /** * (Updatable) The maintenance end time. The value must use the ISO-8601 format "hh:mm". */ maintenanceEndTime: string; /** * (Updatable) The maintenance start time. The value must use the ISO-8601 format "hh:mm". */ maintenanceStartTime: string; } interface AutonomousDatabaseAutonomousDatabaseMaintenanceWindowDayOfWeek { /** * (Updatable) Name of the day of the week. */ name: string; } interface AutonomousDatabaseBackupBackupDestinationDetails { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface AutonomousDatabaseBackupConfig { /** * Name of [Object Storage](https://docs.cloud.oracle.com/iaas/Content/Object/Concepts/objectstorageoverview.htm) bucket to use for storing manual backups. */ manualBackupBucketName: string; /** * The manual backup destination type. */ manualBackupType: string; } interface AutonomousDatabaseBackupSourceDatabaseDetail { /** * Customer Contacts for the Autonomous Container Database. Setting this to an empty list removes all customer contacts. */ autonomousContainerDatabaseCustomerContacts: outputs.Database.AutonomousDatabaseBackupSourceDatabaseDetailAutonomousContainerDatabaseCustomerContact[]; /** * The user-provided name for the Autonomous Container Database. */ autonomousContainerDatabaseDisplayName: string; /** * DST Time-Zone File version of the Autonomous Container Database. */ autonomousContainerDatabaseDstFileVersion: string; /** * Autonomous Container Database name. */ autonomousContainerDatabaseName: string; /** * Customer Contacts for the Autonomous Database. */ autonomousDatabaseCustomerContacts: outputs.Database.AutonomousDatabaseBackupSourceDatabaseDetailAutonomousDatabaseCustomerContact[]; /** * Autonomous Database's name. */ autonomousDatabaseName: string; /** * Autonomous VM cluster's user-friendly name. */ autonomousVmClusterDisplayName: string; /** * The Autonomous Database workload type. The following values are valid: * * OLTP - indicates an Autonomous Transaction Processing database * * DW - indicates an Autonomous Data Warehouse database * * AJD - indicates an Autonomous JSON Database * * APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. */ dbWorkload: string; } interface AutonomousDatabaseBackupSourceDatabaseDetailAutonomousContainerDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface AutonomousDatabaseBackupSourceDatabaseDetailAutonomousDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface AutonomousDatabaseConnectionString { /** * Returns all connection strings that can be used to connect to the Autonomous AI Database. For more information, please see [Predefined Database Service Names for Autonomous AI Transaction Processing](https://docs.oracle.com/en/cloud/paas/atp-cloud/atpug/connect-predefined.html#GUID-9747539B-FD46-44F1-8FF8-F5AC650F15BE) */ allConnectionStrings: { [key: string]: string; }; /** * The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. */ dedicated: string; /** * The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. */ high: string; /** * The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. */ low: string; /** * The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. */ medium: string; /** * A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. */ profiles: outputs.Database.AutonomousDatabaseConnectionStringProfile[]; } interface AutonomousDatabaseConnectionStringProfile { /** * Consumer group used by the connection. */ consumerGroup: string; /** * (Updatable) The user-friendly name for the Autonomous AI Database. The name does not have to be unique. */ displayName: string; /** * Host format used in connection string. */ hostFormat: string; /** * True for a regional connection string, applicable to cross-region DG only. */ isRegional: boolean; /** * Protocol used by the connection. */ protocol: string; /** * Specifies whether the listener performs a direct hand-off of the session, or redirects the session. In RAC deployments where SCAN is used, sessions are redirected to a Node VIP. Use `DIRECT` for direct hand-offs. Use `REDIRECT` to redirect the session. */ sessionMode: string; /** * Specifies whether the connection string is using the long (`LONG`), Easy Connect (`EZCONNECT`), or Easy Connect Plus (`EZCONNECTPLUS`) format. Autonomous AI Database Serverless instances always use the long format. */ syntaxFormat: string; /** * Specifies whether the TLS handshake is using one-way (`SERVER`) or mutual (`MUTUAL`) authentication. */ tlsAuthentication: string; /** * Connection string value. */ value: string; } interface AutonomousDatabaseConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * The URL of the Spatial Studio for the Autonomous AI Database. */ spatialStudioUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface AutonomousDatabaseCustomerContact { /** * (Updatable) The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface AutonomousDatabaseDbToolsDetail { /** * (Updatable) Compute used by database tools. */ computeCount: number; /** * (Updatable) Indicates whether tool is enabled. */ isEnabled: boolean; /** * (Updatable) The max idle time, in minutes, after which the VM used by database tools will be terminated. */ maxIdleTimeInMinutes: number; /** * (Updatable) Name of database tool. */ name: string; } interface AutonomousDatabaseEncryptionKey { /** * (Updatable) AWS ARN role */ arnRole: string; /** * (Updatable) The provider for the Autonomous AI Database encryption key. */ autonomousDatabaseProvider: string; /** * (Updatable) OKV certificate directory name */ certificateDirectoryName: string; /** * (Updatable) OKV certificate id */ certificateId: string; /** * (Updatable) OKV wallet directory name */ directoryName: string; /** * (Updatable) AWS external ID */ externalId: string; /** * (Updatable) AWS key ARN */ keyArn: string; /** * (Updatable) Azure key name */ keyName: string; /** * (Updatable) GCP key ring */ keyRing: string; /** * (Updatable) The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * (Updatable) GCP kms REST API endpoint */ kmsRestEndpoint: string; /** * (Updatable) GCP key ring location */ location: string; /** * (Updatable) UUID of OKV KMS Key */ okvKmsKey: string; /** * (Updatable) URI of OKV server */ okvUri: string; /** * (Updatable) GCP project name */ project: string; /** * (Updatable) AWS key service endpoint URI */ serviceEndpointUri: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * (Updatable) Azure vault URI */ vaultUri: string; } interface AutonomousDatabaseEncryptionKeyHistoryEntry { /** * (Updatable) Details of the Autonomous AI Database encryption key. */ encryptionKeys: outputs.Database.AutonomousDatabaseEncryptionKeyHistoryEntryEncryptionKey[]; /** * The date and time the kms key activated. */ timeActivated: string; } interface AutonomousDatabaseEncryptionKeyHistoryEntryEncryptionKey { /** * (Updatable) AWS ARN role */ arnRole: string; /** * (Updatable) The provider for the Autonomous AI Database encryption key. */ autonomousDatabaseProvider: string; /** * (Updatable) OKV certificate directory name */ certificateDirectoryName: string; /** * (Updatable) OKV certificate id */ certificateId: string; /** * (Updatable) OKV wallet directory name */ directoryName: string; /** * (Updatable) AWS external ID */ externalId: string; /** * (Updatable) AWS key ARN */ keyArn: string; /** * (Updatable) Azure key name */ keyName: string; /** * (Updatable) GCP key ring */ keyRing: string; /** * (Updatable) The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * (Updatable) GCP kms REST API endpoint */ kmsRestEndpoint: string; /** * (Updatable) GCP key ring location */ location: string; /** * (Updatable) UUID of OKV KMS Key */ okvKmsKey: string; /** * (Updatable) URI of OKV server */ okvUri: string; /** * (Updatable) GCP project name */ project: string; /** * (Updatable) AWS key service endpoint URI */ serviceEndpointUri: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * (Updatable) Azure vault URI */ vaultUri: string; } interface AutonomousDatabaseEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; azureEncryptionKeyId: string; hsmPassword: string; /** * Use 'AWS' for creating a new database. */ providerType: string; } interface AutonomousDatabaseKeyHistoryEntry { /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The date and time the kms key activated. */ timeActivated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; } interface AutonomousDatabaseLocalStandbyDb { /** * (Updatable) The Autonomous Database Serverless instance's availability domain. */ availabilityDomain: string; /** * The external logical zone where the local Autonomous Data Guard is located (Intended for multicloud use). */ externalLocationZone: string; /** * The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. */ lagTimeInSeconds: number; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The component chosen for maintenance. */ maintenanceTargetComponent: string; /** * The current state of the Autonomous AI Database. */ state: string; /** * The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. */ timeDataGuardRoleChanged: string; /** * The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. */ timeDisasterRecoveryRoleChanged: string; /** * The date and time when maintenance will begin. */ timeMaintenanceBegin: string; /** * The date and time when maintenance will end. */ timeMaintenanceEnd: string; } interface AutonomousDatabaseLongTermBackupSchedule { /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * The frequency of the long-term backup schedule */ repeatCadence: string; /** * Retention period, in days, for long-term backups */ retentionPeriodInDays: number; /** * The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. */ timeOfBackup: string; } interface AutonomousDatabasePublicConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * The URL of the Spatial Studio for the Autonomous AI Database. */ spatialStudioUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface AutonomousDatabaseRemoteDisasterRecoveryConfiguration { /** * Indicates the disaster recovery (DR) type of the standby Autonomous AI Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. */ disasterRecoveryType: string; /** * If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. */ isReplicateAutomaticBackups: boolean; /** * Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. */ isSnapshotStandby: boolean; /** * Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. */ timeSnapshotStandbyEnabledTill: string; } interface AutonomousDatabaseResourcePoolSummary { /** * (Updatable) Available capacity left for new elastic pool members provision */ availableComputeCapacity: number; /** * (Updatable) Available storage capacity (in TB) that can be used for adding new members or scaling existing members in a dedicated elastic pool. */ availableStorageCapacityInTbs: number; /** * (Updatable) Indicates if the resource pool should be deleted for the Autonomous AI Database. */ isDisabled: boolean; /** * (Updatable) Resource pool size. */ poolSize: number; /** * (Updatable) Resource pool storage size in TBs. */ poolStorageSizeInTbs: number; /** * Resource Pool total capacity, it's currently 4x of pool size */ totalComputeCapacity: number; } interface AutonomousDatabaseScheduledOperation { /** * (Updatable) Day of the week. */ dayOfWeek?: outputs.Database.AutonomousDatabaseScheduledOperationDayOfWeek; /** * (Updatable) auto start time. value must be of ISO-8601 format "HH:mm" */ scheduledStartTime?: string; /** * (Updatable) auto stop time. value must be of ISO-8601 format "HH:mm" */ scheduledStopTime?: string; } interface AutonomousDatabaseScheduledOperationDayOfWeek { /** * (Updatable) Name of the day of the week. */ name: string; } interface AutonomousDatabaseStandbyDb { /** * (Updatable) The Autonomous Database Serverless instance's availability domain. */ availabilityDomain: string; /** * The external logical zone where the local Autonomous Data Guard is located (Intended for multicloud use). */ externalLocationZone: string; /** * The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. */ lagTimeInSeconds: number; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The component chosen for maintenance. */ maintenanceTargetComponent: string; /** * The current state of the Autonomous AI Database. */ state: string; /** * The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. */ timeDataGuardRoleChanged: string; /** * The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. */ timeDisasterRecoveryRoleChanged: string; /** * The date and time when maintenance will begin. */ timeMaintenanceBegin: string; /** * The date and time when maintenance will end. */ timeMaintenanceEnd: string; } interface AutonomousDatabaseTransportableTablespace { /** * URL for Oracle Cloud Infrastructure Storage location for a Transportable Tablespace (TTS) bundle. */ ttsBundleUrl: string; } interface AutonomousDatabaseVanityConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface AutonomousDatabaseVanityUrlDetail { /** * API Gateway ID. */ apiGatewayId: string; /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * Custom URL prefix provided by the customer to access dbTools. */ vanityUrlHostName: string; } interface AutonomousExadataInfrastructureMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.AutonomousExadataInfrastructureMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.AutonomousExadataInfrastructureMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface AutonomousExadataInfrastructureMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface AutonomousExadataInfrastructureMaintenanceWindowDetails { /** * (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * (Updatable) Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.AutonomousExadataInfrastructureMaintenanceWindowDetailsDaysOfWeek[]; /** * (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * (Updatable) If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * (Updatable) Months during the year when maintenance should be performed. */ months: outputs.Database.AutonomousExadataInfrastructureMaintenanceWindowDetailsMonth[]; /** * (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. * * *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * (Updatable) The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface AutonomousExadataInfrastructureMaintenanceWindowDetailsDaysOfWeek { /** * (Updatable) Name of the day of the week. */ name: string; } interface AutonomousExadataInfrastructureMaintenanceWindowDetailsMonth { /** * (Updatable) Name of the month of the year. */ name: string; } interface AutonomousExadataInfrastructureMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface AutonomousVmClusterMaintenanceWindow { customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.AutonomousVmClusterMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; isCustomActionTimeoutEnabled: boolean; isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.AutonomousVmClusterMaintenanceWindowMonth[]; /** * (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. * * *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface AutonomousVmClusterMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface AutonomousVmClusterMaintenanceWindowDetail { customActionTimeoutInMins: number; /** * (Updatable) Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.AutonomousVmClusterMaintenanceWindowDetailDaysOfWeek[]; /** * (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; isCustomActionTimeoutEnabled: boolean; isMonthlyPatchingEnabled: boolean; /** * (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * (Updatable) Months during the year when maintenance should be performed. */ months: outputs.Database.AutonomousVmClusterMaintenanceWindowDetailMonth[]; /** * (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. * * *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * (Updatable) The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface AutonomousVmClusterMaintenanceWindowDetailDaysOfWeek { /** * (Updatable) Name of the day of the week. */ name: string; } interface AutonomousVmClusterMaintenanceWindowDetailMonth { /** * (Updatable) Name of the month of the year. */ name: string; } interface AutonomousVmClusterMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface BackupDestinationAssociatedDatabase { /** * The display name of the database that is associated with the backup destination. */ dbName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; } interface BackupDestinationAssociatedLongTermBackup { /** * The user-provided name of the backup destination. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; } interface BackupDestinationMountTypeDetails { /** * The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. */ localMountPointPath: string; /** * Mount type for backup destination. */ mountType: string; /** * Specifies the directory on which to mount the file system */ nfsServerExport: string; /** * IP addresses for NFS Auto mount. */ nfsServers: string[]; } interface BackupEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; /** * Provide the key OCID of a registered Azure key. */ azureEncryptionKeyId: string; /** * Provide the key OCID of a registered GCP key. */ googleCloudProviderEncryptionKeyId: string; /** * Provide the HSM password as you would in RDBMS for External HSM. */ hsmPassword: string; /** * Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. Use 'AZURE' for creating a new database or migrating a database key to Azure. Use 'AWS' for creating a new database or migrating a database key to Aws. Use 'GCP' for creating a new database or migrating a database key to Gcp. */ providerType: string; } interface CloudAutonomousVmClusterMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.CloudAutonomousVmClusterMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.CloudAutonomousVmClusterMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface CloudAutonomousVmClusterMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface CloudAutonomousVmClusterMaintenanceWindowDetails { /** * (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * (Updatable) Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.CloudAutonomousVmClusterMaintenanceWindowDetailsDaysOfWeek[]; /** * (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * (Updatable) If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * (Updatable) Months during the year when maintenance should be performed. */ months: outputs.Database.CloudAutonomousVmClusterMaintenanceWindowDetailsMonth[]; /** * (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. * * *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * (Updatable) The maintenance window scheduling preference. */ preference: string; /** * (Updatable) If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface CloudAutonomousVmClusterMaintenanceWindowDetailsDaysOfWeek { /** * (Updatable) Name of the day of the week. */ name: string; } interface CloudAutonomousVmClusterMaintenanceWindowDetailsMonth { /** * (Updatable) Name of the month of the year. */ name: string; } interface CloudAutonomousVmClusterMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface CloudAutonomousVmClusterMultiCloudIdentityConnectorConfig { /** * Cloud provider */ cloudProvider: string; /** * The OCID of the identity connector */ id: string; } interface CloudDatabaseManagementCredentialdetails { /** * Specific database username's password [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ passwordSecretId: string; /** * Database username */ userName: string; } interface CloudExadataInfrastructureConfigureExascaleManagementCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface CloudExadataInfrastructureConfigureExascaleManagementDefinedFileSystemConfiguration { /** * If true, the file system is used to create a backup prior to Exadata VM OS update. */ isBackupPartition: boolean; /** * If true, the file system resize is allowed for the Exadata Infrastructure cluster. If false, the file system resize is not allowed. */ isResizable: boolean; /** * The minimum size of file system. */ minSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface CloudExadataInfrastructureConfigureExascaleManagementExascaleConfig { /** * Available storage size for Exascale in GBs. */ availableStorageInGbs: number; availableVmStorageInGbs: number; /** * Storage size needed for Exascale in GBs. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ totalStorageInGbs: number; totalVmStorageInGbs: number; } interface CloudExadataInfrastructureConfigureExascaleManagementMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.CloudExadataInfrastructureConfigureExascaleManagementMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.CloudExadataInfrastructureConfigureExascaleManagementMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface CloudExadataInfrastructureConfigureExascaleManagementMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface CloudExadataInfrastructureConfigureExascaleManagementMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface CloudExadataInfrastructureCustomerContact { /** * (Updatable) The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface CloudExadataInfrastructureDefinedFileSystemConfiguration { /** * If true, the file system is used to create a backup prior to Exadata VM OS update. */ isBackupPartition: boolean; /** * If true, the file system resize is allowed for the Exadata Infrastructure cluster. If false, the file system resize is not allowed. */ isResizable: boolean; /** * The maximum size of file system. */ maxSizeGb: number; /** * The minimum size of file system. */ minSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface CloudExadataInfrastructureExascaleConfig { /** * Available storage size for Exascale in GBs. */ availableStorageInGbs: number; /** * Available storage size for VM storage on Exascale in GBs. */ availableVmStorageInGbs: number; /** * Storage size needed for Exascale in GBs. */ totalStorageInGbs: number; /** * Storage size needed for VM storage on Exascale in GBs. */ totalVmStorageInGbs: number; } interface CloudExadataInfrastructureMaintenanceVersionPreferences { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. */ referenceResourceIdForImageUpdates: string; } interface CloudExadataInfrastructureMaintenanceWindow { /** * (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * (Updatable) Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.CloudExadataInfrastructureMaintenanceWindowDaysOfWeek[]; /** * (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * (Updatable) If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * (Updatable) Months during the year when maintenance should be performed. */ months: outputs.Database.CloudExadataInfrastructureMaintenanceWindowMonth[]; /** * (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. * * *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * (Updatable) The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface CloudExadataInfrastructureMaintenanceWindowDaysOfWeek { /** * (Updatable) Name of the day of the week. */ name: string; } interface CloudExadataInfrastructureMaintenanceWindowMonth { /** * (Updatable) Name of the month of the year. */ name: string; } interface CloudVmClusterCloudAutomationUpdateDetails { /** * (Updatable) Configure the time slot for applying VM cloud automation software updates to the cluster. When nothing is selected, the default time slot is 12 AM to 2 AM UTC. Any 2-hour slot is available starting at 12 AM. */ applyUpdateTimePreference: outputs.Database.CloudVmClusterCloudAutomationUpdateDetailsApplyUpdateTimePreference; /** * (Updatable) Enables a freeze period for the VM cluster prohibiting the VMs from getting cloud automation software updates during critical business cycles. Freeze period start date. Starts at 12:00 AM UTC on the selected date and ends at 11:59:59 PM UTC on the selected date. Validates to ensure the freeze period does not exceed 45 days. */ freezePeriod: outputs.Database.CloudVmClusterCloudAutomationUpdateDetailsFreezePeriod; /** * (Updatable) Annotates whether the cluster should be part of early access to apply VM cloud automation software updates. Those clusters annotated as early access will download the software bits for cloud automation in the first week after the update is available, while other clusters will have to wait until the following week. */ isEarlyAdoptionEnabled: boolean; /** * (Updatable) Specifies if the freeze period is enabled for the VM cluster to prevent the VMs from receiving cloud automation software updates during critical business cycles. Freeze period starts at 12:00 AM UTC and ends at 11:59:59 PM UTC on the selected date. Ensure that the freezing period does not exceed 45 days. */ isFreezePeriodEnabled: boolean; } interface CloudVmClusterCloudAutomationUpdateDetailsApplyUpdateTimePreference { /** * (Updatable) End time for polling VM cloud automation software updates for the cluster. If the endTime is not specified, 2 AM UTC is used by default. */ applyUpdatePreferredEndTime: string; /** * (Updatable) Start time for polling VM cloud automation software updates for the cluster. If the startTime is not specified, 12 AM UTC is used by default. */ applyUpdatePreferredStartTime: string; } interface CloudVmClusterCloudAutomationUpdateDetailsFreezePeriod { /** * (Updatable) End time of the freeze period cycle. */ freezePeriodEndTime: string; /** * (Updatable) Start time of the freeze period cycle. */ freezePeriodStartTime: string; } interface CloudVmClusterDataCollectionOptions { /** * (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface CloudVmClusterFileSystemConfigurationDetail { /** * (Updatable) The file system size to be allocated in GBs. */ fileSystemSizeGb: number; /** * (Updatable) The mount point of file system. */ mountPoint: string; } interface CloudVmClusterIormConfigCache { /** * An array of IORM settings for all the database in the Exadata DB system. */ dbPlans: outputs.Database.CloudVmClusterIormConfigCacheDbPlan[]; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current value for the IORM objective. The default is `AUTO`. */ objective: string; /** * The current state of the cloud VM cluster. */ state: string; } interface CloudVmClusterIormConfigCacheDbPlan { /** * The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * The relative priority of this database. */ share: number; } interface CloudVmClusterIormConfigDbPlan { /** * (Updatable) The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * (Updatable) The relative priority of this database. */ share: number; } interface CloudVmClusterLiveImageVersionDetail { /** * Indicates whether OS updates that require node reboot are pending after the previous online update was applied. */ hasPendingUpdates: boolean; /** * The release date and time for the applied Live Exadata Image OS version. */ timeReleased: string; /** * The OS live update mode performed most recently on the VM Cluster. */ updateMode: string; /** * Live Exadata Image Version of the Guest OS Update applied. */ version: string; } interface CloudVmClusterMultiCloudIdentityConnectorConfig { /** * Cloud provider */ cloudProvider: string; /** * The OCID of the identity connector */ id: string; } interface CloudVmClusterUpdateDetails { /** * (Updatable) The update action. Supported values include `ROLLING_APPLY`, `NON_ROLLING_APPLY`, `PRECHECK`, and `ROLLBACK`. */ updateAction?: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance update. */ updateId?: string; /** * (Updatable) The OS update mode. Supported values are `ONLINE_HIGHCVSS`, `ONLINE_ALLCVSS`, `ONLINE_ALL_UPDATES`, `PENDING_UPDATES`, and `FULL_UPDATE`. */ updateMode?: string; } interface DataGuardAssociationDataCollectionOptions { /** * Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface DataPatchDataPatchOption { shouldSkipClosedPdbs?: boolean; } interface DatabaseConnectionString { /** * All connection strings to use to connect to the Database. */ allConnectionStrings: { [key: string]: string; }; /** * Host name based CDB Connection String. */ cdbDefault: string; /** * IP based CDB Connection String. */ cdbIpDefault: string; } interface DatabaseDataGuardGroup { /** * Specifies readiness of Managed Automatic failover. */ managedAutoFailOverReadiness: string; /** * List of Data Guard members, representing each database that is part of Data Guard. */ members: outputs.Database.DatabaseDataGuardGroupMember[]; /** * The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; } interface DatabaseDataGuardGroupMember { /** * The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `1 second` */ applyLag: string; /** * The rate at which redo logs are synced between the associated databases. Example: `102.96 MByte/s` */ applyRate: string; /** * The Data loss exposure is the redo transport lag between the primary and standby databases. Example: `2 seconds` */ dataLossExposure: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database. */ databaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ dbSystemId: string; /** * The failover readiness status of the Data Guard member. HEALTHY_AND_NOT_ROLECHANGE_TARGET - Indicates that the respective standby member is healthy but not currently designated to take failover, when auto failover is enabled. */ failoverReadiness: string; /** * The message explaining failover readiness status. Example: `This standby database is not failover ready.` */ failoverReadinessMessage: string; /** * Specifies the `DB_UNIQUE_NAME` of the data guard group member databases. */ failoverTargets: string[]; /** * True if active Data Guard is enabled. */ isActiveDataGuardEnabled: boolean; /** * The state of managed auto failover. */ managedAutoFailover: string; /** * The role of the reporting database in this Data Guard association. */ role: string; /** * The switchover readiness status of the Data Guard member. * * HEALTHY_AND_NOT_ROLECHANGE_TARGET - Indicates that the respective standby member is healthy but not currently designated to take switchover, when auto failover is enabled. */ switchoverReadiness: string; /** * The message explaining switchover readiness status. Example: `Address failed checks to avoid extended downtime.` */ switchoverReadinessMessage: string; /** * The date and time when the last successful Data Guard refresh occurred. */ timeUpdated: string; /** * The rate at which redo logs are transported between the associated databases. Example: `1 second` */ transportLag: string; /** * The date and time when last redo transport has been done. */ transportLagRefresh: string; /** * The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * * MAXIMUM_PERFORMANCE - ASYNC * * MAXIMUM_PROTECTION - SYNC */ transportType: string; } interface DatabaseDatabase { /** * A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \#, or -. */ adminPassword: string; /** * The properties for defining auto failover configuration. */ autoFailoverConfiguration: outputs.Database.DatabaseDatabaseAutoFailoverConfiguration; /** * The backup [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ backupId?: string; /** * The password to open the TDE wallet. */ backupTdePassword?: string; /** * The character set for the database. The default is AL32UTF8. Allowed values are: * * AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS */ characterSet: string; /** * The administrator password of the primary database in this Data Guard association. * * **The password MUST be the same as the primary admin password.** */ databaseAdminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database. */ databaseId?: string; /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; /** * (Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). */ dbBackupConfig: outputs.Database.DatabaseDatabaseDbBackupConfig; /** * The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. */ dbName: string; /** * Specifies the `DB_UNIQUE_NAME` of the peer database to be created. */ dbUniqueName: string; /** * **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. * * The database workload type. */ dbWorkload: string; /** * (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). */ definedTags: { [key: string]: string; }; /** * Types of providers supported for managing database encryption keys */ encryptionKeyLocationDetails: outputs.Database.DatabaseDatabaseEncryptionKeyLocationDetails; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * True if active Data Guard is enabled. */ isActiveDataGuardEnabled?: boolean; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances. */ kmsKeyVersionId: string; /** * The database registered for Oracle Managed Database Software Updates. */ managedSoftwareUpdateDetails: outputs.Database.DatabaseDatabaseManagedSoftwareUpdateDetail[]; /** * The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8. */ ncharacterSet: string; /** * (Updatable) Options for DB Home and Database patching */ patchOptions?: outputs.Database.DatabaseDatabasePatchOptions; /** * The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. */ pdbName: string; /** * The list of pluggable databases that needs to be restored into new database. */ pluggableDatabases: string[]; /** * The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode?: string; /** * The password for the VPC user that is used to access the Recovery Appliance, if the given backup is from a backup destination of type RECOVERY_APPLIANCE. */ recoveryApplianceVpcPassword: string; /** * Specifies a prefix for the `Oracle SID` of the database to be created. */ sidPrefix: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source database. */ sourceDatabaseId?: string; /** * Types of providers supported for managing database encryption keys */ sourceEncryptionKeyLocationDetails: outputs.Database.DatabaseDatabaseSourceEncryptionKeyLocationDetails; /** * The TDE wallet password of the source database specified by 'sourceDatabaseId'. */ sourceTdeWalletPassword?: string; /** * The database storage size details. This database option is supported for the Exadata VM cluster on Exascale Infrastructure. */ storageSizeDetails: outputs.Database.DatabaseDatabaseStorageSizeDetails; /** * The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \#, or -. */ tdeWalletPassword: string; timeStampForPointInTimeRecovery?: string; /** * The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * * MAXIMUM_PERFORMANCE - ASYNC * * MAXIMUM_PROTECTION - SYNC * * For more information, see [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation. * * **IMPORTANT** - The only transport type currently supported by the Database service is ASYNC. */ transportType?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster. */ vmClusterId: string; } interface DatabaseDatabaseAutoFailoverConfiguration { /** * Specifies the `DB_UNIQUE_NAME` of the data guard group member databases. */ failoverTargets: string[]; /** * The state of managed auto failover. */ managedAutoFailover: string; } interface DatabaseDatabaseDbBackupConfig { /** * (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ autoBackupEnabled: boolean; /** * (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay?: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.Database.DatabaseDatabaseDbBackupConfigBackupDestinationDetail[]; /** * (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ runImmediateFullBackup: boolean; } interface DatabaseDatabaseDbBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled?: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Backup destination for the TDE wallet backups. */ tdeWalletBackupDestination: outputs.Database.DatabaseDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination; /** * Type of the database backup destination. */ type?: string; vpcPassword?: string; vpcUser?: string; } interface DatabaseDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ backupDestinationId: string; /** * Destination where TDE Wallet backups are to be placed. */ backupDestinationType: string; } interface DatabaseDatabaseEncryptionKeyLocationDetails { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; /** * Provide the key OCID of a registered Azure key. */ azureEncryptionKeyId: string; /** * Provide the key OCID of a registered GCP key. */ googleCloudProviderEncryptionKeyId: string; /** * Provide the HSM password as you would in RDBMS for External HSM. */ hsmPassword?: string; /** * Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. Use 'AZURE' for creating a new database or migrating a database key to Azure. Use 'AWS' for creating a new database or migrating a database key to Aws. Use 'GCP' for creating a new database or migrating a database key to Gcp. */ providerType: string; } interface DatabaseDatabaseManagedSoftwareUpdateDetail { /** * If true, database is registered for Oracle Managed Database Software Updates otherwise database is not registered for Oracle Managed Database Software Updates */ isEnrolled: boolean; /** * Provides details about actual Oracle Managed Database Software Updates scheduled time and version. */ maintenanceDetails: outputs.Database.DatabaseDatabaseManagedSoftwareUpdateDetailMaintenanceDetail[]; /** * Oracle Managed Database Software Updates schedule will be created based on the provided update preferences */ preferenceDetails: outputs.Database.DatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetail[]; } interface DatabaseDatabaseManagedSoftwareUpdateDetailMaintenanceDetail { /** * The date and time of the last readiness check. */ timeOfLastReadinessCheck: string; /** * The date and time of when the status was updated. */ timeOfStatusUpdate: string; /** * The date and time of the database was scheduled for update. */ timeScheduled: string; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The managed software update readiness status */ updateReadinessStatus: string; /** * This field will contain actual cause of update readiness state. */ updateReadinessStatusDetails: string; /** * The version of the database was scheduled for update. */ version: string; } interface DatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetail { /** * The update should be applied on the database for the selected days of the week. */ daysOfWeeks: string[]; /** * The update should be applied on the database for the selected hour of the day. */ hourOfDay: number; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The update should be applied on the database for the selected version scheme. */ versionSchemeDetails: outputs.Database.DatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail[]; } interface DatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail { /** * The update should be applied on the database for the selected major version series. The value can be provided as 23.X.X.X then 23 major version series will be considered. * * The list of supported versions can be obtained using the API for the provided shape /20160918/dbVersions?compartmentId=&dbSystemShape=ExaDbXS */ majorVersion: string; /** * The update should be applied on the database for the selected version scheme. */ source: string; /** * The update should be applied on the database for the selected version preference. *_N represents the LATEST version * * For Ex: The current latest version is 23.7.0.0.0, If versionPreference selects option as ORACLE_DB_N then oracle applies the db update with LATEST version (i.e. 23.7.0.0.0) If versionPreference selects option as ORACLE_DB_N_1 then oracle applies the db update with LATEST-1 version (i.e. 23.6.0.0.0) If versionPreference selects option as ORACLE_DB_N_2 then oracle applies the db update with LATEST-2 version (i.e. 23.5.0.0.0) */ versionPreference: string; } interface DatabaseDatabaseManagementConfig { /** * The status of the Database Management service. */ managementStatus: string; /** * The Database Management type. */ managementType: string; } interface DatabaseDatabasePatchOptions { /** * Skip running datapatch on PDBs in closed state */ shouldSkipClosedPdbs?: boolean; /** * Skip running datapatch on database(s) */ shouldSkipDataPatch?: boolean; } interface DatabaseDatabaseSourceEncryptionKeyLocationDetails { /** * Provide the HSM password as you would in RDBMS for External HSM. */ hsmPassword?: string; /** * Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. Use 'AZURE' for creating a new database or migrating a database key to Azure. Use 'AWS' for creating a new database or migrating a database key to Aws. Use 'GCP' for creating a new database or migrating a database key to Gcp. */ providerType: string; } interface DatabaseDatabaseStorageSizeDetails { /** * The DATA storage size, in gigabytes, that is applicable for the database. */ dataStorageSizeInGb: number; /** * The RECO storage size, in gigabytes, that is applicable for the database. */ recoStorageSizeInGbs: number; /** * The REDO Log storage size, in gigabytes, that is applicable for the database. */ redoLogStorageSizeInGbs: number; } interface DatabaseDbBackupConfig { /** * If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ autoBackupEnabled: boolean; /** * Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.Database.DatabaseDbBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ runImmediateFullBackup: boolean; } interface DatabaseDbBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ id: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Backup destination for the TDE wallet backups. */ tdeWalletBackupDestinations: outputs.Database.DatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination[]; /** * Type of the database backup destination. */ type: string; vpcPassword: string; vpcUser: string; } interface DatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ backupDestinationId: string; /** * Destination where TDE Wallet backups are to be placed. */ backupDestinationType: string; } interface DatabaseManagedSoftwareUpdateDetail { /** * If true, database is registered for Oracle Managed Database Software Updates otherwise database is not registered for Oracle Managed Database Software Updates */ isEnrolled: boolean; /** * Provides details about actual Oracle Managed Database Software Updates scheduled time and version. */ maintenanceDetails: outputs.Database.DatabaseManagedSoftwareUpdateDetailMaintenanceDetail[]; /** * Oracle Managed Database Software Updates schedule will be created based on the provided update preferences */ preferenceDetails: outputs.Database.DatabaseManagedSoftwareUpdateDetailPreferenceDetail[]; } interface DatabaseManagedSoftwareUpdateDetailMaintenanceDetail { /** * The date and time of the last readiness check. */ timeOfLastReadinessCheck: string; /** * The date and time of when the status was updated. */ timeOfStatusUpdate: string; /** * The date and time of the database was scheduled for update. */ timeScheduled: string; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The managed software update readiness status */ updateReadinessStatus: string; /** * This field will contain actual cause of update readiness state. */ updateReadinessStatusDetails: string; /** * The version of the database was scheduled for update. */ version: string; } interface DatabaseManagedSoftwareUpdateDetailPreferenceDetail { /** * The update should be applied on the database for the selected days of the week. */ daysOfWeeks: string[]; /** * The update should be applied on the database for the selected hour of the day. */ hourOfDay: number; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The update should be applied on the database for the selected version scheme. */ versionSchemeDetails: outputs.Database.DatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail[]; } interface DatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail { /** * The update should be applied on the database for the selected major version series. The value can be provided as 23.X.X.X then 23 major version series will be considered. */ majorVersion: string; /** * The source of the database: Use `NONE` for creating a new database. Use `DB_BACKUP` for creating a new database by restoring from a backup. Use `DATAGUARD` for creating a new STANDBY database for a Data Guard setup.. The default is `NONE`. */ source: string; /** * The update should be applied on the database for the selected version preference. *_N represents the LATEST version */ versionPreference: string; } interface DatabaseSnapshotStandbyConnectionString { /** * All connection strings to use to connect to the Database. */ allConnectionStrings: { [key: string]: string; }; /** * Host name based CDB Connection String. */ cdbDefault: string; /** * IP based CDB Connection String. */ cdbIpDefault: string; } interface DatabaseSnapshotStandbyDataGuardGroup { /** * List of Data Guard members, representing each database that is part of Data Guard. */ members: outputs.Database.DatabaseSnapshotStandbyDataGuardGroupMember[]; /** * The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; } interface DatabaseSnapshotStandbyDataGuardGroupMember { /** * The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `1 second` */ applyLag: string; /** * The rate at which redo logs are synced between the associated databases. Example: `102.96 MByte/s` */ applyRate: string; /** * The database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ databaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ dbSystemId: string; /** * True if active Data Guard is enabled. */ isActiveDataGuardEnabled: boolean; /** * The role of the reporting database in this Data Guard association. */ role: string; /** * The rate at which redo logs are transported between the associated databases. Example: `1 second` */ transportLag: string; /** * The date and time when last redo transport has been done. */ transportLagRefresh: string; /** * The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * * MAXIMUM_PERFORMANCE - ASYNC * * MAXIMUM_PROTECTION - SYNC */ transportType: string; } interface DatabaseSnapshotStandbyDatabaseManagementConfig { /** * The status of the Database Management service. */ managementStatus: string; /** * The Database Management type. */ managementType: string; } interface DatabaseSnapshotStandbyDbBackupConfig { /** * If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ autoBackupEnabled: boolean; /** * Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.Database.DatabaseSnapshotStandbyDbBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ runImmediateFullBackup: boolean; } interface DatabaseSnapshotStandbyDbBackupConfigBackupDestinationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface DatabaseStorageSizeDetail { /** * The DATA storage size, in gigabytes, that is applicable for the database. */ dataStorageSizeInGb: number; /** * The RECO storage size, in gigabytes, that is applicable for the database. */ recoStorageSizeInGbs: number; /** * The REDO Log storage size, in gigabytes, that is applicable for the database. */ redoLogStorageSizeInGbs: number; } interface DatabaseUpgradeConnectionString { /** * All connection strings to use to connect to the Database. */ allConnectionStrings: { [key: string]: string; }; /** * Host name based CDB Connection String. */ cdbDefault: string; /** * IP based CDB Connection String. */ cdbIpDefault: string; } interface DatabaseUpgradeDataGuardGroup { /** * Specifies readiness of Managed Automatic failover. */ managedAutoFailOverReadiness: string; /** * List of Data Guard members, representing each database that is part of Data Guard. */ members: outputs.Database.DatabaseUpgradeDataGuardGroupMember[]; /** * The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; } interface DatabaseUpgradeDataGuardGroupMember { /** * The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `1 second` */ applyLag: string; /** * The rate at which redo logs are synced between the associated databases. Example: `102.96 MByte/s` */ applyRate: string; /** * The Data loss exposure is the redo transport lag between the primary and standby databases. Example: `2 seconds` */ dataLossExposure: string; /** * The database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ databaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ dbSystemId: string; /** * The failover readiness status of the Data Guard member. HEALTHY_AND_NOT_ROLECHANGE_TARGET - Indicates that the respective standby member is healthy but not currently designated to take failover, when auto failover is enabled. */ failoverReadiness: string; /** * The message explaining failover readiness status. Example: `This standby database is not failover ready.` */ failoverReadinessMessage: string; /** * Specifies the `DB_UNIQUE_NAME` of the data guard group member databases. */ failoverTargets: string[]; /** * True if active Data Guard is enabled. */ isActiveDataGuardEnabled: boolean; /** * The state of managed auto failover. */ managedAutoFailover: string; /** * The role of the reporting database in this Data Guard association. */ role: string; /** * The switchover readiness status of the Data Guard member. * * HEALTHY_AND_NOT_ROLECHANGE_TARGET - Indicates that the respective standby member is healthy but not currently designated to take switchover, when auto failover is enabled. */ switchoverReadiness: string; /** * The message explaining switchover readiness status. Example: `Address failed checks to avoid extended downtime.` */ switchoverReadinessMessage: string; /** * The date and time when the last successful Data Guard refresh occurred. */ timeUpdated: string; /** * The rate at which redo logs are transported between the associated databases. Example: `1 second` */ transportLag: string; /** * The date and time when last redo transport has been done. */ transportLagRefresh: string; /** * The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * * MAXIMUM_PERFORMANCE - ASYNC * * MAXIMUM_PROTECTION - SYNC */ transportType: string; } interface DatabaseUpgradeDatabaseUpgradeSourceDetails { /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the image to be used to upgrade a database. */ databaseSoftwareImageId: string; /** * A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. * * This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. */ dbVersion: string; /** * Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents" */ options: string; /** * The source of the Oracle Database software to be used for the upgrade. * * Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. * * Use `DB_SOFTWARE_IMAGE` to specify a [database software image](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/databasesoftwareimage.htm) to upgrade the database. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ source: string; } interface DatabaseUpgradeDbBackupConfig { /** * If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ autoBackupEnabled: boolean; /** * Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.Database.DatabaseUpgradeDbBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ runImmediateFullBackup: boolean; } interface DatabaseUpgradeDbBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface DbHomeDatabase { /** * A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \#, or -. */ adminPassword: string; /** * The backup [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ backupId: string; /** * The password to open the TDE wallet. */ backupTdePassword: string; /** * The character set for the database. The default is AL32UTF8. Allowed values are: * * AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS */ characterSet: string; connectionStrings: outputs.Database.DbHomeDatabaseConnectionString[]; /** * The database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ databaseId: string; /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; /** * (Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). */ dbBackupConfig: outputs.Database.DbHomeDatabaseDbBackupConfig; /** * The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. */ dbName: string; dbUniqueName: string; /** * **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. * * The database workload type. */ dbWorkload: string; /** * (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). */ definedTags: { [key: string]: string; }; /** * Types of providers supported for managing database encryption keys */ encryptionKeyLocationDetails: outputs.Database.DbHomeDatabaseEncryptionKeyLocationDetails; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. */ keyStoreId: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId?: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId?: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8. */ ncharacterSet: string; /** * List of one-off patches for Database Homes. */ oneOffPatches: string[]; /** * The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. */ pdbName: string; /** * The list of pluggable databases that needs to be restored into new database. */ pluggableDatabases: string[]; /** * The password for the VPC user that is used to access the Recovery Appliance, if the given backup is from a backup destination of type RECOVERY_APPLIANCE. */ recoveryApplianceVpcPassword: string; /** * Specifies a prefix for the `Oracle SID` of the database to be created. */ sidPrefix: string; /** * The current state of the Database Home. */ state: string; /** * The database storage size details. This database option is supported for the Exadata VM cluster on Exascale Infrastructure. */ storageSizeDetails: outputs.Database.DbHomeDatabaseStorageSizeDetails; /** * The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \#, or -. */ tdeWalletPassword: string; /** * The date and time the Database Home was created. */ timeCreated: string; /** * The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database. */ timeStampForPointInTimeRecovery: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster. */ vmClusterId: string; } interface DbHomeDatabaseConnectionString { allConnectionStrings: { [key: string]: string; }; cdbDefault: string; cdbIpDefault: string; } interface DbHomeDatabaseDbBackupConfig { /** * (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ autoBackupEnabled: boolean; /** * (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay?: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.Database.DbHomeDatabaseDbBackupConfigBackupDestinationDetail[]; /** * (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ runImmediateFullBackup: boolean; } interface DbHomeDatabaseDbBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Backup destination for the TDE wallet backups. */ tdeWalletBackupDestination: outputs.Database.DbHomeDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination; /** * Type of the database backup destination. Supported values: `NFS`. */ type: string; vpcPassword?: string; vpcUser?: string; } interface DbHomeDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ backupDestinationId: string; /** * Destination where TDE Wallet backups are to be placed. */ backupDestinationType: string; } interface DbHomeDatabaseEncryptionKeyLocationDetails { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; /** * Provide the key OCID of a registered Azure key. */ azureEncryptionKeyId: string; googleCloudProviderEncryptionKeyId: string; /** * Provide the HSM password as you would in RDBMS for External HSM. */ hsmPassword?: string; /** * Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. Use 'AZURE' for creating a new database or migrating a database key to Azure. */ providerType: string; } interface DbHomeDatabaseStorageSizeDetails { /** * The DATA storage size, in gigabytes, that is applicable for the database. */ dataStorageSizeInGb: number; /** * The RECO storage size, in gigabytes, that is applicable for the database. */ recoStorageSizeInGbs: number; redoLogStorageSizeInGbs: number; } interface DbNodeSnapshotManagementSnapshot { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster. */ clusterId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Defined tags for the Exadata Database Node Snapshots. 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). */ definedTags: { [key: string]: string; }; /** * Free-form tags for the Exadata Database Node Snapshots. 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Node Snapshot. */ id: string; /** * Additional information about the current lifecycle state of the Exadata Database Node Snapshot. */ lifecycleDetails: string; /** * Details of the mount points */ mountPoints: outputs.Database.DbNodeSnapshotManagementSnapshotMountPoint[]; /** * The suffix of the Exadata Database Node Snapshot names (Snpashot name = Node hostname + "-" + suffix). The Exadata Database Node Snapshot name should be unique. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Node. */ sourceDbnodeId: string; /** * The current state of the Exadata Database Node Snapshot. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time that the Exadata Database Node Snapshot was created. */ timeCreated: string; /** * Details of the volumes */ volumes: outputs.Database.DbNodeSnapshotManagementSnapshotVolume[]; } interface DbNodeSnapshotManagementSnapshotMountPoint { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Node where snapshot was mounted. */ dbNodeId: string; /** * The suffix of the Exadata Database Node Snapshot names (Snpashot name = Node hostname + "-" + suffix). The Exadata Database Node Snapshot name should be unique. */ name: string; } interface DbNodeSnapshotManagementSnapshotVolume { /** * The suffix of the Exadata Database Node Snapshot names (Snpashot name = Node hostname + "-" + suffix). The Exadata Database Node Snapshot name should be unique. */ name: string; /** * Volume Size */ size: number; } interface DbNodeSnapshotMountPoint { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Node where snapshot was mounted. */ dbNodeId: string; /** * Volume Name */ name: string; } interface DbNodeSnapshotVolume { /** * Volume Name */ name: string; /** * Volume Size */ size: number; } interface DbSystemDataCollectionOptions { /** * (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface DbSystemDbHome { createAsync?: boolean; /** * (Updatable) Details for creating a database by restoring from a source database system. * * **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. */ database: outputs.Database.DbSystemDbHomeDatabase; /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the image to be used to restore a database. */ databaseSoftwareImageId: string; dbHomeLocation: string; /** * A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. * * This cannot be updated in parallel with any of the following: licenseModel, dbEdition, cpuCoreCount, computeCount, computeModel, adminPassword, whitelistedIps, isMTLSConnectionRequired, openMode, permissionLevel, dbWorkload, privateEndpointLabel, nsgIds, isRefreshable, dbName, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier. */ dbVersion: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * The user-provided name of the Database Home. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ id: string; /** * Indicates whether unified auditing is enabled or not */ isUnifiedAuditingEnabled: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. */ lastPatchHistoryEntryId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current state of the DB system. */ state: string; /** * The date and time the DB system was created. */ timeCreated: string; } interface DbSystemDbHomeDatabase { /** * A strong password for SYS, SYSTEM, PDB Admin and TDE Wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, \#, or -. */ adminPassword: string; /** * The backup [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ backupId: string; /** * The password to open the TDE wallet. */ backupTdePassword: string; /** * The character set for the database. The default is AL32UTF8. Allowed values are: * * AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS */ characterSet: string; connectionStrings: outputs.Database.DbSystemDbHomeDatabaseConnectionString[]; /** * 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). */ databaseDefinedTags: { [key: string]: string; }; /** * 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"}` */ databaseFreeformTags: { [key: string]: string; }; /** * The database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ databaseId: string; /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; /** * (Updatable) Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). */ dbBackupConfig: outputs.Database.DbSystemDbHomeDatabaseDbBackupConfig; /** * The database domain. In a distributed database system, DB_DOMAIN specifies the logical location of the database within the network structure. */ dbDomain: string; /** * The display name of the database to be created from the backup. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. */ dbName: string; dbUniqueName: string; /** * **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. * * The database workload type. */ dbWorkload: string; /** * (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). */ definedTags: { [key: string]: string; }; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ id: string; /** * True if active Data Guard is enabled. */ isActiveDataGuardEnabled: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. */ keyStoreId: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8. */ ncharacterSet: string; /** * The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. */ pdbName: string; /** * The list of pluggable databases that needs to be restored into new database. */ pluggableDatabases: string[]; /** * The protection mode of this Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * Specifies a prefix for the `Oracle SID` of the database to be created. */ sidPrefix: string; /** * The current state of the DB system. */ state: string; /** * The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, \#, or -. */ tdeWalletPassword: string; /** * The date and time the DB system was created. */ timeCreated: string; /** * The point in time of the original database from which the new database is created. If not specifed, the latest backup is used to create the database. */ timeStampForPointInTimeRecovery: string; /** * The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * * MAXIMUM_PERFORMANCE - ASYNC * * MAXIMUM_PROTECTION - SYNC * * For more information, see [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation. * * **IMPORTANT** - The only transport type currently supported by the Database service is ASYNC. */ transportType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; } interface DbSystemDbHomeDatabaseConnectionString { allConnectionStrings: { [key: string]: string; }; cdbDefault: string; cdbIpDefault: string; } interface DbSystemDbHomeDatabaseDbBackupConfig { /** * (Updatable) If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ autoBackupEnabled: boolean; /** * (Updatable) Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay?: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * (Updatable) Backup destination details. */ backupDestinationDetails: outputs.Database.DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail[]; /** * (Updatable) Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ runImmediateFullBackup: boolean; } interface DbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous AI Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; } interface DbSystemDbSystemOptions { /** * The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management */ storageManagement: string; } interface DbSystemIormConfigCache { /** * An array of IORM settings for all the database in the Exadata DB system. */ dbPlans: outputs.Database.DbSystemIormConfigCacheDbPlan[]; dbSystemId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current value for the IORM objective. The default is `AUTO`. */ objective: string; /** * The current state of the DB system. */ state: string; } interface DbSystemIormConfigCacheDbPlan { /** * The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * The relative priority of this database. */ share: number; } interface DbSystemMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.DbSystemMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.DbSystemMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface DbSystemMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface DbSystemMaintenanceWindowDetails { /** * (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * (Updatable) Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.DbSystemMaintenanceWindowDetailsDaysOfWeek[]; /** * (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * (Updatable) If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * (Updatable) Months during the year when maintenance should be performed. */ months: outputs.Database.DbSystemMaintenanceWindowDetailsMonth[]; /** * (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. * * *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * (Updatable) The maintenance window scheduling preference. */ preference: string; /** * (Updatable) If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface DbSystemMaintenanceWindowDetailsDaysOfWeek { /** * (Updatable) Name of the day of the week. */ name: string; } interface DbSystemMaintenanceWindowDetailsMonth { /** * (Updatable) Name of the month of the year. */ name: string; } interface DbSystemMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface DbSystemsUpgradeDbSystemOption { /** * The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management */ storageManagement: string; } interface DbSystemsUpgradeIormConfigCache { /** * An array of IORM settings for all the database in the Exadata DB system. */ dbPlans: outputs.Database.DbSystemsUpgradeIormConfigCacheDbPlan[]; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current value for the IORM objective. The default is `AUTO`. */ objective: string; /** * The current state of the DB system. */ state: string; } interface DbSystemsUpgradeIormConfigCacheDbPlan { /** * The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * The relative priority of this database. */ share: number; } interface DbSystemsUpgradeMaintenanceWindow { /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.DbSystemsUpgradeMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.DbSystemsUpgradeMaintenanceWindowMonth[]; /** * The maintenance window scheduling preference. */ preference: string; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface DbSystemsUpgradeMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface DbSystemsUpgradeMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface ExadataInfrastructureComputeContact { /** * The email for the Exadata Infrastructure contact. */ email: string; /** * If `true`, this Exadata Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Exadata Infrastructure contact is not a valid MOS contact. */ isContactMosValidated: boolean; /** * If `true`, this Exadata Infrastructure contact is a primary contact. If `false`, this Exadata Infrastructure is a secondary contact. */ isPrimary: boolean; /** * Name of the month of the year. */ name: string; /** * The phone number for the Exadata Infrastructure contact. */ phoneNumber: string; } interface ExadataInfrastructureComputeMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.ExadataInfrastructureComputeMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.ExadataInfrastructureComputeMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface ExadataInfrastructureComputeMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface ExadataInfrastructureComputeMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface ExadataInfrastructureConfigureExascaleManagementContact { /** * The email for the Exadata Infrastructure contact. */ email: string; /** * If `true`, this Exadata Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Exadata Infrastructure contact is not a valid MOS contact. */ isContactMosValidated: boolean; /** * If `true`, this Exadata Infrastructure contact is a primary contact. If `false`, this Exadata Infrastructure is a secondary contact. */ isPrimary: boolean; /** * Name of the month of the year. */ name: string; /** * The phone number for the Exadata Infrastructure contact. */ phoneNumber: string; } interface ExadataInfrastructureConfigureExascaleManagementDefinedFileSystemConfiguration { /** * If true, the file system is used to create a backup prior to Exadata VM OS update. */ isBackupPartition: boolean; /** * If true, the file system resize is allowed for the Exadata Infrastructure cluster. If false, the file system resize is not allowed. */ isResizable: boolean; /** * The minimum size of file system. */ minSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface ExadataInfrastructureConfigureExascaleManagementExascaleConfig { /** * Available storage size for Exascale in GBs. */ availableStorageInGbs: number; availableVmStorageInGbs: number; /** * Storage size needed for Exascale in GBs. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ totalStorageInGbs: number; totalVmStorageInGbs: number; } interface ExadataInfrastructureConfigureExascaleManagementMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.ExadataInfrastructureConfigureExascaleManagementMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.ExadataInfrastructureConfigureExascaleManagementMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface ExadataInfrastructureConfigureExascaleManagementMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface ExadataInfrastructureConfigureExascaleManagementMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface ExadataInfrastructureConfigureExascaleManagementNetworkBondingModeDetail { /** * The network bonding mode for the Exadata infrastructure. */ backupNetworkBondingMode: string; /** * The network bonding mode for the Exadata infrastructure. */ clientNetworkBondingMode: string; /** * The network bonding mode for the Exadata infrastructure. */ drNetworkBondingMode: string; } interface ExadataInfrastructureContact { /** * (Updatable) The email for the Exadata Infrastructure contact. */ email: string; /** * (Updatable) If `true`, this Exadata Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Exadata Infrastructure contact is not a valid MOS contact. */ isContactMosValidated: boolean; /** * (Updatable) If `true`, this Exadata Infrastructure contact is a primary contact. If `false`, this Exadata Infrastructure is a secondary contact. */ isPrimary: boolean; /** * (Updatable) The name of the Exadata Infrastructure contact. */ name: string; /** * (Updatable) The phone number for the Exadata Infrastructure contact. */ phoneNumber?: string; } interface ExadataInfrastructureDefinedFileSystemConfiguration { /** * If true, the file system is used to create a backup prior to Exadata VM OS update. */ isBackupPartition: boolean; /** * If true, the file system resize is allowed for the Exadata Infrastructure cluster. If false, the file system resize is not allowed. */ isResizable: boolean; /** * The maximum size of file system. */ maxSizeGb: number; /** * The minimum size of file system. */ minSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface ExadataInfrastructureExascaleConfig { /** * Available storage size for Exascale in GBs. */ availableStorageInGbs: number; /** * Available storage size for VM storage on Exascale in GBs. */ availableVmStorageInGbs: number; /** * Storage size needed for Exascale in GBs. */ totalStorageInGbs: number; /** * Storage size needed for VM storage on Exascale in GBs. */ totalVmStorageInGbs: number; } interface ExadataInfrastructureMaintenanceVersionPreferences { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. */ referenceResourceIdForImageUpdates: string; } interface ExadataInfrastructureMaintenanceWindow { /** * (Updatable) Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * (Updatable) Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.ExadataInfrastructureMaintenanceWindowDaysOfWeek[]; /** * (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * (Updatable) If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * (Updatable) Months during the year when maintenance should be performed. */ months: outputs.Database.ExadataInfrastructureMaintenanceWindowMonth[]; /** * (Updatable) Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. * * *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * (Updatable) The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface ExadataInfrastructureMaintenanceWindowDaysOfWeek { /** * (Updatable) Name of the day of the week. */ name: string; } interface ExadataInfrastructureMaintenanceWindowMonth { /** * (Updatable) Name of the month of the year. */ name: string; } interface ExadataInfrastructureNetworkBondingModeDetails { /** * (Updatable) The network bonding mode for the Exadata infrastructure. */ backupNetworkBondingMode: string; /** * (Updatable) The network bonding mode for the Exadata infrastructure. */ clientNetworkBondingMode: string; /** * (Updatable) The network bonding mode for the Exadata infrastructure. */ drNetworkBondingMode: string; } interface ExadataInfrastructureStorageContact { email: string; isContactMosValidated: boolean; isPrimary: boolean; name: string; phoneNumber?: string; } interface ExadataInfrastructureStorageMaintenanceWindow { daysOfWeeks: outputs.Database.ExadataInfrastructureStorageMaintenanceWindowDaysOfWeek[]; hoursOfDays: number[]; leadTimeInWeeks: number; months: outputs.Database.ExadataInfrastructureStorageMaintenanceWindowMonth[]; preference: string; weeksOfMonths: number[]; } interface ExadataInfrastructureStorageMaintenanceWindowDaysOfWeek { name: string; } interface ExadataInfrastructureStorageMaintenanceWindowMonth { name: string; } interface ExadataIormConfigDbPlan { /** * (Updatable) The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * (Updatable) The relative priority of this database. */ share: number; } interface ExadbVmClusterDataCollectionOptions { /** * (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface ExadbVmClusterIormConfigCache { /** * An array of IORM settings for all the database in the Exadata DB system. */ dbPlans: outputs.Database.ExadbVmClusterIormConfigCacheDbPlan[]; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current value for the IORM objective. The default is `AUTO`. */ objective: string; /** * The current state of the Exadata VM cluster on Exascale Infrastructure. */ state: string; } interface ExadbVmClusterIormConfigCacheDbPlan { /** * The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * The relative priority of this database. */ share: number; } interface ExadbVmClusterMultiCloudIdentityConnectorConfig { /** * Cloud provider */ cloudProvider: string; /** * The OCID of the identity connector */ id: string; } interface ExadbVmClusterNodeConfig { /** * (Updatable) The number of ECPUs to enable for each node. */ enabledEcpuCountPerNode: number; /** * The memory that you want to be allocated in GBs to each node. Memory is calculated based on 11 GB per VM core reserved. */ memorySizeInGbsPerNode: number; /** * The file system storage in GBs for snapshot for each node. */ snapshotFileSystemStorageSizeGbsPerNode: number; /** * (Updatable) The number of Total ECPUs for each node. */ totalEcpuCountPerNode: number; /** * Total file system storage in GBs for each node. */ totalFileSystemStorageSizeGbsPerNode: number; /** * (Updatable) The file system storage in GBs for each node. */ vmFileSystemStorageSizeGbsPerNode: number; } interface ExadbVmClusterNodeResource { /** * The host name for the node. */ nodeHostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the node. */ nodeId: string; /** * User provided identifier for each node. `nodeName` only exists in Terraform config and state and does not exist in server side. It serves as a placeholder for a node before the node is provisioned. `nodeName` 1) must be unique among all nodes 2) must not be an empty string 3) must not contain any space. 4) `nodeResource` block can be removed to trigger a remove-node operation but `nodeName` can not be changed. */ nodeName: string; /** * The current state of the Exadata VM cluster on Exascale Infrastructure. */ state: string; } interface ExascaleDbStorageVaultHighCapacityDatabaseStorage { /** * Available Capacity */ availableSizeInGbs: number; /** * (Updatable) Total Capacity */ totalSizeInGbs: number; } interface ExecutionActionActionMember { /** * (Updatable) The estimated time of the execution action member in minutes. */ estimatedTimeInMins: number; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent resource the execution action belongs to. */ memberId: string; /** * (Updatable) The priority order of the execution action member. */ memberOrder: number; /** * (Updatable) The current status of the execution action member. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, DURATION_EXCEEDED, RESCHEDULED and COMPLETED. enum: * * SCHEDULED * * IN_PROGRESS * * FAILED * * CANCELED * * DURATION_EXCEEDED * * RESCHEDULED * * SUCCEEDED */ status: string; /** * (Updatable) The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; } interface ExternalContainerDatabaseDatabaseManagementConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ databaseManagementConnectionId: string; /** * The status of the Database Management service. */ databaseManagementStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface ExternalContainerDatabaseStackMonitoringConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ stackMonitoringConnectorId: string; /** * The status of Stack Monitoring. */ stackMonitoringStatus: string; } interface ExternalDatabaseConnectorConnectionCredentials { /** * (Updatable) The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. * * For example: inventorydb.abc112233445566778899 */ credentialName: string; /** * (Updatable) The type of credential used to connect to the database. */ credentialType: string; /** * (Updatable) The password that will be used to connect to the database. */ password?: string; /** * (Updatable) The role of the user that will be connecting to the database. */ role: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ sslSecretId: string; /** * (Updatable) The username that will be used to connect to the database. */ username?: string; } interface ExternalDatabaseConnectorConnectionString { /** * (Updatable) The host name of the database. */ hostname: string; /** * (Updatable) The port used to connect to the database. */ port: number; /** * (Updatable) The protocol used to connect to the database. */ protocol: string; /** * (Updatable) The name of the service alias used to connect to the database. */ service: string; } interface ExternalNonContainerDatabaseDatabaseManagementConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ databaseManagementConnectionId: string; /** * The status of the Database Management service. */ databaseManagementStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface ExternalNonContainerDatabaseOperationsInsightsConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ operationsInsightsConnectorId: string; /** * The status of Operations Insights */ operationsInsightsStatus: string; } interface ExternalNonContainerDatabaseStackMonitoringConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ stackMonitoringConnectorId: string; /** * The status of Stack Monitoring. */ stackMonitoringStatus: string; } interface ExternalPluggableDatabaseDatabaseManagementConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ databaseManagementConnectionId: string; /** * The status of the Database Management service. */ databaseManagementStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface ExternalPluggableDatabaseOperationsInsightsConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ operationsInsightsConnectorId: string; /** * The status of Operations Insights */ operationsInsightsStatus: string; } interface ExternalPluggableDatabaseStackMonitoringConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ stackMonitoringConnectorId: string; /** * The status of Stack Monitoring. */ stackMonitoringStatus: string; } interface GetAdvancedClusterFileSystemsAdvancedClusterFileSystemCollection { items: outputs.Database.GetAdvancedClusterFileSystemsAdvancedClusterFileSystemCollectionItem[]; } interface GetAdvancedClusterFileSystemsAdvancedClusterFileSystemCollectionItem { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * Description of the advanced cluster file system. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the advanced cluster file system. */ id: string; /** * True if the file system is mounted on all VMs within VM Cluster. */ isMounted: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The mount point of file system. */ mountPoint: string; /** * A filter to return only resources that match the entire name given. The match is not case sensitive. */ name: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The total storage allocated for advanced cluster file system in GBs. */ storageInGbs: number; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the advanced cluster file system was created. */ timeCreated: string; /** * The last date and time that the advanced cluster file system was updated. */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * A filter to return only ACFS that match the given vm cluster id exactly. */ vmClusterId: string; } interface GetAdvancedClusterFileSystemsFilter { /** * A filter to return only resources that match the entire name given. The match is not case sensitive. */ name: string; regex?: boolean; values: string[]; } interface GetApplicationVipsApplicationVip { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud VM cluster associated with the application virtual IP (VIP) address. */ cloudVmClusterId: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; dbNodeId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The hostname of the application virtual IP (VIP) address. */ hostnameLabel: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application virtual IP (VIP) address. */ id: string; /** * The application virtual IP (VIP) IPv4 address. */ ipAddress: string; /** * The application virtual IP (VIP) IPv6 address. */ ipv6address: string; /** * Additional information about the current lifecycle state of the application virtual IP (VIP) address. */ lifecycleDetails: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the application virtual IP (VIP) address. */ subnetId: string; /** * The date and time when the create operation for the application virtual IP (VIP) address completed. */ timeAssigned: string; } interface GetApplicationVipsFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousCharacterSetsAutonomousDatabaseCharacterSet { /** * A valid Oracle character set. */ name: string; } interface GetAutonomousCharacterSetsFilter { /** * A valid Oracle character set. */ name: string; regex?: boolean; values: string[]; } interface GetAutonomousContainerDatabaseAssociatedBackupConfigurationDetail { /** * The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. */ backupDestinationAttachHistories: string[]; /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; /** * The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. */ spaceUtilizedInGbs: number; /** * The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. */ timeAtWhichStorageDetailsAreUpdated: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetAutonomousContainerDatabaseBackupAutonomousDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A user-friendly name for the backup. This name need not be unique. */ displayName: string; /** * The current state of the backup. */ state: string; } interface GetAutonomousContainerDatabaseBackupBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous AI Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * The type of backup. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetAutonomousContainerDatabaseBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.Database.GetAutonomousContainerDatabaseBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; } interface GetAutonomousContainerDatabaseBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetAutonomousContainerDatabaseBackupDestinationPropertiesList { /** * The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. */ backupDestinationAttachHistories: string[]; /** * The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. */ spaceUtilizedInGbs: number; /** * The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. */ timeAtWhichStorageDetailsAreUpdated: string; } interface GetAutonomousContainerDatabaseBackupListAutonomousDatabasesInBackupsAutonomousDatabaseInBackupCollection { /** * The list of Autonomous Databases that are part of the Autonomous Container Database Backup. */ items: outputs.Database.GetAutonomousContainerDatabaseBackupListAutonomousDatabasesInBackupsAutonomousDatabaseInBackupCollectionItem[]; } interface GetAutonomousContainerDatabaseBackupListAutonomousDatabasesInBackupsAutonomousDatabaseInBackupCollectionItem { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). If not provided, uses the Autonomous Container Database's compartment. */ compartmentId: string; /** * The user-friendly name for the Autonomous AI Database. The name does not have to be unique. */ displayName: string; /** * The current state of the Autonomous AI Database. */ state: string; } interface GetAutonomousContainerDatabaseBackupListAutonomousDatabasesInBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousContainerDatabaseBackupsAutonomousContainerDatabaseBackupCollection { items: outputs.Database.GetAutonomousContainerDatabaseBackupsAutonomousContainerDatabaseBackupCollectionItem[]; } interface GetAutonomousContainerDatabaseBackupsAutonomousContainerDatabaseBackupCollectionItem { /** * The user-friendly name for the Autonomous Container Database when the Backup was initiated. This name need not be unique. This field captures the name at the time of backup creation, accounting for possible later updates to the display name. */ acdDisplayName: string; /** * The Autonomous Container Database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousContainerDatabaseId: string; /** * List of Autonomous AI Databases that is part of this Autonomous Container Database Backup */ autonomousDatabases: outputs.Database.GetAutonomousContainerDatabaseBackupsAutonomousContainerDatabaseBackupCollectionItemAutonomousDatabase[]; /** * Backup destination details */ backupDestinationDetails: outputs.Database.GetAutonomousContainerDatabaseBackupsAutonomousContainerDatabaseBackupCollectionItemBackupDestinationDetail[]; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. */ dbVersion: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. */ id: string; /** * A filter to return only resources that match the given Infrastructure Type. */ infrastructureType: string; /** * Indicates whether the backup is user-initiated or automatic. */ isAutomatic: boolean; /** * Whether backup is for remote-region or local region */ isRemoteBackup: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * Retention period, in days, for long-term backups */ retentionPeriodInDays: number; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the backup completed. */ timeEnded: string; /** * The date and time the backup started. */ timeStarted: string; /** * The type of backup. */ type: string; } interface GetAutonomousContainerDatabaseBackupsAutonomousContainerDatabaseBackupCollectionItemAutonomousDatabase { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; } interface GetAutonomousContainerDatabaseBackupsAutonomousContainerDatabaseBackupCollectionItemBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous AI Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * call for all remote backups */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * The type of backup. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetAutonomousContainerDatabaseBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousContainerDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetAutonomousContainerDatabaseDataguard { /** * The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` */ applyRate: string; /** * Automatically selected by backend when observer is enabled. */ automaticFailoverTarget: string; /** * The Autonomous Container Database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousContainerDatabaseId: string; /** * The domain of the Autonomous Container Database */ availabilityDomain: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association */ isAutomaticFailoverEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * Automatically selected by backend based on the protection mode. */ redoTransportMode: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; /** * The current state of the Autonomous Container Database. */ state: string; /** * The date and time the Autonomous Container Database was created. */ timeCreated: string; /** * Timestamp when the lags were last calculated for a standby. */ timeLagRefreshedOn: string; /** * The date and time when the last role change action happened. */ timeLastRoleChanged: string; /** * The date and time of the last update to the apply lag, apply rate, and transport lag values. */ timeLastSynced: string; /** * The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` */ transportLag: string; } interface GetAutonomousContainerDatabaseDataguardAssociationPeerAutonomousContainerDatabaseBackupConfig { backupDestinationDetails: outputs.Database.GetAutonomousContainerDatabaseDataguardAssociationPeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail[]; recoveryWindowInDays: number; } interface GetAutonomousContainerDatabaseDataguardAssociationPeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail { backupRetentionPolicyOnTerminate: string; dbrsPolicyId: string; /** * The OCID of the Autonomous Data Guard created for a given Autonomous Container Database. */ id: string; internetProxy: string; isRemote: boolean; isRetentionLockEnabled: boolean; remoteRegion: string; type: string; vpcPassword: string; vpcUser: string; } interface GetAutonomousContainerDatabaseDataguardAssociationsAutonomousContainerDatabaseDataguardAssociation { /** * The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` */ applyRate: string; autonomousContainerDatabaseDataguardAssociationId: string; /** * The Autonomous Container Database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousContainerDatabaseId: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * The OCID of the Autonomous Data Guard created for a given Autonomous Container Database. */ id: string; /** * Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association. Output DataType: boolean. Example : isAutomaticFailoverEnabled = true. */ isAutomaticFailoverEnabled: boolean; /** * Additional information about the current lifecycleState, if available. */ lifecycleDetails: string; migrateTrigger: number; peerAutonomousContainerDatabaseBackupConfigs: outputs.Database.GetAutonomousContainerDatabaseDataguardAssociationsAutonomousContainerDatabaseDataguardAssociationPeerAutonomousContainerDatabaseBackupConfig[]; peerAutonomousContainerDatabaseCompartmentId: string; /** * The OCID of the peer Autonomous Container Database-Autonomous Data Guard association. */ peerAutonomousContainerDatabaseDataguardAssociationId: string; peerAutonomousContainerDatabaseDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the peer Autonomous Container Database. */ peerAutonomousContainerDatabaseId: string; peerAutonomousVmClusterId: string; peerCloudAutonomousVmClusterId: string; peerDbUniqueName: string; /** * The current state of the Autonomous Container Database. */ peerLifecycleState: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ peerRole: string; /** * The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; standbyMaintenanceBufferInDays: number; /** * The current state of Autonomous Data Guard. */ state: string; /** * The date and time the Autonomous DataGuard association was created. */ timeCreated: string; /** * The date and time when the last role change action happened. */ timeLastRoleChanged: string; /** * The date and time of the last update to the apply lag, apply rate, and transport lag values. */ timeLastSynced: string; /** * The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` */ transportLag: string; } interface GetAutonomousContainerDatabaseDataguardAssociationsAutonomousContainerDatabaseDataguardAssociationPeerAutonomousContainerDatabaseBackupConfig { backupDestinationDetails: outputs.Database.GetAutonomousContainerDatabaseDataguardAssociationsAutonomousContainerDatabaseDataguardAssociationPeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail[]; recoveryWindowInDays: number; } interface GetAutonomousContainerDatabaseDataguardAssociationsAutonomousContainerDatabaseDataguardAssociationPeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail { backupRetentionPolicyOnTerminate: string; dbrsPolicyId: string; /** * The OCID of the Autonomous Data Guard created for a given Autonomous Container Database. */ id: string; internetProxy: string; isRemote: boolean; isRetentionLockEnabled: boolean; remoteRegion: string; type: string; vpcPassword: string; vpcUser: string; } interface GetAutonomousContainerDatabaseDataguardAssociationsFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousContainerDatabaseDataguardGroupMember { /** * The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` */ applyRate: string; /** * Automatically selected by backend when observer is enabled. */ automaticFailoverTarget: string; /** * The Autonomous Container Database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousContainerDatabaseId: string; /** * The domain of the Autonomous Container Database */ availabilityDomain: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association */ isAutomaticFailoverEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * Automatically selected by backend based on the protection mode. */ redoTransportMode: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; /** * The current state of the Autonomous Container Database. */ state: string; /** * The date and time the Autonomous Container Database was created. */ timeCreated: string; /** * Timestamp when the lags were last calculated for a standby. */ timeLagRefreshedOn: string; /** * The date and time when the last role change action happened. */ timeLastRoleChanged: string; /** * The date and time of the last update to the apply lag, apply rate, and transport lag values. */ timeLastSynced: string; /** * The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` */ transportLag: string; } interface GetAutonomousContainerDatabaseEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; azureEncryptionKeyId: string; hsmPassword: string; /** * Use 'AWS' for creating a new database. */ providerType: string; } interface GetAutonomousContainerDatabaseKeyHistoryEntry { /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The date and time the kms key activated. */ timeActivated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; } interface GetAutonomousContainerDatabaseMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousContainerDatabaseMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousContainerDatabaseMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousContainerDatabaseMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousContainerDatabaseMaintenanceWindowDetail { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousContainerDatabaseMaintenanceWindowDetailDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousContainerDatabaseMaintenanceWindowDetailMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousContainerDatabaseMaintenanceWindowDetailDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousContainerDatabaseMaintenanceWindowDetailMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousContainerDatabaseMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousContainerDatabasePeerAutonomousContainerDatabaseBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.Database.GetAutonomousContainerDatabasePeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; } interface GetAutonomousContainerDatabasePeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetAutonomousContainerDatabaseRecoveryApplianceDetail { /** * The storage size of the backup destination allocated for an Autonomous Container Database to store backups on the recovery appliance, in GBs, rounded to the nearest integer. */ allocatedStorageSizeInGbs: number; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; /** * The time when the recovery appliance details are updated. */ timeRecoveryApplianceDetailsUpdated: string; } interface GetAutonomousContainerDatabaseResourceUsageAutonomousContainerDatabaseVmUsage { /** * The user-friendly name for the Autonomous Container Database. The name does not need to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. */ id: string; /** * CPUs / cores assigned to ADBs in the Autonomous Container Database. */ provisionedCpus: number; /** * Number of CPUs that are reclaimable or released to the AVMC on Autonomous Container Database restart. */ reclaimableCpus: number; /** * CPUs / cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead. */ reservedCpus: number; /** * CPUs / cores assigned to the Autonomous Container Database. Sum of provisioned, reserved and reclaimable CPUs/ cores. */ usedCpus: number; } interface GetAutonomousContainerDatabaseVersionsAutonomousContainerDatabaseVersion { /** * A URL that points to a detailed description of the Autonomous Container Database version. */ details: string; /** * The list of applications supported for the given version. */ supportedApps: outputs.Database.GetAutonomousContainerDatabaseVersionsAutonomousContainerDatabaseVersionSupportedApp[]; /** * A valid Oracle Database version for provisioning an Autonomous Container Database. */ version: string; } interface GetAutonomousContainerDatabaseVersionsAutonomousContainerDatabaseVersionSupportedApp { /** * The Autonomous Container Database version end of support date. */ endOfSupport: string; /** * Indicates if the image is certified. */ isCertified: boolean; /** * The Autonomous Container Database version release date. */ releaseDate: string; /** * The name of the supported application. */ supportedAppName: string; } interface GetAutonomousContainerDatabaseVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabase { /** * A backup config object holds information about preferred backup destinations only. This object holds information about the associated backup destinations, such as secondary backup destinations created for local backups or remote replicated backups. */ associatedBackupConfigurationDetails: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseAssociatedBackupConfigurationDetail[]; autonomousContainerDatabaseBackupId: string; autonomousDatabasesToClones: string[]; /** * The Autonomous Exadata Infrastructure [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousExadataInfrastructureId: string; /** * The Autonomous VM Cluster [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousVmClusterId: string; /** * A filter to return only resources that match the given availability domain exactly. */ availabilityDomain: string; /** * Sum of CPUs available on the Autonomous VM Cluster + Sum of reclaimable CPUs available in the Autonomous Container Database. */ availableCpus: number; /** * Backup options for the Autonomous Container Database. */ backupConfigs: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseBackupConfig[]; /** * This list describes the backup destination properties associated with the Autonomous Container Database (ACD) 's preferred backup destination. The object at a given index is associated with the destination present at the same index in the backup destination details list of the ACD Backup Configuration. */ backupDestinationPropertiesLists: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseBackupDestinationPropertiesList[]; cloneBandWidth: string; cloneType: string; /** * The cloud Autonomous VM Cluster [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ cloudAutonomousVmClusterId: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The compute model of the Autonomous Container Database. For Autonomous AI Database on Dedicated Exadata Infrastructure, the CPU type (ECPUs or OCPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous AI Database on Dedicated Exadata Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. */ computeModel: string; /** * Customer Contacts. Setting this to an empty list removes all customer contacts. */ customerContacts: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseCustomerContact[]; databaseSoftwareImageId: string; /** * Array of Dg associations. */ dataguardGroupMembers: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseDataguardGroupMember[]; /** * The properties that define Autonomous Container Databases Dataguard. */ dataguards: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseDataguard[]; /** * The Database name for the Autonomous Container Database. The name must be unique within the Cloud Autonomous VM Cluster, starting with an alphabetic character, followed by 1 to 7 alphanumeric characters. */ dbName: string; /** * The CPU value beyond which an Autonomous AI Database will be opened across multiple nodes. The default value of this attribute is 16 for OCPUs and 64 for ECPUs. */ dbSplitThreshold: number; /** * **Deprecated.** The `DB_UNIQUE_NAME` value is set by Oracle Cloud Infrastructure. Do not specify a value for this parameter. Specifying a value for this field will cause Terraform operations to fail. */ dbUniqueName: string; /** * Oracle AI Database version of the Autonomous Container Database. */ dbVersion: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * Determines whether an Autonomous AI Database must be opened across the maximum number of nodes or the least number of nodes. By default, Minimum nodes is selected. */ distributionAffinity: string; /** * DST Time-Zone File version of the Autonomous Container Database. */ dstFileVersion: string; /** * Types of providers supported for managing database encryption keys */ encryptionKeyLocationDetails: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseEncryptionKeyLocationDetail[]; failoverTrigger: number; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * A filter to return only resources that match the given Infrastructure Type. */ infrastructureType: string; /** * Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association */ isAutomaticFailoverEnabled: boolean; /** * **Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. */ isDataGuardEnabled: boolean; /** * Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. */ isDstFileUpdateEnabled: boolean; /** * Indicates if it is multiple standby Autonomous Dataguard */ isMultipleStandby: boolean; /** * Key History Entry. */ keyHistoryEntries: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseKeyHistoryEntry[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. */ keyStoreId: string; /** * The wallet name for Oracle Key Vault. */ keyStoreWalletName: string; keyVersionId: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The largest Autonomous AI Database (CPU) that can be created in a new Autonomous Container Database. */ largestProvisionableAutonomousDatabaseInCpus: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last maintenance run. */ lastMaintenanceRunId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * List of One-Off patches that has been successfully applied to Autonomous Container Database */ listOneOffPatches: string[]; maintenanceWindowDetails: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindowDetail[]; /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ maintenanceWindows: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindow[]; /** * The amount of memory (in GBs) to be enabled per OCPU or ECPU. */ memoryPerComputeUnitInGbs: number; /** * The amount of memory (in GBs, rounded off to nearest integer value) enabled per ECPU or OCPU in the Autonomous VM Cluster. This is deprecated. Please refer to memoryPerComputeUnitInGBs for accurate value. */ memoryPerOracleComputeUnitInGbs: number; /** * Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. */ netServicesArchitecture: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the next maintenance run. */ nextMaintenanceRunId: string; /** * The OKV End Point Group name for the Autonomous Container Database. */ okvEndPointGroupName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last patch applied on the system. */ patchId: string; /** * Database patch model preference. */ patchModel: string; peerAutonomousContainerDatabaseBackupConfigs: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabasePeerAutonomousContainerDatabaseBackupConfig[]; peerAutonomousContainerDatabaseCompartmentId: string; peerAutonomousContainerDatabaseDisplayName: string; peerAutonomousExadataInfrastructureId: string; peerAutonomousVmClusterId: string; peerCloudAutonomousVmClusterId: string; peerDbUniqueName: string; /** * The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * An array of CPU values that can be used to successfully provision a single Autonomous AI Database. */ provisionableCpuses: number[]; /** * The number of CPUs provisioned in an Autonomous Container Database. */ provisionedCpus: number; /** * CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. */ reclaimableCpus: number; /** * Information about the recovery appliance configuration associated with the Autonomous Container Database. */ recoveryApplianceDetails: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseRecoveryApplianceDetail[]; reinstateTrigger: number; /** * The number of CPUs reserved in an Autonomous Container Database. */ reservedCpus: number; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; rotateKeyTrigger: boolean; /** * A filter to return only resources that match the given service-level agreement type exactly. */ serviceLevelAgreementType: string; shouldUseLatestAvailableBackupTimeStamp: boolean; source: string; sourceAutonomousContainerDatabaseId: string; /** * The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before scheduled maintenance of the primary database. */ standbyMaintenanceBufferInDays: number; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; switchoverTrigger: number; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the Autonomous Container Database was created. */ timeCreated: string; /** * The timestamp of last successful backup. Here NULL value represents either there are no successful backups or backups are not configured for this Autonomous Container Database. */ timeOfLastBackup: string; /** * The date and time the Autonomous Container Database will be reverted to Standby from Snapshot Standby. */ timeSnapshotStandbyRevert: string; timeStampToUseForCloning: string; /** * The number of CPUs allocated to the Autonomous VM cluster. */ totalCpus: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * The next maintenance version preference. */ versionPreference: string; /** * The percentage of CPUs reserved across nodes to support node failover. Allowed values are 0%, 25%, 50%, 75%, and 100%, with 50% being the default option. */ vmFailoverReservation: number; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseAssociatedBackupConfigurationDetail { /** * The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. */ backupDestinationAttachHistories: string[]; /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; /** * The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. */ spaceUtilizedInGbs: number; /** * The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. */ timeAtWhichStorageDetailsAreUpdated: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseBackupDestinationPropertiesList { /** * The timestamps at which this backup destination is used as the preferred destination to host the Autonomous Container Database backups. */ backupDestinationAttachHistories: string[]; /** * The total space utilized (in GBs) by this Autonomous Container Database on this backup destination, rounded to the nearest integer. */ spaceUtilizedInGbs: number; /** * The latest timestamp when the backup destination details, such as 'spaceUtilized,' are updated. */ timeAtWhichStorageDetailsAreUpdated: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseDataguard { /** * The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` */ applyRate: string; /** * Automatically selected by backend when observer is enabled. */ automaticFailoverTarget: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database. Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. */ autonomousContainerDatabaseId: string; /** * A filter to return only resources that match the given availability domain exactly. */ availabilityDomain: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association */ isAutomaticFailoverEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * Automatically selected by backend based on the protection mode. */ redoTransportMode: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the Autonomous Container Database was created. */ timeCreated: string; /** * Timestamp when the lags were last calculated for a standby. */ timeLagRefreshedOn: string; /** * The date and time when the last role change action happened. */ timeLastRoleChanged: string; /** * The date and time of the last update to the apply lag, apply rate, and transport lag values. */ timeLastSynced: string; /** * The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` */ transportLag: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseDataguardGroupMember { /** * The lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: `180 Mb per second` */ applyRate: string; /** * Automatically selected by backend when observer is enabled. */ automaticFailoverTarget: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database. Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. */ autonomousContainerDatabaseId: string; /** * A filter to return only resources that match the given availability domain exactly. */ availabilityDomain: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association */ isAutomaticFailoverEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * Automatically selected by backend based on the protection mode. */ redoTransportMode: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the Autonomous Container Database was created. */ timeCreated: string; /** * Timestamp when the lags were last calculated for a standby. */ timeLagRefreshedOn: string; /** * The date and time when the last role change action happened. */ timeLastRoleChanged: string; /** * The date and time of the last update to the apply lag, apply rate, and transport lag values. */ timeLastSynced: string; /** * The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` */ transportLag: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; azureEncryptionKeyId: string; hsmPassword: string; /** * Use 'AWS' for creating a new database. */ providerType: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseKeyHistoryEntry { /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The date and time the kms key activated. */ timeActivated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindowDetail { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindowDetailDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindowDetailMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindowDetailDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindowDetailMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabasePeerAutonomousContainerDatabaseBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.Database.GetAutonomousContainerDatabasesAutonomousContainerDatabasePeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabasePeerAutonomousContainerDatabaseBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetAutonomousContainerDatabasesAutonomousContainerDatabaseRecoveryApplianceDetail { /** * The storage size of the backup destination allocated for an Autonomous Container Database to store backups on the recovery appliance, in GBs, rounded to the nearest integer. */ allocatedStorageSizeInGbs: number; /** * Number of days between the current and earliest point of recoverability covered by automatic backups. */ recoveryWindowInDays: number; /** * The time when the recovery appliance details are updated. */ timeRecoveryApplianceDetailsUpdated: string; } interface GetAutonomousContainerDatabasesFilter { /** * Name of the month of the year. */ name: string; regex?: boolean; values: string[]; } interface GetAutonomousContainerPatchesAutonomousPatch { /** * Autonomous patch type, either "QUARTERLY" or "TIMEZONE". */ autonomousPatchType: string; /** * The text describing this patch package. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the patch. */ id: string; /** * A descriptive text associated with the lifecycleState. Typically can contain additional displayable text. */ lifecycleDetails: string; /** * Database patching model preference. See [My Oracle Support note 2285040.1](https://support.oracle.com/rs?type=doc&id=2285040.1) for information on the Release Update (RU) and Release Update Revision (RUR) patching models. */ patchModel: string; /** * First month of the quarter in which the patch was released. */ quarter: string; /** * The current state of the patch as a result of lastAction. */ state: string; /** * The date and time that the patch was released. */ timeReleased: string; /** * The type of patch. BUNDLE is one example. */ type: string; /** * The version of this patch package. */ version: string; /** * Year in which the patch was released. */ year: string; } interface GetAutonomousContainerPatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousDatabaseApexDetail { /** * The Oracle APEX AI Application Development version. */ apexVersion: string; /** * The Oracle REST Data Services (ORDS) version. */ ordsVersion: string; } interface GetAutonomousDatabaseAutonomousDatabaseMaintenanceWindow { /** * Day of the week. */ dayOfWeeks: outputs.Database.GetAutonomousDatabaseAutonomousDatabaseMaintenanceWindowDayOfWeek[]; /** * The maintenance end time. The value must use the ISO-8601 format "hh:mm". */ maintenanceEndTime: string; /** * The maintenance start time. The value must use the ISO-8601 format "hh:mm". */ maintenanceStartTime: string; } interface GetAutonomousDatabaseAutonomousDatabaseMaintenanceWindowDayOfWeek { /** * Name of the day of the week. */ name: string; } interface GetAutonomousDatabaseBackupBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * The type of backup. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetAutonomousDatabaseBackupConfig { /** * Name of [Object Storage](https://docs.cloud.oracle.com/iaas/Content/Object/Concepts/objectstorageoverview.htm) bucket to use for storing manual backups. */ manualBackupBucketName: string; /** * The manual backup destination type. */ manualBackupType: string; } interface GetAutonomousDatabaseBackupSourceDatabaseDetail { /** * Customer Contacts for the Autonomous Container Database. Setting this to an empty list removes all customer contacts. */ autonomousContainerDatabaseCustomerContacts: outputs.Database.GetAutonomousDatabaseBackupSourceDatabaseDetailAutonomousContainerDatabaseCustomerContact[]; /** * The user-provided name for the Autonomous Container Database. */ autonomousContainerDatabaseDisplayName: string; /** * DST Time-Zone File version of the Autonomous Container Database. */ autonomousContainerDatabaseDstFileVersion: string; /** * Autonomous Container Database name. */ autonomousContainerDatabaseName: string; /** * Customer Contacts for the Autonomous Database. */ autonomousDatabaseCustomerContacts: outputs.Database.GetAutonomousDatabaseBackupSourceDatabaseDetailAutonomousDatabaseCustomerContact[]; /** * Autonomous Database's name. */ autonomousDatabaseName: string; /** * Autonomous VM cluster's user-friendly name. */ autonomousVmClusterDisplayName: string; /** * The Autonomous Database workload type. The following values are valid: * * OLTP - indicates an Autonomous Transaction Processing database * * DW - indicates an Autonomous Data Warehouse database * * AJD - indicates an Autonomous JSON Database * * APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. */ dbWorkload: string; } interface GetAutonomousDatabaseBackupSourceDatabaseDetailAutonomousContainerDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetAutonomousDatabaseBackupSourceDatabaseDetailAutonomousDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetAutonomousDatabaseBackupsAutonomousDatabaseBackup { /** * The database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousDatabaseId: string; /** * Backup destination details */ backupDestinationDetails: outputs.Database.GetAutonomousDatabaseBackupsAutonomousDatabaseBackupBackupDestinationDetail[]; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The size of the database in terabytes at the time the backup was taken. */ databaseSizeInTbs: number; /** * A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. */ dbVersion: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. */ id: string; /** * A filter to return only resources that match the given Infrastructure Type. */ infrastructureType: string; /** * Indicates whether the backup is user-initiated or automatic. */ isAutomatic: boolean; isLongTermBackup: boolean; /** * Indicates whether the backup can be used to restore the associated Autonomous AI Database. */ isRestorable: boolean; /** * A filter to return only resources that have the given key store id. */ keyStoreId: string; /** * The wallet name for Oracle Key Vault. */ keyStoreWalletName: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * Name of the region in which backup is taken in. */ region: string; /** * Retention period, in days, for long-term backups */ retentionPeriodInDays: number; /** * The backup size in terrabytes (TB). */ sizeInTbs: number; /** * Source Autonomous Database details. */ sourceDatabaseDetails: outputs.Database.GetAutonomousDatabaseBackupsAutonomousDatabaseBackupSourceDatabaseDetail[]; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * Timestamp until when the backup will be available */ timeAvailableTill: string; /** * The date and time the backup completed. */ timeEnded: string; /** * The date and time the backup started. */ timeStarted: string; /** * A filter to return only backups that matches with the given type of Backup. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; } interface GetAutonomousDatabaseBackupsAutonomousDatabaseBackupBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * A filter to return only backups that matches with the given type of Backup. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetAutonomousDatabaseBackupsAutonomousDatabaseBackupSourceDatabaseDetail { /** * Customer Contacts for the Autonomous Container Database. Setting this to an empty list removes all customer contacts. */ autonomousContainerDatabaseCustomerContacts: outputs.Database.GetAutonomousDatabaseBackupsAutonomousDatabaseBackupSourceDatabaseDetailAutonomousContainerDatabaseCustomerContact[]; /** * The user-provided name for the Autonomous Container Database. */ autonomousContainerDatabaseDisplayName: string; /** * DST Time-Zone File version of the Autonomous Container Database. */ autonomousContainerDatabaseDstFileVersion: string; /** * Autonomous Container Database name. */ autonomousContainerDatabaseName: string; /** * Customer Contacts for the Autonomous Database. */ autonomousDatabaseCustomerContacts: outputs.Database.GetAutonomousDatabaseBackupsAutonomousDatabaseBackupSourceDatabaseDetailAutonomousDatabaseCustomerContact[]; /** * Autonomous Database's name. */ autonomousDatabaseName: string; /** * Autonomous VM cluster's user-friendly name. */ autonomousVmClusterDisplayName: string; /** * The Autonomous Database workload type. The following values are valid: * * OLTP - indicates an Autonomous Transaction Processing database * * DW - indicates an Autonomous Data Warehouse database * * AJD - indicates an Autonomous JSON Database * * APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. */ dbWorkload: string; } interface GetAutonomousDatabaseBackupsAutonomousDatabaseBackupSourceDatabaseDetailAutonomousContainerDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetAutonomousDatabaseBackupsAutonomousDatabaseBackupSourceDatabaseDetailAutonomousDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetAutonomousDatabaseBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousDatabaseConnectionString { /** * Returns all connection strings that can be used to connect to the Autonomous AI Database. For more information, please see [Predefined Database Service Names for Autonomous AI Transaction Processing](https://docs.oracle.com/en/cloud/paas/atp-cloud/atpug/connect-predefined.html#GUID-9747539B-FD46-44F1-8FF8-F5AC650F15BE) */ allConnectionStrings: { [key: string]: string; }; /** * The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. */ dedicated: string; /** * The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. */ high: string; /** * The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. */ low: string; /** * The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. */ medium: string; /** * A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. */ profiles: outputs.Database.GetAutonomousDatabaseConnectionStringProfile[]; } interface GetAutonomousDatabaseConnectionStringProfile { /** * Consumer group used by the connection. */ consumerGroup: string; /** * The user-friendly name for the Autonomous AI Database. The name does not have to be unique. */ displayName: string; /** * Host format used in connection string. */ hostFormat: string; /** * True for a regional connection string, applicable to cross-region DG only. */ isRegional: boolean; /** * Protocol used by the connection. */ protocol: string; /** * Specifies whether the listener performs a direct hand-off of the session, or redirects the session. In RAC deployments where SCAN is used, sessions are redirected to a Node VIP. Use `DIRECT` for direct hand-offs. Use `REDIRECT` to redirect the session. */ sessionMode: string; /** * Specifies whether the connection string is using the long (`LONG`), Easy Connect (`EZCONNECT`), or Easy Connect Plus (`EZCONNECTPLUS`) format. Autonomous AI Database Serverless instances always use the long format. */ syntaxFormat: string; /** * Specifies whether the TLS handshake is using one-way (`SERVER`) or mutual (`MUTUAL`) authentication. */ tlsAuthentication: string; /** * Connection string value. */ value: string; } interface GetAutonomousDatabaseConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * The URL of the Spatial Studio for the Autonomous AI Database. */ spatialStudioUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface GetAutonomousDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetAutonomousDatabaseDataguardAssociationsAutonomousDatabaseDataguardAssociation { /** * The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synced between the associated databases. Example: `180 Mb per second` */ applyRate: string; /** * The database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousDatabaseId: string; /** * The OCID of the Autonomous Dataguard created for Autonomous Container Database where given Autonomous AI Database resides in. */ id: string; /** * Indicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association */ isAutomaticFailoverEnabled: boolean; /** * Additional information about the current lifecycleState, if available. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the peer Autonomous AI Database. */ peerAutonomousDatabaseId: string; /** * The current state of the Autonomous AI Database. */ peerAutonomousDatabaseLifeCycleState: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ peerRole: string; /** * The protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; /** * The current state of Autonomous Data Guard. */ state: string; /** * The date and time the Data Guard association was created. */ timeCreated: string; /** * The date and time when the last role change action happened. */ timeLastRoleChanged: string; /** * The date and time of the last update to the apply lag, apply rate, and transport lag values. */ timeLastSynced: string; /** * The approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: `7 seconds` */ transportLag: string; } interface GetAutonomousDatabaseDataguardAssociationsFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousDatabaseDbToolsDetail { /** * Compute used by database tools. */ computeCount: number; /** * Indicates whether tool is enabled. */ isEnabled: boolean; /** * The max idle time, in minutes, after which the VM used by database tools will be terminated. */ maxIdleTimeInMinutes: number; /** * Name of the day of the week. */ name: string; } interface GetAutonomousDatabaseEncryptionKey { /** * AWS ARN role */ arnRole: string; /** * The provider for the Autonomous AI Database encryption key. */ autonomousDatabaseProvider: string; /** * OKV certificate directory name */ certificateDirectoryName: string; /** * OKV certificate id */ certificateId: string; /** * OKV wallet directory name */ directoryName: string; /** * AWS external ID */ externalId: string; /** * AWS key ARN */ keyArn: string; /** * Azure key name */ keyName: string; /** * GCP key ring */ keyRing: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * GCP kms REST API endpoint */ kmsRestEndpoint: string; /** * GCP key ring location */ location: string; /** * UUID of OKV KMS Key */ okvKmsKey: string; /** * URI of OKV server */ okvUri: string; /** * GCP project name */ project: string; /** * AWS key service endpoint URI */ serviceEndpointUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * Azure vault URI */ vaultUri: string; } interface GetAutonomousDatabaseEncryptionKeyHistoryEntry { /** * Details of the Autonomous AI Database encryption key. */ encryptionKeys: outputs.Database.GetAutonomousDatabaseEncryptionKeyHistoryEntryEncryptionKey[]; /** * The date and time the kms key activated. */ timeActivated: string; } interface GetAutonomousDatabaseEncryptionKeyHistoryEntryEncryptionKey { /** * AWS ARN role */ arnRole: string; /** * The provider for the Autonomous AI Database encryption key. */ autonomousDatabaseProvider: string; /** * OKV certificate directory name */ certificateDirectoryName: string; /** * OKV certificate id */ certificateId: string; /** * OKV wallet directory name */ directoryName: string; /** * AWS external ID */ externalId: string; /** * AWS key ARN */ keyArn: string; /** * Azure key name */ keyName: string; /** * GCP key ring */ keyRing: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * GCP kms REST API endpoint */ kmsRestEndpoint: string; /** * GCP key ring location */ location: string; /** * UUID of OKV KMS Key */ okvKmsKey: string; /** * URI of OKV server */ okvUri: string; /** * GCP project name */ project: string; /** * AWS key service endpoint URI */ serviceEndpointUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * Azure vault URI */ vaultUri: string; } interface GetAutonomousDatabaseEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; azureEncryptionKeyId: string; hsmPassword: string; /** * Use 'AWS' for creating a new database. */ providerType: string; } interface GetAutonomousDatabaseKeyHistoryEntry { /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The date and time the kms key activated. */ timeActivated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; } interface GetAutonomousDatabaseLocalStandbyDb { /** * The availability domain of a local Autonomous Data Guard standby database of an Autonomous AI Database Serverless instance. */ availabilityDomain: string; /** * The external logical zone where the local Autonomous Data Guard is located (Intended for multicloud use). */ externalLocationZone: string; /** * The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. */ lagTimeInSeconds: number; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The component chosen for maintenance. */ maintenanceTargetComponent: string; /** * The current state of the Autonomous AI Database. */ state: string; /** * The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. */ timeDataGuardRoleChanged: string; /** * The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. */ timeDisasterRecoveryRoleChanged: string; /** * The date and time when maintenance will begin. */ timeMaintenanceBegin: string; /** * The date and time when maintenance will end. */ timeMaintenanceEnd: string; } interface GetAutonomousDatabaseLongTermBackupSchedule { /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * The frequency of the long-term backup schedule */ repeatCadence: string; /** * Retention period, in days, for long-term backups */ retentionPeriodInDays: number; /** * The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. */ timeOfBackup: string; } interface GetAutonomousDatabasePeersAutonomousDatabasePeerCollection { /** * This array holds details about Autonomous AI Database Peers for Oracle an Autonomous AI Database. */ items: outputs.Database.GetAutonomousDatabasePeersAutonomousDatabasePeerCollectionItem[]; } interface GetAutonomousDatabasePeersAutonomousDatabasePeerCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. */ id: string; /** * The name of the region where this peer Autonomous AI Database clone exists. */ region: string; } interface GetAutonomousDatabasePeersFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousDatabasePublicConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * The URL of the Spatial Studio for the Autonomous AI Database. */ spatialStudioUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface GetAutonomousDatabaseRefreshableClonesFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousDatabaseRefreshableClonesRefreshableCloneCollection { items: outputs.Database.GetAutonomousDatabaseRefreshableClonesRefreshableCloneCollectionItem[]; } interface GetAutonomousDatabaseRefreshableClonesRefreshableCloneCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. */ id: string; /** * The name of the region where the refreshable clone exists. */ region: string; } interface GetAutonomousDatabaseRemoteDisasterRecoveryConfiguration { /** * Indicates the disaster recovery (DR) type of the Autonomous AI Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. */ disasterRecoveryType: string; /** * If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. */ isReplicateAutomaticBackups: boolean; /** * Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. */ isSnapshotStandby: boolean; /** * Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. */ timeSnapshotStandbyEnabledTill: string; } interface GetAutonomousDatabaseResourcePoolMembersFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousDatabaseResourcePoolMembersResourcePoolMemberCollection { /** * List of resource pool member summary. */ items: outputs.Database.GetAutonomousDatabaseResourcePoolMembersResourcePoolMemberCollectionItem[]; } interface GetAutonomousDatabaseResourcePoolMembersResourcePoolMemberCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database. */ id: string; } interface GetAutonomousDatabaseResourcePoolSummary { /** * Available capacity left for new elastic pool members provision */ availableComputeCapacity: number; /** * Available storage capacity (in TB) that can be used for adding new members or scaling existing members in a dedicated elastic pool. */ availableStorageCapacityInTbs: number; /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * Resource pool size. */ poolSize: number; /** * Resource pool storage size in TBs. */ poolStorageSizeInTbs: number; /** * Resource Pool total capacity, it's currently 4x of pool size */ totalComputeCapacity: number; } interface GetAutonomousDatabaseScheduledOperation { /** * Day of the week. */ dayOfWeeks: outputs.Database.GetAutonomousDatabaseScheduledOperationDayOfWeek[]; /** * auto start time. value must be of ISO-8601 format "HH:mm" */ scheduledStartTime: string; /** * auto stop time. value must be of ISO-8601 format "HH:mm" */ scheduledStopTime: string; } interface GetAutonomousDatabaseScheduledOperationDayOfWeek { /** * Name of the day of the week. */ name: string; } interface GetAutonomousDatabaseSoftwareImagesAutonomousDatabaseSoftwareImageCollection { items: outputs.Database.GetAutonomousDatabaseSoftwareImagesAutonomousDatabaseSoftwareImageCollectionItem[]; } interface GetAutonomousDatabaseSoftwareImagesAutonomousDatabaseSoftwareImageCollectionItem { /** * One-off patches included in the Autonomous AI Database Software Image */ autonomousDsiOneOffPatches: string[]; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The database version with which the Autonomous AI Database Software Image is to be built. */ databaseVersion: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database Software Image. */ id: string; /** * A filter to return only resources that match the given image shape family exactly. */ imageShapeFamily: string; /** * Detailed message for the lifecycle state. */ lifecycleDetails: string; /** * The Release Updates. */ releaseUpdate: string; sourceCdbId: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the Autonomous AI Database Software Image was created. */ timeCreated: string; } interface GetAutonomousDatabaseSoftwareImagesFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousDatabaseStandbyDb { /** * The availability domain of a local Autonomous Data Guard standby database of an Autonomous AI Database Serverless instance. */ availabilityDomain: string; /** * The external logical zone where the local Autonomous Data Guard is located (Intended for multicloud use). */ externalLocationZone: string; /** * The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. */ lagTimeInSeconds: number; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The component chosen for maintenance. */ maintenanceTargetComponent: string; /** * The current state of the Autonomous AI Database. */ state: string; /** * The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. */ timeDataGuardRoleChanged: string; /** * The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. */ timeDisasterRecoveryRoleChanged: string; /** * The date and time when maintenance will begin. */ timeMaintenanceBegin: string; /** * The date and time when maintenance will end. */ timeMaintenanceEnd: string; } interface GetAutonomousDatabaseTransportableTablespace { ttsBundleUrl: string; } interface GetAutonomousDatabaseVanityConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface GetAutonomousDatabaseVanityUrlDetail { /** * API Gateway ID. */ apiGatewayId: string; /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * Custom URL prefix provided by the customer to access dbTools. */ vanityUrlHostName: string; } interface GetAutonomousDatabasesAutonomousDatabase { /** * The current amount of storage in use for user and system data, in terabytes (TB). */ actualUsedDataStorageSizeInTbs: number; /** * The Availability Domain which is planned for Scheduled Update */ adScheduledForUpdate: string; /** * Additional attributes for this resource. Each attribute is a simple key-value pair with no predefined name, type, or namespace. Example: `{ "gcpAccountName": "gcpName" }` */ additionalAttributes: { [key: string]: string; }; adminPassword: string; /** * The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the `dataStorageSizeInTBs` value. You can compare this value to the `actualUsedDataStorageSizeInTBs` value to determine if a manual shrink operation is appropriate for your allocated storage. */ allocatedStorageSizeInTbs: number; /** * Information about Oracle APEX AI Application Development. */ apexDetails: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseApexDetail[]; /** * This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. It's value would be `TRUE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses primary IP access control list (ACL) for standby. It's value would be `FALSE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses different IP access control list (ACL) for standby compared to primary. */ arePrimaryWhitelistedIpsUsed: boolean; /** * The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the `timeOfAutoRefreshStart` parameter. */ autoRefreshFrequencyInSeconds: number; /** * The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens. */ autoRefreshPointLagInSeconds: number; /** * The Autonomous Container Database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousContainerDatabaseId: string; autonomousDatabaseBackupId: string; autonomousDatabaseId: string; /** * Autonomous Database maintenance window. The maintenance window can be configured during database creation. To change the maintenance window of an existing Autonomous Database Serverless instance, clone the database and specify the maintenance window for the new cloned instance. */ autonomousDatabaseMaintenanceWindows: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseAutonomousDatabaseMaintenanceWindow[]; /** * The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle */ autonomousMaintenanceScheduleType: string; /** * The availability domain of a local Autonomous Data Guard standby database of an Autonomous AI Database Serverless instance. */ availabilityDomain: string; /** * List of Oracle AI Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. */ availableUpgradeVersions: string[]; /** * Autonomous AI Database configuration details for storing [manual backups](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/backup-restore.html#GUID-9035DFB8-4702-4CEB-8281-C2A303820809) in the [Object Storage](https://docs.cloud.oracle.com/iaas/Content/Object/Concepts/objectstorageoverview.htm) service. */ backupConfigs: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseBackupConfig[]; /** * Retention period, in days, for backups. */ backupRetentionPeriodInDays: number; byolComputeCountLimit: number; /** * The character set for the Autonomous AI Database. The default is AL32UTF8. Allowed values are: */ characterSet: string; /** * A list of the source Autonomous AI Database's table space number(s) used to create this partial clone from the backup. */ cloneTableSpaceLists: number[]; /** * The Autonomous AI Database clone type. */ cloneType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Autonomous Serverless Database. */ clusterPlacementGroupId: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Compute used by database tools. */ computeCount: number; /** * The compute model of the Autonomous AI Database. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. */ computeModel: string; /** * The connection string used to connect to the Autonomous AI Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous AI Database for the password value. */ connectionStrings: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseConnectionString[]; /** * The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). Example: `{"sqlDevWebUrl": "https:///ords...", "apexUrl", "https:///ords..."}` */ connectionUrls: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseConnectionUrl[]; /** * The number of CPU cores to be made available to the database. When the ECPU is selected, the value for cpuCoreCount is 0. For Autonomous AI Database on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. */ cpuCoreCount: number; /** * Customer Contacts. */ customerContacts: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseCustomerContact[]; /** * Status of the Data Safe registration for this Autonomous Database. Could be REGISTERED or NOT_REGISTERED. */ dataSafeStatus: string; /** * The quantity of data in the database, in gigabytes. */ dataStorageSizeInGb: number; /** * The quantity of data in the database, in terabytes. */ dataStorageSizeInTbs: number; /** * The Oracle AI Database Edition that applies to the Autonomous AI Databases. */ databaseEdition: string; /** * Status of Database Management for this Autonomous AI Database. */ databaseManagementStatus: string; /** * **Deprecated.** The Autonomous Data Guard region type of the Autonomous AI Database. For Autonomous AI Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region. */ dataguardRegionType: string; /** * The database name. */ dbName: string; /** * The list of database tools details. */ dbToolsDetails: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseDbToolsDetail[]; /** * A filter to return only Autonomous AI Database resources that match the specified dbVersion. */ dbVersion: string; /** * A filter to return only Autonomous AI Database resources that match the specified workload type. */ dbWorkload: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * **Deprecated.** The disaster recovery (DR) region type of the Autonomous AI Database. For Autonomous AI Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. */ disasterRecoveryRegionType: string; /** * Indicates the disaster recovery (DR) type of the Autonomous AI Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. */ disasterRecoveryType: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * If omitted or set to false the provider will not delete scheduledOperations from the Autonomous Database. If set to true, provider will delete scheduledOperations from the Autonomous Database. */ enableDeleteScheduledOperations: boolean; /** * Key History Entry. */ encryptionKeyHistoryEntries: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseEncryptionKeyHistoryEntry[]; /** * Types of providers supported for managing database encryption keys */ encryptionKeyLocationDetails: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseEncryptionKeyLocationDetail[]; /** * Details of the Autonomous AI Database encryption key. */ encryptionKeys: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseEncryptionKey[]; /** * The external logical zone where the local Autonomous Data Guard is located (Intended for multicloud use). */ externalLocationZone: string; /** * Indicates the number of seconds of data loss for a Data Guard failover. */ failedDataRecoveryInSeconds: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * The area assigned to In-Memory tables in Autonomous AI Database. */ inMemoryAreaInGbs: number; /** * The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. */ inMemoryPercentage: number; /** * A filter to return only resources that match the given Infrastructure Type. */ infrastructureType: string; /** * Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone. */ isAccessControlEnabled: boolean; /** * Indicates if auto scaling is enabled for the Autonomous AI Database CPU core count. The default value is `TRUE`. */ isAutoScalingEnabled: boolean; /** * Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is `FALSE`. */ isAutoScalingForStorageEnabled: boolean; /** * Indicates if the Autonomous AI Database is backup retention locked. */ isBackupRetentionLocked: boolean; /** * A filter to return only resources that have Data Guard enabled. */ isDataGuardEnabled: boolean; /** * True if the database uses [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). */ isDedicated: boolean; /** * Autonomous AI Database for Developers are fixed-shape Autonomous AI Databases that developers can use to build and test new applications. On Serverless, these are low-cost and billed per instance, on Dedicated and Cloud@Customer there is no additional cost to create Developer databases. Developer databases come with limited resources and is not intended for large-scale testing and production deployments. When you need more compute or storage resources, you may upgrade to a full paid production database. */ isDevTier: boolean; isDisableAdUpdateSchedule: boolean; isDisableDbVersionUpgradeSchedule: boolean; /** * If true, this will disconnect the Autonomous Database from its peer and the Autonomous Database can work permanently as a standalone database. To disconnect a cross region standby, please also provide the OCID of the standby database in the `peerDbId` parameter. */ isDisconnectPeer: boolean; /** * Filter on the value of the resource's 'isFreeTier' property. A value of `true` returns only Always Free resources. A value of `false` excludes Always Free resources from the returned results. Omitting this parameter returns both Always Free and paid resources. */ isFreeTier: boolean; /** * Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. */ isLocalDataGuardEnabled: boolean; /** * Specifies if the Autonomous AI Database requires mTLS connections. */ isMtlsConnectionRequired: boolean; /** * Indicates if the Autonomous AI Database version is a preview version. */ isPreview: boolean; isPreviewVersionWithServiceTermsAccepted: boolean; /** * Indicates if the refreshable clone can be reconnected to its source database. */ isReconnectCloneEnabled: boolean; /** * Filter on the value of the resource's 'isRefreshableClone' property. A value of `true` returns only refreshable clones. A value of `false` excludes refreshable clones from the returned results. Omitting this parameter returns both refreshable clones and databases that are not refreshable clones. */ isRefreshableClone: boolean; /** * Indicates whether the Autonomous AI Database has Cross Region Data Guard enabled. Not applicable to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. */ isRemoteDataGuardEnabled: boolean; /** * If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. */ isReplicateAutomaticBackups: boolean; isScheduleAdUpdateToEarliest: boolean; isScheduleDbVersionUpgradeToEarliest: boolean; /** * @deprecated The 'is_shrink_only' field has been deprecated. Please use 'shrink_adb_trigger' instead. */ isShrinkOnly: boolean; /** * Key History Entry. */ keyHistoryEntries: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseKeyHistoryEntry[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. */ keyStoreId: string; /** * The wallet name for Oracle Key Vault. */ keyStoreWalletName: string; keyVersionId: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * KMS key lifecycle details. */ kmsKeyLifecycleDetails: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. */ licenseModel: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard */ localAdgAutoFailoverMaxDataLossLimit: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated resource pool leader Autonomous Database in the same region, associated with local Autonomous Data Guard for a dedicated resource pool member. */ localAdgResourcePoolLeaderId: string; /** * Indicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. */ localDisasterRecoveryType: string; /** * Autonomous Data Guard standby database details. */ localStandbyDbs: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseLocalStandbyDb[]; /** * Details for the long-term backup schedule. */ longTermBackupSchedules: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseLongTermBackupSchedule[]; /** * The component chosen for maintenance. */ maintenanceTargetComponent: string; /** * The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled. */ maxCpuCoreCount: number; /** * The amount of memory (in GBs) to be enabled per OCPU or ECPU. */ memoryPerComputeUnitInGbs: number; /** * The amount of memory (in GBs, rounded off to nearest integer value) to be enabled per OCPU or ECPU. This is deprecated. Please refer to memoryPerComputeUnitInGBs for accurate value. */ memoryPerOracleComputeUnitInGbs: number; /** * The national character set for the Autonomous AI Database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8. */ ncharacterSet: string; /** * Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. */ netServicesArchitecture: string; /** * The date and time when the next long-term backup would be created. */ nextLongTermBackupTimeStamp: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). **NsgIds restrictions:** * * A network security group (NSG) is optional for Autonomous AI Databases with private access. The nsgIds list can be empty. */ nsgIds: string[]; /** * The number of OCPU cores to be made available to the database. */ ocpuCount: number; /** * Indicates the Autonomous AI Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. */ openMode: string; /** * Status of Operations Insights for this Autonomous AI Database. */ operationsInsightsStatus: string; /** * The database [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Disaster Recovery peer (source Primary) database, which is located in a different (remote) region from the current peer database. */ peerDbId: string; /** * The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous AI Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. */ peerDbIds: string[]; /** * The Autonomous AI Database permission level. Restricted mode allows access only by admin users. */ permissionLevel: string; /** * The private endpoint for the resource. */ privateEndpoint: string; /** * The private endpoint Ip address for the resource. */ privateEndpointIp: string; /** * The private endpoint label for the resource. */ privateEndpointLabel: string; /** * An array of CPU values that an Autonomous AI Database can be scaled to. */ provisionableCpuses: number[]; /** * The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. */ publicConnectionUrls: outputs.Database.GetAutonomousDatabasesAutonomousDatabasePublicConnectionUrl[]; /** * The public endpoint for the private endpoint enabled resource. */ publicEndpoint: string; /** * The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous AI Database. */ refreshableMode: string; /** * The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous AI Database. */ refreshableStatus: string; /** * Configurations of a Disaster Recovery. */ remoteDisasterRecoveryConfigurations: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseRemoteDisasterRecoveryConfiguration[]; remoteDisasterRecoveryType: string; /** * The database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resourcepool Leader Autonomous AI Database. */ resourcePoolLeaderId: string; /** * The configuration details for resource pool */ resourcePoolSummaries: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseResourcePoolSummary[]; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; rotateKeyTrigger: boolean; /** * The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime. */ scheduledOperations: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseScheduledOperation[]; secretId: string; secretVersionNumber: number; /** * 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": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The URL of the Service Console for the Autonomous AI Database. */ serviceConsoleUrl: string; shrinkAdbTrigger: number; source: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source Autonomous AI Database that was cloned to create the current Autonomous AI Database. */ sourceId: string; /** * **Deprecated** Autonomous Data Guard standby database details. */ standbyDbs: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseStandbyDb[]; /** * The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. */ standbyWhitelistedIps: string[]; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the resource is associated with. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * The list of regions that support the creation of an Autonomous AI Database clone or an Autonomous Data Guard standby database. */ supportedRegionsToCloneTos: string[]; switchoverTo: string; switchoverToRemotePeerId: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the Autonomous AI Database was created. */ timeCreated: string; /** * The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. */ timeDataGuardRoleChanged: string; /** * The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted. */ timeDeletionOfFreeAutonomousDatabase: string; /** * The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. */ timeDisasterRecoveryRoleChanged: string; /** * The earliest date and time to which you can schedule an Autonomous Database availability domain update. */ timeEarliestAvailableAdUpdate: string; /** * The earliest(min) date and time the Autonomous AI Database can be scheduled to upgrade to 26ai. */ timeEarliestAvailableDbVersionUpgrade: string; /** * The latest date and time to which you can schedule an Autonomous Database availability domain update. */ timeLatestAvailableAdUpdate: string; /** * The max date and time the Autonomous AI Database can be scheduled to upgrade to 26ai. */ timeLatestAvailableDbVersionUpgrade: string; /** * The date and time that Autonomous Data Guard was enabled for an Autonomous AI Database where the standby was provisioned in the same region as the primary database. */ timeLocalDataGuardEnabled: string; /** * The date and time when maintenance will begin. */ timeMaintenanceBegin: string; /** * The date and time when maintenance will end. */ timeMaintenanceEnd: string; /** * The date until which maintenance of Autonomous Database is temporarily paused. */ timeMaintenancePauseUntil: string; /** * The the date and time that auto-refreshing will begin for an Autonomous AI Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the `autoRefreshFrequencyInSeconds` parameter. */ timeOfAutoRefreshStart: string; /** * The time the member joined the resource pool. */ timeOfJoiningResourcePool: string; /** * The timestamp of the last failover operation. */ timeOfLastFailover: string; /** * The date and time when last refresh happened. */ timeOfLastRefresh: string; /** * The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh. */ timeOfLastRefreshPoint: string; /** * The timestamp of the last switchover operation for the Autonomous AI Database. */ timeOfLastSwitchover: string; /** * The date and time of next refresh. */ timeOfNextRefresh: string; /** * The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state. */ timeReclamationOfFreeAutonomousDatabase: string; /** * The date and time to which the Autonomous Database availability domain update is scheduled. */ timeScheduledAdUpdate: string; /** * The date and time the Autonomous AI Database scheduled to upgrade to 26ai. */ timeScheduledDbVersionUpgrade: string; /** * The date and time the Autonomous AI Database was most recently undeleted. */ timeUndeleted: string; /** * The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database. */ timeUntilReconnectCloneEnabled: string; timestamp: string; /** * The backup storage to the database. */ totalBackupStorageSizeInGbs: number; transportableTablespaces: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseTransportableTablespace[]; useLatestAvailableBackupTimeStamp: boolean; /** * The storage space consumed by Autonomous AI Database in GBs. */ usedDataStorageSizeInGbs: number; /** * The amount of storage that has been used for Autonomous AI Databases in dedicated infrastructure, in terabytes. */ usedDataStorageSizeInTbs: number; /** * The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). Example: `{"sqlDevWebUrl": "https:///ords...", "apexUrl", "https:///ords..."}` */ vanityConnectionUrls: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseVanityConnectionUrl[]; /** * Details for api gateway and vanity url(custom url) for dbTools. */ vanityUrlDetails: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseVanityUrlDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ vaultId: string; /** * The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. */ whitelistedIps: string[]; } interface GetAutonomousDatabasesAutonomousDatabaseApexDetail { /** * The Oracle APEX AI Application Development version. */ apexVersion: string; /** * The Oracle REST Data Services (ORDS) version. */ ordsVersion: string; } interface GetAutonomousDatabasesAutonomousDatabaseAutonomousDatabaseMaintenanceWindow { /** * Day of the week. */ dayOfWeeks: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseAutonomousDatabaseMaintenanceWindowDayOfWeek[]; /** * The maintenance end time. The value must use the ISO-8601 format "hh:mm". */ maintenanceEndTime: string; /** * The maintenance start time. The value must use the ISO-8601 format "hh:mm". */ maintenanceStartTime: string; } interface GetAutonomousDatabasesAutonomousDatabaseAutonomousDatabaseMaintenanceWindowDayOfWeek { /** * Name of the day of the week. */ name: string; } interface GetAutonomousDatabasesAutonomousDatabaseBackupConfig { /** * Name of [Object Storage](https://docs.cloud.oracle.com/iaas/Content/Object/Concepts/objectstorageoverview.htm) bucket to use for storing manual backups. */ manualBackupBucketName: string; /** * The manual backup destination type. */ manualBackupType: string; } interface GetAutonomousDatabasesAutonomousDatabaseConnectionString { /** * Returns all connection strings that can be used to connect to the Autonomous AI Database. For more information, please see [Predefined Database Service Names for Autonomous AI Transaction Processing](https://docs.oracle.com/en/cloud/paas/atp-cloud/atpug/connect-predefined.html#GUID-9747539B-FD46-44F1-8FF8-F5AC650F15BE) */ allConnectionStrings: { [key: string]: string; }; /** * The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. */ dedicated: string; /** * The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. */ high: string; /** * The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. */ low: string; /** * The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. */ medium: string; /** * A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. */ profiles: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseConnectionStringProfile[]; } interface GetAutonomousDatabasesAutonomousDatabaseConnectionStringProfile { /** * Consumer group used by the connection. */ consumerGroup: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * Host format used in connection string. */ hostFormat: string; isRegional: boolean; /** * Protocol used by the connection. */ protocol: string; /** * Specifies whether the listener performs a direct hand-off of the session, or redirects the session. In RAC deployments where SCAN is used, sessions are redirected to a Node VIP. Use `DIRECT` for direct hand-offs. Use `REDIRECT` to redirect the session. */ sessionMode: string; /** * Specifies whether the connection string is using the long (`LONG`), Easy Connect (`EZCONNECT`), or Easy Connect Plus (`EZCONNECTPLUS`) format. Autonomous AI Database Serverless instances always use the long format. */ syntaxFormat: string; /** * Specifies whether the TLS handshake is using one-way (`SERVER`) or mutual (`MUTUAL`) authentication. */ tlsAuthentication: string; /** * Connection string value. */ value: string; } interface GetAutonomousDatabasesAutonomousDatabaseConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * The URL of the Spatial Studio for the Autonomous AI Database. */ spatialStudioUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface GetAutonomousDatabasesAutonomousDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetAutonomousDatabasesAutonomousDatabaseDbToolsDetail { /** * Compute used by database tools. */ computeCount: number; /** * Indicates whether tool is enabled. */ isEnabled: boolean; /** * The max idle time, in minutes, after which the VM used by database tools will be terminated. */ maxIdleTimeInMinutes: number; /** * Name of the day of the week. */ name: string; } interface GetAutonomousDatabasesAutonomousDatabaseEncryptionKey { /** * AWS ARN role */ arnRole: string; /** * The provider for the Autonomous AI Database encryption key. */ autonomousDatabaseProvider: string; /** * OKV certificate directory name */ certificateDirectoryName: string; /** * OKV certificate id */ certificateId: string; /** * OKV wallet directory name */ directoryName: string; /** * AWS external ID */ externalId: string; /** * AWS key ARN */ keyArn: string; /** * Azure key name */ keyName: string; /** * GCP key ring */ keyRing: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * GCP kms REST API endpoint */ kmsRestEndpoint: string; /** * GCP key ring location */ location: string; /** * UUID of OKV KMS Key */ okvKmsKey: string; /** * URI of OKV server */ okvUri: string; /** * GCP project name */ project: string; /** * AWS key service endpoint URI */ serviceEndpointUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ vaultId: string; /** * Azure vault URI */ vaultUri: string; } interface GetAutonomousDatabasesAutonomousDatabaseEncryptionKeyHistoryEntry { /** * Details of the Autonomous AI Database encryption key. */ encryptionKeys: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseEncryptionKeyHistoryEntryEncryptionKey[]; /** * The date and time the kms key activated. */ timeActivated: string; } interface GetAutonomousDatabasesAutonomousDatabaseEncryptionKeyHistoryEntryEncryptionKey { /** * AWS ARN role */ arnRole: string; /** * The provider for the Autonomous AI Database encryption key. */ autonomousDatabaseProvider: string; /** * OKV certificate directory name */ certificateDirectoryName: string; /** * OKV certificate id */ certificateId: string; /** * OKV wallet directory name */ directoryName: string; /** * AWS external ID */ externalId: string; /** * AWS key ARN */ keyArn: string; /** * Azure key name */ keyName: string; /** * GCP key ring */ keyRing: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * GCP kms REST API endpoint */ kmsRestEndpoint: string; /** * GCP key ring location */ location: string; /** * UUID of OKV KMS Key */ okvKmsKey: string; /** * URI of OKV server */ okvUri: string; /** * GCP project name */ project: string; /** * AWS key service endpoint URI */ serviceEndpointUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ vaultId: string; /** * Azure vault URI */ vaultUri: string; } interface GetAutonomousDatabasesAutonomousDatabaseEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; azureEncryptionKeyId: string; hsmPassword: string; /** * Use 'AWS' for creating a new database. */ providerType: string; } interface GetAutonomousDatabasesAutonomousDatabaseKeyHistoryEntry { /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The date and time the kms key activated. */ timeActivated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ vaultId: string; } interface GetAutonomousDatabasesAutonomousDatabaseLocalStandbyDb { /** * The availability domain of a local Autonomous Data Guard standby database of an Autonomous AI Database Serverless instance. */ availabilityDomain: string; /** * The external logical zone where the local Autonomous Data Guard is located (Intended for multicloud use). */ externalLocationZone: string; /** * The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. */ lagTimeInSeconds: number; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The component chosen for maintenance. */ maintenanceTargetComponent: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. */ timeDataGuardRoleChanged: string; /** * The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. */ timeDisasterRecoveryRoleChanged: string; /** * The date and time when maintenance will begin. */ timeMaintenanceBegin: string; /** * The date and time when maintenance will end. */ timeMaintenanceEnd: string; } interface GetAutonomousDatabasesAutonomousDatabaseLongTermBackupSchedule { /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * The frequency of the long-term backup schedule */ repeatCadence: string; /** * Retention period, in days, for long-term backups */ retentionPeriodInDays: number; /** * The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. */ timeOfBackup: string; } interface GetAutonomousDatabasesAutonomousDatabasePublicConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * The URL of the Spatial Studio for the Autonomous AI Database. */ spatialStudioUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface GetAutonomousDatabasesAutonomousDatabaseRemoteDisasterRecoveryConfiguration { /** * Indicates the disaster recovery (DR) type of the Autonomous AI Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. */ disasterRecoveryType: string; /** * If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. */ isReplicateAutomaticBackups: boolean; /** * Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. */ isSnapshotStandby: boolean; /** * Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. */ timeSnapshotStandbyEnabledTill: string; } interface GetAutonomousDatabasesAutonomousDatabaseResourcePoolSummary { /** * Available capacity left for new elastic pool members provision */ availableComputeCapacity: number; /** * Available storage capacity (in TB) that can be used for adding new members or scaling existing members in a dedicated elastic pool. */ availableStorageCapacityInTbs: number; /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * Resource pool size. */ poolSize: number; /** * Resource pool storage size in TBs. */ poolStorageSizeInTbs: number; /** * Resource Pool total capacity, it's currently 4x of pool size */ totalComputeCapacity: number; } interface GetAutonomousDatabasesAutonomousDatabaseScheduledOperation { /** * Day of the week. */ dayOfWeeks: outputs.Database.GetAutonomousDatabasesAutonomousDatabaseScheduledOperationDayOfWeek[]; /** * auto start time. value must be of ISO-8601 format "HH:mm" */ scheduledStartTime: string; /** * auto stop time. value must be of ISO-8601 format "HH:mm" */ scheduledStopTime: string; } interface GetAutonomousDatabasesAutonomousDatabaseScheduledOperationDayOfWeek { /** * Name of the day of the week. */ name: string; } interface GetAutonomousDatabasesAutonomousDatabaseStandbyDb { /** * The availability domain of a local Autonomous Data Guard standby database of an Autonomous AI Database Serverless instance. */ availabilityDomain: string; /** * The external logical zone where the local Autonomous Data Guard is located (Intended for multicloud use). */ externalLocationZone: string; /** * The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. */ lagTimeInSeconds: number; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The component chosen for maintenance. */ maintenanceTargetComponent: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. */ timeDataGuardRoleChanged: string; /** * The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. */ timeDisasterRecoveryRoleChanged: string; /** * The date and time when maintenance will begin. */ timeMaintenanceBegin: string; /** * The date and time when maintenance will end. */ timeMaintenanceEnd: string; } interface GetAutonomousDatabasesAutonomousDatabaseTransportableTablespace { ttsBundleUrl: string; } interface GetAutonomousDatabasesAutonomousDatabaseVanityConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface GetAutonomousDatabasesAutonomousDatabaseVanityUrlDetail { /** * API Gateway ID. */ apiGatewayId: string; /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * Custom URL prefix provided by the customer to access dbTools. */ vanityUrlHostName: string; } interface GetAutonomousDatabasesClonesAutonomousDatabase { /** * The current amount of storage in use for user and system data, in terabytes (TB). */ actualUsedDataStorageSizeInTbs: number; /** * The Availability Domain which is planned for Scheduled Update */ adScheduledForUpdate: string; /** * Additional attributes for this resource. Each attribute is a simple key-value pair with no predefined name, type, or namespace. Example: `{ "gcpAccountName": "gcpName" }` */ additionalAttributes: { [key: string]: string; }; /** * The amount of storage currently allocated for the database tables and billed for, rounded up. When auto-scaling is not enabled, this value is equal to the `dataStorageSizeInTBs` value. You can compare this value to the `actualUsedDataStorageSizeInTBs` value to determine if a manual shrink operation is appropriate for your allocated storage. */ allocatedStorageSizeInTbs: number; /** * Information about Oracle APEX AI Application Development. */ apexDetails: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseApexDetail[]; /** * This field will be null if the Autonomous AI Database is not Data Guard enabled or Access Control is disabled. It's value would be `TRUE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses primary IP access control list (ACL) for standby. It's value would be `FALSE` if Autonomous AI Database is Data Guard enabled and Access Control is enabled and if the Autonomous AI Database uses different IP access control list (ACL) for standby compared to primary. */ arePrimaryWhitelistedIpsUsed: boolean; /** * The frequency a refreshable clone is refreshed after auto-refresh is enabled. The minimum is 1 hour. The maximum is 7 days. The date and time that auto-refresh is enabled is controlled by the `timeOfAutoRefreshStart` parameter. */ autoRefreshFrequencyInSeconds: number; /** * The time, in seconds, the data of the refreshable clone lags the primary database at the point of refresh. The minimum is 0 minutes (0 mins means refresh to the latest available timestamp). The maximum is 7 days. The lag time increases after refreshing until the next data refresh happens. */ autoRefreshPointLagInSeconds: number; /** * The Autonomous Container Database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Used only by Autonomous AI Database on Dedicated Exadata Infrastructure. */ autonomousContainerDatabaseId: string; /** * Autonomous Database maintenance window. The maintenance window can be configured during database creation. To change the maintenance window of an existing Autonomous Database Serverless instance, clone the database and specify the maintenance window for the new cloned instance. */ autonomousDatabaseMaintenanceWindows: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseAutonomousDatabaseMaintenanceWindow[]; /** * The maintenance schedule type of the Autonomous AI Database Serverless. An EARLY maintenance schedule follows a schedule applying patches prior to the REGULAR schedule. A REGULAR maintenance schedule follows the normal cycle */ autonomousMaintenanceScheduleType: string; /** * The availability domain of a local Autonomous Data Guard standby database of an Autonomous AI Database Serverless instance. */ availabilityDomain: string; /** * List of Oracle AI Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. */ availableUpgradeVersions: string[]; /** * Autonomous AI Database configuration details for storing [manual backups](https://docs.oracle.com/en/cloud/paas/autonomous-database/adbsa/backup-restore.html#GUID-9035DFB8-4702-4CEB-8281-C2A303820809) in the [Object Storage](https://docs.cloud.oracle.com/iaas/Content/Object/Concepts/objectstorageoverview.htm) service. */ backupConfigs: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseBackupConfig[]; /** * Retention period, in days, for backups. */ backupRetentionPeriodInDays: number; byolComputeCountLimit: number; /** * The character set for the Autonomous AI Database. The default is AL32UTF8. Allowed values are: */ characterSet: string; /** * A list of the source Autonomous AI Database's table space number(s) used to create this partial clone from the backup. */ cloneTableSpaceLists: number[]; /** * A filter to return only resources that match the given clone type exactly. */ cloneType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Autonomous Serverless Database. */ clusterPlacementGroupId: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Compute used by database tools. */ computeCount: number; /** * The compute model of the Autonomous AI Database. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. */ computeModel: string; /** * The connection string used to connect to the Autonomous AI Database. The username for the Service Console is ADMIN. Use the password you entered when creating the Autonomous AI Database for the password value. */ connectionStrings: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseConnectionString[]; /** * The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). Example: `{"sqlDevWebUrl": "https:///ords...", "apexUrl", "https:///ords..."}` */ connectionUrls: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseConnectionUrl[]; /** * The number of CPU cores to be made available to the database. When the ECPU is selected, the value for cpuCoreCount is 0. For Autonomous AI Database on Dedicated Exadata infrastructure, the maximum number of cores is determined by the infrastructure shape. See [Characteristics of Infrastructure Shapes](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbde/) for shape details. */ cpuCoreCount: number; /** * Customer Contacts. */ customerContacts: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseCustomerContact[]; /** * Status of the Data Safe registration for this Autonomous AI Database. */ dataSafeStatus: string; /** * The quantity of data in the database, in gigabytes. */ dataStorageSizeInGb: number; /** * The quantity of data in the database, in terabytes. */ dataStorageSizeInTbs: number; /** * The Oracle AI Database Edition that applies to the Autonomous AI Databases. */ databaseEdition: string; /** * Status of Database Management for this Autonomous AI Database. */ databaseManagementStatus: string; /** * **Deprecated.** The Autonomous Data Guard region type of the Autonomous AI Database. For Autonomous AI Database Serverless, Autonomous Data Guard associations have designated primary and standby regions, and these region types do not change when the database changes roles. The standby regions in Autonomous Data Guard associations can be the same region designated as the primary region, or they can be remote regions. Certain database administrative operations may be available only in the primary region of the Autonomous Data Guard association, and cannot be performed when the database using the primary role is operating in a remote Autonomous Data Guard standby region. */ dataguardRegionType: string; /** * The database name. */ dbName: string; /** * The list of database tools details. */ dbToolsDetails: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseDbToolsDetail[]; /** * A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. */ dbVersion: string; /** * The Autonomous AI Database workload type. The following values are valid: * * OLTP - indicates an Autonomous AI Transaction Processing database * * DW - indicates an Autonomous AI Lakehouse database * * AJD - indicates an Autonomous AI JSON Database * * APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. * * LH - indicates an Oracle Autonomous AI Lakehouse database */ dbWorkload: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * **Deprecated.** The disaster recovery (DR) region type of the Autonomous AI Database. For Autonomous AI Database Serverless instances, DR associations have designated primary and standby regions. These region types do not change when the database changes roles. The standby region in DR associations can be the same region as the primary region, or they can be in a remote regions. Some database administration operations may be available only in the primary region of the DR association, and cannot be performed when the database using the primary role is operating in a remote region. */ disasterRecoveryRegionType: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * Key History Entry. */ encryptionKeyHistoryEntries: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseEncryptionKeyHistoryEntry[]; /** * Types of providers supported for managing database encryption keys */ encryptionKeyLocationDetails: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseEncryptionKeyLocationDetail[]; /** * Details of the Autonomous AI Database encryption key. */ encryptionKeys: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseEncryptionKey[]; /** * Indicates the number of seconds of data loss for a Data Guard failover. */ failedDataRecoveryInSeconds: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * The area assigned to In-Memory tables in Autonomous AI Database. */ inMemoryAreaInGbs: number; /** * The percentage of the System Global Area(SGA) assigned to In-Memory tables in Autonomous AI Database. This property is applicable only to Autonomous AI Databases on the Exadata Cloud@Customer platform. */ inMemoryPercentage: number; /** * The infrastructure type this resource belongs to. */ infrastructureType: string; /** * Indicates if the database-level access control is enabled. If disabled, database access is defined by the network security rules. If enabled, database access is restricted to the IP addresses defined by the rules specified with the `whitelistedIps` property. While specifying `whitelistedIps` rules is optional, if database-level access control is enabled and no rules are specified, the database will become inaccessible. The rules can be added later using the `UpdateAutonomousDatabase` API operation or edit option in console. When creating a database clone, the desired access control setting should be specified. By default, database-level access control will be disabled for the clone. */ isAccessControlEnabled: boolean; /** * Indicates if auto scaling is enabled for the Autonomous AI Database CPU core count. The default value is `TRUE`. */ isAutoScalingEnabled: boolean; /** * Indicates if auto scaling is enabled for the Autonomous AI Database storage. The default value is `FALSE`. */ isAutoScalingForStorageEnabled: boolean; /** * Indicates if the Autonomous AI Database is backup retention locked. */ isBackupRetentionLocked: boolean; /** * **Deprecated.** Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. */ isDataGuardEnabled: boolean; /** * True if the database uses [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). */ isDedicated: boolean; /** * Autonomous AI Database for Developers are free Autonomous AI Databases that developers can use to build and test new applications.With Autonomous these database instancess instances, you can try new Autonomous Database features for free and apply them to ongoing or new development projects. Developer database comes with limited resources and is, therefore, not suitable for large-scale testing and production deployments. When you need more compute or storage resources, you can transition to a paid database licensing by cloning your developer database into a regular Autonomous Database. See [Autonomous Database documentation](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/eddjo/index.html) for more details. */ isDevTier: boolean; /** * Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous AI Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. */ isFreeTier: boolean; /** * Indicates whether the Autonomous AI Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. */ isLocalDataGuardEnabled: boolean; /** * Specifies if the Autonomous AI Database requires mTLS connections. */ isMtlsConnectionRequired: boolean; /** * Indicates if the Autonomous AI Database version is a preview version. */ isPreview: boolean; /** * Indicates if the refreshable clone can be reconnected to its source database. */ isReconnectCloneEnabled: boolean; /** * Indicates if the Autonomous AI Database is a refreshable clone. */ isRefreshableClone: boolean; /** * Indicates whether the Autonomous AI Database has Cross Region Data Guard enabled. Not applicable to Autonomous AI Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure. */ isRemoteDataGuardEnabled: boolean; /** * Key History Entry. */ keyHistoryEntries: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseKeyHistoryEntry[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. */ keyStoreId: string; /** * The wallet name for Oracle Key Vault. */ keyStoreWalletName: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * KMS key lifecycle details. */ kmsKeyLifecycleDetails: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. */ kmsKeyVersionId: string; /** * The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. */ licenseModel: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard */ localAdgAutoFailoverMaxDataLossLimit: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated resource pool leader Autonomous Database in the same region, associated with local Autonomous Data Guard for a dedicated resource pool member. */ localAdgResourcePoolLeaderId: string; /** * Indicates the local disaster recovery (DR) type of the Autonomous AI Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. */ localDisasterRecoveryType: string; /** * Autonomous Data Guard standby database details. */ localStandbyDbs: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseLocalStandbyDb[]; /** * Details for the long-term backup schedule. */ longTermBackupSchedules: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseLongTermBackupSchedule[]; /** * The component chosen for maintenance. */ maintenanceTargetComponent: string; /** * The number of Max OCPU cores to be made available to the autonomous database with auto scaling of cpu enabled. */ maxCpuCoreCount: number; /** * The amount of memory (in GBs) to be enabled per OCPU or ECPU. */ memoryPerComputeUnitInGbs: number; /** * The amount of memory (in GBs, rounded off to nearest integer value) to be enabled per OCPU or ECPU. This is deprecated. Please refer to memoryPerComputeUnitInGBs for accurate value. */ memoryPerOracleComputeUnitInGbs: number; /** * The national character set for the Autonomous AI Database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8. */ ncharacterSet: string; /** * Enabling SHARED server architecture enables a database server to allow many client processes to share very few server processes, thereby increasing the number of supported users. */ netServicesArchitecture: string; /** * The date and time when the next long-term backup would be created. */ nextLongTermBackupTimeStamp: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). **NsgIds restrictions:** * * A network security group (NSG) is optional for Autonomous AI Databases with private access. The nsgIds list can be empty. */ nsgIds: string[]; /** * The number of OCPU cores to be made available to the database. */ ocpuCount: number; /** * Indicates the Autonomous AI Database mode. The database can be opened in `READ_ONLY` or `READ_WRITE` mode. */ openMode: string; /** * The list of [OCIDs](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous AI Database Serverless instances, standby databases located in the same region as the source primary database do not have OCIDs. */ peerDbIds: string[]; /** * The private endpoint for the resource. */ privateEndpoint: string; /** * The private endpoint Ip address for the resource. */ privateEndpointIp: string; /** * The resource's private endpoint label. * * Setting the endpoint label to a non-empty string creates a private endpoint database. * * Resetting the endpoint label to an empty string, after the creation of the private endpoint database, changes the private endpoint database to a public endpoint database. * * Setting the endpoint label to a non-empty string value, updates to a new private endpoint database, when the database is disabled and re-enabled. */ privateEndpointLabel: string; /** * An array of CPU values that an Autonomous AI Database can be scaled to. */ provisionableCpuses: number[]; /** * The Public URLs of Private Endpoint database for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. */ publicConnectionUrls: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabasePublicConnectionUrl[]; /** * The public endpoint for the private endpoint enabled resource. */ publicEndpoint: string; /** * The refresh mode of the clone. AUTOMATIC indicates that the clone is automatically being refreshed with data from the source Autonomous AI Database. */ refreshableMode: string; /** * The refresh status of the clone. REFRESHING indicates that the clone is currently being refreshed with data from the source Autonomous AI Database. */ refreshableStatus: string; /** * Configurations of a Disaster Recovery. */ remoteDisasterRecoveryConfigurations: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseRemoteDisasterRecoveryConfiguration[]; /** * The unique identifier for leader Autonomous AI Database OCID [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ resourcePoolLeaderId: string; /** * The configuration details for resource pool */ resourcePoolSummaries: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseResourcePoolSummary[]; /** * The Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. */ role: string; /** * The list of scheduled operations. Consists of values such as dayOfWeek, scheduledStartTime, scheduledStopTime. */ scheduledOperations: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseScheduledOperation[]; /** * 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": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The URL of the Service Console for the Autonomous AI Database. */ serviceConsoleUrl: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source Autonomous AI Database that was cloned to create the current Autonomous AI Database. */ sourceId: string; /** * **Deprecated** Autonomous Data Guard standby database details. */ standbyDbs: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseStandbyDb[]; /** * The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. */ standbyWhitelistedIps: string[]; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the resource is associated with. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * The list of regions that support the creation of an Autonomous AI Database clone or an Autonomous Data Guard standby database. */ supportedRegionsToCloneTos: string[]; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the Autonomous AI Database was created. */ timeCreated: string; /** * The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. */ timeDataGuardRoleChanged: string; /** * The date and time the Always Free database will be automatically deleted because of inactivity. If the database is in the STOPPED state and without activity until this time, it will be deleted. */ timeDeletionOfFreeAutonomousDatabase: string; /** * The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. */ timeDisasterRecoveryRoleChanged: string; /** * The earliest date and time to which you can schedule an Autonomous Database availability domain update. */ timeEarliestAvailableAdUpdate: string; /** * The earliest(min) date and time the Autonomous AI Database can be scheduled to upgrade to 26ai. */ timeEarliestAvailableDbVersionUpgrade: string; /** * The latest date and time to which you can schedule an Autonomous Database availability domain update. */ timeLatestAvailableAdUpdate: string; /** * The max date and time the Autonomous AI Database can be scheduled to upgrade to 26ai. */ timeLatestAvailableDbVersionUpgrade: string; /** * The date and time that Autonomous Data Guard was enabled for an Autonomous AI Database where the standby was provisioned in the same region as the primary database. */ timeLocalDataGuardEnabled: string; /** * The date and time when maintenance will begin. */ timeMaintenanceBegin: string; /** * The date and time when maintenance will end. */ timeMaintenanceEnd: string; /** * The date until which maintenance of Autonomous Database is temporarily paused. */ timeMaintenancePauseUntil: string; /** * The the date and time that auto-refreshing will begin for an Autonomous AI Database refreshable clone. This value controls only the start time for the first refresh operation. Subsequent (ongoing) refresh operations have start times controlled by the value of the `autoRefreshFrequencyInSeconds` parameter. */ timeOfAutoRefreshStart: string; timeOfJoiningResourcePool: string; /** * The timestamp of the last failover operation. */ timeOfLastFailover: string; /** * The date and time when last refresh happened. */ timeOfLastRefresh: string; /** * The refresh point timestamp (UTC). The refresh point is the time to which the database was most recently refreshed. Data created after the refresh point is not included in the refresh. */ timeOfLastRefreshPoint: string; /** * The timestamp of the last switchover operation for the Autonomous AI Database. */ timeOfLastSwitchover: string; /** * The date and time of next refresh. */ timeOfNextRefresh: string; /** * The date and time the Always Free database will be stopped because of inactivity. If this time is reached without any database activity, the database will automatically be put into the STOPPED state. */ timeReclamationOfFreeAutonomousDatabase: string; /** * The date and time to which the Autonomous Database availability domain update is scheduled. */ timeScheduledAdUpdate: string; /** * The date and time the Autonomous AI Database scheduled to upgrade to 26ai. */ timeScheduledDbVersionUpgrade: string; /** * The date and time the Autonomous AI Database was most recently undeleted. */ timeUndeleted: string; /** * The time and date as an RFC3339 formatted string, e.g., 2022-01-01T12:00:00.000Z, to set the limit for a refreshable clone to be reconnected to its source database. */ timeUntilReconnectCloneEnabled: string; /** * The backup storage to the database. */ totalBackupStorageSizeInGbs: number; /** * The storage space consumed by Autonomous AI Database in GBs. */ usedDataStorageSizeInGbs: number; /** * The amount of storage that has been used for Autonomous AI Databases in dedicated infrastructure, in terabytes. */ usedDataStorageSizeInTbs: number; /** * The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN. Note that these URLs are provided by the console only for databases on [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). Example: `{"sqlDevWebUrl": "https:///ords...", "apexUrl", "https:///ords..."}` */ vanityConnectionUrls: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseVanityConnectionUrl[]; /** * Details for api gateway and vanity url(custom url) for dbTools. */ vanityUrlDetails: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseVanityUrlDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ vaultId: string; /** * The client IP access control list (ACL). This feature is available for [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) and on Exadata Cloud@Customer. Only clients connecting from an IP address included in the ACL may access the Autonomous AI Database instance. If `arePrimaryWhitelistedIpsUsed` is 'TRUE' then Autonomous AI Database uses this primary's IP access control list (ACL) for the disaster recovery peer called `standbywhitelistedips`. */ whitelistedIps: string[]; } interface GetAutonomousDatabasesClonesAutonomousDatabaseApexDetail { /** * The Oracle APEX AI Application Development version. */ apexVersion: string; /** * The Oracle REST Data Services (ORDS) version. */ ordsVersion: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseAutonomousDatabaseMaintenanceWindow { /** * Day of the week. */ dayOfWeeks: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseAutonomousDatabaseMaintenanceWindowDayOfWeek[]; /** * The maintenance end time. The value must use the ISO-8601 format "hh:mm". */ maintenanceEndTime: string; /** * The maintenance start time. The value must use the ISO-8601 format "hh:mm". */ maintenanceStartTime: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseAutonomousDatabaseMaintenanceWindowDayOfWeek { /** * Name of the day of the week. */ name: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseBackupConfig { /** * Name of [Object Storage](https://docs.cloud.oracle.com/iaas/Content/Object/Concepts/objectstorageoverview.htm) bucket to use for storing manual backups. */ manualBackupBucketName: string; /** * The manual backup destination type. */ manualBackupType: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseConnectionString { /** * Returns all connection strings that can be used to connect to the Autonomous AI Database. For more information, please see [Predefined Database Service Names for Autonomous AI Transaction Processing](https://docs.oracle.com/en/cloud/paas/atp-cloud/atpug/connect-predefined.html#GUID-9747539B-FD46-44F1-8FF8-F5AC650F15BE) */ allConnectionStrings: { [key: string]: string; }; /** * The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. */ dedicated: string; /** * The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. */ high: string; /** * The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. */ low: string; /** * The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. */ medium: string; /** * A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. */ profiles: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseConnectionStringProfile[]; } interface GetAutonomousDatabasesClonesAutonomousDatabaseConnectionStringProfile { /** * Consumer group used by the connection. */ consumerGroup: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * Host format used in connection string. */ hostFormat: string; /** * True for a regional connection string, applicable to cross-region DG only. */ isRegional: boolean; /** * Protocol used by the connection. */ protocol: string; /** * Specifies whether the listener performs a direct hand-off of the session, or redirects the session. In RAC deployments where SCAN is used, sessions are redirected to a Node VIP. Use `DIRECT` for direct hand-offs. Use `REDIRECT` to redirect the session. */ sessionMode: string; /** * Specifies whether the connection string is using the long (`LONG`), Easy Connect (`EZCONNECT`), or Easy Connect Plus (`EZCONNECTPLUS`) format. Autonomous AI Database Serverless instances always use the long format. */ syntaxFormat: string; /** * Specifies whether the TLS handshake is using one-way (`SERVER`) or mutual (`MUTUAL`) authentication. */ tlsAuthentication: string; /** * Connection string value. */ value: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * The URL of the Spatial Studio for the Autonomous AI Database. */ spatialStudioUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseDbToolsDetail { /** * Compute used by database tools. */ computeCount: number; /** * Indicates whether tool is enabled. */ isEnabled: boolean; /** * The max idle time, in minutes, after which the VM used by database tools will be terminated. */ maxIdleTimeInMinutes: number; /** * Name of the day of the week. */ name: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseEncryptionKey { /** * AWS ARN role */ arnRole: string; /** * The provider for the Autonomous AI Database encryption key. */ autonomousDatabasesCloneProvider: string; /** * OKV certificate directory name */ certificateDirectoryName: string; /** * OKV certificate id */ certificateId: string; /** * OKV wallet directory name */ directoryName: string; /** * AWS external ID */ externalId: string; /** * AWS key ARN */ keyArn: string; /** * Azure key name */ keyName: string; /** * GCP key ring */ keyRing: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * GCP kms REST API endpoint */ kmsRestEndpoint: string; /** * GCP key ring location */ location: string; /** * UUID of OKV KMS Key */ okvKmsKey: string; /** * URI of OKV server */ okvUri: string; /** * GCP project name */ project: string; /** * AWS key service endpoint URI */ serviceEndpointUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ vaultId: string; /** * Azure vault URI */ vaultUri: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseEncryptionKeyHistoryEntry { /** * Details of the Autonomous AI Database encryption key. */ encryptionKeys: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseEncryptionKeyHistoryEntryEncryptionKey[]; /** * The date and time the kms key activated. */ timeActivated: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseEncryptionKeyHistoryEntryEncryptionKey { /** * AWS ARN role */ arnRole: string; /** * The provider for the Autonomous AI Database encryption key. */ autonomousDatabasesCloneProvider: string; /** * OKV certificate directory name */ certificateDirectoryName: string; /** * OKV certificate id */ certificateId: string; /** * OKV wallet directory name */ directoryName: string; /** * AWS external ID */ externalId: string; /** * AWS key ARN */ keyArn: string; /** * Azure key name */ keyName: string; /** * GCP key ring */ keyRing: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * GCP kms REST API endpoint */ kmsRestEndpoint: string; /** * GCP key ring location */ location: string; /** * UUID of OKV KMS Key */ okvKmsKey: string; /** * URI of OKV server */ okvUri: string; /** * GCP project name */ project: string; /** * AWS key service endpoint URI */ serviceEndpointUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ vaultId: string; /** * Azure vault URI */ vaultUri: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; azureEncryptionKeyId: string; hsmPassword: string; /** * Use 'AWS' for creating a new database. */ providerType: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseKeyHistoryEntry { /** * The id of the Autonomous AI Database [Vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts) service key management history entry. */ id: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. */ kmsKeyVersionId: string; /** * The date and time the kms key activated. */ timeActivated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ vaultId: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseLocalStandbyDb { /** * The availability domain of a local Autonomous Data Guard standby database of an Autonomous AI Database Serverless instance. */ availabilityDomain: string; /** * The external logical zone where the local Autonomous Data Guard is located (Intended for multicloud use). */ externalLocationZone: string; /** * The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. */ lagTimeInSeconds: number; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The component chosen for maintenance. */ maintenanceTargetComponent: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. */ timeDataGuardRoleChanged: string; /** * The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. */ timeDisasterRecoveryRoleChanged: string; /** * The date and time when maintenance will begin. */ timeMaintenanceBegin: string; /** * The date and time when maintenance will end. */ timeMaintenanceEnd: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseLongTermBackupSchedule { /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * The frequency of the long-term backup schedule */ repeatCadence: string; /** * Retention period, in days, for long-term backups */ retentionPeriodInDays: number; /** * The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. */ timeOfBackup: string; } interface GetAutonomousDatabasesClonesAutonomousDatabasePublicConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * The URL of the Spatial Studio for the Autonomous AI Database. */ spatialStudioUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseRemoteDisasterRecoveryConfiguration { /** * Indicates the disaster recovery (DR) type of the Autonomous AI Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. */ disasterRecoveryType: string; isReplicateAutomaticBackups: boolean; /** * Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. */ isSnapshotStandby: boolean; /** * Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. */ timeSnapshotStandbyEnabledTill: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseResourcePoolSummary { /** * Available capacity left for new elastic pool members provision */ availableComputeCapacity: number; /** * Available storage capacity (in TB) that can be used for adding new members or scaling existing members in a dedicated elastic pool. */ availableStorageCapacityInTbs: number; /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * Resource pool size. */ poolSize: number; /** * Resource pool storage size in TBs. */ poolStorageSizeInTbs: number; /** * Resource Pool total capacity, it's currently 4x of pool size */ totalComputeCapacity: number; } interface GetAutonomousDatabasesClonesAutonomousDatabaseScheduledOperation { /** * Day of the week. */ dayOfWeeks: outputs.Database.GetAutonomousDatabasesClonesAutonomousDatabaseScheduledOperationDayOfWeek[]; /** * auto start time. value must be of ISO-8601 format "HH:mm" */ scheduledStartTime: string; /** * auto stop time. value must be of ISO-8601 format "HH:mm" */ scheduledStopTime: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseScheduledOperationDayOfWeek { /** * Name of the day of the week. */ name: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseStandbyDb { /** * The availability domain of a local Autonomous Data Guard standby database of an Autonomous AI Database Serverless instance. */ availabilityDomain: string; /** * The external logical zone where the local Autonomous Data Guard is located (Intended for multicloud use). */ externalLocationZone: string; /** * The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. */ lagTimeInSeconds: number; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The component chosen for maintenance. */ maintenanceTargetComponent: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the Autonomous Data Guard role was switched for the Autonomous AI Database. For databases that have standbys in both the primary Data Guard region and a remote Data Guard standby region, this is the latest timestamp of either the database using the "primary" role in the primary Data Guard region, or database located in the remote Data Guard standby region. */ timeDataGuardRoleChanged: string; /** * The date and time the Disaster Recovery role was switched for the standby Autonomous AI Database. */ timeDisasterRecoveryRoleChanged: string; /** * The date and time when maintenance will begin. */ timeMaintenanceBegin: string; /** * The date and time when maintenance will end. */ timeMaintenanceEnd: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseVanityConnectionUrl { /** * Oracle Application Express (APEX) URL. */ apexUrl: string; /** * The URL of the Database Transforms for the Autonomous Database. */ databaseTransformsUrl: string; /** * The URL of the Graph Studio for the Autonomous Database. */ graphStudioUrl: string; /** * The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. */ machineLearningNotebookUrl: string; /** * Oracle Machine Learning user management URL. */ machineLearningUserManagementUrl: string; /** * The URL of the MongoDB API for the Autonomous Database. */ mongoDbUrl: string; /** * The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. */ ordsUrl: string; /** * Oracle SQL Developer Web URL. */ sqlDevWebUrl: string; } interface GetAutonomousDatabasesClonesAutonomousDatabaseVanityUrlDetail { /** * API Gateway ID. */ apiGatewayId: string; /** * Indicates if the vanity url details should be deleted for the Autonomous Database. */ isDisabled: boolean; /** * Custom URL prefix provided by the customer to access dbTools. */ vanityUrlHostName: string; } interface GetAutonomousDatabasesClonesFilter { /** * Name of the day of the week. */ name: string; regex?: boolean; values: string[]; } interface GetAutonomousDatabasesEstimateCostSavingsEstimateCostSavingsSummaryCollection { /** * List of estimate cost saving summary. */ items: outputs.Database.GetAutonomousDatabasesEstimateCostSavingsEstimateCostSavingsSummaryCollectionItem[]; } interface GetAutonomousDatabasesEstimateCostSavingsEstimateCostSavingsSummaryCollectionItem { /** * Estimated cost savings in percentage with elastic pool utilization. */ costSavingsWithElasticPool: number; /** * CPU cost for a given time period under regular billing plan, in ECPU hours. */ estimatedUsageWithoutElasticPool: string; /** * If provided as true, cost estimate with cpu autoscaling. */ isCpuAutoscale: boolean; /** * The epoch time at which cost aggregation ends. */ timeEnded: string; /** * The epoch time at which cost aggregation starts. */ timeStarted: string; /** * CPU cost for a given time period under elastic pool billing plan, in ECPU hours. */ usageWithElasticPool: string; } interface GetAutonomousDatabasesEstimateCostSavingsFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousDatabasesFilter { /** * Name of the day of the week. */ name: string; regex?: boolean; values: string[]; } interface GetAutonomousDbPreviewVersionsAutonomousDbPreviewVersion { /** * The Autonomous AI Database workload type. The following values are valid: * * OLTP - indicates an Autonomous AI Transaction Processing database * * DW - indicates an Autonomous AI Lakehouse database * * AJD - indicates an Autonomous AI JSON Database * * APEX - indicates an Autonomous AI Database with the Oracle APEX AI Application Development workload type. * * LH - indicates an Oracle Autonomous AI Lakehouse database */ dbWorkload: string; /** * A URL that points to a detailed description of the preview version. */ details: string; /** * The date and time when the preview version availability begins. */ timePreviewBegin: string; /** * The date and time when the preview version availability ends. */ timePreviewEnd: string; /** * A valid Autonomous AI Database preview version. */ version: string; } interface GetAutonomousDbPreviewVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousDbVersionsAutonomousDbVersion { /** * A filter to return only Autonomous AI Database resources that match the specified workload type. */ dbWorkload: string; /** * A URL that points to a detailed description of the Autonomous AI Database version. */ details: string; /** * True if the database uses [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). */ isDedicated: boolean; /** * True if this version of the Oracle AI Database software's default is free. */ isDefaultForFree: boolean; /** * True if this version of the Oracle AI Database software's default is paid. */ isDefaultForPaid: boolean; /** * True if this version of the Oracle AI Database software can be used for Always-Free Autonomous AI Databases. */ isFreeTierEnabled: boolean; /** * True if this version of the Oracle AI Database software has payments enabled. */ isPaidEnabled: boolean; /** * A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. */ version: string; } interface GetAutonomousDbVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousExadataInfrastructureMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousExadataInfrastructureMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousExadataInfrastructureMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousExadataInfrastructureMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousExadataInfrastructureMaintenanceWindowDetail { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousExadataInfrastructureMaintenanceWindowDetailDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousExadataInfrastructureMaintenanceWindowDetailMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousExadataInfrastructureMaintenanceWindowDetailDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousExadataInfrastructureMaintenanceWindowDetailMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousExadataInfrastructureMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousExadataInfrastructureOcpuByWorkloadType { /** * The total number of OCPU cores in use for Autonomous AI Lakehouse databases in the infrastructure instance. */ adw: number; /** * The total number of OCPU cores in use for Autonomous AI Transaction Processing databases in the infrastructure instance. */ atp: number; } interface GetAutonomousExadataInfrastructureShapesAutonomousExadataInfrastructureShape { /** * The maximum number of CPU cores that can be enabled on the Autonomous Exadata Infrastructure. */ availableCoreCount: number; /** * The increment in which core count can be increased or decreased. */ coreCountIncrement: number; /** * The maximum number of nodes available for the shape. */ maximumNodeCount: number; /** * The minimum number of CPU cores that can be enabled on the Autonomous Exadata Infrastructure. */ minimumCoreCount: number; /** * The minimum number of nodes available for the shape. */ minimumNodeCount: number; /** * The name of the shape used for the Autonomous Exadata Infrastructure. */ name: string; } interface GetAutonomousExadataInfrastructureShapesFilter { /** * The name of the shape used for the Autonomous Exadata Infrastructure. */ name: string; regex?: boolean; values: string[]; } interface GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructure { /** * A filter to return only resources that match the given availability domain exactly. * * @deprecated Autonomous Exadata Infrastructure resource is now end-of-life.Please provision cloud autonomous vm cluster instead. */ availabilityDomain: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; createAsync: boolean; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The domain name for the Autonomous Exadata Infrastructure. */ domain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The host name for the Autonomous Exadata Infrastructure node. */ hostname: string; /** * The OCID of the Autonomous Exadata Infrastructure. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last maintenance run. */ lastMaintenanceRunId: string; /** * The Oracle license model that applies to all databases in the Autonomous Exadata Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * Additional information about the current lifecycle state of the Autonomous Exadata Infrastructure. */ lifecycleDetails: string; maintenanceWindowDetails: outputs.Database.GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindowDetail[]; /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ maintenanceWindows: outputs.Database.GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindow[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the next maintenance run. */ nextMaintenanceRunId: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). **NsgIds restrictions:** * * A network security group (NSG) is optional for Autonomous AI Databases with private access. The nsgIds list can be empty. */ nsgIds: string[]; /** * The FQDN of the DNS record for the SCAN IP addresses that are associated with the Autonomous Exadata Infrastructure. */ scanDnsName: string; /** * The shape of the Autonomous Exadata Infrastructure. The shape determines resources to allocate to the Autonomous Exadata Infrastructure (CPU cores, memory and storage). */ shape: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The OCID of the subnet the Autonomous Exadata Infrastructure is associated with. */ subnetId: string; /** * The date and time the Autonomous Exadata Infrastructure was created. */ timeCreated: string; /** * The OCID of the zone the Autonomous Exadata Infrastructure is associated with. */ zoneId: string; } interface GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindowDetail { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindowDetailDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindowDetailMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindowDetailDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindowDetailMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousExadataInfrastructuresAutonomousExadataInfrastructureMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousExadataInfrastructuresFilter { /** * Name of the month of the year. */ name: string; regex?: boolean; values: string[]; } interface GetAutonomousVirtualMachinesAutonomousVirtualMachine { /** * The Autonomous Virtual machine [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ autonomousVmClusterId: string; /** * Client IP Address. */ clientIpAddress: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The number of CPU cores enabled on the Autonomous Virtual Machine. */ cpuCoreCount: number; /** * The allocated local node storage in GBs on the Autonomous Virtual Machine. */ dbNodeStorageSizeInGbs: number; /** * The display name of the dbServer associated with the Autonomous Virtual Machine. */ dbServerDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Db server associated with the Autonomous Virtual Machine. */ dbServerId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Virtual Machine. */ id: string; /** * The allocated memory in GBs on the Autonomous Virtual Machine. */ memorySizeInGbs: number; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The name of the Autonomous Virtual Machine. */ vmName: string; } interface GetAutonomousVirtualMachinesFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousVmClusterAcdResourceUsagesAutonomousContainerDatabaseResourceUsage { /** * list of autonomous container database resource usage per autonomous virtual machine. */ autonomousContainerDatabaseVmUsages: outputs.Database.GetAutonomousVmClusterAcdResourceUsagesAutonomousContainerDatabaseResourceUsageAutonomousContainerDatabaseVmUsage[]; /** * CPUs available for provisioning or scaling an Autonomous AI Database in the Autonomous Container Database. */ availableCpus: number; /** * 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). */ definedTags: { [key: string]: string; }; /** * The user-friendly name for the Autonomous Container Database. The name does not need to be unique. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. */ id: string; /** * Largest provisionable ADB in the Autonomous Container Database. */ largestProvisionableAutonomousDatabaseInCpus: number; /** * Valid list of provisionable CPUs for Autonomous AI Database. */ provisionableCpuses: number[]; /** * CPUs / cores assigned to ADBs in the Autonomous Container Database. */ provisionedCpus: number; /** * Number of CPUs that are reclaimable or released to the AVMC on Autonomous Container Database restart. */ reclaimableCpus: number; /** * CPUs / cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead. */ reservedCpus: number; /** * CPUs / cores assigned to the Autonomous Container Database. Sum of provisioned, reserved and reclaimable CPUs/ cores. */ usedCpus: number; } interface GetAutonomousVmClusterAcdResourceUsagesAutonomousContainerDatabaseResourceUsageAutonomousContainerDatabaseVmUsage { /** * The user-friendly name for the Autonomous Container Database. The name does not need to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. */ id: string; /** * CPUs / cores assigned to ADBs in the Autonomous Container Database. */ provisionedCpus: number; /** * Number of CPUs that are reclaimable or released to the AVMC on Autonomous Container Database restart. */ reclaimableCpus: number; /** * CPUs / cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead. */ reservedCpus: number; /** * CPUs / cores assigned to the Autonomous Container Database. Sum of provisioned, reserved and reclaimable CPUs/ cores. */ usedCpus: number; } interface GetAutonomousVmClusterAcdResourceUsagesFilter { name: string; regex?: boolean; values: string[]; } interface GetAutonomousVmClusterMaintenanceWindow { customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousVmClusterMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; isCustomActionTimeoutEnabled: boolean; isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousVmClusterMaintenanceWindowMonth[]; patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousVmClusterMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousVmClusterMaintenanceWindowDetail { customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousVmClusterMaintenanceWindowDetailDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; isCustomActionTimeoutEnabled: boolean; isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousVmClusterMaintenanceWindowDetailMonth[]; patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousVmClusterMaintenanceWindowDetailDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousVmClusterMaintenanceWindowDetailMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousVmClusterMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousVmClusterResourceUsageAutonomousVmResourceUsage { /** * associated autonomous container database usages */ autonomousContainerDatabaseUsages: outputs.Database.GetAutonomousVmClusterResourceUsageAutonomousVmResourceUsageAutonomousContainerDatabaseUsage[]; /** * The number of CPU cores available. */ availableCpus: number; /** * The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous VM cluster. */ id: string; /** * The number of CPUs provisioned in an Autonomous VM Cluster. */ provisionedCpus: number; /** * CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database. */ reclaimableCpus: number; /** * The number of CPUs reserved in an Autonomous VM Cluster. */ reservedCpus: number; /** * The number of CPU cores alloted to the Autonomous Container Databases in an Autonomous VM cluster. */ usedCpus: number; } interface GetAutonomousVmClusterResourceUsageAutonomousVmResourceUsageAutonomousContainerDatabaseUsage { /** * The number of CPU cores available. */ availableCpus: number; /** * The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous VM cluster. */ id: string; /** * The number of CPUs provisioned in an Autonomous VM Cluster. */ provisionedCpus: number; /** * CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database. */ reclaimableCpus: number; /** * The number of CPUs reserved in an Autonomous VM Cluster. */ reservedCpus: number; /** * The number of CPU cores alloted to the Autonomous Container Databases in an Autonomous VM cluster. */ usedCpus: number; } interface GetAutonomousVmClustersAutonomousVmCluster { autonomousDataStoragePercentage: number; /** * The data disk group size allocated for Autonomous Databases, in TBs. */ autonomousDataStorageSizeInTbs: number; /** * The data disk group size available for Autonomous Databases, in TBs. */ availableAutonomousDataStorageSizeInTbs: number; /** * The number of Autonomous Container Databases that can be created with the currently available local storage. */ availableContainerDatabases: number; /** * The numnber of CPU cores available. */ availableCpus: number; /** * **Deprecated.** Use `availableAutonomousDataStorageSizeInTBs` for Autonomous Databases' data storage availability in TBs. */ availableDataStorageSizeInTbs: number; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The compute model of the Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous Database on Dedicated Exadata #Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. */ computeModel: string; /** * The number of CPU cores enabled per VM cluster node. */ cpuCoreCountPerNode: number; cpuPercentage: number; /** * The number of enabled CPU cores. */ cpusEnabled: number; /** * The lowest value to which cpus can be scaled down. */ cpusLowestScaledValue: number; /** * The total data storage allocated in GBs. */ dataStorageSizeInGb: number; /** * The total data storage allocated in TBs */ dataStorageSizeInTbs: number; /** * The local node storage allocated in GBs. */ dbNodeStorageSizeInGbs: number; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Db servers. */ dbServers: string[]; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The distribution algorithm used for the Autonomous VM cluster. */ distributionAlgorithm: string; /** * If provided, filters the results for the given Exadata Infrastructure. */ exadataInfrastructureId: string; /** * The lowest value to which exadataStorage(in TBs) can be scaled down. */ exadataStorageInTbsLowestScaledValue: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous VM cluster. */ id: string; /** * If true, database backup on local Exadata storage is configured for the Autonomous VM cluster. If false, database backup on local Exadata storage is not available in the Autonomous VM cluster. */ isLocalBackupEnabled: boolean; /** * Enable mutual TLS(mTLS) authentication for database while provisioning a VMCluster. Default is TLS. */ isMtlsEnabled: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last maintenance run. */ lastMaintenanceRunId: string; /** * The Oracle license model that applies to the Autonomous VM cluster. The default is LICENSE_INCLUDED. */ licenseModel: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; maintenanceWindowDetails: outputs.Database.GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindowDetail[]; /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ maintenanceWindows: outputs.Database.GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindow[]; /** * The lowest value to which maximum number of ACDs can be scaled down. */ maxAcdsLowestScaledValue: number; /** * The amount of memory (in GBs) to be enabled per OCPU or ECPU. */ memoryPerComputeUnitInGbs: number; /** * The amount of memory (in GBs, rounded off to nearest integer value) enabled per ECPU or OCPU. This is deprecated. Please refer to memoryPerComputeUnitInGBs for accurate value. */ memoryPerOracleComputeUnitInGbs: number; /** * The memory allocated in GBs. */ memorySizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the next maintenance run. */ nextMaintenanceRunId: string; /** * The number of nodes in the Autonomous VM Cluster. */ nodeCount: number; nonProvisionableAutonomousContainerDatabases: number; /** * The number of enabled OCPU cores. */ ocpusEnabled: number; /** * **Deprecated.** Use field totalContainerDatabases. */ provisionableAutonomousContainerDatabases: number; /** * The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. */ provisionedAutonomousContainerDatabases: number; /** * The number of CPUs provisioned in an Autonomous VM Cluster. */ provisionedCpus: number; /** * For Autonomous Databases on Dedicated Exadata Infrastructure: * * These are the CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. * * The CPU type (OCPUs or ECPUs) is determined by the parent Autonomous Exadata VM Cluster's compute model. */ reclaimableCpus: number; /** * The number of CPUs reserved in an Autonomous VM Cluster. */ reservedCpus: number; /** * The SCAN Listener Non TLS port number. Default value is 1521. */ scanListenerPortNonTls: number; /** * The SCAN Listener TLS port number. Default value is 2484. */ scanListenerPortTls: number; /** * Percentage of ECPU memory allocated for SGA(System Global Area). */ sgaPercentage: number; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time that the Autonomous VM cluster was created. */ timeCreated: string; /** * The date and time of Database SSL certificate expiration. */ timeDatabaseSslCertificateExpires: string; /** * The date and time of ORDS certificate expiration. */ timeOrdsCertificateExpires: string; /** * The time zone to use for the Autonomous VM cluster. For details, see [DB System Time Zones](https://docs.cloud.oracle.com/iaas/Content/Database/References/timezones.htm). */ timeZone: string; totalAutonomousDataStorageInTbs: number; /** * The total number of Autonomous Container Databases that can be created. */ totalContainerDatabases: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster network. */ vmClusterNetworkId: string; } interface GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindow { customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; isCustomActionTimeoutEnabled: boolean; isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindowMonth[]; patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindowDetail { customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindowDetailDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; isCustomActionTimeoutEnabled: boolean; isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindowDetailMonth[]; patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindowDetailDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindowDetailMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousVmClustersAutonomousVmClusterMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetAutonomousVmClustersFilter { /** * Name of the month of the year. */ name: string; regex?: boolean; values: string[]; } interface GetBackupDestinationAssociatedDatabase { /** * The display name of the database that is associated with the backup destination. */ dbName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; } interface GetBackupDestinationAssociatedLongTermBackup { /** * The user-provided name of the backup destination. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; } interface GetBackupDestinationMountTypeDetail { /** * The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. */ localMountPointPath: string; mountType: string; /** * Specifies the directory on which to mount the file system */ nfsServerExport: string; /** * Host names or IP addresses for NFS Auto mount. */ nfsServers: string[]; } interface GetBackupDestinationsBackupDestination { /** * List of databases associated with the backup destination. */ associatedDatabases: outputs.Database.GetBackupDestinationsBackupDestinationAssociatedDatabase[]; /** * Indicates the number of long term backups of Autonomous Databases associated with this backup destination. */ associatedLongTermBackupCount: number; /** * List of long term backups of Autonomous Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024. */ associatedLongTermBackups: outputs.Database.GetBackupDestinationsBackupDestinationAssociatedLongTermBackup[]; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance. */ connectionString: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * The user-provided name of the backup destination. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * A descriptive text associated with the lifecycleState. Typically contains additional displayable text */ lifecycleDetails: string; /** * The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. * * @deprecated The 'local_mount_point_path' field has been deprecated. Please use 'local_mount_point_path under mount_type_details' instead. */ localMountPointPath: string; mountTypeDetails: outputs.Database.GetBackupDestinationsBackupDestinationMountTypeDetail[]; /** * NFS Mount type for backup destination. */ nfsMountType: string; /** * Specifies the directory on which to mount the file system */ nfsServerExport: string; /** * Host names or IP addresses for NFS Auto mount. */ nfsServers: string[]; /** * The current lifecycle state of the backup destination. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The time when the total storage size and the utilized storage size of the backup destination are updated. */ timeAtWhichStorageDetailsAreUpdated: string; /** * The date and time the backup destination was created. */ timeCreated: string; /** * The total storage size of the backup destination in GBs, rounded to the nearest integer. */ totalStorageSizeInGbs: number; /** * A filter to return only resources that match the given type of the Backup Destination. */ type: string; /** * The total amount of space utilized on the backup destination (in GBs), rounded to the nearest integer. */ utilizedStorageSizeInGbs: number; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance. */ vpcUsers: string[]; } interface GetBackupDestinationsBackupDestinationAssociatedDatabase { /** * The display name of the database that is associated with the backup destination. */ dbName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; } interface GetBackupDestinationsBackupDestinationAssociatedLongTermBackup { /** * The user-provided name of the backup destination. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; } interface GetBackupDestinationsBackupDestinationMountTypeDetail { /** * The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. */ localMountPointPath: string; mountType: string; /** * Specifies the directory on which to mount the file system */ nfsServerExport: string; /** * Host names or IP addresses for NFS Auto mount. */ nfsServers: string[]; } interface GetBackupDestinationsFilter { name: string; regex?: boolean; values: string[]; } interface GetBackupsBackup { /** * The name of the availability domain where the database backup is stored. */ availabilityDomain: string; /** * A filter to return only resources that match the given backup destination type. */ backupDestinationType: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. */ databaseEdition: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ databaseId: string; /** * The size of the database in gigabytes at the time the backup was taken. */ databaseSizeInGbs: number; /** * The user-friendly name for the backup. The name does not have to be unique. */ displayName: string; /** * Types of providers supported for managing database encryption keys */ encryptionKeyLocationDetails: outputs.Database.GetBackupsBackupEncryptionKeyLocationDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup. */ id: string; /** * True if Oracle Managed Keys is required for restore of the backup. */ isUsingOracleManagedKeys: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. */ keyStoreId: string; /** * The wallet name for Oracle Key Vault. */ keyStoreWalletName: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The retention period of the long term backup in days. */ retentionPeriodInDays: number; /** * The retention period of the long term backup in years. */ retentionPeriodInYears: number; /** * List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations. */ secondaryKmsKeyIds: string[]; /** * Shape of the backup's source database. */ shape: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the backup was completed. */ timeEnded: string; /** * Expiration time of the long term database backup. */ timeExpiryScheduled: string; /** * The date and time the backup started. */ timeStarted: string; /** * A filter to return only backups that matches with the given type of Backup. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * A filter to return only resources that match the given database version. */ version: string; } interface GetBackupsBackupEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; /** * Provide the key OCID of a registered Azure key. */ azureEncryptionKeyId: string; /** * Provide the key OCID of a registered GCP key. */ googleCloudProviderEncryptionKeyId: string; /** * Provide the HSM password as you would in RDBMS for External HSM. */ hsmPassword: string; /** * Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. Use 'AZURE' for creating a new database or migrating a database key to Azure. Use 'AWS' for creating a new database or migrating a database key to Aws. Use 'GCP' for creating a new database or migrating a database key to Gcp. */ providerType: string; } interface GetBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudAutonomousVmClusterAcdResourceUsagesAutonomousContainerDatabaseResourceUsage { /** * List of autonomous container database resource usage per autonomous virtual machine. */ autonomousContainerDatabaseVmUsages: outputs.Database.GetCloudAutonomousVmClusterAcdResourceUsagesAutonomousContainerDatabaseResourceUsageAutonomousContainerDatabaseVmUsage[]; /** * CPUs available for provisioning or scaling an Autonomous AI Database in the Autonomous Container Database. */ availableCpus: number; /** * 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). */ definedTags: { [key: string]: string; }; /** * The user-friendly name for the Autonomous Container Database. The name does not need to be unique. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. */ id: string; /** * Largest provisionable ADB in the Autonomous Container Database. */ largestProvisionableAutonomousDatabaseInCpus: number; /** * Valid list of provisionable CPUs for Autonomous AI Database. */ provisionableCpuses: number[]; /** * CPUs / cores assigned to ADBs in the Autonomous Container Database. */ provisionedCpus: number; /** * Number of CPUs that are reclaimable or released to the AVMC on Autonomous Container Database restart. */ reclaimableCpus: number; /** * CPUs / cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead. */ reservedCpus: number; /** * CPUs / cores assigned to the Autonomous Container Database. Sum of provisioned, reserved and reclaimable CPUs/ cores. */ usedCpus: number; } interface GetCloudAutonomousVmClusterAcdResourceUsagesAutonomousContainerDatabaseResourceUsageAutonomousContainerDatabaseVmUsage { /** * The user-friendly name for the Autonomous Container Database. The name does not need to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database. */ id: string; /** * CPUs / cores assigned to ADBs in the Autonomous Container Database. */ provisionedCpus: number; /** * Number of CPUs that are reclaimable or released to the AVMC on Autonomous Container Database restart. */ reclaimableCpus: number; /** * CPUs / cores reserved for scalability, resilliency and other overheads. This includes failover, autoscaling and idle instance overhead. */ reservedCpus: number; /** * CPUs / cores assigned to the Autonomous Container Database. Sum of provisioned, reserved and reclaimable CPUs/ cores. */ usedCpus: number; } interface GetCloudAutonomousVmClusterAcdResourceUsagesFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudAutonomousVmClusterMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetCloudAutonomousVmClusterMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetCloudAutonomousVmClusterMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetCloudAutonomousVmClusterMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetCloudAutonomousVmClusterMaintenanceWindowDetail { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetCloudAutonomousVmClusterMaintenanceWindowDetailDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetCloudAutonomousVmClusterMaintenanceWindowDetailMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetCloudAutonomousVmClusterMaintenanceWindowDetailDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetCloudAutonomousVmClusterMaintenanceWindowDetailMonth { /** * Name of the month of the year. */ name: string; } interface GetCloudAutonomousVmClusterMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetCloudAutonomousVmClusterMultiCloudIdentityConnectorConfig { /** * Cloud provider */ cloudProvider: string; /** * The OCID of the identity connector */ id: string; } interface GetCloudAutonomousVmClusterResourceUsageAutonomousVmResourceUsage { /** * Associated Autonomous Container Database Usages. */ autonomousContainerDatabaseUsages: outputs.Database.GetCloudAutonomousVmClusterResourceUsageAutonomousVmResourceUsageAutonomousContainerDatabaseUsage[]; /** * The number of CPU cores available. */ availableCpus: number; /** * The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM cluster. */ id: string; /** * The number of CPUs provisioned in an Autonomous VM Cluster. */ provisionedCpus: number; /** * CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database. */ reclaimableCpus: number; /** * The number of CPUs reserved in an Autonomous VM Cluster. */ reservedCpus: number; /** * The number of CPU cores alloted to the Autonomous Container Databases in an Cloud Autonomous VM cluster. */ usedCpus: number; } interface GetCloudAutonomousVmClusterResourceUsageAutonomousVmResourceUsageAutonomousContainerDatabaseUsage { /** * The number of CPU cores available. */ availableCpus: number; /** * The user-friendly name for the Autonomous VM cluster. The name does not need to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cloud Autonomous VM cluster. */ id: string; /** * The number of CPUs provisioned in an Autonomous VM Cluster. */ provisionedCpus: number; /** * CPU cores that continue to be included in the count of OCPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available OCPUs at its parent AVMC level by restarting the Autonomous Container Database. */ reclaimableCpus: number; /** * The number of CPUs reserved in an Autonomous VM Cluster. */ reservedCpus: number; /** * The number of CPU cores alloted to the Autonomous Container Databases in an Cloud Autonomous VM cluster. */ usedCpus: number; } interface GetCloudAutonomousVmClustersCloudAutonomousVmCluster { /** * The percentage of the data storage used for the Autonomous AI Databases in an Autonomous VM Cluster. */ autonomousDataStoragePercentage: number; /** * The data disk group size allocated for Autonomous AI Databases, in TBs. */ autonomousDataStorageSizeInTbs: number; /** * A filter to return only resources that match the given availability domain exactly. */ availabilityDomain: string; /** * The data disk group size available for Autonomous AI Databases, in TBs. */ availableAutonomousDataStorageSizeInTbs: number; /** * The number of Autonomous Container Databases that can be created with the currently available local storage. */ availableContainerDatabases: number; /** * CPU cores available for allocation to Autonomous AI Databases. */ availableCpus: number; /** * If provided, filters the results for the specified cloud Exadata infrastructure. */ cloudExadataInfrastructureId: string; /** * The time zone of the Cloud Autonomous VM Cluster. */ clusterTimeZone: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The compute model of the Cloud Autonomous VM Cluster. ECPU compute model is the recommended model and OCPU compute model is legacy. See [Compute Models in Autonomous AI Database on Dedicated Exadata #Infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbak) for more details. */ computeModel: string; /** * The number of CPU cores on the cloud Autonomous VM cluster. */ cpuCoreCount: number; /** * The number of CPU cores enabled per VM cluster node. */ cpuCoreCountPerNode: number; /** * The percentage of total number of CPUs used in an Autonomous VM Cluster. */ cpuPercentage: number; /** * The total data storage allocated, in gigabytes (GB). */ dataStorageSizeInGb: number; /** * The total data storage allocated, in terabytes (TB). */ dataStorageSizeInTbs: number; /** * The local node storage allocated in GBs. */ dbNodeStorageSizeInGbs: number; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Db servers. */ dbServers: string[]; /** * 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). */ definedTags: { [key: string]: string; }; /** * User defined description of the cloud Autonomous VM cluster. */ description: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The distribution algorithm used for the Autonomous VM cluster. */ distributionAlgorithm: string; /** * The domain name for the cloud Autonomous VM cluster. */ domain: string; /** * The lowest value to which exadataStorage (in TBs) can be scaled down. */ exadataStorageInTbsLowestScaledValue: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The hostname for the cloud Autonomous VM cluster. */ hostname: string; /** * The OCID of the identity connector */ id: string; /** * Enable mutual TLS(mTLS) authentication for database at time of provisioning a VMCluster. This is applicable to database TLS Certificates only. Default is TLS */ isMtlsEnabledVmCluster: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last maintenance run. */ lastMaintenanceRunId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last maintenance update history. This value is updated when a maintenance update starts. */ lastUpdateHistoryEntryId: string; /** * The Oracle license model that applies to the Oracle Autonomous AI Database. Bring your own license (BYOL) allows you to apply your current on-premises Oracle software licenses to equivalent, highly automated Oracle services in the cloud. License Included allows you to subscribe to new Oracle AI Database software licenses and the Oracle AI Database service. Note that when provisioning an [Autonomous AI Database on dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html), this attribute must be null. It is already set at the Autonomous Exadata Infrastructure level. When provisioning an [Autonomous AI Database Serverless] (https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html) database, if a value is not specified, the system defaults the value to `BRING_YOUR_OWN_LICENSE`. Bring your own license (BYOL) also allows you to select the DB edition using the optional parameter. */ licenseModel: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; maintenanceWindowDetails: outputs.Database.GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindowDetail[]; /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ maintenanceWindows: outputs.Database.GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindow[]; /** * The lowest value to which maximum number of ACDs can be scaled down. */ maxAcdsLowestScaledValue: number; /** * The amount of memory (in GBs) to be enabled per OCPU or ECPU. */ memoryPerComputeUnitInGbs: number; /** * The amount of memory (in GBs, rounded off to nearest integer value) enabled per ECPU or OCPU. This is deprecated. Please refer to memoryPerComputeUnitInGBs for accurate value. */ memoryPerOracleComputeUnitInGbs: number; /** * The memory allocated in GBs. */ memorySizeInGbs: number; /** * Details of the multi cloud identity connectors of the VM cluster. */ multiCloudIdentityConnectorConfigs: outputs.Database.GetCloudAutonomousVmClustersCloudAutonomousVmClusterMultiCloudIdentityConnectorConfig[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the next maintenance run. */ nextMaintenanceRunId: string; /** * The number of database servers in the cloud VM cluster. */ nodeCount: number; /** * The number of non-provisionable Autonomous Container Databases in an Autonomous VM Cluster. */ nonProvisionableAutonomousContainerDatabases: number; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). **NsgIds restrictions:** * * A network security group (NSG) is optional for Autonomous AI Databases with private access. The nsgIds list can be empty. */ nsgIds: string[]; /** * The number of CPU cores on the cloud Autonomous VM cluster. Only 1 decimal place is allowed for the fractional part. */ ocpuCount: number; /** * The lowest value to which ocpus can be scaled down. */ ocpusLowestScaledValue: number; opcDryRun: boolean; /** * The number of provisionable Autonomous Container Databases in an Autonomous VM Cluster. */ provisionableAutonomousContainerDatabases: number; /** * The number of provisioned Autonomous Container Databases in an Autonomous VM Cluster. */ provisionedAutonomousContainerDatabases: number; /** * The number of CPUs provisioned in an Autonomous VM Cluster. */ provisionedCpus: number; /** * CPUs that continue to be included in the count of CPUs available to the Autonomous Container Database even after one of its Autonomous AI Database is terminated or scaled down. You can release them to the available CPUs at its parent Autonomous VM Cluster level by restarting the Autonomous Container Database. */ reclaimableCpus: number; registerPkcsTrigger: number; /** * The number of CPUs reserved in an Autonomous VM Cluster. */ reservedCpus: number; /** * The SCAN Listener Non TLS port. Default is 1521. */ scanListenerPortNonTls: number; /** * The SCAN Listenenr TLS port. Default is 2484. */ scanListenerPortTls: number; /** * 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": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * Percentage of ECPU memory allocated for SGA(System Global Area). */ sgaPercentage: number; /** * The model name of the Exadata hardware running the cloud Autonomous VM cluster. */ shape: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the cloud Autonomous VM Cluster is associated with. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * TDE keystore type */ tdeKeyStoreType: string; /** * The date and time that the cloud Autonomous VM cluster was created. */ timeCreated: string; /** * The date and time of Database SSL certificate expiration. */ timeDatabaseSslCertificateExpires: string; /** * The date and time of ORDS certificate expiration. */ timeOrdsCertificateExpires: string; /** * The last date and time that the cloud Autonomous VM cluster was updated. */ timeUpdated: string; /** * The total data disk group size for Autonomous AI Databases, in TBs. */ totalAutonomousDataStorageInTbs: number; /** * The total number of Autonomous Container Databases that can be created with the allocated local storage. */ totalContainerDatabases: number; /** * The total number of CPUs in an Autonomous VM Cluster. */ totalCpus: number; unregisterPkcsTrigger: number; } interface GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindowDetail { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindowDetailDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindowDetailMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * If true, skips the release update (RU) for the quarter. You cannot skip two consecutive quarters. An RU skip request will only be honoured if the current version of the Autonomous Container Database is supported for current quarter. */ skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindowDetailDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindowDetailMonth { /** * Name of the month of the year. */ name: string; } interface GetCloudAutonomousVmClustersCloudAutonomousVmClusterMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetCloudAutonomousVmClustersCloudAutonomousVmClusterMultiCloudIdentityConnectorConfig { /** * Cloud provider */ cloudProvider: string; /** * The OCID of the identity connector */ id: string; } interface GetCloudAutonomousVmClustersFilter { /** * Name of the month of the year. */ name: string; regex?: boolean; values: string[]; } interface GetCloudExadataInfrastructureCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetCloudExadataInfrastructureDefinedFileSystemConfiguration { /** * If true, the file system is used to create a backup prior to Exadata VM OS update. */ isBackupPartition: boolean; /** * If true, the file system resize is allowed for the Exadata Infrastructure cluster. If false, the file system resize is not allowed. */ isResizable: boolean; /** * The maximum size of file system. */ maxSizeGb: number; /** * The minimum size of file system. */ minSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface GetCloudExadataInfrastructureExascaleConfig { /** * Available storage size for Exascale in GBs. */ availableStorageInGbs: number; /** * Available storage size for VM storage on Exascale in GBs. */ availableVmStorageInGbs: number; /** * Storage size needed for Exascale in GBs. */ totalStorageInGbs: number; /** * Storage size needed for VM storage on Exascale in GBs. */ totalVmStorageInGbs: number; } interface GetCloudExadataInfrastructureMaintenanceVersionPreference { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. */ referenceResourceIdForImageUpdates: string; } interface GetCloudExadataInfrastructureMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetCloudExadataInfrastructureMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetCloudExadataInfrastructureMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetCloudExadataInfrastructureMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetCloudExadataInfrastructureMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetCloudExadataInfrastructureUnAllocatedResourceCloudAutonomousVmCluster { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cloud Exadata infrastructure. */ id: string; /** * Total unallocated autonomous data storage in the Cloud Autonomous VM Cluster in TBs. */ unAllocatedAdbStorageInTbs: number; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructure { /** * The requested number of additional storage servers activated for the Exadata infrastructure. */ activatedStorageCount: number; /** * The requested number of additional storage servers for the Exadata infrastructure. */ additionalStorageCount: number; /** * The name of the availability domain that the cloud Exadata infrastructure resource is located in. */ availabilityDomain: string; /** * The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). */ availableStorageSizeInGbs: number; /** * A filter to return only resources that match the given cluster placement group ID exactly. */ clusterPlacementGroupId: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The number of compute servers for the cloud Exadata infrastructure. */ computeCount: number; /** * The compute model of the Autonomous AI Database. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. */ computeModel: string; /** * The total number of CPU cores allocated. */ cpuCount: number; /** * The list of customer email addresses that receive information from Oracle about the specified Oracle Cloud Infrastructure Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. */ customerContacts: outputs.Database.GetCloudExadataInfrastructuresCloudExadataInfrastructureCustomerContact[]; /** * Size, in terabytes, of the DATA disk group. */ dataStorageSizeInTbs: number; /** * The database server type of the Exadata infrastructure. */ databaseServerType: string; /** * The local node storage allocated in GBs. */ dbNodeStorageSizeInGbs: number; /** * The software version of the database servers (dom0) in the cloud Exadata infrastructure. Example: 20.1.15 */ dbServerVersion: string; /** * Details of the file system configuration of the Exadata infrastructure. */ definedFileSystemConfigurations: outputs.Database.GetCloudExadataInfrastructuresCloudExadataInfrastructureDefinedFileSystemConfiguration[]; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The exascale config response details for the Exadata Cloud@Customer infrastructure or cloud Exadata infrastructure . Applies to both Exadata Cloud@Customer instances and Exadata Cloud Service instances. */ exascaleConfigs: outputs.Database.GetCloudExadataInfrastructuresCloudExadataInfrastructureExascaleConfig[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud Exadata infrastructure resource. */ id: string; /** * If true, the infrastructure is using granular maintenance scheduling preference. */ isSchedulingPolicyAssociated: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last maintenance run. */ lastMaintenanceRunId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The preferences for target versions of future maintenance runs. */ maintenanceVersionPreferences: outputs.Database.GetCloudExadataInfrastructuresCloudExadataInfrastructureMaintenanceVersionPreference[]; /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ maintenanceWindows: outputs.Database.GetCloudExadataInfrastructuresCloudExadataInfrastructureMaintenanceWindow[]; /** * The total number of CPU cores available. */ maxCpuCount: number; /** * The total available DATA disk group size. */ maxDataStorageInTbs: number; /** * The total local node storage available in GBs. */ maxDbNodeStorageInGbs: number; /** * The total memory available in GBs. */ maxMemoryInGbs: number; /** * The memory allocated in GBs. */ memorySizeInGbs: number; /** * The monthly software version of the database servers (dom0) in the cloud Exadata infrastructure. Example: 20.1.15 */ monthlyDbServerVersion: string; /** * The monthly software version of the storage servers (cells) in the cloud Exadata infrastructure. Example: 20.1.15 */ monthlyStorageServerVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the next maintenance run. */ nextMaintenanceRunId: string; /** * The model name of the cloud Exadata infrastructure resource. */ shape: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The number of storage servers for the cloud Exadata infrastructure. */ storageCount: number; /** * The storage server type of the Exadata infrastructure. */ storageServerType: string; /** * The software version of the storage servers (cells) in the cloud Exadata infrastructure. Example: 20.1.15 */ storageServerVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the cloud Exadata infrastructure resource was created. */ timeCreated: string; /** * The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). */ totalStorageSizeInGbs: number; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureCustomerContact { /** * The email address used by Oracle to send notifications regarding databases and infrastructure. */ email: string; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureDefinedFileSystemConfiguration { /** * If true, the file system is used to create a backup prior to Exadata VM OS update. */ isBackupPartition: boolean; /** * If true, the file system resize is allowed for the Exadata Infrastructure cluster. If false, the file system resize is not allowed. */ isResizable: boolean; /** * The maximum size of file system. */ maxSizeGb: number; /** * The minimum size of file system. */ minSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureExascaleConfig { /** * Available storage size for Exascale in GBs. */ availableStorageInGbs: number; /** * Available storage size for VM storage on Exascale in GBs. */ availableVmStorageInGbs: number; /** * Storage size needed for Exascale in GBs. */ totalStorageInGbs: number; /** * Storage size needed for VM storage on Exascale in GBs. */ totalVmStorageInGbs: number; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureMaintenanceVersionPreference { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. */ referenceResourceIdForImageUpdates: string; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetCloudExadataInfrastructuresCloudExadataInfrastructureMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetCloudExadataInfrastructuresCloudExadataInfrastructureMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetCloudExadataInfrastructuresFilter { /** * Name of the month of the year. */ name: string; regex?: boolean; values: string[]; } interface GetCloudVmClusterCloudAutomationUpdateDetail { /** * Configure the time slot for applying VM cloud automation software updates to the cluster. When nothing is selected, the default time slot is 12 AM to 2 AM UTC. Any 2-hour slot is available starting at 12 AM. */ applyUpdateTimePreferences: outputs.Database.GetCloudVmClusterCloudAutomationUpdateDetailApplyUpdateTimePreference[]; /** * Enables a freeze period for the VM cluster prohibiting the VMs from getting cloud automation software updates during critical business cycles. Freeze period start date. Starts at 12:00 AM UTC on the selected date and ends at 11:59:59 PM UTC on the selected date. Validates to ensure the freeze period does not exceed 45 days. */ freezePeriods: outputs.Database.GetCloudVmClusterCloudAutomationUpdateDetailFreezePeriod[]; /** * Annotates whether the cluster should be part of early access to apply VM cloud automation software updates. Those clusters annotated as early access will download the software bits for cloud automation in the first week after the update is available, while other clusters will have to wait until the following week. */ isEarlyAdoptionEnabled: boolean; /** * Specifies if the freeze period is enabled for the VM cluster to prevent the VMs from receiving cloud automation software updates during critical business cycles. Freeze period starts at 12:00 AM UTC and ends at 11:59:59 PM UTC on the selected date. Ensure that the freezing period does not exceed 45 days. */ isFreezePeriodEnabled: boolean; } interface GetCloudVmClusterCloudAutomationUpdateDetailApplyUpdateTimePreference { /** * End time for polling VM cloud automation software updates for the cluster. If the endTime is not specified, 2 AM UTC is used by default. */ applyUpdatePreferredEndTime: string; /** * Start time for polling VM cloud automation software updates for the cluster. If the startTime is not specified, 12 AM UTC is used by default. */ applyUpdatePreferredStartTime: string; } interface GetCloudVmClusterCloudAutomationUpdateDetailFreezePeriod { /** * End time of the freeze period cycle. */ freezePeriodEndTime: string; /** * Start time of the freeze period cycle. */ freezePeriodStartTime: string; } interface GetCloudVmClusterDataCollectionOption { /** * Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface GetCloudVmClusterFileSystemConfigurationDetail { /** * The file system size to be allocated in GBs. */ fileSystemSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface GetCloudVmClusterIormConfigCache { /** * An array of IORM settings for all the database in the Exadata DB system. */ dbPlans: outputs.Database.GetCloudVmClusterIormConfigCacheDbPlan[]; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current value for the IORM objective. The default is `AUTO`. */ objective: string; /** * The current state of the cloud VM cluster. */ state: string; } interface GetCloudVmClusterIormConfigCacheDbPlan { /** * The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * The relative priority of this database. */ share: number; } interface GetCloudVmClusterIormConfigDbPlan { /** * The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * The relative priority of this database. */ share: number; } interface GetCloudVmClusterLiveImageVersionDetail { /** * Indicates whether OS updates that require node reboot are pending after the previous online update was applied. */ hasPendingUpdates: boolean; /** * The release date and time for the applied Live Exadata Image OS version. */ timeReleased: string; /** * The OS live update mode performed most recently on the VM Cluster. */ updateMode: string; /** * Live Exadata Image Version of the Guest OS Update applied. */ version: string; } interface GetCloudVmClusterMultiCloudIdentityConnectorConfig { /** * Cloud provider */ cloudProvider: string; /** * The OCID of the identity connector */ id: string; } interface GetCloudVmClusterUpdateDetail { updateAction: string; updateId: string; /** * The OS live update mode performed most recently on the VM Cluster. */ updateMode: string; } interface GetCloudVmClustersCloudVmCluster { /** * The name of the availability domain that the cloud Exadata infrastructure resource is located in. */ availabilityDomain: string; /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the cloud VM cluster. */ backupSubnetId: string; /** * Specifies the properties necessary for cloud automation updates. This includes modifying the apply update time preference, enabling or disabling early adoption, and enabling, modifying, or disabling the update freeze period. */ cloudAutomationUpdateDetails: outputs.Database.GetCloudVmClustersCloudVmClusterCloudAutomationUpdateDetail[]; /** * If provided, filters the results for the specified cloud Exadata infrastructure. */ cloudExadataInfrastructureId: string; /** * The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. */ clusterName: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The compute model of the Autonomous AI Database. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. */ computeModel: string; /** * The number of CPU cores enabled on the cloud VM cluster. */ cpuCoreCount: number; createAsync: boolean; /** * Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. */ dataCollectionOptions: outputs.Database.GetCloudVmClustersCloudVmClusterDataCollectionOption[]; /** * The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. */ dataStoragePercentage: number; /** * The data disk group size to be allocated in TBs. */ dataStorageSizeInTbs: number; /** * The local node storage to be allocated in GBs. */ dbNodeStorageSizeInGbs: number; /** * The list of DB servers. */ dbServers: string[]; /** * 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). */ definedTags: { [key: string]: string; }; /** * The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. */ diskRedundancy: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The domain name for the cloud VM cluster. */ domain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. */ exascaleDbStorageVaultId: string; /** * Details of the file system configuration of the VM cluster. */ fileSystemConfigurationDetails: outputs.Database.GetCloudVmClustersCloudVmClusterFileSystemConfigurationDetail[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A valid Oracle Grid Infrastructure (GI) software version. */ giVersion: string; /** * The hostname for the cloud VM cluster. */ hostname: string; /** * The OCID of the identity connector */ id: string; iormConfigCaches: outputs.Database.GetCloudVmClustersCloudVmClusterIormConfigCache[]; /** * If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. */ isLocalBackupEnabled: boolean; /** * If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. */ isSparseDiskgroupEnabled: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last maintenance update history entry. This value is updated when a maintenance update starts. */ lastUpdateHistoryEntryId: string; /** * The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. */ licenseModel: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The port number configured for the listener on the cloud VM cluster. */ listenerPort: string; /** * Details about the most recent live image version applied on the VM Cluster, if any. If a full OS update was applied, the fields would be blank. */ liveImageVersionDetails: outputs.Database.GetCloudVmClustersCloudVmClusterLiveImageVersionDetail[]; /** * The memory to be allocated in GBs. */ memorySizeInGbs: number; /** * Details of the multi cloud identity connectors of the VM cluster. */ multiCloudIdentityConnectorConfigs: outputs.Database.GetCloudVmClustersCloudVmClusterMultiCloudIdentityConnectorConfig[]; /** * The number of nodes in the cloud VM cluster. */ nodeCount: number; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). **NsgIds restrictions:** * * A network security group (NSG) is optional for Autonomous AI Databases with private access. The nsgIds list can be empty. */ nsgIds: string[]; /** * The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. */ ocpuCount: number; /** * Oracle Linux version for the respective Exadata Image. */ oracleLinuxVersion: string; privateZoneId: string; /** * The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. */ recoStoragePercentage: number; /** * The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. */ scanDnsName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. */ scanDnsRecordId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv4 addresses associated with the cloud VM cluster. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. */ scanIpIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv6 addresses associated with the cloud VM cluster. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. */ scanIpv6ids: string[]; /** * The TCP Single Client Access Name (SCAN) port. The default port is 1521. */ scanListenerPortTcp: number; /** * The TCPS Single Client Access Name (SCAN) port. The default port is 2484. */ scanListenerPortTcpSsl: number; /** * 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": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The model name of the Exadata hardware running the cloud VM cluster. */ shape: string; /** * The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. */ sparseStoragePercentage: number; /** * The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. */ sshPublicKeys: string[]; /** * A filter to return only cloud VM clusters that match the given lifecycle state exactly. */ state: string; /** * Specifies the type of storage management for the Cloud VM Cluster if its ASM or Exascale. */ storageManagementType: string; /** * The storage allocation for the disk group, in gigabytes (GB). */ storageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the cloud VM cluster. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * Operating system version of the image. */ systemVersion: string; /** * TDE keystore type */ tdeKeyStoreType: string; /** * The date and time that the cloud VM cluster was created. */ timeCreated: string; /** * The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](https://docs.cloud.oracle.com/iaas/Content/Database/References/timezones.htm). */ timeZone: string; updateDetails: outputs.Database.GetCloudVmClustersCloudVmClusterUpdateDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) IPv4 addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP IPv4 address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. */ vipIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) IPv6 addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP IPv6 address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. */ vipv6ids: string[]; /** * Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL */ vmBackupStorageType: string; /** * A filter to return only cloud vmclusters that match the given cloud vmcluster type exactly. */ vmClusterType: string; /** * Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL */ vmFileSystemStorageType: string; /** * The OCID of the zone the cloud VM cluster is associated with. */ zoneId: string; } interface GetCloudVmClustersCloudVmClusterCloudAutomationUpdateDetail { /** * Configure the time slot for applying VM cloud automation software updates to the cluster. When nothing is selected, the default time slot is 12 AM to 2 AM UTC. Any 2-hour slot is available starting at 12 AM. */ applyUpdateTimePreferences: outputs.Database.GetCloudVmClustersCloudVmClusterCloudAutomationUpdateDetailApplyUpdateTimePreference[]; /** * Enables a freeze period for the VM cluster prohibiting the VMs from getting cloud automation software updates during critical business cycles. Freeze period start date. Starts at 12:00 AM UTC on the selected date and ends at 11:59:59 PM UTC on the selected date. Validates to ensure the freeze period does not exceed 45 days. */ freezePeriods: outputs.Database.GetCloudVmClustersCloudVmClusterCloudAutomationUpdateDetailFreezePeriod[]; /** * Annotates whether the cluster should be part of early access to apply VM cloud automation software updates. Those clusters annotated as early access will download the software bits for cloud automation in the first week after the update is available, while other clusters will have to wait until the following week. */ isEarlyAdoptionEnabled: boolean; /** * Specifies if the freeze period is enabled for the VM cluster to prevent the VMs from receiving cloud automation software updates during critical business cycles. Freeze period starts at 12:00 AM UTC and ends at 11:59:59 PM UTC on the selected date. Ensure that the freezing period does not exceed 45 days. */ isFreezePeriodEnabled: boolean; } interface GetCloudVmClustersCloudVmClusterCloudAutomationUpdateDetailApplyUpdateTimePreference { /** * End time for polling VM cloud automation software updates for the cluster. If the endTime is not specified, 2 AM UTC is used by default. */ applyUpdatePreferredEndTime: string; /** * Start time for polling VM cloud automation software updates for the cluster. If the startTime is not specified, 12 AM UTC is used by default. */ applyUpdatePreferredStartTime: string; } interface GetCloudVmClustersCloudVmClusterCloudAutomationUpdateDetailFreezePeriod { /** * End time of the freeze period cycle. */ freezePeriodEndTime: string; /** * Start time of the freeze period cycle. */ freezePeriodStartTime: string; } interface GetCloudVmClustersCloudVmClusterDataCollectionOption { /** * Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface GetCloudVmClustersCloudVmClusterFileSystemConfigurationDetail { /** * The file system size to be allocated in GBs. */ fileSystemSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface GetCloudVmClustersCloudVmClusterIormConfigCache { dbPlans: outputs.Database.GetCloudVmClustersCloudVmClusterIormConfigCacheDbPlan[]; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; objective: string; /** * A filter to return only cloud VM clusters that match the given lifecycle state exactly. */ state: string; } interface GetCloudVmClustersCloudVmClusterIormConfigCacheDbPlan { dbName: string; flashCacheLimit: string; share: number; } interface GetCloudVmClustersCloudVmClusterLiveImageVersionDetail { /** * Indicates whether OS updates that require node reboot are pending after the previous online update was applied. */ hasPendingUpdates: boolean; /** * The release date and time for the applied Live Exadata Image OS version. */ timeReleased: string; /** * The OS live update mode performed most recently on the VM Cluster. */ updateMode: string; /** * Live Exadata Image Version of the Guest OS Update applied. */ version: string; } interface GetCloudVmClustersCloudVmClusterMultiCloudIdentityConnectorConfig { /** * Cloud provider */ cloudProvider: string; /** * The OCID of the identity connector */ id: string; } interface GetCloudVmClustersCloudVmClusterUpdateDetail { updateAction: string; updateId: string; /** * The OS live update mode performed most recently on the VM Cluster. */ updateMode: string; } interface GetCloudVmClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetDataGuardAssociationDataCollectionOption { isDiagnosticsEventsEnabled: boolean; isHealthMonitoringEnabled: boolean; isIncidentLogsEnabled: boolean; } interface GetDataGuardAssociationsDataGuardAssociation { /** * The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `9 seconds` */ applyLag: string; /** * The rate at which redo logs are synced between the associated databases. Example: `180 Mb per second` */ applyRate: string; availabilityDomain: string; backupNetworkNsgIds: string[]; clusterPlacementGroupId: string; computeCount: number; computeModel: string; cpuCoreCount: number; createAsync: boolean; creationType: string; dataCollectionOptions: outputs.Database.GetDataGuardAssociationsDataGuardAssociationDataCollectionOption[]; databaseAdminPassword: string; databaseDefinedTags: { [key: string]: string; }; databaseFreeformTags: { [key: string]: string; }; /** * The database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ databaseId: string; databaseSoftwareImageId: string; dbSystemDefinedTags: { [key: string]: string; }; dbSystemFreeformTags: { [key: string]: string; }; dbSystemSecurityAttributes: { [key: string]: string; }; deleteStandbyDbHomeOnDelete: string; displayName: string; domain: string; faultDomains: string[]; hostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Data Guard association. */ id: string; /** * True if active Data Guard is enabled. */ isActiveDataGuardEnabled: boolean; licenseModel: string; /** * Additional information about the current lifecycleState, if available. */ lifecycleDetails: string; migrateTrigger: number; nodeCount: number; nsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the peer database's Data Guard association. */ peerDataGuardAssociationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated peer database. */ peerDatabaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home containing the associated peer database. */ peerDbHomeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system containing the associated peer database. */ peerDbSystemId: string; peerDbUniqueName: string; /** * The role of the peer database in this Data Guard association. */ peerRole: string; peerSidPrefix: string; peerVmClusterId: string; privateIp: string; privateIpV6: string; /** * The protection mode of this Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; /** * The role of the reporting database in this Data Guard association. */ role: string; shape: string; /** * The current state of the Data Guard association. */ state: string; storageVolumePerformanceMode: string; subnetId: string; subscriptionId: string; /** * The date and time the Data Guard association was created. */ timeCreated: string; timeZone: string; /** * The redo transport type used by this Data Guard association. For more information, see [Redo Transport Services](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-redo-transport-services.htm#SBYDB00400) in the Oracle Data Guard documentation. */ transportType: string; } interface GetDataGuardAssociationsDataGuardAssociationDataCollectionOption { isDiagnosticsEventsEnabled: boolean; isHealthMonitoringEnabled: boolean; isIncidentLogsEnabled: boolean; } interface GetDataGuardAssociationsFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabaseConnectionString { /** * All connection strings to use to connect to the Database. */ allConnectionStrings: { [key: string]: string; }; /** * Host name based CDB Connection String. */ cdbDefault: string; /** * IP based CDB Connection String. */ cdbIpDefault: string; } interface GetDatabaseDataGuardGroup { /** * Specifies readiness of Managed Automatic failover. */ managedAutoFailOverReadiness: string; /** * List of Data Guard members, representing each database that is part of Data Guard. */ members: outputs.Database.GetDatabaseDataGuardGroupMember[]; /** * The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; } interface GetDatabaseDataGuardGroupMember { /** * The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `1 second` */ applyLag: string; /** * The rate at which redo logs are synced between the associated databases. Example: `102.96 MByte/s` */ applyRate: string; /** * The Data loss exposure is the redo transport lag between the primary and standby databases. Example: `2 seconds` */ dataLossExposure: string; /** * The database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ databaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ dbSystemId: string; /** * The failover readiness status of the Data Guard member. HEALTHY_AND_NOT_ROLECHANGE_TARGET - Indicates that the respective standby member is healthy but not currently designated to take failover, when auto failover is enabled. */ failoverReadiness: string; /** * The message explaining failover readiness status. Example: `This standby database is not failover ready.` */ failoverReadinessMessage: string; /** * Specifies the `DB_UNIQUE_NAME` of the data guard group member databases. */ failoverTargets: string[]; /** * True if active Data Guard is enabled. */ isActiveDataGuardEnabled: boolean; /** * The state of managed auto failover. */ managedAutoFailover: string; /** * The role of the reporting database in this Data Guard association. */ role: string; /** * The switchover readiness status of the Data Guard member. * * HEALTHY_AND_NOT_ROLECHANGE_TARGET - Indicates that the respective standby member is healthy but not currently designated to take switchover, when auto failover is enabled. */ switchoverReadiness: string; /** * The message explaining switchover readiness status. Example: `Address failed checks to avoid extended downtime.` */ switchoverReadinessMessage: string; /** * The date and time when the last successful Data Guard refresh occurred. */ timeUpdated: string; /** * The rate at which redo logs are transported between the associated databases. Example: `1 second` */ transportLag: string; /** * The date and time when last redo transport has been done. */ transportLagRefresh: string; /** * The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * * MAXIMUM_PERFORMANCE - ASYNC * * MAXIMUM_PROTECTION - SYNC */ transportType: string; } interface GetDatabaseDatabase { adminPassword: string; autoFailoverConfigurations: outputs.Database.GetDatabaseDatabaseAutoFailoverConfiguration[]; backupId: string; backupTdePassword: string; /** * The character set for the database. */ characterSet: string; databaseAdminPassword: string; /** * The database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ databaseId: string; /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; /** * Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). */ dbBackupConfigs: outputs.Database.GetDatabaseDatabaseDbBackupConfig[]; /** * The database name. */ dbName: string; /** * A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. */ dbUniqueName: string; /** * **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. */ dbWorkload: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * Types of providers supported for managing database encryption keys */ encryptionKeyLocationDetails: outputs.Database.GetDatabaseDatabaseEncryptionKeyLocationDetail[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * True if active Data Guard is enabled. */ isActiveDataGuardEnabled: boolean; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The database registered for Oracle Managed Database Software Updates. */ managedSoftwareUpdateDetails: outputs.Database.GetDatabaseDatabaseManagedSoftwareUpdateDetail[]; /** * The national character set for the database. */ ncharacterSet: string; /** * Options for DB Home and Database patching */ patchOptions: outputs.Database.GetDatabaseDatabasePatchOption[]; /** * The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. */ pdbName: string; pluggableDatabases: string[]; /** * The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; recoveryApplianceVpcPassword: string; /** * Specifies a prefix for the `Oracle SID` of the database to be created. */ sidPrefix: string; sourceDatabaseId: string; sourceEncryptionKeyLocationDetails: outputs.Database.GetDatabaseDatabaseSourceEncryptionKeyLocationDetail[]; sourceTdeWalletPassword: string; /** * The database storage size details. This database option is supported for the Exadata VM cluster on Exascale Infrastructure. */ storageSizeDetails: outputs.Database.GetDatabaseDatabaseStorageSizeDetail[]; tdeWalletPassword: string; timeStampForPointInTimeRecovery: string; /** * The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * * MAXIMUM_PERFORMANCE - ASYNC * * MAXIMUM_PROTECTION - SYNC */ transportType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster. */ vmClusterId: string; } interface GetDatabaseDatabaseAutoFailoverConfiguration { /** * Specifies the `DB_UNIQUE_NAME` of the data guard group member databases. */ failoverTargets: string[]; /** * The state of managed auto failover. */ managedAutoFailover: string; } interface GetDatabaseDatabaseDbBackupConfig { /** * If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ autoBackupEnabled: boolean; /** * Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.Database.GetDatabaseDatabaseDbBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ runImmediateFullBackup: boolean; } interface GetDatabaseDatabaseDbBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ id: string; /** * Indicates whether the backup destination is cross-region or local region. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. */ remoteRegion: string; /** * Backup destination for the TDE wallet backups. */ tdeWalletBackupDestinations: outputs.Database.GetDatabaseDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination[]; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetDatabaseDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ backupDestinationId: string; /** * Destination where TDE Wallet backups are to be placed. */ backupDestinationType: string; } interface GetDatabaseDatabaseEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; /** * Provide the key OCID of a registered Azure key. */ azureEncryptionKeyId: string; /** * Provide the key OCID of a registered GCP key. */ googleCloudProviderEncryptionKeyId: string; /** * Provide the HSM password as you would in RDBMS for External HSM. */ hsmPassword: string; /** * Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. Use 'AZURE' for creating a new database or migrating a database key to Azure. Use 'AWS' for creating a new database or migrating a database key to Aws. Use 'GCP' for creating a new database or migrating a database key to Gcp. */ providerType: string; } interface GetDatabaseDatabaseManagedSoftwareUpdateDetail { /** * If true, database is registered for Oracle Managed Database Software Updates otherwise database is not registered for Oracle Managed Database Software Updates */ isEnrolled: boolean; /** * Provides details about actual Oracle Managed Database Software Updates scheduled time and version. */ maintenanceDetails: outputs.Database.GetDatabaseDatabaseManagedSoftwareUpdateDetailMaintenanceDetail[]; /** * Oracle Managed Database Software Updates schedule will be created based on the provided update preferences */ preferenceDetails: outputs.Database.GetDatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetail[]; } interface GetDatabaseDatabaseManagedSoftwareUpdateDetailMaintenanceDetail { /** * The date and time of the last readiness check. */ timeOfLastReadinessCheck: string; /** * The date and time of when the status was updated. */ timeOfStatusUpdate: string; /** * The date and time of the database was scheduled for update. */ timeScheduled: string; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The managed software update readiness status */ updateReadinessStatus: string; /** * This field will contain actual cause of update readiness state. */ updateReadinessStatusDetails: string; /** * The version of the database was scheduled for update. */ version: string; } interface GetDatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetail { /** * The update should be applied on the database for the selected days of the week. */ daysOfWeeks: string[]; /** * The update should be applied on the database for the selected hour of the day. */ hourOfDay: number; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The update should be applied on the database for the selected version scheme. */ versionSchemeDetails: outputs.Database.GetDatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail[]; } interface GetDatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail { /** * The update should be applied on the database for the selected major version series. The value can be provided as 23.X.X.X then 23 major version series will be considered. */ majorVersion: string; /** * The update should be applied on the database for the selected version scheme. */ source: string; /** * The update should be applied on the database for the selected version preference. *_N represents the LATEST version */ versionPreference: string; } interface GetDatabaseDatabaseManagementConfig { /** * The status of the Database Management service. */ managementStatus: string; /** * The Database Management type. */ managementType: string; } interface GetDatabaseDatabasePatchOption { /** * Skip running datapatch on PDBs in closed state */ shouldSkipClosedPdbs: boolean; /** * Skip running datapatch on database(s) */ shouldSkipDataPatch: boolean; } interface GetDatabaseDatabaseSourceEncryptionKeyLocationDetail { /** * Provide the HSM password as you would in RDBMS for External HSM. */ hsmPassword: string; /** * Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. Use 'AZURE' for creating a new database or migrating a database key to Azure. Use 'AWS' for creating a new database or migrating a database key to Aws. Use 'GCP' for creating a new database or migrating a database key to Gcp. */ providerType: string; } interface GetDatabaseDatabaseStorageSizeDetail { /** * The DATA storage size, in gigabytes, that is applicable for the database. */ dataStorageSizeInGb: number; /** * The RECO storage size, in gigabytes, that is applicable for the database. */ recoStorageSizeInGbs: number; /** * The REDO Log storage size, in gigabytes, that is applicable for the database. */ redoLogStorageSizeInGbs: number; } interface GetDatabaseDbBackupConfig { /** * If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ autoBackupEnabled: boolean; /** * Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.Database.GetDatabaseDbBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ runImmediateFullBackup: boolean; } interface GetDatabaseDbBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ id: string; /** * Indicates whether the backup destination is cross-region or local region. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. */ remoteRegion: string; /** * Backup destination for the TDE wallet backups. */ tdeWalletBackupDestinations: outputs.Database.GetDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination[]; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ backupDestinationId: string; /** * Destination where TDE Wallet backups are to be placed. */ backupDestinationType: string; } interface GetDatabaseMaintenanceRunHistoriesFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistory { /** * The OCID of the current execution window. */ currentExecutionWindow: string; /** * List of database server history details. */ dbServersHistoryDetails: outputs.Database.GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryDbServersHistoryDetail[]; /** * The list of granular maintenance history details. */ granularMaintenanceHistories: outputs.Database.GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryGranularMaintenanceHistory[]; /** * The OCID of the maintenance run. */ id: string; /** * Details of a maintenance run. */ maintenanceRunDetails: outputs.Database.GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryMaintenanceRunDetail[]; } interface GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryDbServersHistoryDetail { /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ dbServerPatchingDetails: outputs.Database.GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryDbServersHistoryDetailDbServerPatchingDetail[]; /** * The user-friendly name for the maintenance run. */ displayName: string; /** * The OCID of the maintenance run. */ id: string; } interface GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryDbServersHistoryDetailDbServerPatchingDetail { /** * Estimated time, in minutes, to patch one database server. */ estimatedPatchDuration: number; /** * The status of the patching operation. */ patchingStatus: string; /** * The time when the patching operation ended. */ timePatchingEnded: string; /** * The time when the patching operation started. */ timePatchingStarted: string; } interface GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryGranularMaintenanceHistory { /** * The list of execution actions for this granular maintenance history. */ executionActions: outputs.Database.GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryGranularMaintenanceHistoryExecutionAction[]; /** * Details of an execution window. */ executionWindows: outputs.Database.GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryGranularMaintenanceHistoryExecutionWindow[]; } interface GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryGranularMaintenanceHistoryExecutionAction { /** * List of action members of this execution action. */ actionMembers: outputs.Database.GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryGranularMaintenanceHistoryExecutionActionActionMember[]; /** * Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` */ actionParams: { [key: string]: string; }; /** * The action type of the execution action being performed */ actionType: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * Description of the maintenance run. */ description: string; /** * The user-friendly name for the maintenance run. */ displayName: string; /** * The estimated time of the execution window in minutes. */ estimatedTimeInMins: number; /** * The priority order of the execution action. */ executionActionOrder: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to. */ executionWindowId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the maintenance run. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current sub-state of the execution window. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. */ lifecycleSubstate: string; /** * The state of the maintenance run history. */ state: string; /** * The date and time the execution window was created. */ timeCreated: string; /** * The last date and time that the execution window was updated. */ timeUpdated: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; } interface GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryGranularMaintenanceHistoryExecutionActionActionMember { /** * The estimated time of the execution window in minutes. */ estimatedTimeInMins: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent resource the execution action belongs to. */ memberId: string; /** * The priority order of the execution action member. */ memberOrder: number; /** * The current status of the execution action member. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, DURATION_EXCEEDED, RESCHEDULED and COMPLETED. enum: * * SCHEDULED * * IN_PROGRESS * * FAILED * * CANCELED * * DURATION_EXCEEDED * * RESCHEDULED * * SUCCEEDED */ status: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; } interface GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryGranularMaintenanceHistoryExecutionWindow { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the new execution window created as part of reschedule for the execution window failure. */ deferredExecutionWindowId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * Description of the maintenance run. */ description: string; /** * The user-friendly name for the maintenance run. */ displayName: string; /** * The estimated time of the execution window in minutes. */ estimatedTimeInMins: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the execution resource the execution window belongs to. */ executionResourceId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the maintenance run. */ id: string; /** * Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. */ isEnforcedDuration: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current sub-state of the execution window. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. */ lifecycleSubstate: string; /** * The state of the maintenance run history. */ state: string; /** * The date and time the execution window was created. */ timeCreated: string; /** * The date and time the maintenance run was completed. */ timeEnded: string; /** * The date and time the maintenance run is scheduled to occur. */ timeScheduled: string; /** * The date and time the maintenance run starts. */ timeStarted: string; /** * The last date and time that the execution window was updated. */ timeUpdated: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; /** * A message that gives a description on how and why the window was created. */ windowDetails: string; /** * Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. */ windowDurationInMins: number; /** * The execution window type. Either "PLANNED" or "UNPLANNED". */ windowType: string; } interface GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryMaintenanceRunDetail { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Extend current custom action timeout between the current database servers during waiting state, from 0 (zero) to 30 minutes. */ currentCustomActionTimeoutInMins: number; /** * The name of the current infrastruture component that is getting patched. */ currentPatchingComponent: string; /** * Determines the amount of time the system will wait before the start of each database server patching operation. Specify a number of minutes, from 15 to 120. */ customActionTimeoutInMins: number; /** * The Autonomous AI Database Software Image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; /** * Description of the maintenance run. */ description: string; /** * The user-friendly name for the maintenance run. */ displayName: string; /** * The estimated start time of the next infrastruture component patching operation. */ estimatedComponentPatchingStartTime: string; /** * The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). */ estimatedPatchingTimes: outputs.Database.GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryMaintenanceRunDetailEstimatedPatchingTime[]; /** * The OCID of the maintenance run. */ id: string; /** * If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. */ isDstFileUpdateEnabled: boolean; /** * If `FALSE`, the maintenance run doesn't support granular maintenance. */ isMaintenanceRunGranular: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * Maintenance sub-type. */ maintenanceSubtype: string; /** * The maintenance type. */ maintenanceType: string; /** * Contain the patch failure count. */ patchFailureCount: number; /** * The unique identifier of the patch. The identifier string includes the patch type, the Oracle AI Database version, and the patch creation date (using the format YYMMDD). For example, the identifier `ru_patch_19.9.0.0_201030` is used for an RU patch for Oracle AI Database 19.9.0.0 that was released October 30, 2020. */ patchId: string; /** * The time when the patching operation ended. */ patchingEndTime: string; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The time when the patching operation started. */ patchingStartTime: string; /** * The status of the patching operation. */ patchingStatus: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance run for the Autonomous Data Guard association's peer container database. */ peerMaintenanceRunId: string; /** * The list of OCIDs for the maintenance runs associated with their Autonomous Data Guard peer container databases. */ peerMaintenanceRunIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. This field is set during maintenance run creation based on infrastructure's maintenance run version preferences. Currently this is only be supported for monthly maintenance runs created via scheduling plans. */ referenceResourceIdForImageUpdates: string; /** * The state of the maintenance run history. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The target software version for the database server patching operation. */ targetDbServerVersion: string; /** * The target resource ID. */ targetResourceId: string; /** * The type of the target resource. */ targetResourceType: string; /** * The target Cell version that is to be patched to. */ targetStorageServerVersion: string; /** * The date and time the maintenance run was completed. */ timeEnded: string; /** * The date and time the maintenance run is scheduled to occur. */ timeScheduled: string; /** * The date and time the maintenance run starts. */ timeStarted: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; /** * A list of key-value pairs where the key will contain the window type and value contains all the windowDetails of that window type. */ windowTypeDescriptions: outputs.Database.GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryMaintenanceRunDetailWindowTypeDescription[]; } interface GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryMaintenanceRunDetailEstimatedPatchingTime { /** * The estimated time required in minutes for database server patching. */ estimatedDbServerPatchingTime: number; /** * The estimated time required in minutes for network switch patching. */ estimatedNetworkSwitchesPatchingTime: number; /** * The estimated time required in minutes for storage server patching. */ estimatedStorageServerPatchingTime: number; /** * The estimated total time required in minutes for all patching operations. */ totalEstimatedPatchingTime: number; } interface GetDatabaseMaintenanceRunHistoriesMaintenanceRunHistoryMaintenanceRunDetailWindowTypeDescription { /** * A list of window detail messages from all the active execution windows based on the window type. */ messages: string[]; /** * The execution window type. Either "PLANNED" or "UNPLANNED". */ windowType: string; } interface GetDatabaseMaintenanceRunHistoryDbServersHistoryDetail { /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ dbServerPatchingDetails: outputs.Database.GetDatabaseMaintenanceRunHistoryDbServersHistoryDetailDbServerPatchingDetail[]; /** * The user-friendly name for the maintenance run. */ displayName: string; /** * The OCID of the maintenance run. */ id: string; } interface GetDatabaseMaintenanceRunHistoryDbServersHistoryDetailDbServerPatchingDetail { /** * Estimated time, in minutes, to patch one database server. */ estimatedPatchDuration: number; /** * The status of the patching operation. */ patchingStatus: string; /** * The time when the patching operation ended. */ timePatchingEnded: string; /** * The time when the patching operation started. */ timePatchingStarted: string; } interface GetDatabaseMaintenanceRunHistoryGranularMaintenanceHistory { /** * The list of execution actions for this granular maintenance history. */ executionActions: outputs.Database.GetDatabaseMaintenanceRunHistoryGranularMaintenanceHistoryExecutionAction[]; /** * Details of an execution window. */ executionWindows: outputs.Database.GetDatabaseMaintenanceRunHistoryGranularMaintenanceHistoryExecutionWindow[]; } interface GetDatabaseMaintenanceRunHistoryGranularMaintenanceHistoryExecutionAction { /** * List of action members of this execution action. */ actionMembers: outputs.Database.GetDatabaseMaintenanceRunHistoryGranularMaintenanceHistoryExecutionActionActionMember[]; /** * Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` */ actionParams: { [key: string]: string; }; /** * The action type of the execution action being performed */ actionType: string; /** * The OCID of the compartment. */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * Description of the maintenance run. */ description: string; /** * The user-friendly name for the maintenance run. */ displayName: string; /** * The estimated time of the execution window in minutes. */ estimatedTimeInMins: number; /** * The priority order of the execution action. */ executionActionOrder: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the execution window resource the execution action belongs to. */ executionWindowId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the maintenance run. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current sub-state of the execution window. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. */ lifecycleSubstate: string; /** * The current state of the maintenance run. For Autonomous AI Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED. */ state: string; /** * The date and time the execution window was created. */ timeCreated: string; /** * The last date and time that the execution window was updated. */ timeUpdated: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; } interface GetDatabaseMaintenanceRunHistoryGranularMaintenanceHistoryExecutionActionActionMember { /** * The estimated time of the execution window in minutes. */ estimatedTimeInMins: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent resource the execution action belongs to. */ memberId: string; /** * The priority order of the execution action member. */ memberOrder: number; /** * The current status of the execution action member. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, DURATION_EXCEEDED, RESCHEDULED and COMPLETED. enum: * * SCHEDULED * * IN_PROGRESS * * FAILED * * CANCELED * * DURATION_EXCEEDED * * RESCHEDULED * * SUCCEEDED */ status: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; } interface GetDatabaseMaintenanceRunHistoryGranularMaintenanceHistoryExecutionWindow { /** * The OCID of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the new execution window created as part of reschedule for the execution window failure. */ deferredExecutionWindowId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * Description of the maintenance run. */ description: string; /** * The user-friendly name for the maintenance run. */ displayName: string; /** * The estimated time of the execution window in minutes. */ estimatedTimeInMins: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the execution resource the execution window belongs to. */ executionResourceId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the maintenance run. */ id: string; /** * Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. */ isEnforcedDuration: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current sub-state of the execution window. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. */ lifecycleSubstate: string; /** * The current state of the maintenance run. For Autonomous AI Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED. */ state: string; /** * The date and time the execution window was created. */ timeCreated: string; /** * The date and time the maintenance run was completed. */ timeEnded: string; /** * The date and time the maintenance run is scheduled to occur. */ timeScheduled: string; /** * The date and time the maintenance run starts. */ timeStarted: string; /** * The last date and time that the execution window was updated. */ timeUpdated: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; /** * A message that gives a description on how and why the window was created. */ windowDetails: string; /** * Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. */ windowDurationInMins: number; /** * The execution window type. Either "PLANNED" or "UNPLANNED". */ windowType: string; } interface GetDatabaseMaintenanceRunHistoryMaintenanceRunDetail { /** * The OCID of the compartment. */ compartmentId: string; /** * Extend current custom action timeout between the current database servers during waiting state, from 0 (zero) to 30 minutes. */ currentCustomActionTimeoutInMins: number; /** * The name of the current infrastruture component that is getting patched. */ currentPatchingComponent: string; /** * Determines the amount of time the system will wait before the start of each database server patching operation. Specify a number of minutes, from 15 to 120. */ customActionTimeoutInMins: number; /** * The Autonomous AI Database Software Image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; /** * Description of the maintenance run. */ description: string; /** * The user-friendly name for the maintenance run. */ displayName: string; /** * The estimated start time of the next infrastruture component patching operation. */ estimatedComponentPatchingStartTime: string; /** * The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). */ estimatedPatchingTimes: outputs.Database.GetDatabaseMaintenanceRunHistoryMaintenanceRunDetailEstimatedPatchingTime[]; /** * The OCID of the maintenance run. */ id: string; /** * If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. */ isDstFileUpdateEnabled: boolean; /** * If `FALSE`, the maintenance run doesn't support granular maintenance. */ isMaintenanceRunGranular: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * Maintenance sub-type. */ maintenanceSubtype: string; /** * Maintenance type. */ maintenanceType: string; /** * Contain the patch failure count. */ patchFailureCount: number; /** * The unique identifier of the patch. The identifier string includes the patch type, the Oracle AI Database version, and the patch creation date (using the format YYMMDD). For example, the identifier `ru_patch_19.9.0.0_201030` is used for an RU patch for Oracle AI Database 19.9.0.0 that was released October 30, 2020. */ patchId: string; /** * The time when the patching operation ended. */ patchingEndTime: string; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The time when the patching operation started. */ patchingStartTime: string; /** * The status of the patching operation. */ patchingStatus: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance run for the Autonomous Data Guard association's peer container database. */ peerMaintenanceRunId: string; /** * The list of OCIDs for the maintenance runs associated with their Autonomous Data Guard peer container databases. */ peerMaintenanceRunIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. This field is set during maintenance run creation based on infrastructure's maintenance run version preferences. Currently this is only be supported for monthly maintenance runs created via scheduling plans. */ referenceResourceIdForImageUpdates: string; /** * The current state of the maintenance run. For Autonomous AI Database Serverless instances, valid states are IN_PROGRESS, SUCCEEDED, and FAILED. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The target software version for the database server patching operation. */ targetDbServerVersion: string; /** * The ID of the target resource on which the maintenance run occurs. */ targetResourceId: string; /** * The type of the target resource on which the maintenance run occurs. */ targetResourceType: string; /** * The target Cell version that is to be patched to. */ targetStorageServerVersion: string; /** * The date and time the maintenance run was completed. */ timeEnded: string; /** * The date and time the maintenance run is scheduled to occur. */ timeScheduled: string; /** * The date and time the maintenance run starts. */ timeStarted: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; /** * A list of key-value pairs where the key will contain the window type and value contains all the windowDetails of that window type. */ windowTypeDescriptions: outputs.Database.GetDatabaseMaintenanceRunHistoryMaintenanceRunDetailWindowTypeDescription[]; } interface GetDatabaseMaintenanceRunHistoryMaintenanceRunDetailEstimatedPatchingTime { /** * The estimated time required in minutes for database server patching. */ estimatedDbServerPatchingTime: number; /** * The estimated time required in minutes for network switch patching. */ estimatedNetworkSwitchesPatchingTime: number; /** * The estimated time required in minutes for storage server patching. */ estimatedStorageServerPatchingTime: number; /** * The estimated total time required in minutes for all patching operations. */ totalEstimatedPatchingTime: number; } interface GetDatabaseMaintenanceRunHistoryMaintenanceRunDetailWindowTypeDescription { /** * A list of window detail messages from all the active execution windows based on the window type. */ messages: string[]; /** * The execution window type. Either "PLANNED" or "UNPLANNED". */ windowType: string; } interface GetDatabaseManagedSoftwareUpdateDetail { /** * If true, database is registered for Oracle Managed Database Software Updates otherwise database is not registered for Oracle Managed Database Software Updates */ isEnrolled: boolean; /** * Provides details about actual Oracle Managed Database Software Updates scheduled time and version. */ maintenanceDetails: outputs.Database.GetDatabaseManagedSoftwareUpdateDetailMaintenanceDetail[]; /** * Oracle Managed Database Software Updates schedule will be created based on the provided update preferences */ preferenceDetails: outputs.Database.GetDatabaseManagedSoftwareUpdateDetailPreferenceDetail[]; } interface GetDatabaseManagedSoftwareUpdateDetailMaintenanceDetail { /** * The date and time of the last readiness check. */ timeOfLastReadinessCheck: string; /** * The date and time of when the status was updated. */ timeOfStatusUpdate: string; /** * The date and time of the database was scheduled for update. */ timeScheduled: string; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The managed software update readiness status */ updateReadinessStatus: string; /** * This field will contain actual cause of update readiness state. */ updateReadinessStatusDetails: string; /** * The version of the database was scheduled for update. */ version: string; } interface GetDatabaseManagedSoftwareUpdateDetailPreferenceDetail { /** * The update should be applied on the database for the selected days of the week. */ daysOfWeeks: string[]; /** * The update should be applied on the database for the selected hour of the day. */ hourOfDay: number; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The update should be applied on the database for the selected version scheme. */ versionSchemeDetails: outputs.Database.GetDatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail[]; } interface GetDatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail { /** * The update should be applied on the database for the selected major version series. The value can be provided as 23.X.X.X then 23 major version series will be considered. */ majorVersion: string; /** * The update should be applied on the database for the selected version scheme. */ source: string; /** * The update should be applied on the database for the selected version preference. *_N represents the LATEST version */ versionPreference: string; } interface GetDatabasePdbConversionHistoryEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabasePdbConversionHistoryEntriesPdbConversionHistoryEntry { /** * The operations used to convert a non-container database to a pluggable database. * * Use `PRECHECK` to run a pre-check operation on non-container database prior to converting it into a pluggable database. * * Use `CONVERT` to convert a non-container database into a pluggable database. * * Use `SYNC` if the non-container database was manually converted into a pluggable database using the dbcli command-line utility. Databases may need to be converted manually if the CONVERT action fails when converting a non-container database using the API. * * Use `SYNC_ROLLBACK` if the conversion of a non-container database into a pluggable database was manually rolled back using the dbcli command line utility. Conversions may need to be manually rolled back if the CONVERT action fails when converting a non-container database using the API. */ action: string; /** * Additional container database parameter. */ additionalCdbParams: string; /** * The database name. The name must begin with an alphabetic character and can contain a maximum of 8 alphanumeric characters. Special characters are not permitted. The database name must be unique in the tenancy. */ cdbName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database conversion history. */ id: string; /** * Additional information about the current lifecycle state for the conversion operation. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ sourceDatabaseId: string; /** * A filter to return only the pluggable database conversion history entries that match the specified lifecycle state. For example, you can use this filter to return only entries in the "failed" lifecycle state. */ state: string; /** * The target container database of the pluggable database created by the database conversion operation. Currently, the database conversion operation only supports creating the pluggable database in a new container database. * * Use `NEW_DATABASE` to specify that the pluggable database be created within a new container database in the same database home. */ target: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ targetDatabaseId: string; /** * The date and time when the database conversion operation ended. */ timeEnded: string; /** * The date and time when the database conversion operation started. */ timeStarted: string; } interface GetDatabaseSoftwareImagesDatabaseSoftwareImage { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * List of one-off patches for Database Homes. */ databaseSoftwareImageIncludedPatches: string[]; /** * List of one-off patches for Database Homes. */ databaseSoftwareImageOneOffPatches: string[]; /** * The database version with which the database software image is to be built. */ databaseVersion: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database software image. */ id: string; /** * A filter to return only resources that match the given image shape family exactly. */ imageShapeFamily: string; /** * A filter to return only resources that match the given image type exactly. */ imageType: string; /** * The patches included in the image and the version of the image. */ includedPatchesSummary: string; /** * If provided, filters the results to the set of database versions which are supported for Upgrade. */ isUpgradeSupported: boolean; /** * Detailed message for the lifecycle state. */ lifecycleDetails: string; /** * The output from the OPatch lsInventory command, which is passed as a string. */ lsInventory: string; /** * The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/DbVersionSummary/ListDbVersions) operation. */ patchSet: string; sourceDbHomeId: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the database software image was created. */ timeCreated: string; } interface GetDatabaseSoftwareImagesFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabaseStorageSizeDetail { /** * The DATA storage size, in gigabytes, that is applicable for the database. */ dataStorageSizeInGb: number; /** * The RECO storage size, in gigabytes, that is applicable for the database. */ recoStorageSizeInGbs: number; /** * The REDO Log storage size, in gigabytes, that is applicable for the database. */ redoLogStorageSizeInGbs: number; } interface GetDatabaseUpgradeHistoryEntriesDatabaseUpgradeHistoryEntry { /** * The database upgrade action. */ action: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database upgrade history. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * Additional upgrade options supported by DBUA(Database Upgrade Assistant). Example: "-upgradeTimezone false -keepEvents" */ options: string; /** * The source of the Oracle Database software to be used for the upgrade. * * Use `DB_VERSION` to specify a generally-available Oracle Database software version to upgrade the database. * * Use `DB_SOFTWARE_IMAGE` to specify a [database software image](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/databasesoftwareimage.htm) to upgrade the database. */ source: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ sourceDbHomeId: string; /** * A filter to return only upgradeHistoryEntries that match the given lifecycle state exactly. */ state: string; /** * the database software image used for upgrading database. */ targetDatabaseSoftwareImageId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ targetDbHomeId: string; /** * A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. */ targetDbVersion: string; /** * The date and time when the database upgrade ended. */ timeEnded: string; /** * The date and time when the database upgrade started. */ timeStarted: string; } interface GetDatabaseUpgradeHistoryEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabasesDatabase { actionTrigger: number; /** * The character set for the database. */ characterSet: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The Connection strings used to connect to the Oracle Database. */ connectionStrings: outputs.Database.GetDatabasesDatabaseConnectionString[]; dataGuardAction: string; /** * Details of Data Guard setup that the given database is part of. Also includes information about databases part of this Data Guard group and properties for their Data Guard configuration. */ dataGuardGroups: outputs.Database.GetDatabasesDatabaseDataGuardGroup[]; /** * The configuration of the Database Management service. */ databaseManagementConfigs: outputs.Database.GetDatabasesDatabaseDatabaseManagementConfig[]; /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; databases: outputs.Database.GetDatabasesDatabaseDatabase[]; /** * Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). */ dbBackupConfigs: outputs.Database.GetDatabasesDatabaseDbBackupConfig[]; /** * A Database Home [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). *Note: Either `dbHomeId` or `systemId` is required to make the LIST API call. */ dbHomeId: string; /** * A filter to return only resources that match the entire database name given. The match is not case sensitive. */ dbName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ dbSystemId: string; /** * A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. */ dbUniqueName: string; dbVersion: string; /** * **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. */ dbWorkload: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ id: string; /** * True if the database is a container database. */ isCdb: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault. */ keyStoreId: string; /** * The wallet name for Oracle Key Vault. */ keyStoreWalletName: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; kmsKeyMigration: boolean; kmsKeyRotation: number; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The duration when the latest database backup created. */ lastBackupDurationInSeconds: number; /** * The date and time when the latest database backup was created. */ lastBackupTimestamp: string; /** * The date and time when the latest database backup failed. */ lastFailedBackupTimestamp: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The database registered for Oracle Managed Database Software Updates. */ managedSoftwareUpdateDetails: outputs.Database.GetDatabasesDatabaseManagedSoftwareUpdateDetail[]; /** * The national character set for the database. */ ncharacterSet: string; /** * The patch version of the database. */ patchVersion: string; /** * The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. */ pdbName: string; /** * Specifies a prefix for the `Oracle SID` of the database to be created. */ sidPrefix: string; /** * The update should be applied on the database for the selected version scheme. */ source: string; /** * Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) */ sourceDatabasePointInTimeRecoveryTimestamp: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The database storage size details. This database option is supported for the Exadata VM cluster on Exascale Infrastructure. */ storageSizeDetails: outputs.Database.GetDatabasesDatabaseStorageSizeDetail[]; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the database was created. */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster. */ vmClusterId: string; } interface GetDatabasesDatabaseConnectionString { /** * All connection strings to use to connect to the Database. */ allConnectionStrings: { [key: string]: string; }; /** * Host name based CDB Connection String. */ cdbDefault: string; /** * IP based CDB Connection String. */ cdbIpDefault: string; } interface GetDatabasesDatabaseDataGuardGroup { /** * Specifies readiness of Managed Automatic failover. */ managedAutoFailOverReadiness: string; /** * List of Data Guard members, representing each database that is part of Data Guard. */ members: outputs.Database.GetDatabasesDatabaseDataGuardGroupMember[]; /** * The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; } interface GetDatabasesDatabaseDataGuardGroupMember { /** * The lag time between updates to the primary database and application of the redo data on the standby database, as computed by the reporting database. Example: `1 second` */ applyLag: string; /** * The rate at which redo logs are synced between the associated databases. Example: `102.96 MByte/s` */ applyRate: string; /** * The Data loss exposure is the redo transport lag between the primary and standby databases. Example: `2 seconds` */ dataLossExposure: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database. */ databaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ dbSystemId: string; /** * The failover readiness status of the Data Guard member. HEALTHY_AND_NOT_ROLECHANGE_TARGET - Indicates that the respective standby member is healthy but not currently designated to take failover, when auto failover is enabled. */ failoverReadiness: string; /** * The message explaining failover readiness status. Example: `This standby database is not failover ready.` */ failoverReadinessMessage: string; /** * Filter the databases by failoverTargets param. */ failoverTargets: string[]; /** * True if active Data Guard is enabled. */ isActiveDataGuardEnabled: boolean; /** * Filter the databases by managed auto failover param. */ managedAutoFailover: string; /** * The role of the reporting database in this Data Guard association. */ role: string; /** * The switchover readiness status of the Data Guard member. * * HEALTHY_AND_NOT_ROLECHANGE_TARGET - Indicates that the respective standby member is healthy but not currently designated to take switchover, when auto failover is enabled. */ switchoverReadiness: string; /** * The message explaining switchover readiness status. Example: `Address failed checks to avoid extended downtime.` */ switchoverReadinessMessage: string; /** * The date and time when the last successful Data Guard refresh occurred. */ timeUpdated: string; /** * The rate at which redo logs are transported between the associated databases. Example: `1 second` */ transportLag: string; /** * The date and time when last redo transport has been done. */ transportLagRefresh: string; /** * The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * * MAXIMUM_PERFORMANCE - ASYNC * * MAXIMUM_PROTECTION - SYNC */ transportType: string; } interface GetDatabasesDatabaseDatabase { adminPassword: string; autoFailoverConfigurations: outputs.Database.GetDatabasesDatabaseDatabaseAutoFailoverConfiguration[]; backupId: string; backupTdePassword: string; /** * The character set for the database. */ characterSet: string; databaseAdminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database. */ databaseId: string; /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; /** * Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). */ dbBackupConfigs: outputs.Database.GetDatabasesDatabaseDatabaseDbBackupConfig[]; /** * A filter to return only resources that match the entire database name given. The match is not case sensitive. */ dbName: string; /** * A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed. */ dbUniqueName: string; /** * **Deprecated.** The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored. */ dbWorkload: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * Types of providers supported for managing database encryption keys */ encryptionKeyLocationDetails: outputs.Database.GetDatabasesDatabaseDatabaseEncryptionKeyLocationDetail[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * True if active Data Guard is enabled. */ isActiveDataGuardEnabled: boolean; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * The database registered for Oracle Managed Database Software Updates. */ managedSoftwareUpdateDetails: outputs.Database.GetDatabasesDatabaseDatabaseManagedSoftwareUpdateDetail[]; /** * The national character set for the database. */ ncharacterSet: string; patchOptions: outputs.Database.GetDatabasesDatabaseDatabasePatchOption[]; /** * The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name. */ pdbName: string; pluggableDatabases: string[]; /** * The protection mode of this Data Guard. For more information, see [Oracle Data Guard Protection Modes](http://docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. */ protectionMode: string; recoveryApplianceVpcPassword: string; /** * Specifies a prefix for the `Oracle SID` of the database to be created. */ sidPrefix: string; sourceDatabaseId: string; sourceEncryptionKeyLocationDetails: outputs.Database.GetDatabasesDatabaseDatabaseSourceEncryptionKeyLocationDetail[]; sourceTdeWalletPassword: string; /** * The database storage size details. This database option is supported for the Exadata VM cluster on Exascale Infrastructure. */ storageSizeDetails: outputs.Database.GetDatabasesDatabaseDatabaseStorageSizeDetail[]; tdeWalletPassword: string; timeStampForPointInTimeRecovery: string; /** * The redo transport type to use for this Data Guard association. Valid values depend on the specified `protectionMode`: * * MAXIMUM_AVAILABILITY - SYNC or FASTSYNC * * MAXIMUM_PERFORMANCE - ASYNC * * MAXIMUM_PROTECTION - SYNC */ transportType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster. */ vmClusterId: string; } interface GetDatabasesDatabaseDatabaseAutoFailoverConfiguration { /** * Filter the databases by failoverTargets param. */ failoverTargets: string[]; /** * Filter the databases by managed auto failover param. */ managedAutoFailover: string; } interface GetDatabasesDatabaseDatabaseDbBackupConfig { /** * If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ autoBackupEnabled: boolean; /** * Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.Database.GetDatabasesDatabaseDatabaseDbBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ runImmediateFullBackup: boolean; } interface GetDatabasesDatabaseDatabaseDbBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ id: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Backup destination for the TDE wallet backups. */ tdeWalletBackupDestinations: outputs.Database.GetDatabasesDatabaseDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination[]; /** * Type of the database backup destination. */ type: string; vpcPassword: string; vpcUser: string; } interface GetDatabasesDatabaseDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ backupDestinationId: string; /** * Destination where TDE Wallet backups are to be placed. */ backupDestinationType: string; } interface GetDatabasesDatabaseDatabaseEncryptionKeyLocationDetail { /** * Provide the key OCID of a registered AWS key. */ awsEncryptionKeyId: string; /** * Provide the key OCID of a registered Azure key. */ azureEncryptionKeyId: string; /** * Provide the key OCID of a registered GCP key. */ googleCloudProviderEncryptionKeyId: string; /** * Provide the HSM password as you would in RDBMS for External HSM. */ hsmPassword: string; /** * Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. Use 'AZURE' for creating a new database or migrating a database key to Azure. Use 'AWS' for creating a new database or migrating a database key to Aws. Use 'GCP' for creating a new database or migrating a database key to Gcp. */ providerType: string; } interface GetDatabasesDatabaseDatabaseManagedSoftwareUpdateDetail { /** * If true, database is registered for Oracle Managed Database Software Updates otherwise database is not registered for Oracle Managed Database Software Updates */ isEnrolled: boolean; /** * Provides details about actual Oracle Managed Database Software Updates scheduled time and version. */ maintenanceDetails: outputs.Database.GetDatabasesDatabaseDatabaseManagedSoftwareUpdateDetailMaintenanceDetail[]; /** * Oracle Managed Database Software Updates schedule will be created based on the provided update preferences */ preferenceDetails: outputs.Database.GetDatabasesDatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetail[]; } interface GetDatabasesDatabaseDatabaseManagedSoftwareUpdateDetailMaintenanceDetail { /** * The date and time of the last readiness check. */ timeOfLastReadinessCheck: string; /** * The date and time of when the status was updated. */ timeOfStatusUpdate: string; /** * The date and time of the database was scheduled for update. */ timeScheduled: string; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The managed software update readiness status */ updateReadinessStatus: string; /** * This field will contain actual cause of update readiness state. */ updateReadinessStatusDetails: string; /** * The version of the database was scheduled for update. */ version: string; } interface GetDatabasesDatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetail { /** * The update should be applied on the database for the selected days of the week. */ daysOfWeeks: string[]; /** * The update should be applied on the database for the selected hour of the day. */ hourOfDay: number; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The update should be applied on the database for the selected version scheme. */ versionSchemeDetails: outputs.Database.GetDatabasesDatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail[]; } interface GetDatabasesDatabaseDatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail { /** * The update should be applied on the database for the selected major version series. The value can be provided as 23.X.X.X then 23 major version series will be considered. */ majorVersion: string; /** * The update should be applied on the database for the selected version scheme. */ source: string; /** * The update should be applied on the database for the selected version preference. *_N represents the LATEST version */ versionPreference: string; } interface GetDatabasesDatabaseDatabaseManagementConfig { /** * The status of the Database Management service. */ managementStatus: string; /** * The Database Management type. */ managementType: string; } interface GetDatabasesDatabaseDatabasePatchOption { shouldSkipClosedPdbs: boolean; shouldSkipDataPatch: boolean; } interface GetDatabasesDatabaseDatabaseSourceEncryptionKeyLocationDetail { /** * Provide the HSM password as you would in RDBMS for External HSM. */ hsmPassword: string; /** * Use 'EXTERNAL' for creating a new database or migrating a database key to an External HSM. Use 'AZURE' for creating a new database or migrating a database key to Azure. Use 'AWS' for creating a new database or migrating a database key to Aws. Use 'GCP' for creating a new database or migrating a database key to Gcp. */ providerType: string; } interface GetDatabasesDatabaseDatabaseStorageSizeDetail { /** * The DATA storage size, in gigabytes, that is applicable for the database. */ dataStorageSizeInGb: number; /** * The RECO storage size, in gigabytes, that is applicable for the database. */ recoStorageSizeInGbs: number; /** * The REDO Log storage size, in gigabytes, that is applicable for the database. */ redoLogStorageSizeInGbs: number; } interface GetDatabasesDatabaseDbBackupConfig { /** * If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ autoBackupEnabled: boolean; /** * Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - DELETE_IMMEDIATELY option keep the backup for predefined time i.e 72 hours and then delete permanently... - DELETE_AFTER_RETENTION_PERIOD will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.Database.GetDatabasesDatabaseDbBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ runImmediateFullBackup: boolean; } interface GetDatabasesDatabaseDbBackupConfigBackupDestinationDetail { /** * Defines the automatic and manual backup retention policy for the Autonomous Database termination. The retention policy set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. Options are 'RETAIN_PER_RETENTION_WINDOW' or 'RETAIN_FOR_72_HOURS'.The default value is 'RETAIN_FOR_72_HOURS'. */ backupRetentionPolicyOnTerminate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ id: string; /** * Indicates whether the backup destination is cross-region or local. */ isRemote: boolean; /** * Indicates if backup retention is locked for all the database backups in the Autonomous Container Database (ACD). The retention window cannot be decreased if the backup retention lock is enabled. Once applied on the Autonomous Container Database, the retention lock cannot be removed, or the retention period cannot be decreased after a 14-day period. If the backup is a Long Term Backup and retention lock is enabled, the backup cannot be deleted and must expire. The retention lock set on the Autonomous Container Database is not applicable for cross region remote backups and backups hosted on recovery Appliance backup destination. */ isRetentionLockEnabled: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Backup destination for the TDE wallet backups. */ tdeWalletBackupDestinations: outputs.Database.GetDatabasesDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination[]; /** * Type of the database backup destination. */ type: string; vpcPassword: string; vpcUser: string; } interface GetDatabasesDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ backupDestinationId: string; /** * Destination where TDE Wallet backups are to be placed. */ backupDestinationType: string; } interface GetDatabasesDatabaseManagedSoftwareUpdateDetail { /** * If true, database is registered for Oracle Managed Database Software Updates otherwise database is not registered for Oracle Managed Database Software Updates */ isEnrolled: boolean; /** * Provides details about actual Oracle Managed Database Software Updates scheduled time and version. */ maintenanceDetails: outputs.Database.GetDatabasesDatabaseManagedSoftwareUpdateDetailMaintenanceDetail[]; /** * Oracle Managed Database Software Updates schedule will be created based on the provided update preferences */ preferenceDetails: outputs.Database.GetDatabasesDatabaseManagedSoftwareUpdateDetailPreferenceDetail[]; } interface GetDatabasesDatabaseManagedSoftwareUpdateDetailMaintenanceDetail { /** * The date and time of the last readiness check. */ timeOfLastReadinessCheck: string; /** * The date and time of when the status was updated. */ timeOfStatusUpdate: string; /** * The date and time of the database was scheduled for update. */ timeScheduled: string; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The managed software update readiness status */ updateReadinessStatus: string; /** * This field will contain actual cause of update readiness state. */ updateReadinessStatusDetails: string; /** * The version of the database was scheduled for update. */ version: string; } interface GetDatabasesDatabaseManagedSoftwareUpdateDetailPreferenceDetail { /** * The update should be applied on the database for the selected days of the week. */ daysOfWeeks: string[]; /** * The update should be applied on the database for the selected hour of the day. */ hourOfDay: number; /** * Oracle Managed Database Software update method, either "ROLLING" or "NONROLLING". Default value is ROLLING. *IMPORTANT*: Non-rolling Database Software update update involves system down time. */ updateMode: string; /** * The update should be applied on the database for the selected version scheme. */ versionSchemeDetails: outputs.Database.GetDatabasesDatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail[]; } interface GetDatabasesDatabaseManagedSoftwareUpdateDetailPreferenceDetailVersionSchemeDetail { /** * The update should be applied on the database for the selected major version series. The value can be provided as 23.X.X.X then 23 major version series will be considered. */ majorVersion: string; /** * The update should be applied on the database for the selected version scheme. */ source: string; /** * The update should be applied on the database for the selected version preference. *_N represents the LATEST version */ versionPreference: string; } interface GetDatabasesDatabaseStorageSizeDetail { /** * The DATA storage size, in gigabytes, that is applicable for the database. */ dataStorageSizeInGb: number; /** * The RECO storage size, in gigabytes, that is applicable for the database. */ recoStorageSizeInGbs: number; /** * The REDO Log storage size, in gigabytes, that is applicable for the database. */ redoLogStorageSizeInGbs: number; } interface GetDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbConnectionBundleAssociatedResourceDetail { /** * The OCIDs of the associated resources. */ resourceIds: string[]; } interface GetDbConnectionBundlesDbConnectionBundle { /** * Details about the resources associated with the connection bundle. */ associatedResourceDetails: outputs.Database.GetDbConnectionBundlesDbConnectionBundleAssociatedResourceDetail[]; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * A filter that returns only resources that match the specified database connection bundle type. */ dbConnectionBundleType: string; /** * 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/Content/General/Concepts/resourcetags.htm). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * 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/Content/General/Concepts/resourcetags.htm). */ freeformTags: { [key: string]: string; }; /** * The OCID of the database connection bundle. */ id: string; /** * True for the default, service-created Database Connection Bundle. */ isProtected: boolean; /** * A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * 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/Content/General/Concepts/resourcetags.htm). */ systemTags: { [key: string]: string; }; /** * The time the database connection bundle was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the database connection bundle was last refreshed. An RFC3339 formatted datetime string. */ timeLastRefreshed: string; /** * The time the database connection bundle was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetDbConnectionBundlesDbConnectionBundleAssociatedResourceDetail { /** * The OCIDs of the associated resources. */ resourceIds: string[]; } interface GetDbConnectionBundlesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbHomeDatabase { adminPassword: string; backupId: string; backupTdePassword: string; characterSet: string; connectionStrings: outputs.Database.GetDbHomeDatabaseConnectionString[]; databaseId: string; /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; dbBackupConfigs: outputs.Database.GetDbHomeDatabaseDbBackupConfig[]; dbName: string; dbUniqueName: string; dbWorkload: string; /** * 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). */ definedTags: { [key: string]: string; }; encryptionKeyLocationDetails: outputs.Database.GetDbHomeDatabaseEncryptionKeyLocationDetail[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ id: string; keyStoreId: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; kmsKeyVersionId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; ncharacterSet: string; /** * List of one-off patches for Database Homes. */ oneOffPatches: string[]; pdbName: string; pluggableDatabases: string[]; recoveryApplianceVpcPassword: string; sidPrefix: string; /** * The current state of the Database Home. */ state: string; storageSizeDetails: outputs.Database.GetDbHomeDatabaseStorageSizeDetail[]; tdeWalletPassword: string; /** * The date and time the Database Home was created. */ timeCreated: string; timeStampForPointInTimeRecovery: string; vaultId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster. */ vmClusterId: string; } interface GetDbHomeDatabaseConnectionString { allConnectionStrings: { [key: string]: string; }; cdbDefault: string; cdbIpDefault: string; } interface GetDbHomeDatabaseDbBackupConfig { autoBackupEnabled: boolean; autoBackupWindow: string; autoFullBackupDay: string; autoFullBackupWindow: string; backupDeletionPolicy: string; backupDestinationDetails: outputs.Database.GetDbHomeDatabaseDbBackupConfigBackupDestinationDetail[]; recoveryWindowInDays: number; runImmediateFullBackup: boolean; } interface GetDbHomeDatabaseDbBackupConfigBackupDestinationDetail { backupRetentionPolicyOnTerminate: string; dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ id: string; isRemote: boolean; isRetentionLockEnabled: boolean; remoteRegion: string; tdeWalletBackupDestinations: outputs.Database.GetDbHomeDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination[]; type: string; vpcPassword: string; vpcUser: string; } interface GetDbHomeDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination { backupDestinationId: string; backupDestinationType: string; } interface GetDbHomeDatabaseEncryptionKeyLocationDetail { awsEncryptionKeyId: string; azureEncryptionKeyId: string; googleCloudProviderEncryptionKeyId: string; hsmPassword: string; providerType: string; } interface GetDbHomeDatabaseStorageSizeDetail { dataStorageSizeInGb: number; recoStorageSizeInGbs: number; redoLogStorageSizeInGbs: number; } interface GetDbHomePatchHistoryEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbHomePatchHistoryEntriesPatchHistoryEntry { /** * The action being performed or was completed. */ action: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the patch history entry. */ id: string; /** * A descriptive text associated with the lifecycleState. Typically contains additional displayable text. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the patch. */ patchId: string; /** * The type of Patch operation. */ patchType: string; /** * The current state of the action. */ state: string; /** * The date and time when the patch action completed */ timeEnded: string; /** * The date and time when the patch action started. */ timeStarted: string; } interface GetDbHomePatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbHomePatchesPatch { /** * Actions that can possibly be performed using this patch. */ availableActions: string[]; /** * The text describing this patch package. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the patch. */ id: string; /** * Action that is currently being performed or was completed last. */ lastAction: string; /** * A descriptive text associated with the lifecycleState. Typically can contain additional displayable text. */ lifecycleDetails: string; /** * The current state of the patch as a result of lastAction. */ state: string; /** * The date and time that the patch was released. */ timeReleased: string; /** * The version of this patch package. */ version: string; } interface GetDbHomesDbHome { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; databases: outputs.Database.GetDbHomesDbHomeDatabase[]; dbHomeId: string; /** * The location of the Oracle Database Home. */ dbHomeLocation: string; /** * The DB system [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). If provided, filters the results to the set of database versions which are supported for the DB system. */ dbSystemId: string; /** * A filter to return only DB Homes that match the specified dbVersion. */ dbVersion: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; enableDatabaseDelete: boolean; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Represents database home will be managed by oracle or customer */ homeType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ id: string; isDesupportedVersion: boolean; /** * Indicates whether unified autiding is enabled or not. */ isUnifiedAuditingEnabled: boolean; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; kmsKeyVersionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation is started. */ lastPatchHistoryEntryId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; source: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the Database Home was created. */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster. */ vmClusterId: string; } interface GetDbHomesDbHomeDatabase { adminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment. */ backupId: string; backupTdePassword: string; characterSet: string; connectionStrings: outputs.Database.GetDbHomesDbHomeDatabaseConnectionString[]; databaseId: string; /** * The database software image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; dbBackupConfigs: outputs.Database.GetDbHomesDbHomeDatabaseDbBackupConfig[]; dbName: string; dbUniqueName: string; dbWorkload: string; /** * 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). */ definedTags: { [key: string]: string; }; encryptionKeyLocationDetails: outputs.Database.GetDbHomesDbHomeDatabaseEncryptionKeyLocationDetail[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ id: string; keyStoreId: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; kmsKeyVersionId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; ncharacterSet: string; /** * List of one-off patches for Database Homes. */ oneOffPatches: string[]; pdbName: string; pluggableDatabases: string[]; recoveryApplianceVpcPassword: string; sidPrefix: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; storageSizeDetails: outputs.Database.GetDbHomesDbHomeDatabaseStorageSizeDetail[]; tdeWalletPassword: string; /** * The date and time the Database Home was created. */ timeCreated: string; timeStampForPointInTimeRecovery: string; vaultId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster. */ vmClusterId: string; } interface GetDbHomesDbHomeDatabaseConnectionString { allConnectionStrings: { [key: string]: string; }; cdbDefault: string; cdbIpDefault: string; } interface GetDbHomesDbHomeDatabaseDbBackupConfig { autoBackupEnabled: boolean; autoBackupWindow: string; autoFullBackupDay: string; autoFullBackupWindow: string; backupDeletionPolicy: string; backupDestinationDetails: outputs.Database.GetDbHomesDbHomeDatabaseDbBackupConfigBackupDestinationDetail[]; recoveryWindowInDays: number; runImmediateFullBackup: boolean; } interface GetDbHomesDbHomeDatabaseDbBackupConfigBackupDestinationDetail { backupRetentionPolicyOnTerminate: string; dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ id: string; isRemote: boolean; isRetentionLockEnabled: boolean; remoteRegion: string; tdeWalletBackupDestinations: outputs.Database.GetDbHomesDbHomeDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination[]; type: string; vpcPassword: string; vpcUser: string; } interface GetDbHomesDbHomeDatabaseDbBackupConfigBackupDestinationDetailTdeWalletBackupDestination { backupDestinationId: string; backupDestinationType: string; } interface GetDbHomesDbHomeDatabaseEncryptionKeyLocationDetail { awsEncryptionKeyId: string; azureEncryptionKeyId: string; googleCloudProviderEncryptionKeyId: string; hsmPassword: string; providerType: string; } interface GetDbHomesDbHomeDatabaseStorageSizeDetail { dataStorageSizeInGb: number; recoStorageSizeInGbs: number; redoLogStorageSizeInGbs: number; } interface GetDbHomesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbNodeConsoleConnectionsConsoleConnection { /** * The OCID of the compartment to contain the console connection. */ compartmentId: string; /** * The SSH connection string for the console connection. */ connectionString: string; /** * The database node [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbNodeId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * The SSH public key fingerprint for the console connection. */ fingerprint: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the console connection. */ id: string; /** * Information about the current lifecycle state. */ lifecycleDetails: string; publicKey: string; /** * The SSH public key's fingerprint for the console connection service host. */ serviceHostKeyFingerprint: string; /** * The current state of the console connection. */ state: string; } interface GetDbNodeConsoleConnectionsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbNodeConsoleHistoriesConsoleHistoryCollection { items: outputs.Database.GetDbNodeConsoleHistoriesConsoleHistoryCollectionItem[]; } interface GetDbNodeConsoleHistoriesConsoleHistoryCollectionItem { /** * The OCID of the compartment containing the console history. */ compartmentId: string; /** * The database node [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbNodeId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the console history. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the console history was created. */ timeCreated: string; } interface GetDbNodeConsoleHistoriesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbNodeSnapshotMountPoint { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Node where snapshot was mounted. */ dbNodeId: string; /** * Volume Name */ name: string; } interface GetDbNodeSnapshotVolume { /** * Volume Name */ name: string; /** * Volume Size */ size: number; } interface GetDbNodeSnapshotsDbnodeSnapshot { /** * A filter to return only Exadata Database Node Snapshots that match the given VM cluster. */ clusterId: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Node Snapshot. */ dbnodeSnapshotId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Node Snapshot. */ id: string; /** * Additional information about the current lifecycle state of the Exadata Database Node Snapshot. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Node to which the snapshot is mounted. If the snapshot is not mounted to any node, then the value of `mountDbnodeId` will be `"null"`. */ mountDbnodeId: string; /** * Details of the mount points */ mountPoints: outputs.Database.GetDbNodeSnapshotsDbnodeSnapshotMountPoint[]; /** * A filter to return only resources that match the entire name given. The match is not case sensitive. */ name: string; /** * A filter to return only Exadata Database Snapshots that match the given database node. */ sourceDbnodeId: string; /** * A filter to return only Exadata Database Snapshots that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time that the Exadata Database Node Snapshot was created. */ timeCreated: string; /** * Details of the volumes */ volumes: outputs.Database.GetDbNodeSnapshotsDbnodeSnapshotVolume[]; } interface GetDbNodeSnapshotsDbnodeSnapshotMountPoint { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Node where snapshot was mounted. */ dbNodeId: string; /** * A filter to return only resources that match the entire name given. The match is not case sensitive. */ name: string; } interface GetDbNodeSnapshotsDbnodeSnapshotVolume { /** * A filter to return only resources that match the entire name given. The match is not case sensitive. */ name: string; /** * Volume Size */ size: number; } interface GetDbNodeSnapshotsFilter { /** * A filter to return only resources that match the entire name given. The match is not case sensitive. */ name: string; regex?: boolean; values: string[]; } interface GetDbNodesDbNode { /** * Additional information about the planned maintenance. */ additionalDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup IPv4 address associated with the database node. Use this OCID with either the [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IPv4 address needed to make a database connection. */ backupIpId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup IPv6 address associated with the database node. Use this OCID with the [GetIpv6](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Ipv6/GetIpv6) API to get the IPv6 address needed to make a database connection. */ backupIpv6id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second backup VNIC. */ backupVnic2id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup VNIC. */ backupVnicId: string; /** * The number of compute servers for the DB system. */ computeCount: number; /** * The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. */ computeModel: string; /** * The number of CPU cores enabled on the Db node. */ cpuCoreCount: number; dbNodeId: string; /** * The allocated local node storage in GBs on the Db node. */ dbNodeStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exacc Db server. */ dbServerId: string; /** * The DB system [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). If provided, filters the results to the set of database versions which are supported for the DB system. */ dbSystemId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * The name of the Fault Domain the instance is contained in. */ faultDomain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the host IPv4 address associated with the database node. Use this OCID with either the [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/PrivateIp/GetPrivateIp) or the [GetPublicIpByPrivateIpId](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/PublicIp/GetPublicIpByPrivateIpId) API to get the IPv4 address needed to make a database connection. */ hostIpId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the host IPv6 address associated with the database node. Use this OCID with the [GetIpv6](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/Ipv6/GetIpv6) API to get the IPv6 address needed to make a database connection. */ hostIpv6id: string; /** * The host name for the database node. */ hostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database node. */ id: string; /** * Indicates whether the database node must be rebooted after applying Operating System patches. This flag becomes true after operations such as OS/kernel updates to indicate that a reboot of the node is required. After a successful reboot, this value is expected to return to false. */ isOsPatchRebootRequired: boolean; /** * Information about the current lifecycle state. */ lifecycleDetails: string; /** * The type of database node maintenance. */ maintenanceType: string; /** * The allocated memory in GBs on the Db node. */ memorySizeInGbs: number; /** * The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. */ softwareStorageSizeInGb: number; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time that the database node was created. */ timeCreated: string; /** * End date and time of maintenance window. */ timeMaintenanceWindowEnd: string; /** * Start date and time of maintenance window. */ timeMaintenanceWindowStart: string; /** * The total number of CPU cores reserved on the Db node. */ totalCpuCoreCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second VNIC. */ vnic2id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. */ vnicId: string; } interface GetDbNodesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbServerDbServerPatchingDetail { /** * Estimated time, in minutes, to patch one database server. */ estimatedPatchDuration: number; /** * The status of the patching operation. */ patchingStatus: string; /** * The time when the patching operation ended. */ timePatchingEnded: string; /** * The time when the patching operation started. */ timePatchingStarted: string; } interface GetDbServersDbServer { /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous Virtual Machines associated with the Db server. */ autonomousVirtualMachineIds: string[]; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Autonomous VM Clusters associated with the Db server. */ autonomousVmClusterIds: string[]; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The compute model of the Autonomous AI Database. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. */ computeModel: string; /** * The number of CPU cores enabled on the Db server. */ cpuCoreCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Db nodes associated with the Db server. */ dbNodeIds: string[]; /** * The allocated local node storage in GBs on the Db server. */ dbNodeStorageSizeInGbs: number; /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ dbServerPatchingDetails: outputs.Database.GetDbServersDbServerDbServerPatchingDetail[]; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ExadataInfrastructure. */ exadataInfrastructureId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exacc Db server. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The total number of CPU cores available. */ maxCpuCount: number; /** * The total local node storage available in GBs. */ maxDbNodeStorageInGbs: number; /** * The total memory available in GBs. */ maxMemoryInGbs: number; /** * The allocated memory in GBs on the Db server. */ memorySizeInGbs: number; /** * The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available. */ shape: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time that the Db Server was created. */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM Clusters associated with the Db server. */ vmClusterIds: string[]; } interface GetDbServersDbServerDbServerPatchingDetail { /** * Estimated time, in minutes, to patch one database server. */ estimatedPatchDuration: number; /** * The status of the patching operation. */ patchingStatus: string; /** * The time when the patching operation ended. */ timePatchingEnded: string; /** * The time when the patching operation started. */ timePatchingStarted: string; } interface GetDbServersFilter { name: string; regex?: boolean; values: string[]; } interface GetDbSystemComputePerformancesDbSystemComputePerformance { /** * List of Compute performance details for the specified DB system shape. */ computePerformanceLists: outputs.Database.GetDbSystemComputePerformancesDbSystemComputePerformanceComputePerformanceList[]; /** * The shape of the DB system. */ shape: string; } interface GetDbSystemComputePerformancesDbSystemComputePerformanceComputePerformanceList { /** * The number of OCPU cores available. */ cpuCoreCount: number; /** * The amount of memory allocated for the VMDB System. */ memoryInGbs: number; /** * The network bandwidth of the VMDB system in gbps. */ networkBandwidthInGbps: number; /** * IOPS for the VMDB System. */ networkIops: number; /** * Network throughput for the VMDB System. */ networkThroughputInMbps: number; } interface GetDbSystemComputePerformancesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbSystemHistoryEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbSystemHistoryEntriesPatchHistoryEntry { /** * The action being performed or was completed. */ action: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the patch history entry. */ id: string; /** * A descriptive text associated with the lifecycleState. Typically contains additional displayable text. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the patch. */ patchId: string; /** * The type of Patch operation. */ patchType: string; /** * The current state of the action. */ state: string; /** * The date and time when the patch action completed */ timeEnded: string; /** * The date and time when the patch action started. */ timeStarted: string; } interface GetDbSystemOsPatchHistoryEntriesDbSystemOsPatchHistoryEntryCollection { /** * Array of OS patch details for a DB System. */ items: outputs.Database.GetDbSystemOsPatchHistoryEntriesDbSystemOsPatchHistoryEntryCollectionItem[]; } interface GetDbSystemOsPatchHistoryEntriesDbSystemOsPatchHistoryEntryCollectionItem { /** * A filter to return only OS patch history entries that match the specified OS patch action. */ action: string; /** * The DB system [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OS patch history entry. */ id: string; /** * A descriptive text associated with the lifecycleState. Typically contains additional displayable text. */ lifecycleDetails: string; /** * Results of OS patch details for a DB System. */ osPatchDetails: outputs.Database.GetDbSystemOsPatchHistoryEntriesDbSystemOsPatchHistoryEntryCollectionItemOsPatchDetail[]; /** * A filter to return only OS patch history entries that match the given lifecycle state exactly. */ state: string; /** * The date and time when the patch action completed */ timeEnded: string; /** * The date and time when the patch action started. */ timeStarted: string; } interface GetDbSystemOsPatchHistoryEntriesDbSystemOsPatchHistoryEntryCollectionItemOsPatchDetail { /** * Array of OS patch details for a DB System. */ items: outputs.Database.GetDbSystemOsPatchHistoryEntriesDbSystemOsPatchHistoryEntryCollectionItemOsPatchDetailItem[]; } interface GetDbSystemOsPatchHistoryEntriesDbSystemOsPatchHistoryEntryCollectionItemOsPatchDetailItem { /** * The OCID of the DB node targeted for this patch action. */ dbNodeId: string; /** * Indicates whether a reboot is required after applying the patch. */ isRebootRequired: boolean; /** * List of OS package identifiers (e.g., RPM strings). */ rpms: string[]; } interface GetDbSystemOsPatchHistoryEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbSystemOsPatchHistoryEntryOsPatchDetail { /** * Array of OS patch details for a DB System. */ items: outputs.Database.GetDbSystemOsPatchHistoryEntryOsPatchDetailItem[]; } interface GetDbSystemOsPatchHistoryEntryOsPatchDetailItem { /** * The OCID of the DB node targeted for this patch action. */ dbNodeId: string; /** * Indicates whether a reboot is required after applying the patch. */ isRebootRequired: boolean; /** * List of OS package identifiers (e.g., RPM strings). */ rpms: string[]; } interface GetDbSystemPatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbSystemPatchesPatch { /** * Actions that can possibly be performed using this patch. */ availableActions: string[]; /** * The text describing this patch package. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the patch. */ id: string; /** * Action that is currently being performed or was completed last. */ lastAction: string; /** * A descriptive text associated with the lifecycleState. Typically can contain additional displayable text. */ lifecycleDetails: string; /** * The current state of the patch as a result of lastAction. */ state: string; /** * The date and time that the patch was released. */ timeReleased: string; /** * The version of this patch package. */ version: string; } interface GetDbSystemShapesDbSystemShape { /** * If true, the shape supports configurable DB and Storage Server types. */ areServerTypesSupported: boolean; /** * The maximum number of CPU cores that can be enabled on the DB system for this shape. */ availableCoreCount: number; /** * The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape, ExaCC Elastic shapes and VM Flex shapes. */ availableCoreCountPerNode: number; /** * The maximum DATA storage that can be enabled for this shape. */ availableDataStorageInTbs: number; /** * The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes. */ availableDataStoragePerServerInTbs: number; /** * The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes. */ availableDbNodePerNodeInGbs: number; /** * The maximum Db Node storage that can be enabled for this shape. */ availableDbNodeStorageInGbs: number; /** * The maximum memory that can be enabled for this shape. */ availableMemoryInGbs: number; /** * The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes. */ availableMemoryPerNodeInGbs: number; /** * The compute model of the Autonomous AI Database. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. */ computeModel: string; /** * The discrete number by which the CPU core count for this shape can be increased or decreased. */ coreCountIncrement: number; /** * The display name of the shape used for the DB system. */ displayName: string; /** * The maximum number of Exadata storage servers available for the Exadata infrastructure. */ maxStorageCount: number; /** * The maximum number of compute servers available for this shape. */ maximumNodeCount: number; /** * The minimum number of CPU cores that can be enabled per node for this shape. */ minCoreCountPerNode: number; /** * The minimum data storage that need be allocated for this shape. */ minDataStorageInTbs: number; /** * The minimum Db Node storage that need be allocated per node for this shape. */ minDbNodeStoragePerNodeInGbs: number; /** * The minimum memory that need be allocated per node for this shape. */ minMemoryPerNodeInGbs: number; /** * The minimum number of Exadata storage servers available for the Exadata infrastructure. */ minStorageCount: number; /** * The minimum number of CPU cores that can be enabled on the DB system for this shape. */ minimumCoreCount: number; /** * The minimum number of compute servers available for this shape. */ minimumNodeCount: number; /** * The name of the shape used for the DB system. */ name: string; /** * Deprecated. Use `name` instead of `shape`. * * @deprecated The 'shape' field has been deprecated. Please use 'name' instead. */ shape: string; /** * The shapeAttributes of the DB system shape. */ shapeAttributes: string[]; /** * The family of the shape used for the DB system. */ shapeFamily: string; /** * The shape type for the virtual machine DB system. Shape type is determined by CPU hardware. Valid values are `AMD` , `INTEL` or `INTEL_FLEX_X9`. */ shapeType: string; } interface GetDbSystemShapesFilter { /** * The name of the shape used for the DB system. */ name: string; regex?: boolean; values: string[]; } interface GetDbSystemStoragePerformancesDbSystemStoragePerformance { /** * List of storage performance for the DATA disks */ dataStoragePerformanceLists: outputs.Database.GetDbSystemStoragePerformancesDbSystemStoragePerformanceDataStoragePerformanceList[]; /** * List of storage performance for the RECO disks */ recoStoragePerformanceLists: outputs.Database.GetDbSystemStoragePerformancesDbSystemStoragePerformanceRecoStoragePerformanceList[]; /** * Optional. Filters the performance results by shape type. */ shapeType: string; } interface GetDbSystemStoragePerformancesDbSystemStoragePerformanceDataStoragePerformanceList { /** * Representation of disk performance detail parameters. */ balancedDiskPerformances: outputs.Database.GetDbSystemStoragePerformancesDbSystemStoragePerformanceDataStoragePerformanceListBalancedDiskPerformance[]; /** * Representation of disk performance detail parameters. */ highDiskPerformances: outputs.Database.GetDbSystemStoragePerformancesDbSystemStoragePerformanceDataStoragePerformanceListHighDiskPerformance[]; /** * Size in GBs. */ sizeInGbs: number; } interface GetDbSystemStoragePerformancesDbSystemStoragePerformanceDataStoragePerformanceListBalancedDiskPerformance { /** * Disk IOPS in thousands. */ diskIops: number; /** * Disk Throughput in Mbps. */ diskThroughputInMbps: number; } interface GetDbSystemStoragePerformancesDbSystemStoragePerformanceDataStoragePerformanceListHighDiskPerformance { /** * Disk IOPS in thousands. */ diskIops: number; /** * Disk Throughput in Mbps. */ diskThroughputInMbps: number; } interface GetDbSystemStoragePerformancesDbSystemStoragePerformanceRecoStoragePerformanceList { /** * Representation of disk performance detail parameters. */ balancedDiskPerformances: outputs.Database.GetDbSystemStoragePerformancesDbSystemStoragePerformanceRecoStoragePerformanceListBalancedDiskPerformance[]; /** * Representation of disk performance detail parameters. */ highDiskPerformances: outputs.Database.GetDbSystemStoragePerformancesDbSystemStoragePerformanceRecoStoragePerformanceListHighDiskPerformance[]; /** * Size in GBs. */ sizeInGbs: number; } interface GetDbSystemStoragePerformancesDbSystemStoragePerformanceRecoStoragePerformanceListBalancedDiskPerformance { /** * Disk IOPS in thousands. */ diskIops: number; /** * Disk Throughput in Mbps. */ diskThroughputInMbps: number; } interface GetDbSystemStoragePerformancesDbSystemStoragePerformanceRecoStoragePerformanceListHighDiskPerformance { /** * Disk IOPS in thousands. */ diskIops: number; /** * Disk Throughput in Mbps. */ diskThroughputInMbps: number; } interface GetDbSystemStoragePerformancesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbSystemsDbSystem { /** * A filter to return only resources that match the given availability domain exactly. */ availabilityDomain: string; /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems. */ backupSubnetId: string; /** * The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. */ clusterName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure or Db System. */ clusterPlacementGroupId: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The number of compute servers for the DB system. */ computeCount: number; /** * The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. */ computeModel: string; /** * The number of CPU cores enabled on the DB system. */ cpuCoreCount: number; /** * Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. */ dataCollectionOptions: outputs.Database.GetDbSystemsDbSystemDataCollectionOption[]; /** * The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs. */ dataStoragePercentage: number; /** * The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. Required for VMDBs. */ dataStorageSizeInGb: number; /** * The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. */ databaseEdition: string; dbHomes: outputs.Database.GetDbSystemsDbSystemDbHome[]; /** * The DB system options. */ dbSystemOptions: outputs.Database.GetDbSystemsDbSystemDbSystemOption[]; /** * 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). */ definedTags: { [key: string]: string; }; /** * The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. */ diskRedundancy: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The domain name for the DB system. */ domain: string; /** * List of the Fault Domains in which this DB system is provisioned. */ faultDomains: string[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The hostname for the DB system. */ hostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ id: string; iormConfigCaches: outputs.Database.GetDbSystemsDbSystemIormConfigCache[]; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; kmsKeyVersionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last maintenance run. */ lastMaintenanceRunId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. */ lastPatchHistoryEntryId: string; /** * The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. */ licenseModel: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The port number configured for the listener on the DB system. */ listenerPort: number; maintenanceWindowDetails: outputs.Database.GetDbSystemsDbSystemMaintenanceWindowDetail[]; /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ maintenanceWindows: outputs.Database.GetDbSystemsDbSystemMaintenanceWindow[]; /** * Memory allocated to the DB system, in gigabytes. */ memorySizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the next maintenance run. */ nextMaintenanceRunId: string; /** * The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. */ nodeCount: number; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). **NsgIds restrictions:** * * A network security group (NSG) is optional for Autonomous AI Databases with private access. The nsgIds list can be empty. */ nsgIds: string[]; osPatchAction: string; osPatchDbNodeId: string; osPatchTrigger: number; /** * The most recent OS Patch Version applied on the DB system. */ osVersion: string; /** * The point in time for a cloned database system when the data disks were cloned from the source database system, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ pointInTimeDataDiskCloneTimestamp: string; primaryDbSystemId: string; privateIp: string; privateIpV6: string; /** * The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. */ recoStorageSizeInGb: number; /** * The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system. */ scanDnsName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the DB system. */ scanDnsRecordId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. */ scanIpIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. */ scanIpv6ids: string[]; /** * 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": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of the DB system. The shape determines resources to allocate to the DB system. * * For virtual machine shapes, the number of CPU cores and memory * * For bare metal and Exadata shapes, the number of CPU cores, storage, and memory */ shape: string; source: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ sourceDbSystemId: string; /** * True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. Only applied for Exadata shape. */ sparseDiskgroup: boolean; /** * The public key portion of one or more key pairs used for SSH access to the DB system. */ sshPublicKeys: string[]; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See [Block Volume Performance](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm) for more information. */ storageVolumePerformanceMode: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the DB system is associated with. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the DB system was created. */ timeCreated: string; /** * The time zone of the DB system. For details, see [DB System Time Zones](https://docs.cloud.oracle.com/iaas/Content/Database/References/timezones.htm). */ timeZone: string; /** * The Oracle Database version of the DB system. */ version: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster. */ vipIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. */ vipv6ids: string[]; /** * The OCID of the zone the DB system is associated with. */ zoneId: string; } interface GetDbSystemsDbSystemDataCollectionOption { /** * Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface GetDbSystemsDbSystemDbHome { createAsync: boolean; databaseSoftwareImageId: string; databases: outputs.Database.GetDbSystemsDbSystemDbHomeDatabase[]; dbHomeLocation: string; dbVersion: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ id: string; isUnifiedAuditingEnabled: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. */ lastPatchHistoryEntryId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the DB system was created. */ timeCreated: string; } interface GetDbSystemsDbSystemDbHomeDatabase { adminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment. */ backupId: string; backupTdePassword: string; characterSet: string; connectionStrings: outputs.Database.GetDbSystemsDbSystemDbHomeDatabaseConnectionString[]; databaseDefinedTags: { [key: string]: string; }; databaseFreeformTags: { [key: string]: string; }; databaseId: string; databaseSoftwareImageId: string; dbBackupConfigs: outputs.Database.GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfig[]; dbDomain: string; dbName: string; dbUniqueName: string; dbWorkload: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ id: string; isActiveDataGuardEnabled: boolean; keyStoreId: string; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; kmsKeyVersionId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; ncharacterSet: string; pdbName: string; pluggableDatabases: string[]; protectionMode: string; sidPrefix: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; tdeWalletPassword: string; /** * The date and time the DB system was created. */ timeCreated: string; timeStampForPointInTimeRecovery: string; transportType: string; vaultId: string; } interface GetDbSystemsDbSystemDbHomeDatabaseConnectionString { allConnectionStrings: { [key: string]: string; }; cdbDefault: string; cdbIpDefault: string; } interface GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfig { autoBackupEnabled: boolean; autoBackupWindow: string; autoFullBackupDay: string; autoFullBackupWindow: string; backupDeletionPolicy: string; backupDestinationDetails: outputs.Database.GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail[]; recoveryWindowInDays: number; runImmediateFullBackup: boolean; } interface GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail { backupRetentionPolicyOnTerminate: string; dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system. */ id: string; isRemote: boolean; isRetentionLockEnabled: boolean; isZeroDataLossEnabled: boolean; remoteRegion: string; type: string; } interface GetDbSystemsDbSystemDbSystemOption { /** * The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management */ storageManagement: string; } interface GetDbSystemsDbSystemIormConfigCache { dbPlans: outputs.Database.GetDbSystemsDbSystemIormConfigCacheDbPlan[]; dbSystemId: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; objective: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; } interface GetDbSystemsDbSystemIormConfigCacheDbPlan { dbName: string; flashCacheLimit: string; share: number; } interface GetDbSystemsDbSystemMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetDbSystemsDbSystemMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetDbSystemsDbSystemMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetDbSystemsDbSystemMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetDbSystemsDbSystemMaintenanceWindowDetail { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetDbSystemsDbSystemMaintenanceWindowDetailDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetDbSystemsDbSystemMaintenanceWindowDetailMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetDbSystemsDbSystemMaintenanceWindowDetailDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetDbSystemsDbSystemMaintenanceWindowDetailMonth { /** * Name of the month of the year. */ name: string; } interface GetDbSystemsDbSystemMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetDbSystemsFilter { /** * Name of the month of the year. */ name: string; regex?: boolean; values: string[]; } interface GetDbSystemsUpgradeHistoryEntriesDbSystemUpgradeHistoryEntry { /** * The operating system upgrade action. */ action: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the upgrade history entry. */ id: string; /** * A descriptive text associated with the lifecycleState. Typically contains additional displayable text. */ lifecycleDetails: string; /** * A valid Oracle Grid Infrastructure (GI) software version. */ newGiVersion: string; /** * A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 */ newOsVersion: string; /** * A valid Oracle Grid Infrastructure (GI) software version. */ oldGiVersion: string; /** * A valid Oracle Software (OS) version eg. Oracle Linux Server release 8 */ oldOsVersion: string; /** * The retention period, in days, for the snapshot that allows you to perform a rollback of the upgrade operation. After this number of days passes, you cannot roll back the upgrade. */ snapshotRetentionPeriodInDays: number; /** * A filter to return only upgrade history entries that match the given lifecycle state exactly. */ state: string; /** * The date and time when the upgrade action completed */ timeEnded: string; /** * The date and time when the upgrade action started. */ timeStarted: string; } interface GetDbSystemsUpgradeHistoryEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetDbVersionsDbVersion { /** * True if this version of the Oracle Database software is the latest version for a release. */ isLatestForMajorVersion: boolean; /** * True if this version of the Oracle Database software is the preview version. */ isPreviewDbVersion: boolean; /** * If provided, filters the results to the set of database versions which are supported for Upgrade. */ isUpgradeSupported: boolean; /** * True if this version of the Oracle Database software supports pluggable databases. */ supportsPdb: boolean; /** * A valid Oracle Database version. */ version: string; } interface GetDbVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetExadataInfrastructureContact { /** * The email for the Exadata Infrastructure contact. */ email: string; /** * If `true`, this Exadata Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Exadata Infrastructure contact is not a valid MOS contact. */ isContactMosValidated: boolean; /** * If `true`, this Exadata Infrastructure contact is a primary contact. If `false`, this Exadata Infrastructure is a secondary contact. */ isPrimary: boolean; /** * Name of the month of the year. */ name: string; /** * The phone number for the Exadata Infrastructure contact. */ phoneNumber: string; } interface GetExadataInfrastructureDefinedFileSystemConfiguration { /** * If true, the file system is used to create a backup prior to Exadata VM OS update. */ isBackupPartition: boolean; /** * If true, the file system resize is allowed for the Exadata Infrastructure cluster. If false, the file system resize is not allowed. */ isResizable: boolean; /** * The maximum size of file system. */ maxSizeGb: number; /** * The minimum size of file system. */ minSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface GetExadataInfrastructureExascaleConfig { /** * Available storage size for Exascale in GBs. */ availableStorageInGbs: number; /** * Available storage size for VM storage on Exascale in GBs. */ availableVmStorageInGbs: number; /** * Storage size needed for Exascale in GBs. */ totalStorageInGbs: number; /** * Storage size needed for VM storage on Exascale in GBs. */ totalVmStorageInGbs: number; } interface GetExadataInfrastructureMaintenanceVersionPreference { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. */ referenceResourceIdForImageUpdates: string; } interface GetExadataInfrastructureMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetExadataInfrastructureMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetExadataInfrastructureMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetExadataInfrastructureMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetExadataInfrastructureMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetExadataInfrastructureNetworkBondingModeDetail { /** * The network bonding mode for the Exadata infrastructure. */ backupNetworkBondingMode: string; /** * The network bonding mode for the Exadata infrastructure. */ clientNetworkBondingMode: string; /** * The network bonding mode for the Exadata infrastructure. */ drNetworkBondingMode: string; } interface GetExadataInfrastructureUnAllocatedResourceAutonomousVmCluster { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. */ id: string; /** * Total unallocated autonomous data storage in the AVM in TBs. */ unAllocatedAdbStorageInTbs: number; } interface GetExadataInfrastructuresExadataInfrastructure { /** * The requested number of additional storage servers activated for the Exadata infrastructure. */ activatedStorageCount: number; activationFile: string; /** * The requested number of additional compute servers for the Exadata infrastructure. */ additionalComputeCount: number; /** * Oracle Exadata System Model specification. The system model determines the amount of compute or storage server resources available for use. For more information, please see [System and Shape Configuration Options] (https://docs.oracle.com/en/engineered-systems/exadata-cloud-at-customer/ecccm/ecc-system-config-options.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B) */ additionalComputeSystemModel: string; /** * The requested number of additional storage servers for the Exadata infrastructure. */ additionalStorageCount: number; /** * The CIDR block for the Exadata administration network. */ adminNetworkCidr: string; /** * The name of the availability domain that the Exadata infrastructure is located in. */ availabilityDomain: string; /** * The IP address for the first control plane server. */ cloudControlPlaneServer1: string; /** * The IP address for the second control plane server. */ cloudControlPlaneServer2: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The number of compute servers for the Exadata infrastructure. */ computeCount: number; /** * The compute model of the Autonomous AI Database. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. */ computeModel: string; /** * The list of contacts for the Exadata infrastructure. */ contacts: outputs.Database.GetExadataInfrastructuresExadataInfrastructureContact[]; /** * The corporate network proxy for access to the control plane network. */ corporateProxy: string; /** * The number of enabled CPU cores. */ cpusEnabled: number; createAsync: boolean; /** * The CSI Number of the Exadata infrastructure. */ csiNumber: string; /** * Size, in terabytes, of the DATA disk group. */ dataStorageSizeInTbs: number; /** * The database server type of the Exadata infrastructure. */ databaseServerType: string; /** * The local node storage allocated in GBs. */ dbNodeStorageSizeInGbs: number; /** * The software version of the database servers (dom0) in the Exadata infrastructure. */ dbServerVersion: string; /** * Details of the file system configuration of the Exadata infrastructure. */ definedFileSystemConfigurations: outputs.Database.GetExadataInfrastructuresExadataInfrastructureDefinedFileSystemConfiguration[]; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The list of DNS server IP addresses. Maximum of 3 allowed. */ dnsServers: string[]; /** * The exascale config response details for the Exadata Cloud@Customer infrastructure or cloud Exadata infrastructure . Applies to both Exadata Cloud@Customer instances and Exadata Cloud Service instances. */ exascaleConfigs: outputs.Database.GetExadataInfrastructuresExadataInfrastructureExascaleConfig[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The gateway for the control plane network. */ gateway: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. */ id: string; /** * The CIDR block for the Exadata InfiniBand interconnect. */ infiniBandNetworkCidr: string; /** * Indicates whether cps offline diagnostic report is enabled for this Exadata infrastructure. This will allow a customer to quickly check status themselves and fix problems on their end, saving time and frustration for both Oracle and the customer when they find the CPS in a disconnected state.You can enable offline diagnostic report during Exadata infrastructure provisioning. You can also disable or enable it at any time using the UpdateExadatainfrastructure API. */ isCpsOfflineReportEnabled: boolean; /** * Indicates if deployment is Multi-Rack or not. */ isMultiRackDeployment: boolean; /** * If true, the infrastructure is using granular maintenance scheduling preference. */ isSchedulingPolicyAssociated: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * A field to capture ‘Maintenance SLO Status’ for the Exadata infrastructure with values ‘OK’, ‘DEGRADED’. Default is ‘OK’ when the infrastructure is provisioned. */ maintenanceSloStatus: string; /** * The preferences for target versions of future maintenance runs. */ maintenanceVersionPreferences: outputs.Database.GetExadataInfrastructuresExadataInfrastructureMaintenanceVersionPreference[]; /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ maintenanceWindows: outputs.Database.GetExadataInfrastructuresExadataInfrastructureMaintenanceWindow[]; /** * The total number of CPU cores available. */ maxCpuCount: number; /** * The total available DATA disk group size. */ maxDataStorageInTbs: number; /** * The total local node storage available in GBs. */ maxDbNodeStorageInGbs: number; /** * The total memory available in GBs. */ maxMemoryInGbs: number; /** * The memory allocated in GBs. */ memorySizeInGbs: number; /** * The monthly software version of the database servers (dom0) in the Exadata infrastructure. */ monthlyDbServerVersion: string; /** * The base64 encoded Multi-Rack configuration json file. */ multiRackConfigurationFile: string; /** * The netmask for the control plane network. */ netmask: string; /** * Details of bonding mode for Client and Backup and DR networks of an Exadata infrastructure. */ networkBondingModeDetails: outputs.Database.GetExadataInfrastructuresExadataInfrastructureNetworkBondingModeDetail[]; /** * The list of NTP server IP addresses. Maximum of 3 allowed. */ ntpServers: string[]; /** * The serial number for the Exadata infrastructure. */ rackSerialNumber: string; /** * The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. */ shape: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The number of Exadata storage servers for the Exadata infrastructure. */ storageCount: number; /** * The storage server type of the Exadata infrastructure. */ storageServerType: string; /** * The software version of the storage servers (cells) in the Exadata infrastructure. */ storageServerVersion: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the Exadata infrastructure was created. */ timeCreated: string; /** * The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](https://docs.cloud.oracle.com/iaas/Content/Database/References/timezones.htm). */ timeZone: string; } interface GetExadataInfrastructuresExadataInfrastructureContact { /** * The email for the Exadata Infrastructure contact. */ email: string; /** * If `true`, this Exadata Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Exadata Infrastructure contact is not a valid MOS contact. */ isContactMosValidated: boolean; /** * If `true`, this Exadata Infrastructure contact is a primary contact. If `false`, this Exadata Infrastructure is a secondary contact. */ isPrimary: boolean; /** * Name of the month of the year. */ name: string; /** * The phone number for the Exadata Infrastructure contact. */ phoneNumber: string; } interface GetExadataInfrastructuresExadataInfrastructureDefinedFileSystemConfiguration { /** * If true, the file system is used to create a backup prior to Exadata VM OS update. */ isBackupPartition: boolean; /** * If true, the file system resize is allowed for the Exadata Infrastructure cluster. If false, the file system resize is not allowed. */ isResizable: boolean; /** * The maximum size of file system. */ maxSizeGb: number; /** * The minimum size of file system. */ minSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface GetExadataInfrastructuresExadataInfrastructureExascaleConfig { /** * Available storage size for Exascale in GBs. */ availableStorageInGbs: number; /** * Available storage size for VM storage on Exascale in GBs. */ availableVmStorageInGbs: number; /** * Storage size needed for Exascale in GBs. */ totalStorageInGbs: number; /** * Storage size needed for VM storage on Exascale in GBs. */ totalVmStorageInGbs: number; } interface GetExadataInfrastructuresExadataInfrastructureMaintenanceVersionPreference { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. */ referenceResourceIdForImageUpdates: string; } interface GetExadataInfrastructuresExadataInfrastructureMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: outputs.Database.GetExadataInfrastructuresExadataInfrastructureMaintenanceWindowDaysOfWeek[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are * * 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: outputs.Database.GetExadataInfrastructuresExadataInfrastructureMaintenanceWindowMonth[]; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; skipRus: boolean[]; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetExadataInfrastructuresExadataInfrastructureMaintenanceWindowDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetExadataInfrastructuresExadataInfrastructureMaintenanceWindowMonth { /** * Name of the month of the year. */ name: string; } interface GetExadataInfrastructuresExadataInfrastructureNetworkBondingModeDetail { /** * The network bonding mode for the Exadata infrastructure. */ backupNetworkBondingMode: string; /** * The network bonding mode for the Exadata infrastructure. */ clientNetworkBondingMode: string; /** * The network bonding mode for the Exadata infrastructure. */ drNetworkBondingMode: string; } interface GetExadataInfrastructuresFilter { /** * Name of the month of the year. */ name: string; regex?: boolean; values: string[]; } interface GetExadataIormConfigDbPlan { /** * The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * The relative priority of this database. */ share: number; } interface GetExadbVmClusterDataCollectionOption { /** * Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface GetExadbVmClusterIormConfigCache { /** * An array of IORM settings for all the database in the Exadata DB system. */ dbPlans: outputs.Database.GetExadbVmClusterIormConfigCacheDbPlan[]; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current value for the IORM objective. The default is `AUTO`. */ objective: string; /** * The current state of the Exadata VM cluster on Exascale Infrastructure. */ state: string; } interface GetExadbVmClusterIormConfigCacheDbPlan { /** * The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * The relative priority of this database. */ share: number; } interface GetExadbVmClusterMultiCloudIdentityConnectorConfig { /** * Cloud provider */ cloudProvider: string; /** * The OCID of the identity connector */ id: string; } interface GetExadbVmClusterNodeConfig { /** * The number of ECPUs to enable for each node. */ enabledEcpuCountPerNode: number; /** * The memory that you want to be allocated in GBs to each node. Memory is calculated based on 11 GB per VM core reserved. */ memorySizeInGbsPerNode: number; /** * The file system storage in GBs for snapshot for each node. */ snapshotFileSystemStorageSizeGbsPerNode: number; /** * The number of Total ECPUs for each node. */ totalEcpuCountPerNode: number; /** * Total file system storage in GBs for each node. */ totalFileSystemStorageSizeGbsPerNode: number; /** * The file system storage in GBs for each node. */ vmFileSystemStorageSizeGbsPerNode: number; } interface GetExadbVmClusterNodeResource { /** * The host name for the node. */ nodeHostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the node. */ nodeId: string; nodeName: string; /** * The current state of the Exadata VM cluster on Exascale Infrastructure. */ state: string; } interface GetExadbVmClusterUpdateHistoryEntriesExadbVmClusterUpdateHistoryEntry { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. */ id: string; /** * Descriptive text providing additional details about the lifecycle state. */ lifecycleDetails: string; /** * The current lifecycle state of the maintenance update operation. */ state: string; /** * The date and time when the maintenance update action completed. */ timeCompleted: string; /** * The date and time when the maintenance update action started. */ timeStarted: string; /** * The update action. */ updateAction: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance update. */ updateId: string; /** * A filter to return only resources that match the given update type exactly. */ updateType: string; /** * The version of the maintenance update package. */ version: string; } interface GetExadbVmClusterUpdateHistoryEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetExadbVmClusterUpdatesExadbVmClusterUpdate { /** * The possible actions performed by the update operation on the infrastructure components. */ availableActions: string[]; /** * Details of the maintenance update package. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance update. */ id: string; /** * The previous update action performed. */ lastAction: string; /** * Descriptive text providing additional details about the lifecycle state. */ lifecycleDetails: string; /** * The current state of the maintenance update. Dependent on value of `lastAction`. */ state: string; /** * The date and time the maintenance update was released. */ timeReleased: string; /** * A filter to return only resources that match the given update type exactly. */ updateType: string; /** * A filter to return only resources that match the given update version exactly. */ version: string; } interface GetExadbVmClusterUpdatesFilter { name: string; regex?: boolean; values: string[]; } interface GetExadbVmClustersExadbVmCluster { /** * The name of the availability domain in which the Exadata VM cluster on Exascale Infrastructure is located. */ availabilityDomain: string; /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * The cluster name for Exadata VM cluster on Exascale Infrastructure. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive. */ clusterName: string; /** * A filter to return only resources that match the given cluster placement group ID exactly. */ clusterPlacementGroupId: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. */ dataCollectionOptions: outputs.Database.GetExadbVmClustersExadbVmClusterDataCollectionOption[]; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given Exascale Database Storage Vault ID. */ exascaleDbStorageVaultId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A valid Oracle Grid Infrastructure (GI) software version. */ giVersion: string; /** * Grid Setup will be done using this grid image id. */ gridImageId: string; /** * The type of Grid Image */ gridImageType: string; /** * The hostname for the Exadata VM cluster on Exascale Infrastructure. The hostname must begin with an alphabetic character, and can contain alphanumeric characters and hyphens (-). For Exadata systems, the maximum length of the hostname is 12 characters. */ hostname: string; /** * The OCID of the identity connector */ id: string; /** * The IORM settings of the Exadata DB system. */ iormConfigCaches: outputs.Database.GetExadbVmClustersExadbVmClusterIormConfigCache[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last maintenance update history entry. This value is updated when a maintenance update starts. */ lastUpdateHistoryEntryId: string; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. */ listenerPort: string; /** * Details of the multi cloud identity connectors of the VM cluster. */ multiCloudIdentityConnectorConfigs: outputs.Database.GetExadbVmClustersExadbVmClusterMultiCloudIdentityConnectorConfig[]; /** * The configuration of each node in the Exadata VM cluster on Exascale Infrastructure. */ nodeConfigs: outputs.Database.GetExadbVmClustersExadbVmClusterNodeConfig[]; /** * The list of node in the Exadata VM cluster on Exascale Infrastructure. */ nodeResources: outputs.Database.GetExadbVmClustersExadbVmClusterNodeResource[]; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). **NsgIds restrictions:** * * A network security group (NSG) is optional for Autonomous AI Databases with private access. The nsgIds list can be empty. */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; registerPkcsTrigger: number; /** * The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. */ scanDnsName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. */ scanDnsRecordId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. */ scanIpIds: string[]; /** * The TCP Single Client Access Name (SCAN) port. The default port is 1521. */ scanListenerPortTcp: number; /** * The Secured Communication (TCPS) protocol Single Client Access Name (SCAN) port. The default port is 2484. */ scanListenerPortTcpSsl: number; /** * 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": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of the Exadata VM cluster on Exascale Infrastructure resource */ shape: string; /** * The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later */ shapeAttribute: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given lifecycle state exactly. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * Operating system version of the image. */ systemVersion: string; /** * TDE keystore type */ tdeKeyStoreType: string; /** * The date and time that the Exadata VM cluster on Exascale Infrastructure was created. */ timeCreated: string; /** * The time zone to use for the Exadata VM cluster on Exascale Infrastructure. For details, see [Time Zones](https://docs.cloud.oracle.com/iaas/Content/Database/References/timezones.htm). */ timeZone: string; unregisterPkcsTrigger: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, then the VIP is reassigned to another active node in the cluster. */ vipIds: string[]; /** * The OCID of the zone with which the Exadata VM cluster on Exascale Infrastructure is associated. */ zoneId: string; } interface GetExadbVmClustersExadbVmClusterDataCollectionOption { /** * Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface GetExadbVmClustersExadbVmClusterIormConfigCache { /** * An array of IORM settings for all the database in the Exadata DB system. */ dbPlans: outputs.Database.GetExadbVmClustersExadbVmClusterIormConfigCacheDbPlan[]; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current value for the IORM objective. The default is `AUTO`. */ objective: string; /** * A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given lifecycle state exactly. */ state: string; } interface GetExadbVmClustersExadbVmClusterIormConfigCacheDbPlan { /** * The database name. For the default `DbPlan`, the `dbName` is `default`. */ dbName: string; /** * The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. */ flashCacheLimit: string; /** * The relative priority of this database. */ share: number; } interface GetExadbVmClustersExadbVmClusterMultiCloudIdentityConnectorConfig { /** * Cloud provider */ cloudProvider: string; /** * The OCID of the identity connector */ id: string; } interface GetExadbVmClustersExadbVmClusterNodeConfig { enabledEcpuCountPerNode: number; /** * The memory that you want to be allocated in GBs to each node. Memory is calculated based on 11 GB per VM core reserved. */ memorySizeInGbsPerNode: number; /** * The file system storage in GBs for snapshot for each node. */ snapshotFileSystemStorageSizeGbsPerNode: number; totalEcpuCountPerNode: number; /** * Total file system storage in GBs for each node. */ totalFileSystemStorageSizeGbsPerNode: number; /** * The file system storage in GBs for each node. */ vmFileSystemStorageSizeGbsPerNode: number; } interface GetExadbVmClustersExadbVmClusterNodeResource { /** * The host name for the node. */ nodeHostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the node. */ nodeId: string; nodeName: string; /** * A filter to return only Exadata VM clusters on Exascale Infrastructure that match the given lifecycle state exactly. */ state: string; } interface GetExadbVmClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetExascaleDbStorageVaultHighCapacityDatabaseStorage { /** * Available Capacity */ availableSizeInGbs: number; /** * Total Capacity */ totalSizeInGbs: number; } interface GetExascaleDbStorageVaultsExascaleDbStorageVault { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * A filter to return only Exadata Database Storage Vaults which match the given attachedShapeAttributes or has null attachedShapeAttributes */ attachedShapeAttributes: string[]; /** * Maximum limit storage size in gigabytes, that is applicable for the Database Storage Vault. */ autoscaleLimitInGbs: number; /** * The name of the availability domain in which the Exadata Database Storage Vault is located. */ availabilityDomain: string; /** * A filter to return only resources that match the given cluster placement group ID exactly. */ clusterPlacementGroupId: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * Exadata Database Storage Vault description. */ description: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * A filter to return only list of Vaults that are linked to the exadata infrastructure Id. */ exadataInfrastructureId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Exadata Database Storage Details */ highCapacityDatabaseStorages: outputs.Database.GetExascaleDbStorageVaultsExascaleDbStorageVaultHighCapacityDatabaseStorage[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. */ id: string; /** * Indicates if autoscale feature is enabled for the Database Storage Vault. The default value is `FALSE`. */ isAutoscaleEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * A filter to return only Exadata Database Storage Vaults that match the given lifecycle state exactly. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time that the Exadata Database Storage Vault was created. */ timeCreated: string; /** * The time zone that you want to use for the Exadata Database Storage Vault. For details, see [Time Zones](https://docs.cloud.oracle.com/iaas/Content/Database/References/timezones.htm). */ timeZone: string; /** * The number of Exadata VM clusters used the Exadata Database Storage Vault. */ vmClusterCount: number; /** * The List of Exadata VM cluster on Exascale Infrastructure [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) **Note:** If Exadata Database Storage Vault is not used for any Exadata VM cluster on Exascale Infrastructure, this list is empty. */ vmClusterIds: string[]; } interface GetExascaleDbStorageVaultsExascaleDbStorageVaultHighCapacityDatabaseStorage { /** * Available Capacity */ availableSizeInGbs: number; /** * Total Capacity */ totalSizeInGbs: number; } interface GetExascaleDbStorageVaultsFilter { name: string; regex?: boolean; values: string[]; } interface GetExecutionActionActionMember { /** * The estimated time of the execution action in minutes. */ estimatedTimeInMins: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent resource the execution action belongs to. */ memberId: string; /** * The priority order of the execution action member. */ memberOrder: number; /** * The current status of the execution action member. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, DURATION_EXCEEDED, RESCHEDULED and COMPLETED. enum: * * SCHEDULED * * IN_PROGRESS * * FAILED * * CANCELED * * DURATION_EXCEEDED * * RESCHEDULED * * SUCCEEDED */ status: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; } interface GetExecutionActionsExecutionAction { /** * List of action members of this execution action. */ actionMembers: outputs.Database.GetExecutionActionsExecutionActionActionMember[]; /** * Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` */ actionParams: { [key: string]: string; }; /** * The action type of the execution action being performed */ actionType: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * Description of the execution action. */ description: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The estimated time of the execution action in minutes. */ estimatedTimeInMins: number; /** * The priority order of the execution action. */ executionActionOrder: number; /** * A filter to return only resources that match the given execution wondow id. */ executionWindowId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the execution action. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current sub-state of the execution action. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. */ lifecycleSubstate: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the execution action was created. */ timeCreated: string; /** * The last date and time that the execution action was updated. */ timeUpdated: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; } interface GetExecutionActionsExecutionActionActionMember { /** * The estimated time of the execution action in minutes. */ estimatedTimeInMins: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent resource the execution action belongs to. */ memberId: string; /** * The priority order of the execution action member. */ memberOrder: number; /** * The current status of the execution action member. Valid states are SCHEDULED, IN_PROGRESS, FAILED, CANCELED, DURATION_EXCEEDED, RESCHEDULED and COMPLETED. enum: * * SCHEDULED * * IN_PROGRESS * * FAILED * * CANCELED * * DURATION_EXCEEDED * * RESCHEDULED * * SUCCEEDED */ status: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; } interface GetExecutionActionsFilter { name: string; regex?: boolean; values: string[]; } interface GetExecutionWindowsExecutionWindow { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * Description of the execution window. */ description: string; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The estimated time of the execution window in minutes. */ estimatedTimeInMins: number; /** * A filter to return only resources that match the given resource id exactly. */ executionResourceId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the execution window. */ id: string; /** * Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. */ isEnforcedDuration: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current sub-state of the execution window. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. */ lifecycleSubstate: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the execution window was created. */ timeCreated: string; /** * The date and time that the execution window ended. */ timeEnded: string; /** * The scheduled start date and time of the execution window. */ timeScheduled: string; /** * The date and time that the execution window was started. */ timeStarted: string; /** * The last date and time that the execution window was updated. */ timeUpdated: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; /** * Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. */ windowDurationInMins: number; /** * The execution window is of PLANNED or UNPLANNED type. */ windowType: string; } interface GetExecutionWindowsFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalContainerDatabaseDatabaseManagementConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ databaseManagementConnectionId: string; /** * The status of the Database Management service. */ databaseManagementStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetExternalContainerDatabaseStackMonitoringConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ stackMonitoringConnectorId: string; /** * The status of Stack Monitoring. */ stackMonitoringStatus: string; } interface GetExternalContainerDatabasesExternalContainerDatabase { /** * The character set of the external database. */ characterSet: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The Oracle Database configuration */ databaseConfiguration: string; /** * The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. */ databaseEdition: string; /** * The configuration of the Database Management service. */ databaseManagementConfigs: outputs.Database.GetExternalContainerDatabasesExternalContainerDatabaseDatabaseManagementConfig[]; /** * The Oracle Database version. */ databaseVersion: string; /** * The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. */ dbId: string; /** * The database packs licensed for the external Oracle Database. */ dbPacks: string; /** * The `DB_UNIQUE_NAME` of the external database. */ dbUniqueName: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The national character of the external database. */ ncharacterSet: string; /** * The configuration of Stack Monitoring for the external database. */ stackMonitoringConfigs: outputs.Database.GetExternalContainerDatabasesExternalContainerDatabaseStackMonitoringConfig[]; /** * A filter to return only resources that match the specified lifecycle state. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the database was created. */ timeCreated: string; /** * The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered. */ timeZone: string; } interface GetExternalContainerDatabasesExternalContainerDatabaseDatabaseManagementConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ databaseManagementConnectionId: string; /** * The status of the Database Management service. */ databaseManagementStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetExternalContainerDatabasesExternalContainerDatabaseStackMonitoringConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ stackMonitoringConnectorId: string; /** * The status of Stack Monitoring. */ stackMonitoringStatus: string; } interface GetExternalContainerDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalDatabaseConnectorConnectionCredential { /** * The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the database. */ credentialType: string; /** * The password that will be used to connect to the database. */ password: string; /** * The role of the user that will be connecting to the database. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ sslSecretId: string; /** * The username that will be used to connect to the database. */ username: string; } interface GetExternalDatabaseConnectorConnectionString { /** * The host name of the database. */ hostname: string; /** * The port used to connect to the database. */ port: number; /** * The protocol used to connect to the database. */ protocol: string; /** * The name of the service alias used to connect to the database. */ service: string; } interface GetExternalDatabaseConnectorsExternalDatabaseConnector { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector crendentials. */ connectionCredentials: outputs.Database.GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionCredential[]; /** * The status of connectivity to the external database. */ connectionStatus: string; /** * The Oracle AI Database connection string. */ connectionStrings: outputs.Database.GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionString[]; /** * The ID of the agent used for the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ connectorAgentId: string; /** * The type of connector used by the external database resource. */ connectorType: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database whose connectors will be listed. */ externalDatabaseId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * A filter to return only resources that match the specified lifecycle state. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the `connectionStatus` of this external connector was last updated. */ timeConnectionStatusLastUpdated: string; /** * The date and time the external connector was created. */ timeCreated: string; } interface GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionCredential { /** * The name of the credential information that used to connect to the database. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the database. */ credentialType: string; /** * The password that will be used to connect to the database. */ password: string; /** * The role of the user that will be connecting to the database. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ sslSecretId: string; /** * The username that will be used to connect to the database. */ username: string; } interface GetExternalDatabaseConnectorsExternalDatabaseConnectorConnectionString { /** * The host name of the database. */ hostname: string; /** * The port used to connect to the database. */ port: number; /** * The protocol used to connect to the database. */ protocol: string; /** * The name of the service alias used to connect to the database. */ service: string; } interface GetExternalDatabaseConnectorsFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalNonContainerDatabaseDatabaseManagementConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ databaseManagementConnectionId: string; /** * The status of the Database Management service. */ databaseManagementStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetExternalNonContainerDatabaseOperationsInsightsConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ operationsInsightsConnectorId: string; /** * The status of Operations Insights */ operationsInsightsStatus: string; } interface GetExternalNonContainerDatabaseStackMonitoringConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ stackMonitoringConnectorId: string; /** * The status of Stack Monitoring. */ stackMonitoringStatus: string; } interface GetExternalNonContainerDatabasesExternalNonContainerDatabase { /** * The character set of the external database. */ characterSet: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The Oracle Database configuration */ databaseConfiguration: string; /** * The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. */ databaseEdition: string; /** * The configuration of the Database Management service. */ databaseManagementConfigs: outputs.Database.GetExternalNonContainerDatabasesExternalNonContainerDatabaseDatabaseManagementConfig[]; /** * The Oracle Database version. */ databaseVersion: string; /** * The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. */ dbId: string; /** * The database packs licensed for the external Oracle Database. */ dbPacks: string; /** * The `DB_UNIQUE_NAME` of the external database. */ dbUniqueName: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The national character of the external database. */ ncharacterSet: string; /** * The configuration of Operations Insights for the external database */ operationsInsightsConfigs: outputs.Database.GetExternalNonContainerDatabasesExternalNonContainerDatabaseOperationsInsightsConfig[]; /** * The configuration of Stack Monitoring for the external database. */ stackMonitoringConfigs: outputs.Database.GetExternalNonContainerDatabasesExternalNonContainerDatabaseStackMonitoringConfig[]; /** * A filter to return only resources that match the specified lifecycle state. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the database was created. */ timeCreated: string; /** * The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered. */ timeZone: string; } interface GetExternalNonContainerDatabasesExternalNonContainerDatabaseDatabaseManagementConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ databaseManagementConnectionId: string; /** * The status of the Database Management service. */ databaseManagementStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetExternalNonContainerDatabasesExternalNonContainerDatabaseOperationsInsightsConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ operationsInsightsConnectorId: string; /** * The status of Operations Insights */ operationsInsightsStatus: string; } interface GetExternalNonContainerDatabasesExternalNonContainerDatabaseStackMonitoringConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ stackMonitoringConnectorId: string; /** * The status of Stack Monitoring. */ stackMonitoringStatus: string; } interface GetExternalNonContainerDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalPluggableDatabaseDatabaseManagementConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ databaseManagementConnectionId: string; /** * The status of the Database Management service. */ databaseManagementStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetExternalPluggableDatabaseOperationsInsightsConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ operationsInsightsConnectorId: string; /** * The status of Operations Insights */ operationsInsightsStatus: string; } interface GetExternalPluggableDatabaseStackMonitoringConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ stackMonitoringConnectorId: string; /** * The status of Stack Monitoring. */ stackMonitoringStatus: string; } interface GetExternalPluggableDatabasesExternalPluggableDatabase { /** * The character set of the external database. */ characterSet: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The Oracle Database configuration */ databaseConfiguration: string; /** * The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE. */ databaseEdition: string; /** * The configuration of the Database Management service. */ databaseManagementConfigs: outputs.Database.GetExternalPluggableDatabasesExternalPluggableDatabaseDatabaseManagementConfig[]; /** * The Oracle Database version. */ databaseVersion: string; /** * The Oracle Database ID, which identifies an Oracle Database located outside of Oracle Cloud. */ dbId: string; /** * The database packs licensed for the external Oracle Database. */ dbPacks: string; /** * The `DB_UNIQUE_NAME` of the external database. */ dbUniqueName: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The ExternalContainerDatabase [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ externalContainerDatabaseId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure external database resource. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The national character of the external database. */ ncharacterSet: string; /** * The configuration of Operations Insights for the external database */ operationsInsightsConfigs: outputs.Database.GetExternalPluggableDatabasesExternalPluggableDatabaseOperationsInsightsConfig[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the the non-container database that was converted to a pluggable database to create this resource. */ sourceId: string; /** * The configuration of Stack Monitoring for the external database. */ stackMonitoringConfigs: outputs.Database.GetExternalPluggableDatabasesExternalPluggableDatabaseStackMonitoringConfig[]; /** * A filter to return only resources that match the specified lifecycle state. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the database was created. */ timeCreated: string; /** * The time zone of the external database. It is a time zone offset (a character type in the format '[+|-]TZH:TZM') or a time zone region name, depending on how the time zone value was specified when the database was created / last altered. */ timeZone: string; } interface GetExternalPluggableDatabasesExternalPluggableDatabaseDatabaseManagementConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ databaseManagementConnectionId: string; /** * The status of the Database Management service. */ databaseManagementStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetExternalPluggableDatabasesExternalPluggableDatabaseOperationsInsightsConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ operationsInsightsConnectorId: string; /** * The status of Operations Insights */ operationsInsightsStatus: string; } interface GetExternalPluggableDatabasesExternalPluggableDatabaseStackMonitoringConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [external database connector](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/datatypes/CreateExternalDatabaseConnectorDetails). */ stackMonitoringConnectorId: string; /** * The status of Stack Monitoring. */ stackMonitoringStatus: string; } interface GetExternalPluggableDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetFlexComponentsFilter { /** * A filter to return only resources that match the entire name given. The match is not case sensitive. */ name: string; regex?: boolean; values: string[]; } interface GetFlexComponentsFlexComponentCollection { items: outputs.Database.GetFlexComponentsFlexComponentCollectionItem[]; } interface GetFlexComponentsFlexComponentCollectionItem { /** * The maximum number of CPU cores that can ben enabled on the DB Server for this Flex Component. */ availableCoreCount: number; /** * The maximum storage that can be enabled on the Storage Server for this Flex Component. */ availableDbStorageInGbs: number; /** * The maximum local storage that can be enabled on the DB Server for this Flex Component. */ availableLocalStorageInGbs: number; /** * The maximum memory size that can be enabled on the DB Server for this Flex Component. */ availableMemoryInGbs: number; /** * The compute model of the DB Server for this Flex Component. */ computeModel: string; /** * The description summary for this Flex Component. */ descriptionSummary: string; /** * The hardware type of the DB (Compute) or Storage (Cell) Server for this Flex Component. */ hardwareType: string; /** * The minimum number of CPU cores that can be enabled on the DB Server for this Flex Component. */ minimumCoreCount: number; /** * A filter to return only resources that match the entire name given. The match is not case sensitive. */ name: string; /** * The runtime minimum number of CPU cores that can be enabled for this Flex Component. */ runtimeMinimumCoreCount: number; /** * A filter to return only resources that belong to the entire shape name given. The match is not case sensitive. */ shape: string; } interface GetGiVersionMinorVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetGiVersionMinorVersionsGiMinorVersion { /** * Grid Infrastructure Image Id */ gridImageId: string; /** * The Oracle Grid Infrastructure major version. */ version: string; } interface GetGiVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetGiVersionsGiVersion { /** * A valid Oracle Grid Infrastructure (GI) software version. */ version: string; } interface GetKeyStoreAssociatedDatabase { /** * The name of the database that is associated with the key store. */ dbName: string; /** * The unique name of the database that is associated with the key store. */ dbUniqueName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store. */ id: string; } interface GetKeyStoreAssociatedLongTermBackup { /** * The user-friendly name for the key store. The name does not need to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store. */ id: string; } interface GetKeyStoreTypeDetail { /** * The administrator username to connect to Oracle Key Vault */ adminUsername: string; /** * The list of Oracle Key Vault connection IP addresses. */ connectionIps: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ secretId: string; /** * The type of key store. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; } interface GetKeyStoresFilter { name: string; regex?: boolean; values: string[]; } interface GetKeyStoresKeyStore { /** * List of databases associated with the key store. */ associatedDatabases: outputs.Database.GetKeyStoresKeyStoreAssociatedDatabase[]; /** * Indicates the number of long term backups of Autonomous Databases associated with this backup destination. */ associatedLongTermBackupCount: number; /** * List of long term backups of Autonomous Databases associated with this backup destination.The maximum associated number of long term backup listed here would be 1024. */ associatedLongTermBackups: outputs.Database.GetKeyStoresKeyStoreAssociatedLongTermBackup[]; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; confirmDetailsTrigger: number; /** * 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). */ definedTags: { [key: string]: string; }; /** * The user-friendly name for the key store. The name does not need to be unique. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current state of the key store. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time that the key store was created. */ timeCreated: string; /** * Key store type details. */ typeDetails: outputs.Database.GetKeyStoresKeyStoreTypeDetail[]; } interface GetKeyStoresKeyStoreAssociatedDatabase { /** * The name of the database that is associated with the key store. */ dbName: string; /** * The unique name of the database that is associated with the key store. */ dbUniqueName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store. */ id: string; } interface GetKeyStoresKeyStoreAssociatedLongTermBackup { /** * The user-friendly name for the key store. The name does not need to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store. */ id: string; } interface GetKeyStoresKeyStoreTypeDetail { /** * The administrator username to connect to Oracle Key Vault */ adminUsername: string; /** * The list of Oracle Key Vault connection IP addresses. */ connectionIps: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ secretId: string; /** * The type of key store. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. */ vaultId: string; } interface GetMaintenanceRunEstimatedPatchingTime { /** * The estimated time required in minutes for database server patching. */ estimatedDbServerPatchingTime: number; /** * The estimated time required in minutes for network switch patching. */ estimatedNetworkSwitchesPatchingTime: number; /** * The estimated time required in minutes for storage server patching. */ estimatedStorageServerPatchingTime: number; /** * The estimated total time required in minutes for all patching operations. */ totalEstimatedPatchingTime: number; } interface GetMaintenanceRunWindowTypeDescription { /** * A list of window detail messages from all the active execution windows based on the window type. */ messages: string[]; /** * The execution window is of PLANNED or UNPLANNED type. */ windowType: string; } interface GetMaintenanceRunsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaintenanceRunsMaintenanceRun { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Extend current custom action timeout between the current database servers during waiting state, from 0 (zero) to 30 minutes. */ currentCustomActionTimeoutInMins: number; /** * The name of the current infrastruture component that is getting patched. */ currentPatchingComponent: string; /** * Determines the amount of time the system will wait before the start of each database server patching operation. Specify a number of minutes, from 15 to 120. */ customActionTimeoutInMins: number; /** * The Autonomous AI Database Software Image [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ databaseSoftwareImageId: string; /** * Description of the maintenance run. */ description: string; /** * The user-friendly name for the maintenance run. */ displayName: string; /** * The estimated start time of the next infrastruture component patching operation. */ estimatedComponentPatchingStartTime: string; /** * The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). */ estimatedPatchingTimes: outputs.Database.GetMaintenanceRunsMaintenanceRunEstimatedPatchingTime[]; /** * The OCID of the maintenance run. */ id: string; /** * If true, enables the configuration of a custom action timeout (waiting period) between database servers patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * Indicates if an automatic DST Time Zone file update is enabled for the Autonomous Container Database. If enabled along with Release Update, patching will be done in a Non-Rolling manner. */ isDstFileUpdateEnabled: boolean; /** * If `FALSE`, the maintenance run doesn't support granular maintenance. */ isMaintenanceRunGranular: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The sub-type of the maintenance run. */ maintenanceSubtype: string; /** * The maintenance type. */ maintenanceType: string; /** * Contain the patch failure count. */ patchFailureCount: number; /** * The unique identifier of the patch. The identifier string includes the patch type, the Oracle AI Database version, and the patch creation date (using the format YYMMDD). For example, the identifier `ru_patch_19.9.0.0_201030` is used for an RU patch for Oracle AI Database 19.9.0.0 that was released October 30, 2020. */ patchId: string; patchType: string; /** * The time when the patching operation ended. */ patchingEndTime: string; /** * Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. */ patchingMode: string; /** * The time when the patching operation started. */ patchingStartTime: string; /** * The status of the patching operation. */ patchingStatus: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance run for the Autonomous Data Guard association's peer container database. */ peerMaintenanceRunId: string; /** * The list of OCIDs for the maintenance runs associated with their Autonomous Data Guard peer container databases. */ peerMaintenanceRunIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource the maintenance run will refer to when trying to fetch target versions. This field is set during maintenance run creation based on infrastructure's maintenance run version preferences. Currently this is only be supported for monthly maintenance runs created via scheduling plans. */ referenceResourceIdForImageUpdates: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The target software version for the database server patching operation. */ targetDbServerVersion: string; /** * The target resource ID. */ targetResourceId: string; /** * The type of the target resource. Accepted values are: AUTONOMOUS_CONTAINER_DATABASE, AUTONOMOUS_EXADATA_INFRASTRUCTURE, EXADATA_DB_SYSTEM */ targetResourceType: string; /** * The target Cell version that is to be patched to. */ targetStorageServerVersion: string; /** * The date and time the maintenance run was completed. */ timeEnded: string; /** * The date and time the maintenance run is scheduled to occur. */ timeScheduled: string; /** * The date and time the maintenance run starts. */ timeStarted: string; /** * The total time taken by corresponding resource activity in minutes. */ totalTimeTakenInMins: number; /** * A list of key-value pairs where the key will contain the window type and value contains all the windowDetails of that window type. */ windowTypeDescriptions: outputs.Database.GetMaintenanceRunsMaintenanceRunWindowTypeDescription[]; } interface GetMaintenanceRunsMaintenanceRunEstimatedPatchingTime { /** * The estimated time required in minutes for database server patching. */ estimatedDbServerPatchingTime: number; /** * The estimated time required in minutes for network switch patching. */ estimatedNetworkSwitchesPatchingTime: number; /** * The estimated time required in minutes for storage server patching. */ estimatedStorageServerPatchingTime: number; /** * The estimated total time required in minutes for all patching operations. */ totalEstimatedPatchingTime: number; } interface GetMaintenanceRunsMaintenanceRunWindowTypeDescription { /** * A list of window detail messages from all the active execution windows based on the window type. */ messages: string[]; /** * The execution window is of PLANNED or UNPLANNED type. */ windowType: string; } interface GetManagedPreferredCredentialsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedPreferredCredentialsPreferredCredentialCollection { items: outputs.Database.GetManagedPreferredCredentialsPreferredCredentialCollectionItem[]; } interface GetManagedPreferredCredentialsPreferredCredentialCollectionItem { /** * The name of the preferred credential. */ credentialName: string; /** * Indicates whether the preferred credential is accessible. */ isAccessible: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential that contains the database user password metadata. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Vault service secret that contains the database user password. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The status of the preferred credential. */ status: string; /** * The type of preferred credential. Only 'BASIC' is supported currently. */ type: string; /** * The user name used to connect to the database. */ userName: string; } interface GetOneoffPatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetOneoffPatchesOneoffPatch { /** * (Updatable) The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * A valid Oracle Database version. To get a list of supported versions, use the [ListDbVersions](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/DbVersionSummary/ListDbVersions) operation. */ dbVersion: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; downloadOneoffPatchTrigger: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the one-off patch. */ id: string; /** * Detailed message for the lifecycle state. */ lifecycleDetails: string; /** * List of one-off patches for Database Homes. */ oneOffPatches: string[]; /** * The PSU or PBP or Release Updates. To get a list of supported versions, use the [ListDbVersions](https://docs.cloud.oracle.com/iaas/api/#/en/database/latest/DbVersionSummary/ListDbVersions) operation. */ releaseUpdate: string; /** * SHA-256 checksum of the one-off patch. */ sha256sum: string; /** * The size of one-off patch in kilobytes. */ sizeInKbs: number; /** * A filter to return only resources that match the given lifecycle state exactly */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time one-off patch was created. */ timeCreated: string; /** * The date and time until which the one-off patch will be available for download. */ timeOfExpiration: string; /** * The date and time one-off patch was updated. */ timeUpdated: string; } interface GetPluggableDatabaseConnectionString { /** * All connection strings to use to connect to the pluggable database. */ allConnectionStrings: { [key: string]: string; }; /** * A host name-based PDB connection string. */ pdbDefault: string; /** * An IP-based PDB connection string. */ pdbIpDefault: string; } interface GetPluggableDatabasePdbCreationTypeDetail { creationType: string; dblinkUserPassword: string; dblinkUsername: string; isThinClone: boolean; refreshableCloneDetails: outputs.Database.GetPluggableDatabasePdbCreationTypeDetailRefreshableCloneDetail[]; sourceContainerDatabaseAdminPassword: string; sourcePluggableDatabaseId: string; sourcePluggableDatabaseSnapshotId: string; } interface GetPluggableDatabasePdbCreationTypeDetailRefreshableCloneDetail { /** * Indicates whether the Pluggable Database is a refreshable clone. */ isRefreshableClone: boolean; } interface GetPluggableDatabasePdbNodeLevelDetail { /** * The Node name of the Database Instance. */ nodeName: string; /** * The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). */ openMode: string; } interface GetPluggableDatabasePluggableDatabaseManagementConfig { /** * The status of the Pluggable Database Management service. */ managementStatus: string; } interface GetPluggableDatabaseRefreshableCloneConfig { /** * Indicates whether the Pluggable Database is a refreshable clone. */ isRefreshableClone: boolean; } interface GetPluggableDatabaseSnapshotsFilter { /** * A filter to return only resources that match the entire name given. The match is not case sensitive. */ name: string; regex?: boolean; values: string[]; } interface GetPluggableDatabaseSnapshotsPluggableDatabaseSnapshot { /** * A filter to return only Exadata Database Node Snapshots that match the given VM cluster. */ clusterId: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database Snapshot. */ id: string; /** * Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot. */ lifecycleDetails: string; /** * A filter to return only resources that match the entire name given. The match is not case sensitive. */ name: string; /** * A filter to return only Exadata Pluggable Database Snapshots that match the given database [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ pluggableDatabaseId: string; /** * A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z */ timeCreated: string; } interface GetPluggableDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetPluggableDatabasesPluggableDatabase { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Connection strings to connect to an Oracle Pluggable Database. */ connectionStrings: outputs.Database.GetPluggableDatabasesPluggableDatabaseConnectionString[]; containerDatabaseAdminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CDB. */ containerDatabaseId: string; convertToRegularTrigger: number; /** * 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). */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pluggable database. */ id: string; /** * The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it. */ isRestricted: boolean; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances. */ kmsKeyVersionId: string; /** * Detailed message for the lifecycle state. */ lifecycleDetails: string; /** * The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). */ openMode: string; /** * The patch version of the pluggable database. */ patchVersion: string; pdbAdminPassword: string; pdbCreationTypeDetails: outputs.Database.GetPluggableDatabasesPluggableDatabasePdbCreationTypeDetail[]; /** * A filter to return only pluggable databases that match the entire name given. The match is not case sensitive. */ pdbName: string; /** * Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}] */ pdbNodeLevelDetails: outputs.Database.GetPluggableDatabasesPluggableDatabasePdbNodeLevelDetail[]; /** * The configuration of the Pluggable Database Management service. */ pluggableDatabaseManagementConfigs: outputs.Database.GetPluggableDatabasesPluggableDatabasePluggableDatabaseManagementConfig[]; refreshTrigger: number; /** * Pluggable Database Refreshable Clone Configuration. */ refreshableCloneConfigs: outputs.Database.GetPluggableDatabasesPluggableDatabaseRefreshableCloneConfig[]; rotateKeyTrigger: number; shouldCreatePdbBackup: boolean; shouldPdbAdminAccountBeLocked: boolean; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; tdeWalletPassword: string; /** * The date and time the pluggable database was created. */ timeCreated: string; } interface GetPluggableDatabasesPluggableDatabaseConnectionString { /** * All connection strings to use to connect to the pluggable database. */ allConnectionStrings: { [key: string]: string; }; /** * A host name-based PDB connection string. */ pdbDefault: string; /** * An IP-based PDB connection string. */ pdbIpDefault: string; } interface GetPluggableDatabasesPluggableDatabasePdbCreationTypeDetail { creationType: string; dblinkUserPassword: string; dblinkUsername: string; isThinClone: boolean; refreshableCloneDetails: outputs.Database.GetPluggableDatabasesPluggableDatabasePdbCreationTypeDetailRefreshableCloneDetail[]; sourceContainerDatabaseAdminPassword: string; sourcePluggableDatabaseId: string; sourcePluggableDatabaseSnapshotId: string; } interface GetPluggableDatabasesPluggableDatabasePdbCreationTypeDetailRefreshableCloneDetail { /** * Indicates whether the Pluggable Database is a refreshable clone. */ isRefreshableClone: boolean; } interface GetPluggableDatabasesPluggableDatabasePdbNodeLevelDetail { /** * The Node name of the Database Instance. */ nodeName: string; /** * The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). */ openMode: string; } interface GetPluggableDatabasesPluggableDatabasePluggableDatabaseManagementConfig { /** * The status of the Pluggable Database Management service. */ managementStatus: string; } interface GetPluggableDatabasesPluggableDatabaseRefreshableCloneConfig { /** * Indicates whether the Pluggable Database is a refreshable clone. */ isRefreshableClone: boolean; } interface GetScheduledActionActionMember { /** * The estimated patching time for the scheduled action. */ estimatedTimeInMins: number; /** * The ocid of the action member. */ memberId: string; /** * The order of the action member in a scheduled action. */ memberOrder: number; } interface GetScheduledActionParamsActionParamValuesCollection { /** * List of Action Parameters and their possible values. */ items: outputs.Database.GetScheduledActionParamsActionParamValuesCollectionItem[]; } interface GetScheduledActionParamsActionParamValuesCollectionItem { /** * The default value for this parameter. */ defaultValue: string; /** * Whether this parameter is required or not for this action type.、 */ isRequired: boolean; /** * The name of this parameter. */ parameterName: string; /** * The type of the parameter. */ parameterType: string; /** * Possible values for this parameter. In case of integer it's min and max values. */ parameterValues: string[]; } interface GetScheduledActionParamsFilter { name: string; regex?: boolean; values: string[]; } interface GetScheduledActionsFilter { name: string; regex?: boolean; values: string[]; } interface GetScheduledActionsScheduledActionCollection { items: outputs.Database.GetScheduledActionsScheduledActionCollectionItem[]; } interface GetScheduledActionsScheduledActionCollectionItem { /** * The list of action members in a scheduled action. */ actionMembers: outputs.Database.GetScheduledActionsScheduledActionCollectionItemActionMember[]; /** * The order of the scheduled action. */ actionOrder: number; /** * Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` */ actionParams: { [key: string]: string; }; /** * The type of the scheduled action being performed */ actionType: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The estimated patching time for the scheduled action. */ estimatedTimeInMins: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only resources that match the given Scheduled Action id exactly. */ id: string; /** * A filter to return only resources that match the given scheduling policy id exactly. */ schedulingPlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Scheduling Window. */ schedulingWindowId: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the Scheduled Action Resource was created. */ timeCreated: string; /** * The date and time the Scheduled Action Resource was updated. */ timeUpdated: string; } interface GetScheduledActionsScheduledActionCollectionItemActionMember { /** * The estimated patching time for the scheduled action. */ estimatedTimeInMins: number; /** * The ocid of the action member. */ memberId: string; /** * The order of the action member in a scheduled action. */ memberOrder: number; } interface GetSchedulingPlansFilter { name: string; regex?: boolean; values: string[]; } interface GetSchedulingPlansSchedulingPlanCollection { items: outputs.Database.GetSchedulingPlansSchedulingPlanCollectionItem[]; } interface GetSchedulingPlansSchedulingPlanCollectionItem { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The estimated time for the Scheduling Plan. */ estimatedTimeInMins: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only resources that match the given Schedule Plan id exactly. */ id: string; /** * If true, recommended scheduled actions will be generated for the scheduling plan. */ isUsingRecommendedScheduledActions: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current intent the Scheduling Plan. Valid states is EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE. */ planIntent: string; /** * A filter to return only resources that match the given resource id exactly. */ resourceId: string; /** * A filter to return only resources that match the given scheduling policy id exactly. */ schedulingPolicyId: string; /** * The service type of the Scheduling Plan. */ serviceType: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time the Scheduling Plan Resource was created. */ timeCreated: string; /** * The date and time the Scheduling Plan Resource was updated. */ timeUpdated: string; } interface GetSchedulingPoliciesFilter { /** * Name of the month of the year. */ name: string; regex?: boolean; values: string[]; } interface GetSchedulingPoliciesSchedulingPolicy { /** * The cadence period. */ cadence: string; /** * Start of the month to be followed during the cadence period. */ cadenceStartMonths: outputs.Database.GetSchedulingPoliciesSchedulingPolicyCadenceStartMonth[]; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Scheduling Policy. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the Scheduling Policy was created. */ timeCreated: string; /** * The date and time of the next scheduling window associated with the schedulingPolicy is planned to start. */ timeNextWindowStarts: string; /** * The last date and time that the Scheduling Policy was updated. */ timeUpdated: string; } interface GetSchedulingPoliciesSchedulingPolicyCadenceStartMonth { /** * Name of the month of the year. */ name: string; } interface GetSchedulingPolicyCadenceStartMonth { /** * Name of the month of the year. */ name: string; } interface GetSchedulingPolicyRecommendedScheduledActionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSchedulingPolicyRecommendedScheduledActionsRecommendedScheduledActionsCollection { /** * List of scheduled actions. */ items: outputs.Database.GetSchedulingPolicyRecommendedScheduledActionsRecommendedScheduledActionsCollectionItem[]; } interface GetSchedulingPolicyRecommendedScheduledActionsRecommendedScheduledActionsCollectionItem { /** * The list of action members in a scheduled action. */ actionMembers: outputs.Database.GetSchedulingPolicyRecommendedScheduledActionsRecommendedScheduledActionsCollectionItemActionMember[]; /** * The order of the scheduled action. */ actionOrder: number; /** * Map where a key value pair describes the specific action parameter. Example: `{"count": "3"}` */ actionParams: { [key: string]: string; }; /** * The type of the scheduled action being performed */ actionType: string; /** * Description of the scheduled action being performed, i.e. apply full update to DB Servers 1,2,3,4. */ displayName: string; /** * The estimated patching time in minutes for the entire scheduled action. */ estimatedTimeInMins: number; /** * The id of the scheduling window this scheduled action belongs to. */ schedulingWindowId: string; } interface GetSchedulingPolicyRecommendedScheduledActionsRecommendedScheduledActionsCollectionItemActionMember { /** * The estimated patching time in minutes for the entire scheduled action. */ estimatedTimeInMins: number; /** * The ocid of the action member. */ memberId: string; /** * The order of the action member in a scheduled action. */ memberOrder: number; } interface GetSchedulingPolicySchedulingWindowWindowPreference { /** * Days during the week when scheduling window should be performed. */ daysOfWeeks: outputs.Database.GetSchedulingPolicySchedulingWindowWindowPreferenceDaysOfWeek[]; /** * Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. */ duration: number; /** * Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. */ isEnforcedDuration: boolean; /** * Months during the year when scheduled window should be performed. */ months: outputs.Database.GetSchedulingPolicySchedulingWindowWindowPreferenceMonth[]; /** * The scheduling window start time. The value must use the ISO-8601 format "hh:mm". */ startTime: string; /** * Weeks during the month when scheduled window should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow scheduling window during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Scheduling window cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and startTime parameters to allow you to specify specific days of the week and hours that scheduled window will be performed. */ weeksOfMonths: number[]; } interface GetSchedulingPolicySchedulingWindowWindowPreferenceDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetSchedulingPolicySchedulingWindowWindowPreferenceMonth { /** * Name of the month of the year. */ name: string; } interface GetSchedulingPolicySchedulingWindowsFilter { /** * Name of the month of the year. */ name: string; regex?: boolean; values: string[]; } interface GetSchedulingPolicySchedulingWindowsSchedulingWindow { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Scheduling Window. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The Scheduling Policy [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ schedulingPolicyId: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the Scheduling Window was created. */ timeCreated: string; /** * The date and time of the next upcoming window associated within the schedulingWindow is planned to start. */ timeNextSchedulingWindowStarts: string; /** * The last date and time that the Scheduling Window was updated. */ timeUpdated: string; /** * The Single Scheduling Window details. */ windowPreferences: outputs.Database.GetSchedulingPolicySchedulingWindowsSchedulingWindowWindowPreference[]; } interface GetSchedulingPolicySchedulingWindowsSchedulingWindowWindowPreference { /** * Days during the week when scheduling window should be performed. */ daysOfWeeks: outputs.Database.GetSchedulingPolicySchedulingWindowsSchedulingWindowWindowPreferenceDaysOfWeek[]; /** * Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. */ duration: number; /** * Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. */ isEnforcedDuration: boolean; /** * Months during the year when scheduled window should be performed. */ months: outputs.Database.GetSchedulingPolicySchedulingWindowsSchedulingWindowWindowPreferenceMonth[]; /** * The scheduling window start time. The value must use the ISO-8601 format "hh:mm". */ startTime: string; /** * Weeks during the month when scheduled window should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow scheduling window during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Scheduling window cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and startTime parameters to allow you to specify specific days of the week and hours that scheduled window will be performed. */ weeksOfMonths: number[]; } interface GetSchedulingPolicySchedulingWindowsSchedulingWindowWindowPreferenceDaysOfWeek { /** * Name of the month of the year. */ name: string; } interface GetSchedulingPolicySchedulingWindowsSchedulingWindowWindowPreferenceMonth { /** * Name of the month of the year. */ name: string; } interface GetSystemVersionMinorVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSystemVersionMinorVersionsSystemVersionMinorVersionCollection { /** * List of System minor versions. */ items: outputs.Database.GetSystemVersionMinorVersionsSystemVersionMinorVersionCollectionItem[]; } interface GetSystemVersionMinorVersionsSystemVersionMinorVersionCollectionItem { /** * A valid system minor version. */ version: string; } interface GetSystemVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSystemVersionsSystemVersionCollection { /** * List of System versions. */ items: outputs.Database.GetSystemVersionsSystemVersionCollectionItem[]; } interface GetSystemVersionsSystemVersionCollectionItem { /** * Specifies gi version query parameter. */ giVersion: string; /** * If provided, filters the results for the given shape. */ shape: string; /** * Compatible Exadata system versions for a given shape and GI version. */ systemVersions: string[]; } interface GetVmClusterCloudAutomationUpdateDetail { /** * Configure the time slot for applying VM cloud automation software updates to the cluster. When nothing is selected, the default time slot is 12 AM to 2 AM UTC. Any 2-hour slot is available starting at 12 AM. */ applyUpdateTimePreferences: outputs.Database.GetVmClusterCloudAutomationUpdateDetailApplyUpdateTimePreference[]; /** * Enables a freeze period for the VM cluster prohibiting the VMs from getting cloud automation software updates during critical business cycles. Freeze period start date. Starts at 12:00 AM UTC on the selected date and ends at 11:59:59 PM UTC on the selected date. Validates to ensure the freeze period does not exceed 45 days. */ freezePeriods: outputs.Database.GetVmClusterCloudAutomationUpdateDetailFreezePeriod[]; /** * Annotates whether the cluster should be part of early access to apply VM cloud automation software updates. Those clusters annotated as early access will download the software bits for cloud automation in the first week after the update is available, while other clusters will have to wait until the following week. */ isEarlyAdoptionEnabled: boolean; /** * Specifies if the freeze period is enabled for the VM cluster to prevent the VMs from receiving cloud automation software updates during critical business cycles. Freeze period starts at 12:00 AM UTC and ends at 11:59:59 PM UTC on the selected date. Ensure that the freezing period does not exceed 45 days. */ isFreezePeriodEnabled: boolean; } interface GetVmClusterCloudAutomationUpdateDetailApplyUpdateTimePreference { /** * End time for polling VM cloud automation software updates for the cluster. If the endTime is not specified, 2 AM UTC is used by default. */ applyUpdatePreferredEndTime: string; /** * Start time for polling VM cloud automation software updates for the cluster. If the startTime is not specified, 12 AM UTC is used by default. */ applyUpdatePreferredStartTime: string; } interface GetVmClusterCloudAutomationUpdateDetailFreezePeriod { /** * End time of the freeze period cycle. */ freezePeriodEndTime: string; /** * Start time of the freeze period cycle. */ freezePeriodStartTime: string; } interface GetVmClusterDataCollectionOption { /** * Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface GetVmClusterFileSystemConfigurationDetail { /** * The file system size to be allocated in GBs. */ fileSystemSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface GetVmClusterLiveImageVersionDetail { /** * Indicates whether OS updates that require node reboot are pending after the previous online update was applied. */ hasPendingUpdates: boolean; /** * The release date and time for the applied Live Exadata Image OS version. */ timeReleased: string; /** * The OS live update mode performed most recently on the VM Cluster. */ updateMode: string; /** * Live Exadata Image Version of the Guest OS Update applied. */ version: string; } interface GetVmClusterNetworkDrScan { /** * The node host name. */ hostname: string; /** * The list of SCAN IP addresses. Three addresses should be provided. */ ips: string[]; /** * The SCAN TCPIP port. Default is 1521. */ scanListenerPortTcp: number; /** * The SCAN TCPIP SSL port. Default is 2484. */ scanListenerPortTcpSsl: number; } interface GetVmClusterNetworkScan { /** * The node host name. */ hostname: string; /** * The list of SCAN IP addresses. Three addresses should be provided. */ ips: string[]; /** * **Deprecated.** This field is deprecated. You may use 'scanListenerPortTcp' to specify the port. The SCAN TCPIP port. Default is 1521. */ port: number; /** * The SCAN TCPIP port. Default is 1521. */ scanListenerPortTcp: number; /** * The SCAN TCPIP SSL port. Default is 2484. */ scanListenerPortTcpSsl: number; } interface GetVmClusterNetworkVmNetwork { /** * The network domain name. */ domainName: string; /** * The network gateway. */ gateway: string; /** * The network netmask. */ netmask: string; /** * The network type. */ networkType: string; /** * The list of node details. */ nodes: outputs.Database.GetVmClusterNetworkVmNetworkNode[]; /** * The network VLAN ID. */ vlanId: string; } interface GetVmClusterNetworkVmNetworkNode { /** * The Db server associated with the node. */ dbServerId: string; /** * The node host name. */ hostname: string; /** * The node IP address. */ ip: string; /** * The current state of the VM cluster network nodes. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors. */ state: string; /** * The node virtual IP (VIP) address. */ vip: string; /** * The node virtual IP (VIP) host name. */ vipHostname: string; } interface GetVmClusterNetworksFilter { name: string; regex?: boolean; values: string[]; } interface GetVmClusterNetworksVmClusterNetwork { action: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * The list of DNS server IP addresses. Maximum of 3 allowed. */ dns: string[]; /** * The SCAN details for DR network */ drScans: outputs.Database.GetVmClusterNetworksVmClusterNetworkDrScan[]; /** * The Exadata infrastructure [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ exadataInfrastructureId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster network. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The list of NTP server IP addresses. Maximum of 3 allowed. */ ntps: string[]; /** * The SCAN details. */ scans: outputs.Database.GetVmClusterNetworksVmClusterNetworkScan[]; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * The date and time when the VM cluster network was created. */ timeCreated: string; validateVmClusterNetwork: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated VM Cluster. */ vmClusterId: string; /** * Details of the client and backup networks. */ vmNetworks: outputs.Database.GetVmClusterNetworksVmClusterNetworkVmNetwork[]; } interface GetVmClusterNetworksVmClusterNetworkDrScan { /** * The node host name. */ hostname: string; /** * The list of SCAN IP addresses. Three addresses should be provided. */ ips: string[]; /** * The SCAN TCPIP port. Default is 1521. */ scanListenerPortTcp: number; /** * The SCAN TCPIP SSL port. Default is 2484. */ scanListenerPortTcpSsl: number; } interface GetVmClusterNetworksVmClusterNetworkScan { /** * The node host name. */ hostname: string; /** * The list of SCAN IP addresses. Three addresses should be provided. */ ips: string[]; /** * **Deprecated.** This field is deprecated. You may use 'scanListenerPortTcp' to specify the port. The SCAN TCPIP port. Default is 1521. */ port: number; /** * The SCAN TCPIP port. Default is 1521. */ scanListenerPortTcp: number; /** * The SCAN TCPIP SSL port. Default is 2484. */ scanListenerPortTcpSsl: number; } interface GetVmClusterNetworksVmClusterNetworkVmNetwork { /** * The network domain name. */ domainName: string; /** * The network gateway. */ gateway: string; /** * The network netmask. */ netmask: string; /** * The network type. */ networkType: string; /** * The list of node details. */ nodes: outputs.Database.GetVmClusterNetworksVmClusterNetworkVmNetworkNode[]; /** * The network VLAN ID. */ vlanId: string; } interface GetVmClusterNetworksVmClusterNetworkVmNetworkNode { /** * The Db server associated with the node. */ dbServerId: string; /** * The node host name. */ hostname: string; /** * The node IP address. */ ip: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The node virtual IP (VIP) address. */ vip: string; /** * The node virtual IP (VIP) host name. */ vipHostname: string; } interface GetVmClusterPatchHistoryEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetVmClusterPatchHistoryEntriesPatchHistoryEntry { /** * The action being performed or was completed. */ action: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the patch history entry. */ id: string; /** * A descriptive text associated with the lifecycleState. Typically contains additional displayable text. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the patch. */ patchId: string; /** * The current state of the action. */ state: string; /** * The date and time when the patch action completed */ timeEnded: string; /** * The date and time when the patch action started. */ timeStarted: string; } interface GetVmClusterPatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetVmClusterPatchesPatch { /** * Actions that can possibly be performed using this patch. */ availableActions: string[]; /** * The text describing this patch package. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the patch. */ id: string; /** * Action that is currently being performed or was completed last. */ lastAction: string; /** * A descriptive text associated with the lifecycleState. Typically can contain additional displayable text. */ lifecycleDetails: string; /** * The current state of the patch as a result of lastAction. */ state: string; /** * The date and time that the patch was released. */ timeReleased: string; /** * The version of this patch package. */ version: string; } interface GetVmClusterRecommendedNetworkDrScan { /** * The node host name. */ hostname: string; /** * The list of SCAN IP addresses. Three addresses should be provided. */ ips: string[]; /** * The SCAN TCPIP port. Default is 1521. */ scanListenerPortTcp: number; /** * The SCAN TCPIP SSL port. Default is 2484. */ scanListenerPortTcpSsl: number; } interface GetVmClusterRecommendedNetworkNetwork { /** * The cidr for the network. */ cidr: string; /** * The network domain name. */ domain: string; /** * The network gateway. */ gateway: string; /** * The network netmask. */ netmask: string; /** * The network type. */ networkType: string; /** * The network domain name. */ prefix: string; /** * The network VLAN ID. */ vlanId: string; } interface GetVmClusterRecommendedNetworkScan { /** * The node host name. */ hostname: string; /** * The list of SCAN IP addresses. Three addresses should be provided. */ ips: string[]; /** * **Deprecated.** This field is deprecated. You may use 'scanListenerPortTcp' to specify the port. The SCAN TCPIP port. Default is 1521. */ port: number; /** * The SCAN TCPIP port. Default is 1521. */ scanListenerPortTcp: number; /** * The SCAN TCPIP SSL port. Default is 2484. */ scanListenerPortTcpSsl: number; } interface GetVmClusterRecommendedNetworkVmNetwork { /** * The network domain name. */ domainName: string; /** * The network gateway. */ gateway: string; /** * The network netmask. */ netmask: string; /** * The network type. */ networkType: string; /** * The list of node details. */ nodes: outputs.Database.GetVmClusterRecommendedNetworkVmNetworkNode[]; /** * The network VLAN ID. */ vlanId: string; } interface GetVmClusterRecommendedNetworkVmNetworkNode { /** * The Db server associated with the node. */ dbServerId: string; /** * The node host name. */ hostname: string; /** * The node IP address. */ ip: string; /** * The current state of the VM cluster network nodes. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors. */ state: string; /** * The node virtual IP (VIP) address. */ vip: string; /** * The node virtual IP (VIP) host name. */ vipHostname: string; } interface GetVmClusterUpdateDetail { updateAction: string; updateId: string; /** * The OS live update mode performed most recently on the VM Cluster. */ updateMode: string; } interface GetVmClusterUpdateHistoryEntriesFilter { name: string; regex?: boolean; values: string[]; } interface GetVmClusterUpdateHistoryEntriesVmClusterUpdateHistoryEntry { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance update history entry. */ id: string; /** * Descriptive text providing additional details about the lifecycle state. */ lifecycleDetails: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time when the maintenance update action completed. */ timeCompleted: string; /** * The date and time when the maintenance update action started. */ timeStarted: string; /** * The update action performed using this maintenance update. */ updateAction: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance update. */ updateId: string; /** * The OS update mode performed using this maintenance update. */ updateMode: string; /** * A filter to return only resources that match the given update type exactly. */ updateType: string; } interface GetVmClusterUpdatesFilter { name: string; regex?: boolean; values: string[]; } interface GetVmClusterUpdatesVmClusterUpdate { /** * The possible actions that can be performed using this maintenance update. */ availableActions: string[]; /** * The possible update options that can be performed using this maintenance update (only valid for OS Update). */ availableUpdateModes: string[]; /** * Details of the maintenance update package. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance update. */ id: string; /** * The update action performed most recently using this maintenance update. */ lastAction: string; /** * The update mode performed most recently using this maintenance update (only valid for OS Update). */ lastUpdateMode: string; /** * Descriptive text providing additional details about the lifecycle state. */ lifecycleDetails: string; /** * Oracle Linux version for the respective Exadata Image. */ oracleLinuxVersion: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * The date and time the maintenance update was released. */ timeReleased: string; /** * A filter to return only resources that match the given update type exactly. */ updateType: string; /** * The version of the maintenance update package. */ version: string; } interface GetVmClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetVmClustersVmCluster { /** * The name of the availability domain that the VM cluster is located in. */ availabilityDomain: string; /** * Specifies the properties necessary for cloud automation updates. This includes modifying the apply update time preference, enabling or disabling early adoption, and enabling, modifying, or disabling the update freeze period. */ cloudAutomationUpdateDetails: outputs.Database.GetVmClustersVmClusterCloudAutomationUpdateDetail[]; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The compute model of the Autonomous AI Database. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy. */ computeModel: string; cpuCoreCount: number; /** * The number of enabled CPU cores. */ cpusEnabled: number; /** * Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. */ dataCollectionOptions: outputs.Database.GetVmClustersVmClusterDataCollectionOption[]; /** * The percentage assigned to DATA storage (user data and database files). See [Storage Configuration](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. */ dataStoragePercentage: number; /** * Size of the DATA disk group in GBs. */ dataStorageSizeInGb: number; /** * Size, in terabytes, of the DATA disk group. */ dataStorageSizeInTbs: number; /** * The local node storage allocated in GBs. */ dbNodeStorageSizeInGbs: number; /** * The list of Db server. */ dbServers: string[]; /** * 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). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. The match is not case sensitive. */ displayName: string; /** * If provided, filters the results for the given Exadata Infrastructure. */ exadataInfrastructureId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault. */ exascaleDbStorageVaultId: string; /** * Details of the file system configuration of the VM cluster. */ fileSystemConfigurationDetails: outputs.Database.GetVmClustersVmClusterFileSystemConfigurationDetail[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The Oracle Grid Infrastructure software version for the VM cluster. */ giVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster. */ id: string; /** * If true, database backup on local Exadata storage is configured for the VM cluster. If false, database backup on local Exadata storage is not available in the VM cluster. */ isLocalBackupEnabled: boolean; /** * If true, sparse disk group is configured for the VM cluster. If false, sparse disk group is not created. */ isSparseDiskgroupEnabled: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. */ lastPatchHistoryEntryId: string; /** * The Oracle license model that applies to the VM cluster. The default is LICENSE_INCLUDED. */ licenseModel: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * Details about the most recent live image version applied on the VM Cluster, if any. If a full OS update was applied, the fields would be blank. */ liveImageVersionDetails: outputs.Database.GetVmClustersVmClusterLiveImageVersionDetail[]; /** * The memory allocated in GBs. */ memorySizeInGbs: number; ocpuCount: number; ocpusEnabled: number; /** * Oracle Linux version for the respective Exadata Image. */ oracleLinuxVersion: string; /** * The percentage assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). See [Storage Configuration](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. */ recoStoragePercentage: number; /** * The shape of the Exadata infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. */ shape: string; /** * The percentage assigned to SPARSE storage (Exadata snapshots). See [Storage Configuration](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. */ sparseStoragePercentage: number; /** * The public key portion of one or more key pairs used for SSH access to the VM cluster. */ sshPublicKeys: string[]; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * Specifies whether the type of storage management for the VM cluster is ASM or Exascale. */ storageManagementType: string; /** * 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). */ systemTags: { [key: string]: string; }; /** * Operating system version of the image. */ systemVersion: string; /** * The date and time that the VM cluster was created. */ timeCreated: string; /** * The time zone of the Exadata infrastructure. For details, see [Exadata Infrastructure Time Zones](https://docs.cloud.oracle.com/iaas/Content/Database/References/timezones.htm). */ timeZone: string; updateDetails: outputs.Database.GetVmClustersVmClusterUpdateDetail[]; /** * Specifies the type of VM Backups Storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then VM Backups storage will be on DB Servers. - EXASCALE if selected then VM Backups storage will be on Exascale Storage Servers. Default Value is LOCAL. */ vmBackupStorageType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster network. */ vmClusterNetworkId: string; /** * A filter to return only vmclusters that match the given vmcluster type exactly. */ vmClusterType: string; /** * Specifies the type of file system storage and supported values are LOCAL and EXASCALE. - LOCAL if selected then file system storage will be on DB Servers. - EXASCALE if selected then file system storage will be on Exascale Storage Servers. Default Value is LOCAL */ vmFileSystemStorageType: string; } interface GetVmClustersVmClusterCloudAutomationUpdateDetail { /** * Configure the time slot for applying VM cloud automation software updates to the cluster. When nothing is selected, the default time slot is 12 AM to 2 AM UTC. Any 2-hour slot is available starting at 12 AM. */ applyUpdateTimePreferences: outputs.Database.GetVmClustersVmClusterCloudAutomationUpdateDetailApplyUpdateTimePreference[]; /** * Enables a freeze period for the VM cluster prohibiting the VMs from getting cloud automation software updates during critical business cycles. Freeze period start date. Starts at 12:00 AM UTC on the selected date and ends at 11:59:59 PM UTC on the selected date. Validates to ensure the freeze period does not exceed 45 days. */ freezePeriods: outputs.Database.GetVmClustersVmClusterCloudAutomationUpdateDetailFreezePeriod[]; /** * Annotates whether the cluster should be part of early access to apply VM cloud automation software updates. Those clusters annotated as early access will download the software bits for cloud automation in the first week after the update is available, while other clusters will have to wait until the following week. */ isEarlyAdoptionEnabled: boolean; /** * Specifies if the freeze period is enabled for the VM cluster to prevent the VMs from receiving cloud automation software updates during critical business cycles. Freeze period starts at 12:00 AM UTC and ends at 11:59:59 PM UTC on the selected date. Ensure that the freezing period does not exceed 45 days. */ isFreezePeriodEnabled: boolean; } interface GetVmClustersVmClusterCloudAutomationUpdateDetailApplyUpdateTimePreference { /** * End time for polling VM cloud automation software updates for the cluster. If the endTime is not specified, 2 AM UTC is used by default. */ applyUpdatePreferredEndTime: string; /** * Start time for polling VM cloud automation software updates for the cluster. If the startTime is not specified, 12 AM UTC is used by default. */ applyUpdatePreferredStartTime: string; } interface GetVmClustersVmClusterCloudAutomationUpdateDetailFreezePeriod { /** * End time of the freeze period cycle. */ freezePeriodEndTime: string; /** * Start time of the freeze period cycle. */ freezePeriodStartTime: string; } interface GetVmClustersVmClusterDataCollectionOption { /** * Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface GetVmClustersVmClusterFileSystemConfigurationDetail { /** * The file system size to be allocated in GBs. */ fileSystemSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface GetVmClustersVmClusterLiveImageVersionDetail { /** * Indicates whether OS updates that require node reboot are pending after the previous online update was applied. */ hasPendingUpdates: boolean; /** * The release date and time for the applied Live Exadata Image OS version. */ timeReleased: string; /** * The OS live update mode performed most recently on the VM Cluster. */ updateMode: string; /** * Live Exadata Image Version of the Guest OS Update applied. */ version: string; } interface GetVmClustersVmClusterUpdateDetail { updateAction: string; updateId: string; /** * The OS live update mode performed most recently on the VM Cluster. */ updateMode: string; } interface KeyStoreAssociatedDatabase { /** * The name of the database that is associated with the key store. */ dbName: string; /** * The unique name of the database that is associated with the key store. */ dbUniqueName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store. */ id: string; } interface KeyStoreAssociatedLongTermBackup { /** * The user-friendly name for the key store. The name does not need to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store. */ id: string; } interface KeyStoreTypeDetails { /** * (Updatable) The administrator username to connect to Oracle Key Vault */ adminUsername: string; /** * (Updatable) The list of Oracle Key Vault connection IP addresses. */ connectionIps: string[]; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ secretId: string; /** * (Updatable) The type of key store. */ type: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `secretId` are required for Customer Managed Keys. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vaultId: string; } interface MaintenanceRunEstimatedPatchingTime { /** * The estimated time required in minutes for database server patching. */ estimatedDbServerPatchingTime: number; /** * The estimated time required in minutes for network switch patching. */ estimatedNetworkSwitchesPatchingTime: number; /** * The estimated time required in minutes for storage server patching. */ estimatedStorageServerPatchingTime: number; /** * The estimated total time required in minutes for all patching operations. */ totalEstimatedPatchingTime: number; } interface MaintenanceRunWindowTypeDescription { /** * A list of window detail messages from all the active execution windows based on the window type. */ messages: string[]; /** * The execution window is of PLANNED or UNPLANNED type. */ windowType: string; } interface PluggableDatabaseConnectionString { /** * All connection strings to use to connect to the pluggable database. */ allConnectionStrings: { [key: string]: string; }; /** * A host name-based PDB connection string. */ pdbDefault: string; /** * An IP-based PDB connection string. */ pdbIpDefault: string; } interface PluggableDatabaseManagementsManagementConnectionString { /** * All connection strings to use to connect to the pluggable database. */ allConnectionStrings: { [key: string]: string; }; /** * (Updatable) A required field when set to `true` calls enable action and when set to `false` calls disable action. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ enablePluggabledatabasemanagement: boolean; /** * A host name-based PDB connection string. */ pdbDefault: string; /** * An IP-based PDB connection string. */ pdbIpDefault: string; } interface PluggableDatabaseManagementsManagementCredentialDetails { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [secret](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). */ passwordSecretId: string; /** * The name of the Oracle Database user that will be used to connect to the database. */ userName: string; } interface PluggableDatabaseManagementsManagementPluggableDatabaseManagementConfig { /** * (Updatable) A required field when set to `true` calls enable action and when set to `false` calls disable action. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ enablePluggabledatabasemanagement: boolean; /** * The status of the Pluggable Database Management service. */ managementStatus: string; } interface PluggableDatabasePdbCreationTypeDetails { /** * The Pluggable Database creation type. */ creationType: string; /** * The DB link user password. */ dblinkUserPassword: string; /** * The name of the DB link user. */ dblinkUsername: string; /** * True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned. */ isThinClone: boolean; /** * Parameters for creating Pluggable Database Refreshable Clone. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. */ refreshableCloneDetails: outputs.Database.PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetails; /** * The DB system administrator password of the source Container Database. */ sourceContainerDatabaseAdminPassword: string; /** * The OCID of the Source Pluggable Database. */ sourcePluggableDatabaseId: string; /** * The OCID of the Source Pluggable Database Snapshot id. */ sourcePluggableDatabaseSnapshotId: string; } interface PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetails { /** * Indicates whether Pluggable Database is a refreshable clone. */ isRefreshableClone: boolean; } interface PluggableDatabasePdbNodeLevelDetail { /** * The Node name of the Database Instance. */ nodeName: string; /** * The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). */ openMode: string; } interface PluggableDatabasePluggableDatabaseManagementConfig { /** * The status of the Pluggable Database Management service. */ managementStatus: string; } interface PluggableDatabaseRefreshableCloneConfig { /** * Indicates whether the Pluggable Database is a refreshable clone. */ isRefreshableClone: boolean; } interface PluggableDatabasesLocalCloneConnectionString { /** * All connection strings to use to connect to the pluggable database. */ allConnectionStrings: { [key: string]: string; }; /** * A host name-based PDB connection string. */ pdbDefault: string; /** * An IP-based PDB connection string. */ pdbIpDefault: string; } interface PluggableDatabasesLocalClonePdbNodeLevelDetail { /** * The Node name of the Database Instance. */ nodeName: string; /** * The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). */ openMode: string; } interface PluggableDatabasesLocalClonePluggableDatabaseManagementConfig { /** * The status of the Pluggable Database Management service. */ managementStatus: string; } interface PluggableDatabasesLocalCloneRefreshableCloneConfig { /** * Indicates whether the Pluggable Database is a refreshable clone. */ isRefreshableClone: boolean; } interface PluggableDatabasesRemoteCloneConnectionString { /** * All connection strings to use to connect to the pluggable database. */ allConnectionStrings: { [key: string]: string; }; /** * A host name-based PDB connection string. */ pdbDefault: string; /** * An IP-based PDB connection string. */ pdbIpDefault: string; } interface PluggableDatabasesRemoteClonePdbNodeLevelDetail { /** * The Node name of the Database Instance. */ nodeName: string; /** * The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software). */ openMode: string; } interface PluggableDatabasesRemoteClonePluggableDatabaseManagementConfig { /** * The status of the Pluggable Database Management service. */ managementStatus: string; } interface PluggableDatabasesRemoteCloneRefreshableCloneConfig { /** * Indicates whether the Pluggable Database is a refreshable clone. */ isRefreshableClone: boolean; } interface ScheduledActionActionMember { /** * (Updatable) The estimated time for the intended action member. */ estimatedTimeInMins: number; /** * (Updatable) The ocid of the action member. */ memberId: string; /** * (Updatable) The order of the action member in a scheduled action. */ memberOrder: number; } interface SchedulingPolicyCadenceStartMonth { /** * (Updatable) Name of the month of the year. */ name: string; } interface SchedulingPolicySchedulingWindowWindowPreference { /** * (Updatable) Days during the week when scheduling window should be performed. */ daysOfWeeks: outputs.Database.SchedulingPolicySchedulingWindowWindowPreferenceDaysOfWeek[]; /** * (Updatable) Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes. */ duration: number; /** * (Updatable) Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`. */ isEnforcedDuration: boolean; /** * (Updatable) Months during the year when scheduled window should be performed. */ months: outputs.Database.SchedulingPolicySchedulingWindowWindowPreferenceMonth[]; /** * (Updatable) The scheduling window start time. The value must use the ISO-8601 format "hh:mm". */ startTime: string; /** * (Updatable) Weeks during the month when scheduled window should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow scheduling window during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Scheduling window cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and startTime parameters to allow you to specify specific days of the week and hours that scheduled window will be performed. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ weeksOfMonths: number[]; } interface SchedulingPolicySchedulingWindowWindowPreferenceDaysOfWeek { /** * (Updatable) Name of the day of the week. */ name: string; } interface SchedulingPolicySchedulingWindowWindowPreferenceMonth { /** * (Updatable) Name of the month of the year. */ name: string; } interface VmClusterAddVirtualNetworkCloudAutomationUpdateDetail { /** * Configure the time slot for applying VM cloud automation software updates to the cluster. When nothing is selected, the default time slot is 12 AM to 2 AM UTC. Any 2-hour slot is available starting at 12 AM. */ applyUpdateTimePreferences: outputs.Database.VmClusterAddVirtualNetworkCloudAutomationUpdateDetailApplyUpdateTimePreference[]; /** * Enables a freeze period for the VM cluster prohibiting the VMs from getting cloud automation software updates during critical business cycles. Freeze period start date. Starts at 12:00 AM UTC on the selected date and ends at 11:59:59 PM UTC on the selected date. Validates to ensure the freeze period does not exceed 45 days. */ freezePeriods: outputs.Database.VmClusterAddVirtualNetworkCloudAutomationUpdateDetailFreezePeriod[]; /** * Annotates whether the cluster should be part of early access to apply VM cloud automation software updates. Those clusters annotated as early access will download the software bits for cloud automation in the first week after the update is available, while other clusters will have to wait until the following week. */ isEarlyAdoptionEnabled: boolean; /** * Specifies if the freeze period is enabled for the VM cluster to prevent the VMs from receiving cloud automation software updates during critical business cycles. Freeze period starts at 12:00 AM UTC and ends at 11:59:59 PM UTC on the selected date. Ensure that the freezing period does not exceed 45 days. */ isFreezePeriodEnabled: boolean; } interface VmClusterAddVirtualNetworkCloudAutomationUpdateDetailApplyUpdateTimePreference { /** * End time for polling VM cloud automation software updates for the cluster. If the endTime is not specified, 2 AM UTC is used by default. */ applyUpdatePreferredEndTime: string; /** * Start time for polling VM cloud automation software updates for the cluster. If the startTime is not specified, 12 AM UTC is used by default. */ applyUpdatePreferredStartTime: string; } interface VmClusterAddVirtualNetworkCloudAutomationUpdateDetailFreezePeriod { /** * End time of the freeze period cycle. */ freezePeriodEndTime: string; /** * Start time of the freeze period cycle. */ freezePeriodStartTime: string; } interface VmClusterAddVirtualNetworkDataCollectionOption { /** * Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface VmClusterAddVirtualNetworkDbServer { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Exacc Db server. */ dbServerId: string; } interface VmClusterAddVirtualNetworkFileSystemConfigurationDetail { /** * The file system size to be allocated in GBs. */ fileSystemSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface VmClusterCloudAutomationUpdateDetails { /** * (Updatable) Configure the time slot for applying VM cloud automation software updates to the cluster. When nothing is selected, the default time slot is 12 AM to 2 AM UTC. Any 2-hour slot is available starting at 12 AM. */ applyUpdateTimePreference: outputs.Database.VmClusterCloudAutomationUpdateDetailsApplyUpdateTimePreference; /** * (Updatable) Enables a freeze period for the VM cluster prohibiting the VMs from getting cloud automation software updates during critical business cycles. Freeze period start date. Starts at 12:00 AM UTC on the selected date and ends at 11:59:59 PM UTC on the selected date. Validates to ensure the freeze period does not exceed 45 days. */ freezePeriod: outputs.Database.VmClusterCloudAutomationUpdateDetailsFreezePeriod; /** * (Updatable) Annotates whether the cluster should be part of early access to apply VM cloud automation software updates. Those clusters annotated as early access will download the software bits for cloud automation in the first week after the update is available, while other clusters will have to wait until the following week. */ isEarlyAdoptionEnabled: boolean; /** * (Updatable) Specifies if the freeze period is enabled for the VM cluster to prevent the VMs from receiving cloud automation software updates during critical business cycles. Freeze period starts at 12:00 AM UTC and ends at 11:59:59 PM UTC on the selected date. Ensure that the freezing period does not exceed 45 days. */ isFreezePeriodEnabled: boolean; } interface VmClusterCloudAutomationUpdateDetailsApplyUpdateTimePreference { /** * (Updatable) End time for polling VM cloud automation software updates for the cluster. If the endTime is not specified, 2 AM UTC is used by default. */ applyUpdatePreferredEndTime: string; /** * (Updatable) Start time for polling VM cloud automation software updates for the cluster. If the startTime is not specified, 12 AM UTC is used by default. */ applyUpdatePreferredStartTime: string; } interface VmClusterCloudAutomationUpdateDetailsFreezePeriod { /** * (Updatable) End time of the freeze period cycle. */ freezePeriodEndTime: string; /** * (Updatable) Start time of the freeze period cycle. */ freezePeriodStartTime: string; } interface VmClusterDataCollectionOptions { /** * (Updatable) Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * (Updatable) Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * (Updatable) Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface VmClusterFileSystemConfigurationDetail { /** * (Updatable) The file system size to be allocated in GBs. */ fileSystemSizeGb: number; /** * (Updatable) The mount point of file system. */ mountPoint: string; } interface VmClusterLiveImageVersionDetail { /** * Indicates whether OS updates that require node reboot are pending after the previous online update was applied. */ hasPendingUpdates: boolean; /** * The release date and time for the applied Live Exadata Image OS version. */ timeReleased: string; /** * The OS live update mode performed most recently on the VM Cluster. */ updateMode: string; /** * Live Exadata Image Version of the Guest OS Update applied. */ version: string; } interface VmClusterNetworkDrScan { /** * (Updatable) The Disaster recovery SCAN hostname. */ hostname: string; /** * (Updatable) The list of Disaster recovery SCAN IP addresses. Three addresses should be provided. */ ips: string[]; /** * (Updatable) The Disaster recovery SCAN TCPIP port. Default is 1521. */ scanListenerPortTcp: number; /** * (Updatable) The DR SCAN TCPIP SSL port. Default is 2484. */ scanListenerPortTcpSsl: number; } interface VmClusterNetworkScan { /** * (Updatable) The SCAN hostname. */ hostname: string; /** * (Updatable) The list of SCAN IP addresses. Three addresses should be provided. */ ips: string[]; /** * (Updatable) **Deprecated.** This field is deprecated. You may use 'scanListenerPortTcp' to specify the port. The SCAN TCPIP port. Default is 1521. */ port: number; /** * (Updatable) The SCAN TCPIP port. Default is 1521. */ scanListenerPortTcp: number; /** * (Updatable) The SCAN TCPIP SSL port. Default is 2484. */ scanListenerPortTcpSsl: number; } interface VmClusterNetworkVmNetwork { /** * (Updatable) The network domain name. */ domainName: string; /** * (Updatable) The network gateway. */ gateway: string; /** * (Updatable) The network netmask. */ netmask: string; /** * (Updatable) The network type. */ networkType: string; /** * (Updatable) The list of node details. */ nodes: outputs.Database.VmClusterNetworkVmNetworkNode[]; /** * (Updatable) The network VLAN ID. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vlanId: string; } interface VmClusterNetworkVmNetworkNode { /** * (Updatable) The Db server associated with the node. */ dbServerId: string; /** * (Updatable) The node host name. */ hostname: string; /** * (Updatable) The node IP address. */ ip: string; /** * (Updatable) The current state of the VM cluster network nodes. CREATING - The resource is being created REQUIRES_VALIDATION - The resource is created and may not be usable until it is validated. VALIDATING - The resource is being validated and not available to use. VALIDATED - The resource is validated and is available for consumption by VM cluster. VALIDATION_FAILED - The resource validation has failed and might require user input to be corrected. UPDATING - The resource is being updated and not available to use. ALLOCATED - The resource is currently being used by VM cluster. TERMINATING - The resource is being deleted and not available to use. TERMINATED - The resource is deleted and unavailable. FAILED - The resource is in a failed state due to validation or other errors. */ state: string; /** * (Updatable) The node virtual IP (VIP) address. */ vip: string; /** * (Updatable) The node virtual IP (VIP) host name. */ vipHostname: string; } interface VmClusterRemoveVirtualMachineCloudAutomationUpdateDetail { /** * Configure the time slot for applying VM cloud automation software updates to the cluster. When nothing is selected, the default time slot is 12 AM to 2 AM UTC. Any 2-hour slot is available starting at 12 AM. */ applyUpdateTimePreferences: outputs.Database.VmClusterRemoveVirtualMachineCloudAutomationUpdateDetailApplyUpdateTimePreference[]; /** * Enables a freeze period for the VM cluster prohibiting the VMs from getting cloud automation software updates during critical business cycles. Freeze period start date. Starts at 12:00 AM UTC on the selected date and ends at 11:59:59 PM UTC on the selected date. Validates to ensure the freeze period does not exceed 45 days. */ freezePeriods: outputs.Database.VmClusterRemoveVirtualMachineCloudAutomationUpdateDetailFreezePeriod[]; /** * Annotates whether the cluster should be part of early access to apply VM cloud automation software updates. Those clusters annotated as early access will download the software bits for cloud automation in the first week after the update is available, while other clusters will have to wait until the following week. */ isEarlyAdoptionEnabled: boolean; /** * Specifies if the freeze period is enabled for the VM cluster to prevent the VMs from receiving cloud automation software updates during critical business cycles. Freeze period starts at 12:00 AM UTC and ends at 11:59:59 PM UTC on the selected date. Ensure that the freezing period does not exceed 45 days. */ isFreezePeriodEnabled: boolean; } interface VmClusterRemoveVirtualMachineCloudAutomationUpdateDetailApplyUpdateTimePreference { /** * End time for polling VM cloud automation software updates for the cluster. If the endTime is not specified, 2 AM UTC is used by default. */ applyUpdatePreferredEndTime: string; /** * Start time for polling VM cloud automation software updates for the cluster. If the startTime is not specified, 12 AM UTC is used by default. */ applyUpdatePreferredStartTime: string; } interface VmClusterRemoveVirtualMachineCloudAutomationUpdateDetailFreezePeriod { /** * End time of the freeze period cycle. */ freezePeriodEndTime: string; /** * Start time of the freeze period cycle. */ freezePeriodStartTime: string; } interface VmClusterRemoveVirtualMachineDataCollectionOption { /** * Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` or `updateCloudVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster`, `UpdateCloudVmCluster` or `updateDbsystem` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster`, `updateCloudVmCluster` or `updateDbsystem` API. */ isIncidentLogsEnabled: boolean; } interface VmClusterRemoveVirtualMachineDbServer { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Exacc Db server. */ dbServerId: string; } interface VmClusterRemoveVirtualMachineFileSystemConfigurationDetail { /** * The file system size to be allocated in GBs. */ fileSystemSizeGb: number; /** * The mount point of file system. */ mountPoint: string; } interface VmClusterUpdateDetails { /** * (Updatable) The update action. Supported values include `ROLLING_APPLY`, `PRECHECK`, and `ROLLBACK`. */ updateAction?: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance update. */ updateId?: string; /** * (Updatable) The OS update mode. Supported values are `ONLINE_HIGHCVSS`, `ONLINE_ALLCVSS`, `ONLINE_ALL_UPDATES`, `PENDING_UPDATES`, and `FULL_UPDATE`. */ updateMode?: string; } } export declare namespace DatabaseManagement { interface AutonomousDatabaseAutonomousDatabaseDbmFeaturesManagementFeatureDetails { /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails?: outputs.DatabaseManagement.AutonomousDatabaseAutonomousDatabaseDbmFeaturesManagementFeatureDetailsConnectorDetails; /** * The connection details required to connect to the database. */ databaseConnectionDetails?: outputs.DatabaseManagement.AutonomousDatabaseAutonomousDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetails; /** * The name of the Database Management feature. */ feature: string; } interface AutonomousDatabaseAutonomousDatabaseDbmFeaturesManagementFeatureDetailsConnectorDetails { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector * * DIRECT: Direct connection */ connectorType?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId?: string; } interface AutonomousDatabaseAutonomousDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetails { /** * The credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials?: outputs.DatabaseManagement.AutonomousDatabaseAutonomousDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionCredentials; /** * The details of the Oracle Database connection string. */ connectionString?: outputs.DatabaseManagement.AutonomousDatabaseAutonomousDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionString; } interface AutonomousDatabaseAutonomousDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionCredentials { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. * * For example: inventorydb.abc112233445566778899 */ credentialName?: string; /** * The type of credential used to connect to the database. */ credentialType?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId?: string; /** * The role of the user connecting to the database. */ role?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId?: string; /** * The user name used to connect to the database. */ userName?: string; } interface AutonomousDatabaseAutonomousDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionString { /** * The list of supported connection types: * * BASIC: Basic connection details */ connectionType?: string; /** * The port number used to connect to the database. */ port?: number; /** * The protocol used to connect to the database. */ protocol?: string; /** * The service name of the database. */ service?: string; } interface CloudAsmServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud database resides. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the cloud database. */ dbUniqueName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * The list of ASM disk groups used by the database. */ diskGroups: string[]; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface CloudClusterNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface CloudClusterScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface CloudClusterVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface CloudDbSystemConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.CloudDbSystemConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.CloudDbSystemConnectorConnectionInfoConnectionString[]; } interface CloudDbSystemConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface CloudDbSystemConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface CloudDbSystemDatabaseManagementConfig { /** * The status of the associated service. */ isEnabled: boolean; /** * The associated service-specific inputs in JSON string format, which Database Management can identify. */ metadata: string; } interface CloudDbSystemDiscoveryDiscoveredComponent { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The list of ASM instances for the cloud Asm. */ asmInstances: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentAsmInstance[]; /** * The list of associated components. */ associatedComponents: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentAssociatedComponent[]; /** * Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database. */ canEnableAllCurrentPdbs: boolean; /** * The unique identifier of the Oracle cluster. */ clusterId: string; /** * The list of cluster instances for the cloud cluster. */ clusterInstances: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentClusterInstance[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud DB system resides. */ compartmentId: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The name of the discovered DB system component. */ componentName: string; /** * The component type. */ componentType: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The number of CPU cores available on the DB node. */ cpuCoreCount: number; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The Oracle Database edition. */ dbEdition: string; /** * The Oracle Database ID. */ dbId: string; /** * The list of database instances. */ dbInstances: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentDbInstance[]; /** * The name of the DB node. */ dbNodeName: string; /** * The database packs licensed for the cloud Oracle Database. */ dbPacks: string; /** * The role of the Oracle Database in Oracle Data Guard configuration. */ dbRole: string; /** * The type of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. */ dbType: string; /** * The `DB_UNIQUE_NAME` of the cloud database. */ dbUniqueName: string; /** * The Oracle Database version. */ dbVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The list of protocol addresses the listener is configured to listen on. */ endpoints: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentEndpoint[]; /** * The directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The unique identifier of the PDB. */ guid: string; /** * The location of the DB home. */ homeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database. */ isAutoEnablePluggableDatabase: boolean; /** * Indicates whether the Oracle Database is part of a cluster. */ isCluster: boolean; /** * Indicates whether the cluster is an Oracle Flex Cluster or not. */ isFlexCluster: boolean; /** * Indicates whether Oracle Flex ASM is enabled or not. */ isFlexEnabled: boolean; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring: boolean; /** * The listener alias. */ listenerAlias: string; /** * The type of listener. */ listenerType: string; /** * The destination directory of the listener log file. */ logDirectory: string; /** * The total memory in gigabytes (GB) on the DB node. */ memorySizeInGbs: number; /** * The list of network address configurations of the cloud cluster. */ networkConfigurations: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentNetworkConfiguration[]; /** * The name of the node with the VIP. */ nodeName: string; /** * The role of the cluster node. */ nodeRole: string; /** * The location of the Oracle Cluster Registry (OCR) file. */ ocrFileLocation: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; /** * The list of Pluggable Databases. */ pluggableDatabases: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentPluggableDatabase[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing Oracle Cloud Infrastructure resource matching the discovered DB system. */ resourceId: string; /** * The list of Single Client Access Name (SCAN) configurations of the cloud cluster. */ scanConfigurations: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentScanConfiguration[]; /** * The state of the discovered DB system component. */ status: string; /** * The destination directory of the listener trace file. */ traceDirectory: string; /** * The version of Oracle Clusterware running in the cluster. */ version: string; /** * The list of Virtual IP (VIP) configurations of the cloud cluster. */ vipConfigurations: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentVipConfiguration[]; } interface CloudDbSystemDiscoveryDiscoveredComponentAsmInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; } interface CloudDbSystemDiscoveryDiscoveredComponentAssociatedComponent { /** * The association type. */ associationType: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The component type. */ componentType: string; } interface CloudDbSystemDiscoveryDiscoveredComponentClusterInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The unique identifier of the Oracle cluster. */ clusterId: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnector[]; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The role of the cluster node. */ nodeRole: string; } interface CloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system discovery. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfo[]; /** * The status of connectivity to the cloud DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the cloud DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface CloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString[]; } interface CloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface CloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface CloudDbSystemDiscoveryDiscoveredComponentConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system discovery. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfo[]; /** * The status of connectivity to the cloud DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the cloud DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface CloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionString[]; } interface CloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface CloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface CloudDbSystemDiscoveryDiscoveredComponentDbInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * The name of the node with the VIP. */ nodeName: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; } interface CloudDbSystemDiscoveryDiscoveredComponentEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface CloudDbSystemDiscoveryDiscoveredComponentNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface CloudDbSystemDiscoveryDiscoveredComponentPluggableDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud DB system resides. */ compartmentId: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The unique identifier of the PDB. */ guid: string; } interface CloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system discovery. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfo[]; /** * The status of connectivity to the cloud DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the cloud DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface CloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.CloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString[]; } interface CloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface CloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface CloudDbSystemDiscoveryDiscoveredComponentScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface CloudDbSystemDiscoveryDiscoveredComponentVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface CloudDbSystemDiscoveryPatchOperation { /** * (Updatable) The operation can be one of these values: `MERGE` */ operation: string; /** * (Updatable) */ selection: string; /** * (Updatable) * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value?: outputs.DatabaseManagement.CloudDbSystemDiscoveryPatchOperationValue; } interface CloudDbSystemDiscoveryPatchOperationValue { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud DB system resides. */ compartmentId?: string; /** * The connector details used to connect to the cloud DB system component. */ connector?: outputs.DatabaseManagement.CloudDbSystemDiscoveryPatchOperationValueConnector; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName?: string; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring?: boolean; } interface CloudDbSystemDiscoveryPatchOperationValueConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system discovery. */ agentId?: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfo?: outputs.DatabaseManagement.CloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfo; /** * The type of connector. */ connectorType: string; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; } interface CloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials?: outputs.DatabaseManagement.CloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionCredentials; /** * The Oracle Database connection string. */ connectionString?: outputs.DatabaseManagement.CloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionString; } interface CloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionCredentials { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName?: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId?: string; /** * The role of the user connecting to the ASM instance. */ role?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId?: string; /** * The user name used to connect to the ASM instance. */ userName?: string; } interface CloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName?: string; /** * The list of host names of the ASM instances. */ hosts?: string[]; /** * The port used to connect to the ASM instance. */ port?: number; /** * The protocol used to connect to the ASM instance. */ protocol?: string; /** * The service name of the ASM instance. */ service?: string; } interface CloudDbSystemStackMonitoringConfig { /** * The status of the associated service. */ isEnabled: boolean; /** * The associated service-specific inputs in JSON string format, which Database Management can identify. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ metadata: string; } interface CloudExadataInfrastructureStorageGrid { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * (Updatable) The name of the Exadata infrastructure. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The number of Exadata storage servers in the Exadata infrastructure. */ serverCount: number; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface CloudExadataInfrastructureVmCluster { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The infrastructure deployment type. */ deploymentType: string; /** * (Updatable) The name of the Exadata infrastructure. */ displayName: string; /** * The Oracle home directory. */ homeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * (Updatable) The Oracle license model that applies to the database management resources. */ licenseModel: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface CloudExadataStorageConnectorCredentialInfo { /** * (Updatable) The password of the user. */ password: string; /** * (Updatable) The full path of the SSL truststore location in the agent. */ sslTrustStoreLocation: string; /** * (Updatable) The password of the SSL truststore location in the agent. */ sslTrustStorePassword: string; /** * (Updatable) The SSL truststore type. */ sslTrustStoreType: string; /** * (Updatable) The name of the user. */ username: string; } interface CloudExadataStorageGridStorageServer { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector. */ connectorId: string; /** * The CPU count of the Exadata storage server. */ cpuCount: number; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * (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"}` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The IP address of the Exadata storage server. */ ipAddress: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The make model of the Exadata storage server. */ makeModel: string; /** * The maximum flash disk IO operations per second of the Exadata storage server. */ maxFlashDiskIops: number; /** * The maximum flash disk IO throughput in MB/s of the Exadata storage server. */ maxFlashDiskThroughput: number; /** * The maximum hard disk IO operations per second of the Exadata storage server. */ maxHardDiskIops: number; /** * The maximum hard disk IO throughput in MB/s of the Exadata storage server. */ maxHardDiskThroughput: number; /** * The Exadata storage server memory size in GB. */ memoryGb: number; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface CloudExadataStorageServerConnector { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server. */ agentId: string; /** * The unique string of the connection. For example, "https:///MS/RESTService/". */ connectionUri: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * (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"}` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata storage server. */ storageServerId: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface CloudListenerEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port number. */ port: number; /** * The listener protocol. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface CloudListenerServicedAsm { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud database resides. */ compartmentId: string; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; } interface CloudListenerServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud database resides. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the cloud database. */ dbUniqueName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface DatabaseDbmFeaturesManagementFeatureDetails { /** * Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database. */ canEnableAllCurrentPdbs: boolean; /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails?: outputs.DatabaseManagement.DatabaseDbmFeaturesManagementFeatureDetailsConnectorDetails; /** * The connection details required to connect to the database. */ databaseConnectionDetails?: outputs.DatabaseManagement.DatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetails; /** * The name of the Database Management feature. */ feature: string; /** * Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database. */ isAutoEnablePluggableDatabase?: boolean; /** * The management type for the database. Use "BASIC" for basic management. Use "ADVANCED" for full management. */ managementType?: string; } interface DatabaseDbmFeaturesManagementFeatureDetailsConnectorDetails { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector * * DIRECT: Direct connection */ connectorType?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId?: string; } interface DatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetails { /** * The credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials?: outputs.DatabaseManagement.DatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionCredentials; /** * The details of the Oracle Database connection string. */ connectionString?: outputs.DatabaseManagement.DatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionString; } interface DatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionCredentials { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. * * For example: inventorydb.abc112233445566778899 */ credentialName?: string; /** * The type of credential used to connect to the database. */ credentialType?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId?: string; /** * The role of the user connecting to the database. */ role?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId?: string; /** * The user name used to connect to the database. */ userName?: string; } interface DatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionString { /** * The list of supported connection types: * * BASIC: Basic connection details */ connectionType?: string; /** * The port number used to connect to the database. */ port?: number; /** * The protocol used to connect to the database. */ protocol?: string; /** * The service name of the database. */ service?: string; } interface ExternalAsmServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the external database resides. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the external database. */ dbUniqueName: string; /** * The list of ASM disk groups used by the database. */ diskGroups: string[]; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface ExternalClusterNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface ExternalClusterScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface ExternalClusterVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface ExternalDbSystemConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.ExternalDbSystemConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.ExternalDbSystemConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.ExternalDbSystemConnectorConnectionInfoDatabaseCredential[]; } interface ExternalDbSystemConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface ExternalDbSystemConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface ExternalDbSystemConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface ExternalDbSystemDatabaseManagementConfig { /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface ExternalDbSystemDiscoveryDiscoveredComponent { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; asmInstances: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentAsmInstance[]; /** * The list of associated components. */ associatedComponents: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentAssociatedComponent[]; /** * Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database. */ canEnableAllCurrentPdbs: boolean; /** * The unique identifier of the Oracle cluster. */ clusterId: string; clusterInstances: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentClusterInstance[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the external DB system resides. */ compartmentId: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The name of the discovered DB system component. */ componentName: string; /** * The component type. */ componentType: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The number of CPU cores available on the DB node. */ cpuCoreCount: number; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The Oracle Database edition. */ dbEdition: string; /** * The Oracle Database ID. */ dbId: string; /** * The list of database instances. */ dbInstances: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentDbInstance[]; /** * The name of the DB node. */ dbNodeName: string; /** * The database packs licensed for the external Oracle Database. */ dbPacks: string; /** * The role of the Oracle Database in Oracle Data Guard configuration. */ dbRole: string; /** * The type of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. */ dbType: string; /** * The `DB_UNIQUE_NAME` of the external database. */ dbUniqueName: string; /** * The Oracle Database version. */ dbVersion: string; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The list of protocol addresses the listener is configured to listen on. */ endpoints: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentEndpoint[]; /** * The directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The unique identifier of the PDB. */ guid: string; /** * The location of the DB home. */ homeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database. */ isAutoEnablePluggableDatabase: boolean; /** * Indicates whether the Oracle Database is part of a cluster. */ isCluster: boolean; /** * Indicates whether the cluster is an Oracle Flex Cluster or not. */ isFlexCluster: boolean; /** * Indicates whether Oracle Flex ASM is enabled or not. */ isFlexEnabled: boolean; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring: boolean; /** * The listener alias. */ listenerAlias: string; /** * The type of listener. */ listenerType: string; /** * The destination directory of the listener log file. */ logDirectory: string; /** * The total memory in gigabytes (GB) on the DB node. */ memorySizeInGbs: number; /** * The list of network address configurations of the external cluster. */ networkConfigurations: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentNetworkConfiguration[]; /** * The name of the node with the VIP. */ nodeName: string; /** * The role of the cluster node. */ nodeRole: string; /** * The location of the Oracle Cluster Registry (OCR) file. */ ocrFileLocation: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; /** * The list of Pluggable Databases. */ pluggableDatabases: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabase[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing Oracle Cloud Infrastructure resource matching the discovered DB system. */ resourceId: string; /** * The list of Single Client Access Name (SCAN) configurations of the external cluster. */ scanConfigurations: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentScanConfiguration[]; /** * The state of the discovered DB system component. */ status: string; /** * The destination directory of the listener trace file. */ traceDirectory: string; /** * The version of Oracle Clusterware running in the cluster. */ version: string; /** * The list of Virtual IP (VIP) configurations of the external cluster. */ vipConfigurations: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentVipConfiguration[]; } interface ExternalDbSystemDiscoveryDiscoveredComponentAsmInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentAssociatedComponent { /** * The association type. */ associationType: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The component type. */ componentType: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentClusterInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The unique identifier of the Oracle cluster. */ clusterId: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnector[]; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The role of the cluster node. */ nodeRole: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system discovery. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfo[]; /** * The status of connectivity to the external DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the external DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoDatabaseCredential[]; } interface ExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system discovery. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfo[]; /** * The status of connectivity to the external DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the external DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoDatabaseCredential[]; } interface ExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentDbInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * The name of the node with the VIP. */ nodeName: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface ExternalDbSystemDiscoveryDiscoveredComponentNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the external DB system resides. */ compartmentId: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The unique identifier of the PDB. */ guid: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system discovery. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfo[]; /** * The status of connectivity to the external DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the external DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoDatabaseCredential[]; } interface ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface ExternalDbSystemDiscoveryDiscoveredComponentVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface ExternalDbSystemDiscoveryPatchOperation { /** * (Updatable) The operation can be one of these values: `MERGE` */ operation: string; /** * (Updatable) */ selection: string; /** * (Updatable) * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value?: outputs.DatabaseManagement.ExternalDbSystemDiscoveryPatchOperationValue; } interface ExternalDbSystemDiscoveryPatchOperationValue { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the external DB system resides. */ compartmentId?: string; /** * The connector details used to connect to the external DB system component. */ connector?: outputs.DatabaseManagement.ExternalDbSystemDiscoveryPatchOperationValueConnector; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName?: string; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring?: boolean; } interface ExternalDbSystemDiscoveryPatchOperationValueConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system discovery. */ agentId?: string; /** * The connection details required to connect to an external DB system component. */ connectionInfo?: outputs.DatabaseManagement.ExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfo; /** * The type of connector. */ connectorType: string; /** * (Updatable) The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; } interface ExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials?: outputs.DatabaseManagement.ExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionCredentials; /** * The Oracle Database connection string. */ connectionString?: outputs.DatabaseManagement.ExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionString; } interface ExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionCredentials { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName?: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId?: string; /** * The role of the database user. */ role?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId?: string; /** * The user name used to connect to the ASM instance. */ userName?: string; } interface ExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName?: string; /** * The list of host names of the ASM instances. */ hosts?: string[]; /** * The port used to connect to the ASM instance. */ port?: number; /** * The protocol used to connect to the ASM instance. */ protocol?: string; /** * The service name of the ASM instance. */ service?: string; } interface ExternalDbSystemStackMonitoringConfig { /** * The status of the associated service. */ isEnabled: boolean; /** * The associated service-specific inputs in JSON string format, which Database Management can identify. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ metadata: string; } interface ExternalExadataInfrastructureDatabaseSystem { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * (Updatable) The name of the Exadata infrastructure. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * (Updatable) The Oracle license model that applies to the database management resources. */ licenseModel: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface ExternalExadataInfrastructureStorageGrid { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * (Updatable) The name of the Exadata infrastructure. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The number of Exadata storage servers in the Exadata infrastructure. */ serverCount: number; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface ExternalExadataStorageConnectorCredentialInfo { /** * (Updatable) The password of the user. */ password: string; /** * (Updatable) The full path of the SSL truststore location in the agent. */ sslTrustStoreLocation: string; /** * (Updatable) The password of the SSL truststore location in the agent. */ sslTrustStorePassword: string; /** * (Updatable) The SSL truststore type. */ sslTrustStoreType: string; /** * (Updatable) The name of the user. */ username: string; } interface ExternalExadataStorageGridStorageServer { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector. */ connectorId: string; /** * The CPU count of the Exadata storage server. */ cpuCount: number; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * (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"}` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The IP address of the Exadata storage server. */ ipAddress: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The make model of the Exadata storage server. */ makeModel: string; /** * The maximum flash disk IO operations per second of the Exadata storage server. */ maxFlashDiskIops: number; /** * The maximum flash disk IO throughput in MB/s of the Exadata storage server. */ maxFlashDiskThroughput: number; /** * The maximum hard disk IO operations per second of the Exadata storage server. */ maxHardDiskIops: number; /** * The maximum hard disk IO throughput in MB/s of the Exadata storage server. */ maxHardDiskThroughput: number; /** * The Exadata storage server memory size in GB. */ memoryGb: number; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface ExternalExadataStorageServerConnector { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server. */ agentId: string; /** * The unique string of the connection. For example, "https:///MS/RESTService/". */ connectionUri: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * (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"}` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata storage server. */ storageServerId: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface ExternalListenerEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port number. */ port: number; /** * The listener protocol. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface ExternalListenerServicedAsm { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the external database resides. */ compartmentId: string; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; } interface ExternalListenerServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the external database resides. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the external database. */ dbUniqueName: string; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface ExternalMySqlDatabaseConnectorConnectorDetails { /** * (Updatable) Type of the credential. */ credentialType: string; /** * (Updatable) External MySQL Database Connector Name. */ displayName: string; /** * (Updatable) OCID of MySQL Database resource. */ externalDatabaseId: string; /** * (Updatable) Host name for Connector. */ hostName: string; /** * (Updatable) Agent Id of the MACS agent. */ macsAgentId: string; /** * (Updatable) Protocol to be used to connect to External MySQL Database; TCP, TCP with SSL or Socket. */ networkProtocol: string; /** * (Updatable) Port number to connect to External MySQL Database. */ port: number; /** * (Updatable) If using existing SSL secret to connect, OCID for the secret resource. */ sslSecretId: string; } interface ExternalcontainerdatabaseExternalContainerDbmFeaturesManagementFeatureDetails { /** * Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database. */ canEnableAllCurrentPdbs: boolean; /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails: outputs.DatabaseManagement.ExternalcontainerdatabaseExternalContainerDbmFeaturesManagementFeatureDetailsConnectorDetails; /** * The name of the Database Management feature. */ feature: string; /** * Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database. */ isAutoEnablePluggableDatabase: boolean; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface ExternalcontainerdatabaseExternalContainerDbmFeaturesManagementFeatureDetailsConnectorDetails { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector * * DIRECT: Direct connection */ connectorType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId: string; } interface ExternalnoncontainerdatabaseExternalNonContainerDbmFeaturesManagementFeatureDetails { /** * Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database. */ canEnableAllCurrentPdbs: boolean; /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails: outputs.DatabaseManagement.ExternalnoncontainerdatabaseExternalNonContainerDbmFeaturesManagementFeatureDetailsConnectorDetails; /** * The name of the Database Management feature. */ feature: string; /** * Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database. */ isAutoEnablePluggableDatabase: boolean; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface ExternalnoncontainerdatabaseExternalNonContainerDbmFeaturesManagementFeatureDetailsConnectorDetails { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector * * DIRECT: Direct connection */ connectorType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId: string; } interface ExternalpluggabledatabaseExternalPluggableDbmFeaturesManagementFeatureDetails { /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails: outputs.DatabaseManagement.ExternalpluggabledatabaseExternalPluggableDbmFeaturesManagementFeatureDetailsConnectorDetails; /** * The name of the Database Management feature. */ feature: string; } interface ExternalpluggabledatabaseExternalPluggableDbmFeaturesManagementFeatureDetailsConnectorDetails { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector * * DIRECT: Direct connection */ connectorType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId: string; } interface GetCloudAsmConfigurationInitParameter { /** * The user-friendly name for the ASM instance. The name does not have to be unique. */ asmInstanceDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud ASM instance. */ asmInstanceId: string; /** * The list of disk group names that an ASM instance mounts at startup or when the `ALTER DISKGROUP ALL MOUNT` statement is issued. */ autoMountDiskGroups: string[]; /** * An operating system-dependent value used to limit the set of disks considered for discovery. */ diskDiscoveryPath: string; /** * The list of failure groups that contain preferred read disks. */ preferredReadFailureGroups: string[]; /** * The maximum power on an ASM instance for disk rebalancing. */ rebalancePower: number; } interface GetCloudAsmDiskGroupsCloudAsmDiskGroupCollection { /** * An array of cloud ASM disk groups. */ items: outputs.DatabaseManagement.GetCloudAsmDiskGroupsCloudAsmDiskGroupCollectionItem[]; } interface GetCloudAsmDiskGroupsCloudAsmDiskGroupCollectionItem { /** * The unique names of the databases using the disk group. */ databases: string[]; /** * The number of ASM instances that have the disk group in dismounted state. */ dismountingInstanceCount: number; /** * Indicates whether the disk group is a sparse disk group or not. */ isSparse: boolean; /** * The number of ASM instances that have the disk group in mounted state. */ mountingInstanceCount: number; /** * The name of the ASM disk group. */ name: string; /** * The redundancy type of the disk group. */ redundancyType: string; /** * The total capacity of the disk group (in megabytes). */ totalSizeInMbs: string; /** * The percentage of used space in the disk group. */ usedPercent: number; /** * The used capacity of the disk group (in megabytes). */ usedSizeInMbs: string; } interface GetCloudAsmDiskGroupsFilter { /** * The name of the ASM disk group. */ name: string; regex?: boolean; values: string[]; } interface GetCloudAsmInstancesCloudAsmInstanceCollection { items: outputs.DatabaseManagement.GetCloudAsmInstancesCloudAsmInstanceCollectionItem[]; } interface GetCloudAsmInstancesCloudAsmInstanceCollectionItem { /** * The Automatic Diagnostic Repository (ADR) home directory for the ASM instance. */ adrHomeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud ASM. */ cloudAsmId: string; cloudAsmInstanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB node on which the ASM instance is running. */ cloudDbNodeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system that the ASM instance is a part of. */ cloudDbSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the cloud ASM instance. */ componentName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) in DBaas service. */ dbaasId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The name of the host on which the ASM instance is running. */ hostName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud ASM instance. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current lifecycle state of the cloud ASM instance. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cloud ASM instance was created. */ timeCreated: string; /** * The date and time the cloud ASM instance was last updated. */ timeUpdated: string; } interface GetCloudAsmInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudAsmServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud database resides. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the cloud database. */ dbUniqueName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * The list of ASM disk groups used by the database. */ diskGroups: string[]; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface GetCloudAsmUsersCloudAsmUserCollection { /** * An array of cloud ASM users. */ items: outputs.DatabaseManagement.GetCloudAsmUsersCloudAsmUserCollectionItem[]; } interface GetCloudAsmUsersCloudAsmUserCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud ASM. */ asmId: string; /** * The name of the ASM user. */ name: string; /** * The list of privileges of the ASM user. */ privileges: string[]; } interface GetCloudAsmUsersFilter { /** * The name of the ASM user. */ name: string; regex?: boolean; values: string[]; } interface GetCloudAsmsCloudAsmCollection { items: outputs.DatabaseManagement.GetCloudAsmsCloudAsmCollectionItem[]; } interface GetCloudAsmsCloudAsmCollectionItem { /** * The additional details of the cloud ASM defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; cloudAsmId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud connector. */ cloudConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system. */ cloudDbSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the cloud ASM. */ componentName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; /** * Indicates whether the ASM is a cluster ASM or not. */ isCluster: boolean; /** * Indicates whether Oracle Flex ASM is enabled or not. */ isFlexEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The list of databases that are serviced by the ASM. */ servicedDatabases: outputs.DatabaseManagement.GetCloudAsmsCloudAsmCollectionItemServicedDatabase[]; /** * The current lifecycle state of the cloud ASM. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cloud ASM was created. */ timeCreated: string; /** * The date and time the cloud ASM was last updated. */ timeUpdated: string; /** * The ASM version. */ version: string; } interface GetCloudAsmsCloudAsmCollectionItemServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the cloud database. */ dbUniqueName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * The list of ASM disk groups used by the database. */ diskGroups: string[]; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface GetCloudAsmsFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudClusterInstancesCloudClusterInstanceCollection { items: outputs.DatabaseManagement.GetCloudClusterInstancesCloudClusterInstanceCollectionItem[]; } interface GetCloudClusterInstancesCloudClusterInstanceCollectionItem { /** * The Automatic Diagnostic Repository (ADR) home directory for the cluster instance. */ adrHomeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud cluster. */ cloudClusterId: string; cloudClusterInstanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud connector. */ cloudConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB node. */ cloudDbNodeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system that the cluster instance is a part of. */ cloudDbSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the cloud cluster instance. */ componentName: string; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) in DBaas service. */ dbaasId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The name of the host on which the cluster instance is running. */ hostName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud cluster instance. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The role of the cluster node. */ nodeRole: string; /** * The current lifecycle state of the cloud cluster instance. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cloud cluster instance was created. */ timeCreated: string; /** * The date and time the cloud cluster instance was last updated. */ timeUpdated: string; } interface GetCloudClusterInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudClusterNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface GetCloudClusterScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface GetCloudClusterVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface GetCloudClustersCloudClusterCollection { items: outputs.DatabaseManagement.GetCloudClustersCloudClusterCollectionItem[]; } interface GetCloudClustersCloudClusterCollectionItem { /** * The additional details of the cloud cluster defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; cloudClusterId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud connector. */ cloudConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system. */ cloudDbSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the cloud cluster. */ componentName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) in DBaas service. */ dbaasId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud cluster. */ id: string; /** * Indicates whether the cluster is Oracle Flex Cluster or not. */ isFlexCluster: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The list of network address configurations of the cloud cluster. */ networkConfigurations: outputs.DatabaseManagement.GetCloudClustersCloudClusterCollectionItemNetworkConfiguration[]; /** * The location of the Oracle Cluster Registry (OCR). */ ocrFileLocation: string; /** * The list of Single Client Access Name (SCAN) configurations of the cloud cluster. */ scanConfigurations: outputs.DatabaseManagement.GetCloudClustersCloudClusterCollectionItemScanConfiguration[]; /** * The current lifecycle state of the cloud cluster. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cloud cluster was created. */ timeCreated: string; /** * The date and time the cloud cluster was last updated. */ timeUpdated: string; /** * The cluster version. */ version: string; /** * The list of Virtual IP (VIP) configurations of the cloud cluster. */ vipConfigurations: outputs.DatabaseManagement.GetCloudClustersCloudClusterCollectionItemVipConfiguration[]; } interface GetCloudClustersCloudClusterCollectionItemNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface GetCloudClustersCloudClusterCollectionItemScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface GetCloudClustersCloudClusterCollectionItemVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface GetCloudClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudDatabasesCloudDatabaseCollection { /** * An array of cloud databases. */ items: outputs.DatabaseManagement.GetCloudDatabasesCloudDatabaseCollectionItem[]; } interface GetCloudDatabasesCloudDatabaseCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB home. */ cloudDbHomeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The operating system of database. */ databasePlatformName: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or Non-container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The Oracle database version. */ databaseVersion: string; /** * The configuration details of Database Management for a cloud DB system. */ dbManagementConfigs: outputs.DatabaseManagement.GetCloudDatabasesCloudDatabaseCollectionItemDbManagementConfig[]; /** * The basic information about a cloud DB system. */ dbSystemInfos: outputs.DatabaseManagement.GetCloudDatabasesCloudDatabaseCollectionItemDbSystemInfo[]; /** * The `DB_UNIQUE_NAME` of the cloud database. */ dbUniqueName: string; /** * The list of feature configurations */ dbmgmtFeatureConfigs: outputs.DatabaseManagement.GetCloudDatabasesCloudDatabaseCollectionItemDbmgmtFeatureConfig[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system. */ id: string; /** * The list of database instances if the database is a RAC database. */ instanceDetails: outputs.DatabaseManagement.GetCloudDatabasesCloudDatabaseCollectionItemInstanceDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent Container Database (CDB) if this is a Pluggable Database (PDB). */ parentContainerDatabaseId: string; /** * The current lifecycle state of the cloud database resource. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cloud DB system was created. */ timeCreated: string; } interface GetCloudDatabasesCloudDatabaseCollectionItemDbManagementConfig { /** * The status of the associated service. */ isEnabled: boolean; /** * The associated service-specific inputs in JSON string format, which Database Management can identify. */ metadata: string; } interface GetCloudDatabasesCloudDatabaseCollectionItemDbSystemInfo { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system. */ id: string; } interface GetCloudDatabasesCloudDatabaseCollectionItemDbmgmtFeatureConfig { /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails: outputs.DatabaseManagement.GetCloudDatabasesCloudDatabaseCollectionItemDbmgmtFeatureConfigConnectorDetail[]; /** * The connection details required to connect to the database. */ databaseConnectionDetails: outputs.DatabaseManagement.GetCloudDatabasesCloudDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetail[]; /** * The name of the Database Management feature. */ feature: string; /** * The list of statuses for Database Management features. */ featureStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetCloudDatabasesCloudDatabaseCollectionItemDbmgmtFeatureConfigConnectorDetail { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector * * DIRECT: Direct connection */ connectorType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId: string; } interface GetCloudDatabasesCloudDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetail { /** * The credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDatabasesCloudDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionCredential[]; /** * The details of the Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDatabasesCloudDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionString[]; } interface GetCloudDatabasesCloudDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the database. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the database. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the database. */ userName: string; } interface GetCloudDatabasesCloudDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionString { /** * The list of supported connection types: * * BASIC: Basic connection details */ connectionType: string; /** * The port number used to connect to the database. */ port: number; /** * The protocol used to connect to the database. */ protocol: string; /** * The service name of the database. */ service: string; } interface GetCloudDatabasesCloudDatabaseCollectionItemInstanceDetail { /** * The name of the host machine. */ hostName: string; /** * The name of the database instance. */ instanceName: string; /** * The instance number of the database instance. */ instanceNumber: number; } interface GetCloudDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudDbHomesCloudDbHomeCollection { items: outputs.DatabaseManagement.GetCloudDbHomesCloudDbHomeCollectionItem[]; } interface GetCloudDbHomesCloudDbHomeCollectionItem { /** * The additional details of the DB home defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; cloudDbHomeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system. */ cloudDbSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the cloud DB home. */ componentName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB home in DBaas service. */ dbaasId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The location of the DB home. */ homeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB home. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current lifecycle state of the cloud DB home. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cloud DB home was created. */ timeCreated: string; /** * The date and time the cloud DB home was last updated. */ timeUpdated: string; } interface GetCloudDbHomesFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudDbNodesCloudDbNodeCollection { items: outputs.DatabaseManagement.GetCloudDbNodesCloudDbNodeCollectionItem[]; } interface GetCloudDbNodesCloudDbNodeCollectionItem { /** * The additional details of the cloud DB node defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud connector. */ cloudConnectorId: string; cloudDbNodeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system. */ cloudDbSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the cloud DB node. */ componentName: string; /** * The number of CPU cores available on the DB node. */ cpuCoreCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB node in DBaas service. */ dbaasId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The name of the domain. */ domainName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The host name for the DB node. */ hostName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB node. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The total memory in gigabytes (GB) on the DB node. */ memorySizeInGbs: number; /** * The current lifecycle state of the cloud DB node. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cloud DB node was created. */ timeCreated: string; /** * The date and time the cloud DB node was last updated. */ timeUpdated: string; } interface GetCloudDbNodesFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudDbSystemConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDbSystemConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDbSystemConnectorConnectionInfoConnectionString[]; } interface GetCloudDbSystemConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetCloudDbSystemConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetCloudDbSystemConnectorsCloudDbSystemConnectorCollection { items: outputs.DatabaseManagement.GetCloudDbSystemConnectorsCloudDbSystemConnectorCollectionItem[]; } interface GetCloudDbSystemConnectorsCloudDbSystemConnectorCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system connector. */ agentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system. */ cloudDbSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.GetCloudDbSystemConnectorsCloudDbSystemConnectorCollectionItemConnectionInfo[]; /** * The status of connectivity to the cloud DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system connector. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current lifecycle state of the cloud DB system connector. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the connectionStatus of the cloud DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; /** * The date and time the cloud DB system connector was created. */ timeCreated: string; /** * The date and time the cloud DB system connector was last updated. */ timeUpdated: string; } interface GetCloudDbSystemConnectorsCloudDbSystemConnectorCollectionItemConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDbSystemConnectorsCloudDbSystemConnectorCollectionItemConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDbSystemConnectorsCloudDbSystemConnectorCollectionItemConnectionInfoConnectionString[]; } interface GetCloudDbSystemConnectorsCloudDbSystemConnectorCollectionItemConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetCloudDbSystemConnectorsCloudDbSystemConnectorCollectionItemConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetCloudDbSystemConnectorsFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudDbSystemDatabaseManagementConfig { /** * The status of the associated service. */ isEnabled: boolean; /** * The associated service-specific inputs in JSON string format, which Database Management can identify. */ metadata: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollection { items: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItem[]; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system connector. */ agentId: string; cloudDbSystemDiscoveryId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent cloud DB Infrastructure. For VM DB systems , it will be the DBSystem ID. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively. */ dbaasParentInfrastructureId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The deployment type of cloud DB system. */ deploymentType: string; /** * The list of DB system components that were found in the DB system discovery. */ discoveredComponents: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponent[]; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system discovery. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; patchOperations: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperation[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing Oracle Cloud Infrastructure resource matching the discovered DB system. */ resourceId: string; /** * The current lifecycle state of the cloud DB system discovery resource. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cloud DB system discovery was created. */ timeCreated: string; /** * The date and time the cloud DB system discovery was last updated. */ timeUpdated: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponent { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The list of ASM instances for the cloud Asm. */ asmInstances: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentAsmInstance[]; /** * The list of associated components. */ associatedComponents: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentAssociatedComponent[]; /** * Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database. */ canEnableAllCurrentPdbs: boolean; /** * The unique identifier of the Oracle cluster. */ clusterId: string; /** * The list of cluster instances for the cloud cluster. */ clusterInstances: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstance[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The name of the discovered DB system component. */ componentName: string; /** * The component type. */ componentType: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The number of CPU cores available on the DB node. */ cpuCoreCount: number; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The Oracle Database edition. */ dbEdition: string; /** * The Oracle Database ID. */ dbId: string; /** * The list of database instances. */ dbInstances: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentDbInstance[]; /** * The name of the DB node. */ dbNodeName: string; /** * The database packs licensed for the cloud Oracle Database. */ dbPacks: string; /** * The role of the Oracle Database in Oracle Data Guard configuration. */ dbRole: string; /** * The type of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. */ dbType: string; /** * The `DB_UNIQUE_NAME` of the cloud database. */ dbUniqueName: string; /** * The Oracle Database version. */ dbVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The list of protocol addresses the listener is configured to listen on. */ endpoints: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentEndpoint[]; /** * The directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The unique identifier of the PDB. */ guid: string; /** * The location of the DB home. */ homeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database. */ isAutoEnablePluggableDatabase: boolean; /** * Indicates whether the Oracle Database is part of a cluster. */ isCluster: boolean; /** * Indicates whether the cluster is an Oracle Flex Cluster or not. */ isFlexCluster: boolean; /** * Indicates whether Oracle Flex ASM is enabled or not. */ isFlexEnabled: boolean; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring: boolean; /** * The listener alias. */ listenerAlias: string; /** * The type of listener. */ listenerType: string; /** * The destination directory of the listener log file. */ logDirectory: string; /** * The total memory in gigabytes (GB) on the DB node. */ memorySizeInGbs: number; /** * The list of network address configurations of the cloud cluster. */ networkConfigurations: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentNetworkConfiguration[]; /** * The name of the node with the VIP. */ nodeName: string; /** * The role of the cluster node. */ nodeRole: string; /** * The location of the Oracle Cluster Registry (OCR) file. */ ocrFileLocation: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; /** * The list of Pluggable Databases. */ pluggableDatabases: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabase[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing Oracle Cloud Infrastructure resource matching the discovered DB system. */ resourceId: string; /** * The list of Single Client Access Name (SCAN) configurations of the cloud cluster. */ scanConfigurations: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentScanConfiguration[]; /** * The state of the discovered DB system component. */ status: string; /** * The destination directory of the listener trace file. */ traceDirectory: string; /** * The version of Oracle Clusterware running in the cluster. */ version: string; /** * The list of Virtual IP (VIP) configurations of the cloud cluster. */ vipConfigurations: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentVipConfiguration[]; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentAsmInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentAssociatedComponent { /** * The association type. */ associationType: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The component type. */ componentType: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The unique identifier of the Oracle cluster. */ clusterId: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnector[]; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The role of the cluster node. */ nodeRole: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfo[]; /** * The status of connectivity to the cloud DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The date and time the connectionStatus of the cloud DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString[]; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfo[]; /** * The status of connectivity to the cloud DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The date and time the connectionStatus of the cloud DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfoConnectionString[]; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentDbInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * The name of the node with the VIP. */ nodeName: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The unique identifier of the PDB. */ guid: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfo[]; /** * The status of connectivity to the cloud DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The date and time the connectionStatus of the cloud DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString[]; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemDiscoveredComponentVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperation { operation: string; selection: string; values: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperationValue[]; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperationValue { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperationValueConnector[]; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring: boolean; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperationValueConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system connector. */ agentId: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfo[]; /** * The type of connector. */ connectorType: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfoConnectionString[]; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetCloudDbSystemDiscoveriesCloudDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetCloudDbSystemDiscoveriesFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudDbSystemDiscoveryDiscoveredComponent { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The list of ASM instances for the cloud Asm. */ asmInstances: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentAsmInstance[]; /** * The list of associated components. */ associatedComponents: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentAssociatedComponent[]; /** * Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database. */ canEnableAllCurrentPdbs: boolean; /** * The unique identifier of the Oracle cluster. */ clusterId: string; /** * The list of cluster instances for the cloud cluster. */ clusterInstances: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentClusterInstance[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The name of the discovered DB system component. */ componentName: string; /** * The component type. */ componentType: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The number of CPU cores available on the DB node. */ cpuCoreCount: number; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The Oracle Database edition. */ dbEdition: string; /** * The Oracle Database ID. */ dbId: string; /** * The list of database instances. */ dbInstances: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentDbInstance[]; /** * The name of the DB node. */ dbNodeName: string; /** * The database packs licensed for the cloud Oracle Database. */ dbPacks: string; /** * The role of the Oracle Database in Oracle Data Guard configuration. */ dbRole: string; /** * The type of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. */ dbType: string; /** * The `DB_UNIQUE_NAME` of the cloud database. */ dbUniqueName: string; /** * The Oracle Database version. */ dbVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The list of protocol addresses the listener is configured to listen on. */ endpoints: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentEndpoint[]; /** * The directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The unique identifier of the PDB. */ guid: string; /** * The location of the DB home. */ homeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database. */ isAutoEnablePluggableDatabase: boolean; /** * Indicates whether the Oracle Database is part of a cluster. */ isCluster: boolean; /** * Indicates whether the cluster is an Oracle Flex Cluster or not. */ isFlexCluster: boolean; /** * Indicates whether Oracle Flex ASM is enabled or not. */ isFlexEnabled: boolean; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring: boolean; /** * The listener alias. */ listenerAlias: string; /** * The type of listener. */ listenerType: string; /** * The destination directory of the listener log file. */ logDirectory: string; /** * The total memory in gigabytes (GB) on the DB node. */ memorySizeInGbs: number; /** * The list of network address configurations of the cloud cluster. */ networkConfigurations: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentNetworkConfiguration[]; /** * The name of the node with the VIP. */ nodeName: string; /** * The role of the cluster node. */ nodeRole: string; /** * The location of the Oracle Cluster Registry (OCR) file. */ ocrFileLocation: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; /** * The list of Pluggable Databases. */ pluggableDatabases: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentPluggableDatabase[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing Oracle Cloud Infrastructure resource matching the discovered DB system. */ resourceId: string; /** * The list of Single Client Access Name (SCAN) configurations of the cloud cluster. */ scanConfigurations: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentScanConfiguration[]; /** * The state of the discovered DB system component. */ status: string; /** * The destination directory of the listener trace file. */ traceDirectory: string; /** * The version of Oracle Clusterware running in the cluster. */ version: string; /** * The list of Virtual IP (VIP) configurations of the cloud cluster. */ vipConfigurations: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentVipConfiguration[]; } interface GetCloudDbSystemDiscoveryDiscoveredComponentAsmInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentAssociatedComponent { /** * The association type. */ associationType: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The component type. */ componentType: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentClusterInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The unique identifier of the Oracle cluster. */ clusterId: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnector[]; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The role of the cluster node. */ nodeRole: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfo[]; /** * The status of connectivity to the cloud DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the cloud DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString[]; } interface GetCloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfo[]; /** * The status of connectivity to the cloud DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the cloud DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionString[]; } interface GetCloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentDbInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * The name of the node with the VIP. */ nodeName: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface GetCloudDbSystemDiscoveryDiscoveredComponentNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentPluggableDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The unique identifier of the PDB. */ guid: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfo[]; /** * The status of connectivity to the cloud DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the cloud DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString[]; } interface GetCloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface GetCloudDbSystemDiscoveryDiscoveredComponentVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface GetCloudDbSystemDiscoveryPatchOperation { operation: string; selection: string; values: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryPatchOperationValue[]; } interface GetCloudDbSystemDiscoveryPatchOperationValue { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The connector details used to connect to the cloud DB system component. */ connectors: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryPatchOperationValueConnector[]; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring: boolean; } interface GetCloudDbSystemDiscoveryPatchOperationValueConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the cloud DB system connector. */ agentId: string; /** * The connection details required to connect to a cloud DB system component. */ connectionInfos: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfo[]; /** * The type of connector. */ connectorType: string; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; } interface GetCloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the Cloud ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetCloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionString[]; } interface GetCloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the ASM instance. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the ASM instance. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetCloudDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetCloudDbSystemStackMonitoringConfig { /** * The status of the associated service. */ isEnabled: boolean; /** * The associated service-specific inputs in JSON string format, which Database Management can identify. */ metadata: string; } interface GetCloudDbSystemsCloudDbSystemCollection { items: outputs.DatabaseManagement.GetCloudDbSystemsCloudDbSystemCollectionItem[]; } interface GetCloudDbSystemsCloudDbSystemCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The configuration details of Database Management for a cloud DB system. */ databaseManagementConfigs: outputs.DatabaseManagement.GetCloudDbSystemsCloudDbSystemCollectionItemDatabaseManagementConfig[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system discovery. */ dbSystemDiscoveryId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dbaas parent infrastructure of the cloud DB system. */ dbaasParentInfrastructureId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return cloud DB systems of the specified deployment type. */ deploymentType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used during the discovery of the DB system. */ discoveryAgentId: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system. */ homeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system. */ id: string; /** * Indicates whether the DB system is a cluster DB system or not. */ isCluster: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The configuration details of Stack Monitoring for a cloud DB system. */ stackMonitoringConfigs: outputs.DatabaseManagement.GetCloudDbSystemsCloudDbSystemCollectionItemStackMonitoringConfig[]; /** * The lifecycle state of a resource. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cloud DB system was created. */ timeCreated: string; /** * The date and time the cloud DB system was last updated. */ timeUpdated: string; } interface GetCloudDbSystemsCloudDbSystemCollectionItemDatabaseManagementConfig { /** * The status of the associated service. */ isEnabled: boolean; /** * The associated service-specific inputs in JSON string format, which Database Management can identify. */ metadata: string; } interface GetCloudDbSystemsCloudDbSystemCollectionItemStackMonitoringConfig { /** * The status of the associated service. */ isEnabled: boolean; /** * The associated service-specific inputs in JSON string format, which Database Management can identify. */ metadata: string; } interface GetCloudDbSystemsFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudExadataInfrastructureStorageGrid { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The number of Exadata storage servers in the Exadata infrastructure. */ serverCount: number; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetCloudExadataInfrastructureVmCluster { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The infrastructure deployment type. */ deploymentType: string; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * The Oracle home directory. */ homeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The Oracle license model that applies to the database management resources. */ licenseModel: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureCollection { items: outputs.DatabaseManagement.GetCloudExadataInfrastructuresCloudExadataInfrastructureCollectionItem[]; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureCollectionItem { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The list of [OCIDs] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartments. */ databaseCompartments: string[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The infrastructure deployment type. */ deploymentType: string; discoveryKey: string; /** * The optional single value query filter parameter on the entity display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; infrastructureType: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The Oracle license model that applies to the database management resources. */ licenseModel: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The rack size of the Exadata infrastructure. */ rackSize: string; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The Exadata storage server grid of the Exadata infrastructure. */ storageGrids: outputs.DatabaseManagement.GetCloudExadataInfrastructuresCloudExadataInfrastructureCollectionItemStorageGrid[]; storageServerNames: string[]; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; vmClusterIds: string[]; /** * The list of VM Clusters in the Exadata infrastructure. */ vmClusters: outputs.DatabaseManagement.GetCloudExadataInfrastructuresCloudExadataInfrastructureCollectionItemVmCluster[]; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureCollectionItemStorageGrid { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The optional single value query filter parameter on the entity display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The number of Exadata storage servers in the Exadata infrastructure. */ serverCount: number; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetCloudExadataInfrastructuresCloudExadataInfrastructureCollectionItemVmCluster { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The infrastructure deployment type. */ deploymentType: string; /** * The optional single value query filter parameter on the entity display name. */ displayName: string; /** * The Oracle home directory. */ homeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The Oracle license model that applies to the database management resources. */ licenseModel: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetCloudExadataInfrastructuresFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudExadataStorageConnectorCredentialInfo { password: string; sslTrustStoreLocation: string; sslTrustStorePassword: string; sslTrustStoreType: string; username: string; } interface GetCloudExadataStorageConnectorsCloudExadataStorageConnectorCollection { items: outputs.DatabaseManagement.GetCloudExadataStorageConnectorsCloudExadataStorageConnectorCollectionItem[]; } interface GetCloudExadataStorageConnectorsCloudExadataStorageConnectorCollectionItem { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server. */ agentId: string; /** * The unique string of the connection. For example, "https:///MS/RESTService/". */ connectionUri: string; credentialInfos: outputs.DatabaseManagement.GetCloudExadataStorageConnectorsCloudExadataStorageConnectorCollectionItemCredentialInfo[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The optional single value query filter parameter on the entity display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. */ exadataInfrastructureId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata storage server. */ storageServerId: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetCloudExadataStorageConnectorsCloudExadataStorageConnectorCollectionItemCredentialInfo { password: string; sslTrustStoreLocation: string; sslTrustStorePassword: string; sslTrustStoreType: string; username: string; } interface GetCloudExadataStorageConnectorsFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudExadataStorageGridStorageServer { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector. */ connectorId: string; /** * The CPU count of the Exadata storage server. */ cpuCount: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The IP address of the Exadata storage server. */ ipAddress: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The make model of the Exadata storage server. */ makeModel: string; /** * The maximum flash disk IO operations per second of the Exadata storage server. */ maxFlashDiskIops: number; /** * The maximum flash disk IO throughput in MB/s of the Exadata storage server. */ maxFlashDiskThroughput: number; /** * The maximum hard disk IO operations per second of the Exadata storage server. */ maxHardDiskIops: number; /** * The maximum hard disk IO throughput in MB/s of the Exadata storage server. */ maxHardDiskThroughput: number; /** * The Exadata storage server memory size in GB. */ memoryGb: number; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetCloudExadataStorageServerConnector { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server. */ agentId: string; /** * The unique string of the connection. For example, "https:///MS/RESTService/". */ connectionUri: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata storage server. */ storageServerId: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetCloudExadataStorageServerIormPlanDbPlan { /** * A list of DatabasePlanDirectives. */ items: outputs.DatabaseManagement.GetCloudExadataStorageServerIormPlanDbPlanItem[]; } interface GetCloudExadataStorageServerIormPlanDbPlanItem { /** * The resource allocation as a percentage (0-100) within the level. */ allocation: number; /** * Starting with Oracle Exadata System Software release 19.1.0, you can use the asmcluster attribute to distinguish between databases with the same name running in different Oracle ASM clusters. */ asmCluster: string; /** * Defines a soft limit for space usage in Exadata Smart Flash Cache. If the cache is not full, the limit can be exceeded. You specify the value for flashcachelimit in bytes. You can also use the suffixes M (megabytes), G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T. The value for flashcachelimit must be at least 4 MB. The flashcachelimit and flashcachesize attributes cannot be specified in the same directive. The value for flashcachelimit cannot be smaller than flashcachemin, if it is specified. */ flashCacheLimit: string; /** * Specifies a minimum guaranteed space allocation in Exadata Smart Flash Cache. You specify the value for flashcachemin in bytes. You can also use the suffixes M (megabytes), G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T. The value for flashcachemin must be at least 4 MB. In any plan, the sum of all flashcachemin values cannot exceed the size of Exadata Smart Flash Cache. If flashcachelimit is specified, then the value for flashcachemin cannot exceed flashcachelimit. If flashcachesize is specified, then the value for flashcachemin cannot exceed flashcachesize. */ flashCacheMin: string; /** * Defines a hard limit for space usage in Exadata Smart Flash Cache. The limit cannot be exceeded, even if the cache is not full. In an IORM plan, if the size of Exadata Smart Flash Cache can accommodate all of the flashcachemin and flashcachesize allocations, then each flashcachesize definition represents a guaranteed space allocation. However, starting with Oracle Exadata System Software release 19.2.0 you can use the flashcachesize attribute to over-provision space in Exadata Smart Flash Cache. Consequently, if the size of Exadata Smart Flash Cache cannot accommodate all of the flashcachemin and flashcachesize allocations, then only flashcachemin is guaranteed. */ flashCacheSize: string; /** * Controls use of Exadata Smart Flash Cache by a database. This ensures that cache space is reserved for mission-critical databases. flashcache=off is invalid in a directive that contains the flashcachemin, flashcachelimit, or flashcachesize attributes. */ isFlashCacheOn: boolean; /** * Controls use of Exadata Smart Flash Log by a database. This ensures that Exadata Smart Flash Log is reserved for mission-critical databases. */ isFlashLogOn: boolean; /** * Controls use of the persistent memory (PMEM) cache by a database. This ensures that cache space is reserved for mission-critical databases. pmemcache=off is invalid in a directive that contains the pmemcachemin, pmemcachelimit, or pmemcachesize attributes. */ isPmemCacheOn: boolean; /** * Controls use of persistent memory logging (PMEM log) by a database. This ensures that PMEM log is reserved for mission-critical databases. */ isPmemLogOn: boolean; /** * The allocation level. Valid values are from 1 to 8. Resources are allocated to level 1 first, and then remaining resources are allocated to level 2, and so on. */ level: number; /** * The name of a database or a profile. */ name: string; /** * Defines a soft limit for space usage in the persistent memory (PMEM) cache. If the cache is not full, the limit can be exceeded. You specify the value for pmemcachelimit in bytes. You can also use the suffixes M (megabytes), G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T. The value for pmemcachelimit must be at least 4 MB. The pmemcachelimit and pmemcachesize attributes cannot be specified in the same directive. The value for pmemcachelimit cannot be smaller than pmemcachemin, if it is specified. */ pmemCacheLimit: string; /** * Specifies a minimum guaranteed space allocation in the persistent memory (PMEM) cache. */ pmemCacheMin: string; /** * Defines a hard limit for space usage in the persistent memory (PMEM) cache. The limit cannot be exceeded, even if the cache is not full. In an IORM plan, if the size of the PMEM cache can accommodate all of the pmemcachemin and pmemcachesize allocations, then each pmemcachesize definition represents a guaranteed space allocation. However, you can use the pmemcachesize attribute to over-provision space in the PMEM cache. Consequently, if the PMEM cache size cannot accommodate all of the pmemcachemin and pmemcachesize allocations, then only pmemcachemin is guaranteed. */ pmemCacheSize: string; /** * Enables you to specify different plan directives based on the Oracle Data Guard database role. */ role: string; /** * The relative priority of a database in the database plan. A higher share value implies higher priority and more access to the I/O resources. Use either share or (level, allocation). All plan directives in a database plan should use the same setting. Share-based resource allocation is the recommended method for a database plan. */ share: number; /** * Enables you to create a profile or template, to ease management and configuration of resource plans in environments with many databases. * * type=database: Specifies a directive that applies to a specific database. If type in not specified, then the directive defaults to the database type. * * type=profile: Specifies a directive that applies to a profile rather than a specific database. */ type: string; } interface GetCloudExadataStorageServerOpenAlertHistoryAlert { /** * The alert message. */ message: string; /** * The severity of the alert. */ severity: string; /** * The start time of the alert. */ timeStartAt: string; /** * The type of alert. */ type: string; } interface GetCloudExadataStorageServersCloudExadataStorageServerCollection { items: outputs.DatabaseManagement.GetCloudExadataStorageServersCloudExadataStorageServerCollectionItem[]; } interface GetCloudExadataStorageServersCloudExadataStorageServerCollectionItem { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; connectorId: string; /** * The CPU count of the Exadata storage server. */ cpuCount: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The optional single value query filter parameter on the entity display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. */ exadataInfrastructureId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The IP address of the Exadata storage server. */ ipAddress: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The make model of the Exadata storage server. */ makeModel: string; /** * The maximum flash disk IO operations per second of the Exadata storage server. */ maxFlashDiskIops: number; /** * The maximum flash disk IO throughput in MB/s of the Exadata storage server. */ maxFlashDiskThroughput: number; /** * The maximum hard disk IO operations per second of the Exadata storage server. */ maxHardDiskIops: number; /** * The maximum hard disk IO throughput in MB/s of the Exadata storage server. */ maxHardDiskThroughput: number; /** * The Exadata storage server memory size in GB. */ memoryGb: number; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata storage server grid. */ storageGridId: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetCloudExadataStorageServersFilter { name: string; regex?: boolean; values: string[]; } interface GetCloudListenerEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port number. */ port: number; /** * The listener protocol. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface GetCloudListenerServicedAsm { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud database resides. */ compartmentId: string; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; } interface GetCloudListenerServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud database resides. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the cloud database. */ dbUniqueName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface GetCloudListenerServicesCloudListenerServiceCollection { /** * An array of cloud listener services. */ items: outputs.DatabaseManagement.GetCloudListenerServicesCloudListenerServiceCollectionItem[]; } interface GetCloudListenerServicesCloudListenerServiceCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud listener. */ listenerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Managed Database. */ managedDatabaseId: string; /** * The name of the service. */ name: string; } interface GetCloudListenerServicesFilter { /** * The name of the service. */ name: string; regex?: boolean; values: string[]; } interface GetCloudListenersCloudListenerCollection { items: outputs.DatabaseManagement.GetCloudListenersCloudListenerCollectionItem[]; } interface GetCloudListenersCloudListenerCollectionItem { /** * The additional details of the cloud listener defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled. */ adrHomeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud connector. */ cloudConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB home. */ cloudDbHomeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB node. */ cloudDbNodeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud DB system. */ cloudDbSystemId: string; cloudListenerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the cloud listener. */ componentName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The list of protocol addresses the listener is configured to listen on. */ endpoints: outputs.DatabaseManagement.GetCloudListenersCloudListenerCollectionItemEndpoint[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The name of the host on which the cloud listener is running. */ hostName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The listener alias. */ listenerAlias: string; /** * The location of the listener configuration file listener.ora. */ listenerOraLocation: string; /** * The type of listener. */ listenerType: string; /** * The destination directory of the listener log file. */ logDirectory: string; /** * The Oracle home location of the listener. */ oracleHome: string; /** * The list of ASMs that are serviced by the listener. */ servicedAsms: outputs.DatabaseManagement.GetCloudListenersCloudListenerCollectionItemServicedAsm[]; /** * The list of databases that are serviced by the listener. */ servicedDatabases: outputs.DatabaseManagement.GetCloudListenersCloudListenerCollectionItemServicedDatabase[]; /** * The current lifecycle state of the cloud listener. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cloud listener was created. */ timeCreated: string; /** * The date and time the cloud listener was last updated. */ timeUpdated: string; /** * The destination directory of the listener trace file. */ traceDirectory: string; /** * The listener version. */ version: string; } interface GetCloudListenersCloudListenerCollectionItemEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port number. */ port: number; /** * The listener protocol. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface GetCloudListenersCloudListenerCollectionItemServicedAsm { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; } interface GetCloudListenersCloudListenerCollectionItemServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the cloud database. */ dbUniqueName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing DBaas Oracle Cloud Infrastructure resource matching the discovered DB system component. */ dbaasId: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface GetCloudListenersFilter { name: string; regex?: boolean; values: string[]; } interface GetDbManagementPrivateEndpointAssociatedDatabaseItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ id: string; /** * The name of the database. */ name: string; /** * The time when Database Management was enabled for the database. */ timeRegistered: string; } interface GetDbManagementPrivateEndpointAssociatedDatabasesAssociatedDatabaseCollection { /** * A list of databases using a Database Management private endpoint. */ items: outputs.DatabaseManagement.GetDbManagementPrivateEndpointAssociatedDatabasesAssociatedDatabaseCollectionItem[]; } interface GetDbManagementPrivateEndpointAssociatedDatabasesAssociatedDatabaseCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ id: string; /** * The name of the database. */ name: string; /** * The time when Database Management was enabled for the database. */ timeRegistered: string; } interface GetDbManagementPrivateEndpointAssociatedDatabasesFilter { /** * The name of the database. */ name: string; regex?: boolean; values: string[]; } interface GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollection { items: outputs.DatabaseManagement.GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollectionItem[]; } interface GetDbManagementPrivateEndpointsDbManagementPrivateEndpointCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the Database Management private endpoint. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint. */ id: string; /** * The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter. */ isCluster: boolean; /** * The option to filter Database Management private endpoints which are endbled with DNS proxy server. This should be used along with the vcnId query parameter. Only one of this parameter and IsClusterDbManagementPrivateEndpointQueryParam should be set to true at one time. */ isDnsResolutionEnabled: boolean; /** * A filter to return only resources that match the entire name. */ name: string; /** * The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs. */ nsgIds: string[]; /** * The IP addresses assigned to the Database Management private endpoint. */ privateIp: string; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The lifecycle state of a resource. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet. */ subnetId: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Database Managament private endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetDbManagementPrivateEndpointsFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetExadataInfrastructureFleetMetricExadataInfrastructureFleetSummary { /** * A list of Exadata infrastructures present in the fleet and their usage metrics. */ aggregatedMetrics: outputs.DatabaseManagement.GetExadataInfrastructureFleetMetricExadataInfrastructureFleetSummaryAggregatedMetric[]; /** * A list of the Exadata infrastructures in the fleet. */ inventories: outputs.DatabaseManagement.GetExadataInfrastructureFleetMetricExadataInfrastructureFleetSummaryInventory[]; } interface GetExadataInfrastructureFleetMetricExadataInfrastructureFleetSummaryAggregatedMetric { /** * The baseline value of the metric. */ baselineValue: number; /** * The dimensions of the metric. */ dimensions: outputs.DatabaseManagement.GetExadataInfrastructureFleetMetricExadataInfrastructureFleetSummaryAggregatedMetricDimension[]; /** * The name of the metric. */ metricName: string; /** * The percentage change in the metric aggregated value compared to the baseline value. */ percentageChange: number; /** * The target value of the metric. */ targetValue: number; /** * The unit of the value. */ unit: string; } interface GetExadataInfrastructureFleetMetricExadataInfrastructureFleetSummaryAggregatedMetricDimension { /** * The name of the dimension. */ dimensionName: string; /** * The value of the dimension. */ dimensionValue: string; } interface GetExadataInfrastructureFleetMetricExadataInfrastructureFleetSummaryInventory { /** * The Exadata infrastructure deployment type. */ deploymentType: string; /** * The number of Exadata infrastructures in the fleet. */ inventoryCount: number; /** * The size of the Exadata infrastructure. */ rackSize: string; } interface GetExadataInfrastructureFleetMetricFleetExadataInfrastructure { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The Exadata infrastructure deployment type. */ deploymentType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. */ infrastructureId: string; /** * The display name of the Exadata infrastructure. */ infrastructureName: string; /** * A list of the health metrics like CPU, Storage, and Memory. */ metrics: outputs.DatabaseManagement.GetExadataInfrastructureFleetMetricFleetExadataInfrastructureMetric[]; /** * The number of Database Systems created on the Exadata infrastructure. */ numberOfDbSystems: number; /** * The size of the Exadata infrastructure. */ rackSize: string; /** * The lifecycle state of the Exadata infrastructure. */ state: string; /** * The number of storage server for the Exadata infrastructure. */ storageServerCount: number; } interface GetExadataInfrastructureFleetMetricFleetExadataInfrastructureMetric { /** * The baseline value of the metric. */ baselineValue: number; /** * The dimensions of the metric. */ dimensions: outputs.DatabaseManagement.GetExadataInfrastructureFleetMetricFleetExadataInfrastructureMetricDimension[]; /** * The name of the metric. */ metricName: string; /** * The percentage change in the metric aggregated value compared to the baseline value. */ percentageChange: number; /** * The target value of the metric. */ targetValue: number; /** * The data point date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". */ timestamp: string; /** * The unit of the value. */ unit: string; } interface GetExadataInfrastructureFleetMetricFleetExadataInfrastructureMetricDimension { /** * The name of the dimension. */ dimensionName: string; /** * The value of the dimension. */ dimensionValue: string; } interface GetExternalAsmConfigurationInitParameter { /** * The user-friendly name for the ASM instance. The name does not have to be unique. */ asmInstanceDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external ASM instance. */ asmInstanceId: string; /** * The list of disk group names that an ASM instance mounts at startup or when the `ALTER DISKGROUP ALL MOUNT` statement is issued. */ autoMountDiskGroups: string[]; /** * An operating system-dependent value used to limit the set of disks considered for discovery. */ diskDiscoveryPath: string; /** * The list of failure groups that contain preferred read disks. */ preferredReadFailureGroups: string[]; /** * The maximum power on an ASM instance for disk rebalancing. */ rebalancePower: number; } interface GetExternalAsmDiskGroupsExternalAsmDiskGroupCollection { /** * An array of external ASM disk groups. */ items: outputs.DatabaseManagement.GetExternalAsmDiskGroupsExternalAsmDiskGroupCollectionItem[]; } interface GetExternalAsmDiskGroupsExternalAsmDiskGroupCollectionItem { /** * The unique names of the databases using the disk group. */ databases: string[]; /** * The number of ASM instances that have the disk group in dismounted state. */ dismountingInstanceCount: number; /** * Indicates whether the disk group is a sparse disk group or not. */ isSparse: boolean; /** * The number of ASM instances that have the disk group in mounted state. */ mountingInstanceCount: number; /** * The name of the ASM disk group. */ name: string; /** * The redundancy type of the disk group. */ redundancyType: string; /** * The total capacity of the disk group (in megabytes). */ totalSizeInMbs: string; /** * The percentage of used space in the disk group. */ usedPercent: number; /** * The used capacity of the disk group (in megabytes). */ usedSizeInMbs: string; } interface GetExternalAsmDiskGroupsFilter { /** * The name of the ASM disk group. */ name: string; regex?: boolean; values: string[]; } interface GetExternalAsmInstancesExternalAsmInstanceCollection { items: outputs.DatabaseManagement.GetExternalAsmInstancesExternalAsmInstanceCollectionItem[]; } interface GetExternalAsmInstancesExternalAsmInstanceCollectionItem { /** * The Automatic Diagnostic Repository (ADR) home directory for the ASM instance. */ adrHomeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the external ASM instance. */ componentName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external ASM. */ externalAsmId: string; externalAsmInstanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB node on which the ASM instance is running. */ externalDbNodeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system that the ASM instance is a part of. */ externalDbSystemId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The name of the host on which the ASM instance is running. */ hostName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external ASM instance. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current lifecycle state of the external ASM instance. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the external ASM instance was created. */ timeCreated: string; /** * The date and time the external ASM instance was last updated. */ timeUpdated: string; } interface GetExternalAsmInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalAsmServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the external database resides. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the external database. */ dbUniqueName: string; /** * The list of ASM disk groups used by the database. */ diskGroups: string[]; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface GetExternalAsmUsersExternalAsmUserCollection { /** * An array of external ASM users. */ items: outputs.DatabaseManagement.GetExternalAsmUsersExternalAsmUserCollectionItem[]; } interface GetExternalAsmUsersExternalAsmUserCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external ASM. */ asmId: string; /** * The name of the ASM user. */ name: string; /** * The list of privileges of the ASM user. */ privileges: string[]; } interface GetExternalAsmUsersFilter { /** * The name of the ASM user. */ name: string; regex?: boolean; values: string[]; } interface GetExternalAsmsExternalAsmCollection { items: outputs.DatabaseManagement.GetExternalAsmsExternalAsmCollectionItem[]; } interface GetExternalAsmsExternalAsmCollectionItem { /** * The additional details of the external ASM defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the external ASM. */ componentName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; externalAsmId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external connector. */ externalConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system. */ externalDbSystemId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; /** * Indicates whether the ASM is a cluster ASM or not. */ isCluster: boolean; /** * Indicates whether Oracle Flex ASM is enabled or not. */ isFlexEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The list of databases that are serviced by the ASM. */ servicedDatabases: outputs.DatabaseManagement.GetExternalAsmsExternalAsmCollectionItemServicedDatabase[]; /** * The current lifecycle state of the external ASM. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the external ASM was created. */ timeCreated: string; /** * The date and time the external ASM was last updated. */ timeUpdated: string; /** * The ASM version. */ version: string; } interface GetExternalAsmsExternalAsmCollectionItemServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the external database. */ dbUniqueName: string; /** * The list of ASM disk groups used by the database. */ diskGroups: string[]; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface GetExternalAsmsFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalClusterInstancesExternalClusterInstanceCollection { items: outputs.DatabaseManagement.GetExternalClusterInstancesExternalClusterInstanceCollectionItem[]; } interface GetExternalClusterInstancesExternalClusterInstanceCollectionItem { /** * The Automatic Diagnostic Repository (ADR) home directory for the cluster instance. */ adrHomeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the external cluster instance. */ componentName: string; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external cluster. */ externalClusterId: string; externalClusterInstanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external connector. */ externalConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB node. */ externalDbNodeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system that the cluster instance is a part of. */ externalDbSystemId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The name of the host on which the cluster instance is running. */ hostName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external cluster instance. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The role of the cluster node. */ nodeRole: string; /** * The current lifecycle state of the external cluster instance. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the external cluster instance was created. */ timeCreated: string; /** * The date and time the external cluster instance was last updated. */ timeUpdated: string; } interface GetExternalClusterInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalClusterNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface GetExternalClusterScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface GetExternalClusterVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface GetExternalClustersExternalClusterCollection { items: outputs.DatabaseManagement.GetExternalClustersExternalClusterCollectionItem[]; } interface GetExternalClustersExternalClusterCollectionItem { /** * The additional details of the external cluster defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the external cluster. */ componentName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; externalClusterId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external connector. */ externalConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system. */ externalDbSystemId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external cluster. */ id: string; /** * Indicates whether the cluster is Oracle Flex Cluster or not. */ isFlexCluster: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The list of network address configurations of the external cluster. */ networkConfigurations: outputs.DatabaseManagement.GetExternalClustersExternalClusterCollectionItemNetworkConfiguration[]; /** * The location of the Oracle Cluster Registry (OCR). */ ocrFileLocation: string; /** * The list of Single Client Access Name (SCAN) configurations of the external cluster. */ scanConfigurations: outputs.DatabaseManagement.GetExternalClustersExternalClusterCollectionItemScanConfiguration[]; /** * The current lifecycle state of the external cluster. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the external cluster was created. */ timeCreated: string; /** * The date and time the external cluster was last updated. */ timeUpdated: string; /** * The cluster version. */ version: string; /** * The list of Virtual IP (VIP) configurations of the external cluster. */ vipConfigurations: outputs.DatabaseManagement.GetExternalClustersExternalClusterCollectionItemVipConfiguration[]; } interface GetExternalClustersExternalClusterCollectionItemNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface GetExternalClustersExternalClusterCollectionItemScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface GetExternalClustersExternalClusterCollectionItemVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface GetExternalClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalDatabasesExternalDatabaseCollection { /** * An array of external databases. */ items: outputs.DatabaseManagement.GetExternalDatabasesExternalDatabaseCollectionItem[]; } interface GetExternalDatabasesExternalDatabaseCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The operating system of database. */ databasePlatformName: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or Non-container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The Oracle database version. */ databaseVersion: string; /** * The configuration of the Database Management service. */ dbManagementConfigs: outputs.DatabaseManagement.GetExternalDatabasesExternalDatabaseCollectionItemDbManagementConfig[]; /** * The basic information about an external DB system. */ dbSystemInfos: outputs.DatabaseManagement.GetExternalDatabasesExternalDatabaseCollectionItemDbSystemInfo[]; /** * The `DB_UNIQUE_NAME` of the external database. */ dbUniqueName: string; /** * The list of feature configurations */ dbmgmtFeatureConfigs: outputs.DatabaseManagement.GetExternalDatabasesExternalDatabaseCollectionItemDbmgmtFeatureConfig[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent Container Database (CDB) if this is a Pluggable Database (PDB). */ externalContainerDatabaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB home. */ externalDbHomeId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system. */ id: string; /** * The list of database instances if the database is a RAC database. */ instanceDetails: outputs.DatabaseManagement.GetExternalDatabasesExternalDatabaseCollectionItemInstanceDetail[]; /** * The current lifecycle state of the external database resource. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the external DB system was created. */ timeCreated: string; } interface GetExternalDatabasesExternalDatabaseCollectionItemDbManagementConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ connectorId: string; /** * The status of the Database Management service. */ databaseManagementStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetExternalDatabasesExternalDatabaseCollectionItemDbSystemInfo { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The basic information about an external Exadata Infrastructure. */ exadataInfraInfos: outputs.DatabaseManagement.GetExternalDatabasesExternalDatabaseCollectionItemDbSystemInfoExadataInfraInfo[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system. */ id: string; } interface GetExternalDatabasesExternalDatabaseCollectionItemDbSystemInfoExadataInfraInfo { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system. */ id: string; } interface GetExternalDatabasesExternalDatabaseCollectionItemDbmgmtFeatureConfig { /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails: outputs.DatabaseManagement.GetExternalDatabasesExternalDatabaseCollectionItemDbmgmtFeatureConfigConnectorDetail[]; /** * The connection details required to connect to the database. */ databaseConnectionDetails: outputs.DatabaseManagement.GetExternalDatabasesExternalDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetail[]; /** * The name of the Database Management feature. */ feature: string; /** * The list of statuses for Database Management features. */ featureStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetExternalDatabasesExternalDatabaseCollectionItemDbmgmtFeatureConfigConnectorDetail { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector */ connectorType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId: string; } interface GetExternalDatabasesExternalDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetail { /** * The credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDatabasesExternalDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionCredential[]; /** * The details of the Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDatabasesExternalDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionString[]; } interface GetExternalDatabasesExternalDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the database. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the database. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the database. */ userName: string; } interface GetExternalDatabasesExternalDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionString { /** * The list of supported connection types: * * BASIC: Basic connection details */ connectionType: string; /** * The port number used to connect to the database. */ port: number; /** * The protocol used to connect to the database. */ protocol: string; /** * The service name of the database. */ service: string; } interface GetExternalDatabasesExternalDatabaseCollectionItemInstanceDetail { /** * The name of the host machine. */ hostName: string; /** * The name of the database instance. */ instanceName: string; /** * The instance number of the database instance. */ instanceNumber: number; } interface GetExternalDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalDbHomesExternalDbHomeCollection { items: outputs.DatabaseManagement.GetExternalDbHomesExternalDbHomeCollectionItem[]; } interface GetExternalDbHomesExternalDbHomeCollectionItem { /** * The additional details of the DB home defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the external DB home. */ componentName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; externalDbHomeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system. */ externalDbSystemId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The location of the DB home. */ homeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB home. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current lifecycle state of the external DB home. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the external DB home was created. */ timeCreated: string; /** * The date and time the external DB home was last updated. */ timeUpdated: string; } interface GetExternalDbHomesFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalDbNodesExternalDbNodeCollection { items: outputs.DatabaseManagement.GetExternalDbNodesExternalDbNodeCollectionItem[]; } interface GetExternalDbNodesExternalDbNodeCollectionItem { /** * The additional details of the external DB node defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the external DB node. */ componentName: string; /** * The number of CPU cores available on the DB node. */ cpuCoreCount: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * Name of the domain. */ domainName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external connector. */ externalConnectorId: string; externalDbNodeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system. */ externalDbSystemId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The host name for the DB node. */ hostName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB node. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The total memory in gigabytes (GB) on the DB node. */ memorySizeInGbs: number; /** * The current lifecycle state of the external DB node. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the external DB node was created. */ timeCreated: string; /** * The date and time the external DB node was last updated. */ timeUpdated: string; } interface GetExternalDbNodesFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalDbSystemConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDbSystemConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDbSystemConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.GetExternalDbSystemConnectorConnectionInfoDatabaseCredential[]; } interface GetExternalDbSystemConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetExternalDbSystemConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetExternalDbSystemConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface GetExternalDbSystemConnectorsExternalDbSystemConnectorCollection { items: outputs.DatabaseManagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItem[]; } interface GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. */ agentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfo[]; /** * The status of connectivity to the external DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system. */ externalDbSystemId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system connector. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The current lifecycle state of the external DB system connector. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the connectionStatus of the external DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; /** * The date and time the external DB system connector was created. */ timeCreated: string; /** * The date and time the external DB system connector was last updated. */ timeUpdated: string; } interface GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoDatabaseCredential[]; } interface GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetExternalDbSystemConnectorsExternalDbSystemConnectorCollectionItemConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface GetExternalDbSystemConnectorsFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalDbSystemDatabaseManagementConfig { /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollection { items: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItem[]; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. */ agentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The list of DB system components that were found in the DB system discovery. */ discoveredComponents: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponent[]; /** * A filter to only return the resources that match the entire display name. */ displayName: string; externalDbSystemDiscoveryId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system discovery. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; patchOperations: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperation[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing Oracle Cloud Infrastructure resource matching the discovered DB system. */ resourceId: string; /** * The current lifecycle state of the external DB system discovery resource. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the external DB system discovery was created. */ timeCreated: string; /** * The date and time the external DB system discovery was last updated. */ timeUpdated: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponent { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; asmInstances: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentAsmInstance[]; /** * The list of associated components. */ associatedComponents: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentAssociatedComponent[]; /** * Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database. */ canEnableAllCurrentPdbs: boolean; /** * The unique identifier of the Oracle cluster. */ clusterId: string; clusterInstances: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstance[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The name of the discovered DB system component. */ componentName: string; /** * The component type. */ componentType: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The number of CPU cores available on the DB node. */ cpuCoreCount: number; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The Oracle Database edition. */ dbEdition: string; /** * The Oracle Database ID. */ dbId: string; /** * The list of database instances. */ dbInstances: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentDbInstance[]; /** * The name of the DB node. */ dbNodeName: string; /** * The database packs licensed for the external Oracle Database. */ dbPacks: string; /** * The role of the Oracle Database in Oracle Data Guard configuration. */ dbRole: string; /** * The type of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. */ dbType: string; /** * The `DB_UNIQUE_NAME` of the external database. */ dbUniqueName: string; /** * The Oracle Database version. */ dbVersion: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The list of protocol addresses the listener is configured to listen on. */ endpoints: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentEndpoint[]; /** * The directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The unique identifier of the PDB. */ guid: string; /** * The location of the DB home. */ homeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database. */ isAutoEnablePluggableDatabase: boolean; /** * Indicates whether the Oracle Database is part of a cluster. */ isCluster: boolean; /** * Indicates whether the cluster is an Oracle Flex Cluster or not. */ isFlexCluster: boolean; /** * Indicates whether Oracle Flex ASM is enabled or not. */ isFlexEnabled: boolean; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring: boolean; /** * The listener alias. */ listenerAlias: string; /** * The type of listener. */ listenerType: string; /** * The destination directory of the listener log file. */ logDirectory: string; /** * The total memory in gigabytes (GB) on the DB node. */ memorySizeInGbs: number; /** * The list of network address configurations of the external cluster. */ networkConfigurations: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentNetworkConfiguration[]; /** * The name of the node with the VIP. */ nodeName: string; /** * The role of the cluster node. */ nodeRole: string; /** * The location of the Oracle Cluster Registry (OCR) file. */ ocrFileLocation: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; /** * The list of Pluggable Databases. */ pluggableDatabases: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabase[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing Oracle Cloud Infrastructure resource matching the discovered DB system. */ resourceId: string; /** * The list of Single Client Access Name (SCAN) configurations of the external cluster. */ scanConfigurations: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentScanConfiguration[]; /** * The state of the discovered DB system component. */ status: string; /** * The destination directory of the listener trace file. */ traceDirectory: string; /** * The version of Oracle Clusterware running in the cluster. */ version: string; /** * The list of Virtual IP (VIP) configurations of the external cluster. */ vipConfigurations: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentVipConfiguration[]; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentAsmInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentAssociatedComponent { /** * The association type. */ associationType: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The component type. */ componentType: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The unique identifier of the Oracle cluster. */ clusterId: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnector[]; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The role of the cluster node. */ nodeRole: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfo[]; /** * The status of connectivity to the external DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The date and time the connectionStatus of the external DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfoDatabaseCredential[]; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentClusterInstanceConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfo[]; /** * The status of connectivity to the external DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The date and time the connectionStatus of the external DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfoDatabaseCredential[]; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentDbInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * The name of the node with the VIP. */ nodeName: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The unique identifier of the PDB. */ guid: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfo[]; /** * The status of connectivity to the external DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The date and time the connectionStatus of the external DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfoDatabaseCredential[]; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentPluggableDatabaseConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemDiscoveredComponentVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperation { operation: string; selection: string; values: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperationValue[]; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperationValue { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperationValueConnector[]; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring: boolean; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperationValueConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. */ agentId: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfo[]; /** * The type of connector. */ connectorType: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfoConnectionString[]; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetExternalDbSystemDiscoveriesExternalDbSystemDiscoveryCollectionItemPatchOperationValueConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetExternalDbSystemDiscoveriesFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalDbSystemDiscoveryDiscoveredComponent { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; asmInstances: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentAsmInstance[]; /** * The list of associated components. */ associatedComponents: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentAssociatedComponent[]; /** * Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database. */ canEnableAllCurrentPdbs: boolean; /** * The unique identifier of the Oracle cluster. */ clusterId: string; clusterInstances: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstance[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The name of the discovered DB system component. */ componentName: string; /** * The component type. */ componentType: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The number of CPU cores available on the DB node. */ cpuCoreCount: number; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The Oracle Database edition. */ dbEdition: string; /** * The Oracle Database ID. */ dbId: string; /** * The list of database instances. */ dbInstances: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentDbInstance[]; /** * The name of the DB node. */ dbNodeName: string; /** * The database packs licensed for the external Oracle Database. */ dbPacks: string; /** * The role of the Oracle Database in Oracle Data Guard configuration. */ dbRole: string; /** * The type of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. */ dbType: string; /** * The `DB_UNIQUE_NAME` of the external database. */ dbUniqueName: string; /** * The Oracle Database version. */ dbVersion: string; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The list of protocol addresses the listener is configured to listen on. */ endpoints: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentEndpoint[]; /** * The directory in which Oracle Grid Infrastructure is installed. */ gridHome: string; /** * The unique identifier of the PDB. */ guid: string; /** * The location of the DB home. */ homeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database. */ isAutoEnablePluggableDatabase: boolean; /** * Indicates whether the Oracle Database is part of a cluster. */ isCluster: boolean; /** * Indicates whether the cluster is an Oracle Flex Cluster or not. */ isFlexCluster: boolean; /** * Indicates whether Oracle Flex ASM is enabled or not. */ isFlexEnabled: boolean; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring: boolean; /** * The listener alias. */ listenerAlias: string; /** * The type of listener. */ listenerType: string; /** * The destination directory of the listener log file. */ logDirectory: string; /** * The total memory in gigabytes (GB) on the DB node. */ memorySizeInGbs: number; /** * The list of network address configurations of the external cluster. */ networkConfigurations: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentNetworkConfiguration[]; /** * The name of the node with the VIP. */ nodeName: string; /** * The role of the cluster node. */ nodeRole: string; /** * The location of the Oracle Cluster Registry (OCR) file. */ ocrFileLocation: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; /** * The list of Pluggable Databases. */ pluggableDatabases: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabase[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the existing Oracle Cloud Infrastructure resource matching the discovered DB system. */ resourceId: string; /** * The list of Single Client Access Name (SCAN) configurations of the external cluster. */ scanConfigurations: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentScanConfiguration[]; /** * The state of the discovered DB system component. */ status: string; /** * The destination directory of the listener trace file. */ traceDirectory: string; /** * The version of Oracle Clusterware running in the cluster. */ version: string; /** * The list of Virtual IP (VIP) configurations of the external cluster. */ vipConfigurations: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentVipConfiguration[]; } interface GetExternalDbSystemDiscoveryDiscoveredComponentAsmInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentAssociatedComponent { /** * The association type. */ associationType: string; /** * The identifier of the discovered DB system component. */ componentId: string; /** * The component type. */ componentType: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The unique identifier of the Oracle cluster. */ clusterId: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnector[]; /** * The Oracle base location of Cluster Ready Services (CRS). */ crsBaseDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The role of the cluster node. */ nodeRole: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfo[]; /** * The status of connectivity to the external DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the external DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoDatabaseCredential[]; } interface GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentClusterInstanceConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfo[]; /** * The status of connectivity to the external DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the external DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoDatabaseCredential[]; } interface GetExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentDbInstance { /** * The Automatic Diagnostic Repository (ADR) home directory for the DB instance. */ adrHomeDirectory: string; /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The name of the ASM instance. */ instanceName: string; /** * The name of the node with the VIP. */ nodeName: string; /** * The Oracle home location of the DB instance. */ oracleHome: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface GetExternalDbSystemDiscoveryDiscoveredComponentNetworkConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The network type. */ networkType: string; /** * The subnet for the network. */ subnet: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnector[]; /** * The unique identifier of the parent Container Database (CDB). */ containerDatabaseId: string; /** * The unique identifier of the PDB. */ guid: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. */ agentId: string; /** * The error message indicating the reason for connection failure or `null` if the connection was successful. */ connectionFailureMessage: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfo[]; /** * The status of connectivity to the external DB system component. */ connectionStatus: string; /** * The type of connector. */ connectorType: string; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * The date and time the connectionStatus of the external DB system connector was last updated. */ timeConnectionStatusLastUpdated: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString[]; /** * The credential to connect to the database to perform tablespace administration tasks. */ databaseCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoDatabaseCredential[]; } interface GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentPluggableDatabaseConnectorConnectionInfoDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentScanConfiguration { /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the SCAN listener. */ scanName: string; /** * The port number of the SCAN listener. */ scanPort: number; /** * The protocol of the SCAN listener. */ scanProtocol: string; } interface GetExternalDbSystemDiscoveryDiscoveredComponentVipConfiguration { /** * The VIP name or IP address. */ address: string; /** * The network number from which VIPs are obtained. */ networkNumber: number; /** * The name of the node with the VIP. */ nodeName: string; } interface GetExternalDbSystemDiscoveryPatchOperation { operation: string; selection: string; values: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryPatchOperationValue[]; } interface GetExternalDbSystemDiscoveryPatchOperationValue { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The connector details used to connect to the external DB system component. */ connectors: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryPatchOperationValueConnector[]; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; /** * Indicates whether the DB system component should be provisioned as an Oracle Cloud Infrastructure resource or not. */ isSelectedForMonitoring: boolean; } interface GetExternalDbSystemDiscoveryPatchOperationValueConnector { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used for the external DB system connector. */ agentId: string; /** * The connection details required to connect to an external DB system component. */ connectionInfos: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfo[]; /** * The type of connector. */ connectorType: string; /** * The user-friendly name for the DB system. The name does not have to be unique. */ displayName: string; } interface GetExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfo { /** * The component type. */ componentType: string; /** * The credentials used to connect to the ASM instance. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionCredential[]; /** * The Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionString[]; } interface GetExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the ASM instance. */ userName: string; } interface GetExternalDbSystemDiscoveryPatchOperationValueConnectorConnectionInfoConnectionString { /** * The host name of the database or the SCAN name in case of a RAC database. */ hostName: string; /** * The list of host names of the ASM instances. */ hosts: string[]; /** * The port used to connect to the ASM instance. */ port: number; /** * The protocol used to connect to the ASM instance. */ protocol: string; /** * The service name of the ASM instance. */ service: string; } interface GetExternalDbSystemStackMonitoringConfig { /** * The status of the associated service. */ isEnabled: boolean; /** * The associated service-specific inputs in JSON string format, which Database Management can identify. */ metadata: string; } interface GetExternalDbSystemsExternalDbSystemCollection { items: outputs.DatabaseManagement.GetExternalDbSystemsExternalDbSystemCollectionItem[]; } interface GetExternalDbSystemsExternalDbSystemCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The details required to enable Database Management for an external DB system. */ databaseManagementConfigs: outputs.DatabaseManagement.GetExternalDbSystemsExternalDbSystemCollectionItemDatabaseManagementConfig[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system discovery. */ dbSystemDiscoveryId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent used during the discovery of the DB system. */ discoveryAgentId: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The Oracle Grid home directory in case of cluster-based DB system and Oracle home directory in case of single instance-based DB system. */ homeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system. */ id: string; /** * Indicates whether the DB system is a cluster DB system or not. */ isCluster: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The configuration details of Stack Monitoring for an external DB system. */ stackMonitoringConfigs: outputs.DatabaseManagement.GetExternalDbSystemsExternalDbSystemCollectionItemStackMonitoringConfig[]; /** * The current lifecycle state of the external DB system resource. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the external DB system was created. */ timeCreated: string; /** * The date and time the external DB system was last updated. */ timeUpdated: string; } interface GetExternalDbSystemsExternalDbSystemCollectionItemDatabaseManagementConfig { /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetExternalDbSystemsExternalDbSystemCollectionItemStackMonitoringConfig { /** * The status of the associated service. */ isEnabled: boolean; /** * The associated service-specific inputs in JSON string format, which Database Management can identify. */ metadata: string; } interface GetExternalDbSystemsFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalExadataInfrastructureDatabaseSystem { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The Oracle license model that applies to the database management resources. */ licenseModel: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetExternalExadataInfrastructureStorageGrid { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The number of Exadata storage servers in the Exadata infrastructure. */ serverCount: number; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetExternalExadataInfrastructuresExternalExadataInfrastructureCollection { items: outputs.DatabaseManagement.GetExternalExadataInfrastructuresExternalExadataInfrastructureCollectionItem[]; } interface GetExternalExadataInfrastructuresExternalExadataInfrastructureCollectionItem { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The list of [OCIDs] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartments. */ databaseCompartments: string[]; /** * A list of DB systems. */ databaseSystems: outputs.DatabaseManagement.GetExternalExadataInfrastructuresExternalExadataInfrastructureCollectionItemDatabaseSystem[]; dbSystemIds: string[]; /** * 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"}` */ definedTags: { [key: string]: string; }; discoveryKey: string; /** * The optional single value query filter parameter on the entity display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The Oracle license model that applies to the database management resources. */ licenseModel: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The rack size of the Exadata infrastructure. */ rackSize: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The Exadata storage server grid of the Exadata infrastructure. */ storageGrids: outputs.DatabaseManagement.GetExternalExadataInfrastructuresExternalExadataInfrastructureCollectionItemStorageGrid[]; storageServerNames: string[]; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetExternalExadataInfrastructuresExternalExadataInfrastructureCollectionItemDatabaseSystem { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The optional single value query filter parameter on the entity display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The Oracle license model that applies to the database management resources. */ licenseModel: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetExternalExadataInfrastructuresExternalExadataInfrastructureCollectionItemStorageGrid { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The optional single value query filter parameter on the entity display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The number of Exadata storage servers in the Exadata infrastructure. */ serverCount: number; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetExternalExadataInfrastructuresFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalExadataStorageConnectorCredentialInfo { password: string; sslTrustStoreLocation: string; sslTrustStorePassword: string; sslTrustStoreType: string; username: string; } interface GetExternalExadataStorageConnectorsExternalExadataStorageConnectorCollection { items: outputs.DatabaseManagement.GetExternalExadataStorageConnectorsExternalExadataStorageConnectorCollectionItem[]; } interface GetExternalExadataStorageConnectorsExternalExadataStorageConnectorCollectionItem { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server. */ agentId: string; /** * The unique string of the connection. For example, "https:///MS/RESTService/". */ connectionUri: string; connectorName: string; credentialInfos: outputs.DatabaseManagement.GetExternalExadataStorageConnectorsExternalExadataStorageConnectorCollectionItemCredentialInfo[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The optional single value query filter parameter on the entity display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. */ exadataInfrastructureId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata storage server. */ storageServerId: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetExternalExadataStorageConnectorsExternalExadataStorageConnectorCollectionItemCredentialInfo { password: string; sslTrustStoreLocation: string; sslTrustStorePassword: string; sslTrustStoreType: string; username: string; } interface GetExternalExadataStorageConnectorsFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalExadataStorageGridStorageServer { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector. */ connectorId: string; /** * The CPU count of the Exadata storage server. */ cpuCount: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The IP address of the Exadata storage server. */ ipAddress: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The make model of the Exadata storage server. */ makeModel: string; /** * The maximum flash disk IO operations per second of the Exadata storage server. */ maxFlashDiskIops: number; /** * The maximum flash disk IO throughput in MB/s of the Exadata storage server. */ maxFlashDiskThroughput: number; /** * The maximum hard disk IO operations per second of the Exadata storage server. */ maxHardDiskIops: number; /** * The maximum hard disk IO throughput in MB/s of the Exadata storage server. */ maxHardDiskThroughput: number; /** * The Exadata storage server memory size in GB. */ memoryGb: number; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetExternalExadataStorageServerConnector { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server. */ agentId: string; /** * The unique string of the connection. For example, "https:///MS/RESTService/". */ connectionUri: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The name of the Exadata resource. English letters, numbers, "-", "_" and "." only. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata storage server. */ storageServerId: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetExternalExadataStorageServerIormPlanDbPlan { /** * A list of DatabasePlanDirectives. */ items: outputs.DatabaseManagement.GetExternalExadataStorageServerIormPlanDbPlanItem[]; } interface GetExternalExadataStorageServerIormPlanDbPlanItem { /** * The resource allocation as a percentage (0-100) within the level. */ allocation: number; /** * Starting with Oracle Exadata System Software release 19.1.0, you can use the asmcluster attribute to distinguish between databases with the same name running in different Oracle ASM clusters. */ asmCluster: string; /** * Defines a soft limit for space usage in Exadata Smart Flash Cache. If the cache is not full, the limit can be exceeded. You specify the value for flashcachelimit in bytes. You can also use the suffixes M (megabytes), G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T. The value for flashcachelimit must be at least 4 MB. The flashcachelimit and flashcachesize attributes cannot be specified in the same directive. The value for flashcachelimit cannot be smaller than flashcachemin, if it is specified. */ flashCacheLimit: string; /** * Specifies a minimum guaranteed space allocation in Exadata Smart Flash Cache. You specify the value for flashcachemin in bytes. You can also use the suffixes M (megabytes), G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T. The value for flashcachemin must be at least 4 MB. In any plan, the sum of all flashcachemin values cannot exceed the size of Exadata Smart Flash Cache. If flashcachelimit is specified, then the value for flashcachemin cannot exceed flashcachelimit. If flashcachesize is specified, then the value for flashcachemin cannot exceed flashcachesize. */ flashCacheMin: string; /** * Defines a hard limit for space usage in Exadata Smart Flash Cache. The limit cannot be exceeded, even if the cache is not full. In an IORM plan, if the size of Exadata Smart Flash Cache can accommodate all of the flashcachemin and flashcachesize allocations, then each flashcachesize definition represents a guaranteed space allocation. However, starting with Oracle Exadata System Software release 19.2.0 you can use the flashcachesize attribute to over-provision space in Exadata Smart Flash Cache. Consequently, if the size of Exadata Smart Flash Cache cannot accommodate all of the flashcachemin and flashcachesize allocations, then only flashcachemin is guaranteed. */ flashCacheSize: string; /** * Controls use of Exadata Smart Flash Cache by a database. This ensures that cache space is reserved for mission-critical databases. flashcache=off is invalid in a directive that contains the flashcachemin, flashcachelimit, or flashcachesize attributes. */ isFlashCacheOn: boolean; /** * Controls use of Exadata Smart Flash Log by a database. This ensures that Exadata Smart Flash Log is reserved for mission-critical databases. */ isFlashLogOn: boolean; /** * Controls use of the persistent memory (PMEM) cache by a database. This ensures that cache space is reserved for mission-critical databases. pmemcache=off is invalid in a directive that contains the pmemcachemin, pmemcachelimit, or pmemcachesize attributes. */ isPmemCacheOn: boolean; /** * Controls use of persistent memory logging (PMEM log) by a database. This ensures that PMEM log is reserved for mission-critical databases. */ isPmemLogOn: boolean; /** * The allocation level. Valid values are from 1 to 8. Resources are allocated to level 1 first, and then remaining resources are allocated to level 2, and so on. */ level: number; limit: number; /** * The name of a database or a profile. */ name: string; /** * Defines a soft limit for space usage in the persistent memory (PMEM) cache. If the cache is not full, the limit can be exceeded. You specify the value for pmemcachelimit in bytes. You can also use the suffixes M (megabytes), G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T. The value for pmemcachelimit must be at least 4 MB. The pmemcachelimit and pmemcachesize attributes cannot be specified in the same directive. The value for pmemcachelimit cannot be smaller than pmemcachemin, if it is specified. */ pmemCacheLimit: string; /** * Specifies a minimum guaranteed space allocation in the persistent memory (PMEM) cache. */ pmemCacheMin: string; /** * Defines a hard limit for space usage in the persistent memory (PMEM) cache. The limit cannot be exceeded, even if the cache is not full. In an IORM plan, if the size of the PMEM cache can accommodate all of the pmemcachemin and pmemcachesize allocations, then each pmemcachesize definition represents a guaranteed space allocation. However, you can use the pmemcachesize attribute to over-provision space in the PMEM cache. Consequently, if the PMEM cache size cannot accommodate all of the pmemcachemin and pmemcachesize allocations, then only pmemcachemin is guaranteed. */ pmemCacheSize: string; /** * Enables you to specify different plan directives based on the Oracle Data Guard database role. */ role: string; /** * The relative priority of a database in the database plan. A higher share value implies higher priority and more access to the I/O resources. Use either share or (level, allocation). All plan directives in a database plan should use the same setting. Share-based resource allocation is the recommended method for a database plan. */ share: number; /** * Enables you to create a profile or template, to ease management and configuration of resource plans in environments with many databases. * * type=database: Specifies a directive that applies to a specific database. If type in not specified, then the directive defaults to the database type. * * type=profile: Specifies a directive that applies to a profile rather than a specific database. */ type: string; } interface GetExternalExadataStorageServerOpenAlertHistoryAlert { /** * The alert message. */ message: string; /** * The severity of the alert. */ severity: string; /** * The start time of the alert. */ timeStartAt: string; /** * The type of alert. */ type: string; } interface GetExternalExadataStorageServerTopSqlCpuActivityActivity { /** * The CPU activity percentage. */ cpuActivity: number; /** * The database name. */ databaseName: string; /** * The SQL ID. */ sqlId: string; } interface GetExternalExadataStorageServersExternalExadataStorageServerCollection { items: outputs.DatabaseManagement.GetExternalExadataStorageServersExternalExadataStorageServerCollectionItem[]; } interface GetExternalExadataStorageServersExternalExadataStorageServerCollectionItem { /** * The additional details of the resource defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; connectorId: string; /** * The CPU count of the Exadata storage server. */ cpuCount: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The optional single value query filter parameter on the entity display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. */ exadataInfrastructureId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata resource. */ id: string; /** * The internal ID of the Exadata resource. */ internalId: string; /** * The IP address of the Exadata storage server. */ ipAddress: string; /** * The details of the lifecycle state of the Exadata resource. */ lifecycleDetails: string; /** * The make model of the Exadata storage server. */ makeModel: string; /** * The maximum flash disk IO operations per second of the Exadata storage server. */ maxFlashDiskIops: number; /** * The maximum flash disk IO throughput in MB/s of the Exadata storage server. */ maxFlashDiskThroughput: number; /** * The maximum hard disk IO operations per second of the Exadata storage server. */ maxHardDiskIops: number; /** * The maximum hard disk IO throughput in MB/s of the Exadata storage server. */ maxHardDiskThroughput: number; /** * The Exadata storage server memory size in GB. */ memoryGb: number; /** * The type of Exadata resource. */ resourceType: string; /** * The current lifecycle state of the database resource. */ state: string; /** * The status of the Exadata resource. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata storage server grid. */ storageGridId: string; /** * The timestamp of the creation of the Exadata resource. */ timeCreated: string; /** * The timestamp of the last update of the Exadata resource. */ timeUpdated: string; /** * The version of the Exadata resource. */ version: string; } interface GetExternalExadataStorageServersFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalListenerEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port number. */ port: number; /** * The listener protocol. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface GetExternalListenerServicedAsm { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the external database resides. */ compartmentId: string; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; } interface GetExternalListenerServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the external database resides. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the external database. */ dbUniqueName: string; /** * The user-friendly name for the database. The name does not have to be unique. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface GetExternalListenerServicesExternalListenerServiceCollection { /** * An array of external listener services. */ items: outputs.DatabaseManagement.GetExternalListenerServicesExternalListenerServiceCollectionItem[]; } interface GetExternalListenerServicesExternalListenerServiceCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external listener. */ listenerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Managed Database. */ managedDatabaseId: string; /** * The name of the service. */ name: string; } interface GetExternalListenerServicesFilter { /** * The name of the service. */ name: string; regex?: boolean; values: string[]; } interface GetExternalListenersExternalListenerCollection { items: outputs.DatabaseManagement.GetExternalListenersExternalListenerCollectionItem[]; } interface GetExternalListenersExternalListenerCollectionItem { /** * The additional details of the external listener defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled. */ adrHomeDirectory: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the external listener. */ componentName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The list of protocol addresses the listener is configured to listen on. */ endpoints: outputs.DatabaseManagement.GetExternalListenersExternalListenerCollectionItemEndpoint[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external connector. */ externalConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB home. */ externalDbHomeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB node. */ externalDbNodeId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external DB system. */ externalDbSystemId: string; externalListenerId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The name of the host on which the external listener is running. */ hostName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The listener alias. */ listenerAlias: string; /** * The location of the listener configuration file listener.ora. */ listenerOraLocation: string; /** * The type of listener. */ listenerType: string; /** * The destination directory of the listener log file. */ logDirectory: string; /** * The Oracle home location of the listener. */ oracleHome: string; /** * The list of ASMs that are serviced by the listener. */ servicedAsms: outputs.DatabaseManagement.GetExternalListenersExternalListenerCollectionItemServicedAsm[]; /** * The list of databases that are serviced by the listener. */ servicedDatabases: outputs.DatabaseManagement.GetExternalListenersExternalListenerCollectionItemServicedDatabase[]; /** * The current lifecycle state of the external listener. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the external listener was created. */ timeCreated: string; /** * The date and time the external listener was last updated. */ timeUpdated: string; /** * The destination directory of the listener trace file. */ traceDirectory: string; /** * The listener version. */ version: string; } interface GetExternalListenersExternalListenerCollectionItemEndpoint { /** * The host name or IP address. */ host: string; /** * The unique name of the service. */ key: string; /** * The port number. */ port: number; /** * The listener protocol. */ protocol: string; /** * The list of services registered with the listener. */ services: string[]; } interface GetExternalListenersExternalListenerCollectionItemServicedAsm { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; } interface GetExternalListenersExternalListenerCollectionItemServicedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The unique name of the external database. */ dbUniqueName: string; /** * A filter to only return the resources that match the entire display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database. */ id: string; /** * Indicates whether the database is a Managed Database or not. */ isManaged: boolean; } interface GetExternalListenersFilter { name: string; regex?: boolean; values: string[]; } interface GetExternalMySqlDatabaseConnectorConnectorDetail { /** * Credential type used to connect to database. */ credentialType: string; displayName: string; /** * OCID of MySQL Database resource */ externalDatabaseId: string; /** * Host name for Connector. */ hostName: string; /** * Agent Id of the MACS agent. */ macsAgentId: string; /** * Network Protocol. */ networkProtocol: string; /** * Connector port. */ port: number; /** * OCID of the SSL secret, if TCPS with SSL is used to connect to database. */ sslSecretId: string; } interface GetExternalMySqlDatabaseConnectorsFilter { /** * The parameter to filter by MySQL Database System type. */ name: string; regex?: boolean; values: string[]; } interface GetExternalMySqlDatabaseConnectorsMySqlConnectorCollection { items: outputs.DatabaseManagement.GetExternalMySqlDatabaseConnectorsMySqlConnectorCollectionItem[]; } interface GetExternalMySqlDatabaseConnectorsMySqlConnectorCollectionItem { /** * Oracle Cloud Infrastructure Services associated with this connector. */ associatedServices: string; checkConnectionStatusTrigger: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Connection Status */ connectionStatus: string; connectorDetails: outputs.DatabaseManagement.GetExternalMySqlDatabaseConnectorsMySqlConnectorCollectionItemConnectorDetail[]; /** * Connector Type. */ connectorType: string; /** * Credential type used to connect to database. */ credentialType: string; /** * OCID of MySQL Database resource */ externalDatabaseId: string; /** * Host name for Connector. */ hostName: string; /** * OCID of MySQL Database Connector. */ id: string; isTestConnectionParam: boolean; /** * Agent Id of the MACS agent. */ macsAgentId: string; /** * The parameter to filter by MySQL Database System type. */ name: string; /** * Network Protocol. */ networkProtocol: string; /** * Connector port. */ port: number; /** * Name of MySQL Database. */ sourceDatabase: string; /** * Type of MySQL Database. */ sourceDatabaseType: string; /** * OCID of the SSL secret, if TCPS with SSL is used to connect to database. */ sslSecretId: string; /** * Name of the SSL secret, if TCPS with SSL is used to connect to database. */ sslSecretName: string; /** * Indicates lifecycle state of the resource. */ state: string; /** * Time when connection status was last updated. */ timeConnectionStatusUpdated: string; /** * Connector creation time. */ timeCreated: string; /** * Connector update time. */ timeUpdated: string; } interface GetExternalMySqlDatabaseConnectorsMySqlConnectorCollectionItemConnectorDetail { /** * Credential type used to connect to database. */ credentialType: string; displayName: string; /** * OCID of MySQL Database resource */ externalDatabaseId: string; /** * Host name for Connector. */ hostName: string; /** * Agent Id of the MACS agent. */ macsAgentId: string; /** * Network Protocol. */ networkProtocol: string; /** * Connector port. */ port: number; /** * OCID of the SSL secret, if TCPS with SSL is used to connect to database. */ sslSecretId: string; } interface GetExternalMySqlDatabasesExternalMySqlDatabaseCollection { items: outputs.DatabaseManagement.GetExternalMySqlDatabasesExternalMySqlDatabaseCollectionItem[]; } interface GetExternalMySqlDatabasesExternalMySqlDatabaseCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Display Name of the External MySQL Database. */ dbName: string; /** * OCID of External MySQL Database. */ externalDatabaseId: string; } interface GetExternalMySqlDatabasesFilter { /** * The parameter to filter by MySQL Database System type. */ name: string; regex?: boolean; values: string[]; } interface GetJobExecutionsStatusItem { /** * The number of job executions of a particular status. */ count: number; /** * The status of the job execution. */ status: string; } interface GetJobExecutionsStatusesFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetJobExecutionsStatusesJobExecutionsStatusSummaryCollection { /** * A list of JobExecutionsSummary objects. */ items: outputs.DatabaseManagement.GetJobExecutionsStatusesJobExecutionsStatusSummaryCollectionItem[]; } interface GetJobExecutionsStatusesJobExecutionsStatusSummaryCollectionItem { /** * The number of job executions of a particular status. */ count: number; /** * The status of the job execution. */ status: string; } interface GetManagedDatabaseAddmTaskItem { /** * The ID number of the beginning AWR snapshot. */ beginSnapshotId: string; /** * The database user who owns the ADDM task. */ dbUser: string; /** * The description of the ADDM task. */ description: string; /** * The ID number of the ending AWR snapshot. */ endSnapshotId: string; /** * The timestamp of the ending AWR snapshot used in the ADDM task as defined by date-time RFC3339 format. */ endSnapshotTime: string; /** * The number of ADDM findings. */ findings: string; /** * A description of how the task was created. */ howCreated: string; /** * The timestamp of the beginning AWR snapshot used in the ADDM task as defined by date-time RFC3339 format. */ startSnapshotTime: string; /** * The status of the ADDM task. */ status: string; /** * The ID number of the ADDM task. */ taskId: string; /** * The name of the ADDM task. */ taskName: string; /** * The creation date of the ADDM task. */ timeCreated: string; } interface GetManagedDatabaseAddmTasksAddmTasksCollection { /** * The list of ADDM task metadata. */ items: outputs.DatabaseManagement.GetManagedDatabaseAddmTasksAddmTasksCollectionItem[]; } interface GetManagedDatabaseAddmTasksAddmTasksCollectionItem { /** * The ID number of the beginning AWR snapshot. */ beginSnapshotId: string; /** * The database user who owns the ADDM task. */ dbUser: string; /** * The description of the ADDM task. */ description: string; /** * The ID number of the ending AWR snapshot. */ endSnapshotId: string; /** * The timestamp of the ending AWR snapshot used in the ADDM task as defined by date-time RFC3339 format. */ endSnapshotTime: string; /** * The number of ADDM findings. */ findings: string; /** * A description of how the task was created. */ howCreated: string; /** * The timestamp of the beginning AWR snapshot used in the ADDM task as defined by date-time RFC3339 format. */ startSnapshotTime: string; /** * The status of the ADDM task. */ status: string; /** * The ID number of the ADDM task. */ taskId: string; /** * The name of the ADDM task. */ taskName: string; /** * The creation date of the ADDM task. */ timeCreated: string; } interface GetManagedDatabaseAddmTasksFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseAlertLogCountItem { /** * The category of different alert logs. */ category: string; /** * The count of alert logs with specific category. */ count: number; } interface GetManagedDatabaseAlertLogCountsAlertLogCountsCollection { /** * An array of the counts of different urgency or type of alert logs. */ items: outputs.DatabaseManagement.GetManagedDatabaseAlertLogCountsAlertLogCountsCollectionItem[]; } interface GetManagedDatabaseAlertLogCountsAlertLogCountsCollectionItem { /** * The category of different alert logs. */ category: string; /** * The count of alert logs with specific category. */ count: number; } interface GetManagedDatabaseAlertLogCountsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseAttentionLogCountItem { /** * The category of different attention logs. */ category: string; /** * The count of attention logs with specific category. */ count: number; } interface GetManagedDatabaseAttentionLogCountsAttentionLogCountsCollection { /** * An array of the counts of different urgency or type of attention logs. */ items: outputs.DatabaseManagement.GetManagedDatabaseAttentionLogCountsAttentionLogCountsCollectionItem[]; } interface GetManagedDatabaseAttentionLogCountsAttentionLogCountsCollectionItem { /** * The category of different attention logs. */ category: string; /** * The count of attention logs with specific category. */ count: number; } interface GetManagedDatabaseAttentionLogCountsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseCursorCacheStatementsCursorCacheStatementCollection { /** * A list of SQL statements in the cursor cache. */ items: outputs.DatabaseManagement.GetManagedDatabaseCursorCacheStatementsCursorCacheStatementCollectionItem[]; } interface GetManagedDatabaseCursorCacheStatementsCursorCacheStatementCollectionItem { /** * The name of the parsing schema. */ schema: string; /** * The SQL statement identifier. Identifies a SQL statement in the cursor cache. */ sqlId: string; /** * A filter to return all the SQL plan baselines that match the SQL text. By default, the search is case insensitive. To run an exact or case-sensitive search, double-quote the search string. You may also use the '%' symbol as a wildcard. */ sqlText: string; } interface GetManagedDatabaseCursorCacheStatementsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseDbmgmtFeatureConfig { /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails: outputs.DatabaseManagement.GetManagedDatabaseDbmgmtFeatureConfigConnectorDetail[]; /** * The connection details required to connect to the database. */ databaseConnectionDetails: outputs.DatabaseManagement.GetManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetail[]; /** * The name of the Database Management feature. */ feature: string; /** * The list of statuses for Database Management features. */ featureStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetManagedDatabaseDbmgmtFeatureConfigConnectorDetail { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector */ connectorType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId: string; } interface GetManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetail { /** * The credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetailConnectionCredential[]; /** * The details of the Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetailConnectionString[]; } interface GetManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetailConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the database. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the database. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the database. */ userName: string; } interface GetManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetailConnectionString { /** * The list of supported connection types: * * BASIC: Basic connection details */ connectionType: string; /** * The port number used to connect to the database. */ port: number; /** * The protocol used to connect to the database. */ protocol: string; /** * The service name of the database. */ service: string; } interface GetManagedDatabaseGroupManagedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database resides. */ compartmentId: string; /** * The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The infrastructure used to deploy the Oracle Database. */ deploymentType: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Managed Database. */ id: string; /** * The name of the Managed Database Group. */ name: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Managed Database was added to the group. */ timeAdded: string; /** * The workload type of the Autonomous Database. */ workloadType: string; } interface GetManagedDatabaseGroupsFilter { /** * A filter to return only resources that match the entire name. Only one of the parameters, id or name should be provided */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseGroupsManagedDatabaseGroupCollection { items: outputs.DatabaseManagement.GetManagedDatabaseGroupsManagedDatabaseGroupCollectionItem[]; } interface GetManagedDatabaseGroupsManagedDatabaseGroupCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The information specified by the user about the Managed Database Group. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The identifier of the resource. Only one of the parameters, id or name should be provided. */ id: string; /** * A list of Managed Databases in the Managed Database Group. */ managedDatabases: outputs.DatabaseManagement.GetManagedDatabaseGroupsManagedDatabaseGroupCollectionItemManagedDatabase[]; /** * A filter to return only resources that match the entire name. Only one of the parameters, id or name should be provided */ name: string; /** * The lifecycle state of a resource. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Managed Database Group was created. */ timeCreated: string; /** * The date and time the Managed Database Group was last updated. */ timeUpdated: string; } interface GetManagedDatabaseGroupsManagedDatabaseGroupCollectionItemManagedDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The infrastructure used to deploy the Oracle Database. */ deploymentType: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The identifier of the resource. Only one of the parameters, id or name should be provided. */ id: string; /** * A filter to return only resources that match the entire name. Only one of the parameters, id or name should be provided */ name: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Managed Database was added to the group. */ timeAdded: string; /** * The workload type of the Autonomous Database. */ workloadType: string; } interface GetManagedDatabaseManagedDatabaseGroup { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database Group resides. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Managed Database Group. */ id: string; /** * The name of the Managed Database. */ name: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database resides. */ compartmentId: string; /** * The infrastructure used to deploy the Oracle Database. */ dbDeploymentType: string; /** * The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ dbSubType: string; /** * The type of Oracle Database installation. */ dbType: string; /** * The version of the Oracle Database. */ dbVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Managed Database. */ id: string; /** * The name of the rule. */ name: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReport { /** * The list of rules that were not adhered to by the Optimizer Statistics Collection. */ rules: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRule[]; /** * A summary of the Optimizer Statistics Advisor execution. */ summary: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRule { /** * The description of the rule. */ description: string; /** * The list of findings for the rule. */ findings: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFinding[]; /** * The name of the rule. */ name: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFinding { /** * The details of the schema or operation. */ details: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingDetail[]; /** * The message of the rationale. */ message: string; /** * The list of recommendations. */ recommendations: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingRecommendation[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingDetail { /** * The list of operation details. */ operations: string[]; /** * The names of the impacted database schemas and their objects. */ schemas: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingDetailSchema[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingDetailSchema { /** * The name of the rule. */ name: string; /** * The names of schema objects. */ objects: string[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingRecommendation { /** * An example of the recommendation. */ examples: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingRecommendationExample[]; /** * The message of the rationale. */ message: string; /** * The rationale of the recommendation. */ rationales: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingRecommendationRationale[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingRecommendationExample { /** * The list of examples for the recommendation. */ lines: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingRecommendationExampleLine[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingRecommendationExampleLine { /** * The comments about the operation. */ comment: string; /** * The details of the example operation. */ operation: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionReportRuleFindingRecommendationRationale { /** * The message of the rationale. */ message: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsFilter { /** * The name of the rule. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollection { items: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItem[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItem { /** * The summary of the Managed Database resource. */ databases: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemDatabase[]; /** * The errors in the Optimizer Statistics Advisor execution, if any. */ errorMessage: string; /** * The name of the Optimizer Statistics Advisor execution. */ executionName: string; /** * The list of findings for the rule. */ findings: number; /** * A report that includes the rules, findings, recommendations, and actions discovered during the execution of the Optimizer Statistics Advisor. */ reports: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReport[]; /** * The status of the Optimizer Statistics Advisor execution. */ status: string; /** * The Optimizer Statistics Advisor execution status message, if any. */ statusMessage: string; /** * The name of the Optimizer Statistics Advisor task. */ taskName: string; /** * The end time of the time range to retrieve the Optimizer Statistics Advisor execution of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". */ timeEnd: string; /** * The start time of the time range to retrieve the Optimizer Statistics Advisor execution of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". */ timeStart: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database resides. */ compartmentId: string; /** * The infrastructure used to deploy the Oracle Database. */ dbDeploymentType: string; /** * The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ dbSubType: string; /** * The type of Oracle Database installation. */ dbType: string; /** * The version of the Oracle Database. */ dbVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Managed Database. */ id: string; /** * The name of the rule. */ name: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReport { /** * The list of rules that were not adhered to by the Optimizer Statistics Collection. */ rules: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRule[]; /** * A summary of the Optimizer Statistics Advisor execution. */ summary: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRule { /** * The description of the rule. */ description: string; /** * The list of findings for the rule. */ findings: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFinding[]; /** * The name of the rule. */ name: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFinding { /** * The details of the schema or operation. */ details: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingDetail[]; /** * The message of the rationale. */ message: string; /** * The list of recommendations. */ recommendations: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingRecommendation[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingDetail { /** * The list of operation details. */ operations: string[]; /** * The names of the impacted database schemas and their objects. */ schemas: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingDetailSchema[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingDetailSchema { /** * The name of the rule. */ name: string; /** * The names of schema objects. */ objects: string[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingRecommendation { /** * An example of the recommendation. */ examples: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingRecommendationExample[]; /** * The message of the rationale. */ message: string; /** * The rationale of the recommendation. */ rationales: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingRecommendationRationale[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingRecommendationExample { /** * The list of examples for the recommendation. */ lines: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingRecommendationExampleLine[]; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingRecommendationExampleLine { /** * The comments about the operation. */ comment: string; /** * The details of the example operation. */ operation: string; } interface GetManagedDatabaseOptimizerStatisticsAdvisorExecutionsOptimizerStatisticsAdvisorExecutionsCollectionItemReportRuleFindingRecommendationRationale { /** * The message of the rationale. */ message: string; } interface GetManagedDatabaseOptimizerStatisticsCollectionAggregationsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseOptimizerStatisticsCollectionAggregationsOptimizerStatisticsCollectionAggregationsCollection { /** * The list of Optimizer Statistics Collection details. */ items: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsCollectionAggregationsOptimizerStatisticsCollectionAggregationsCollectionItem[]; } interface GetManagedDatabaseOptimizerStatisticsCollectionAggregationsOptimizerStatisticsCollectionAggregationsCollectionItem { /** * The number of tasks or objects for which statistics gathering is completed. */ completed: number; /** * The number of tasks or objects for which statistics gathering failed. */ failed: number; /** * The optimizer statistics tasks grouped by type. */ groupBy: string; /** * The number of tasks or objects for which statistics gathering is in progress. */ inProgress: number; /** * The number of tasks or objects for which statistics are yet to be gathered. */ pending: number; /** * The number of tasks or objects for which statistics gathering was skipped. */ skipped: number; /** * Indicates the end of the hour as the statistics are aggregated per hour. */ timeEnd: string; /** * Indicates the start of the hour as the statistics are aggregated per hour. */ timeStart: string; /** * The number of tasks or objects for which statistics gathering timed out. */ timedOut: number; /** * The total number of tasks or objects for which statistics collection is finished. This number is the sum of all the tasks or objects with various statuses: pending, inProgress, completed, failed, skipped, timedOut, and unknown. */ total: number; /** * The number of tasks or objects for which the status of statistics gathering is unknown. */ unknown: number; } interface GetManagedDatabaseOptimizerStatisticsCollectionOperationDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database resides. */ compartmentId: string; /** * The infrastructure used to deploy the Oracle Database. */ dbDeploymentType: string; /** * The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ dbSubType: string; /** * The type of Oracle Database installation. */ dbType: string; /** * The version of the Oracle Database. */ dbVersion: string; /** * The ID of the operation. */ id: string; /** * The name of the Managed Database. */ name: string; } interface GetManagedDatabaseOptimizerStatisticsCollectionOperationTask { /** * The status of the Optimizer Statistics Collection task. */ status: string; /** * The name of the target object for which statistics are gathered. */ target: string; /** * The type of target object. */ targetType: string; /** * The end time of the Optimizer Statistics Collection task. */ timeEnd: string; /** * The start time of the Optimizer Statistics Collection task. */ timeStart: string; } interface GetManagedDatabaseOptimizerStatisticsCollectionOperationsFilter { /** * The name of the Managed Database. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseOptimizerStatisticsCollectionOperationsOptimizerStatisticsCollectionOperationsCollection { items: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsCollectionOperationsOptimizerStatisticsCollectionOperationsCollectionItem[]; } interface GetManagedDatabaseOptimizerStatisticsCollectionOperationsOptimizerStatisticsCollectionOperationsCollectionItem { /** * The number of objects for which statistics collection is completed. */ completedCount: number; /** * The summary of the Managed Database resource. */ databases: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsCollectionOperationsOptimizerStatisticsCollectionOperationsCollectionItemDatabase[]; /** * The time it takes to complete the operation (in seconds). */ durationInSeconds: number; /** * The end time of the operation. */ endTime: string; /** * The number of objects for which statistics collection failed. */ failedCount: number; /** * The ID of the operation. */ id: number; /** * The number of objects for which statistics collection is in progress. */ inProgressCount: number; /** * The name of the job. */ jobName: string; /** * The name of the operation. */ operationName: string; /** * The start time of the operation. */ startTime: string; /** * The status of the Optimizer Statistics Collection task. */ status: string; /** * The name of the target object for which statistics are gathered. */ target: string; /** * An array of Optimizer Statistics Collection task details. */ tasks: outputs.DatabaseManagement.GetManagedDatabaseOptimizerStatisticsCollectionOperationsOptimizerStatisticsCollectionOperationsCollectionItemTask[]; /** * The number of objects for which statistics collection timed out. */ timedOutCount: number; /** * The total number of objects for which statistics is collected. This number is the sum of all the objects with various statuses: completed, inProgress, failed, and timedOut. */ totalObjectsCount: number; } interface GetManagedDatabaseOptimizerStatisticsCollectionOperationsOptimizerStatisticsCollectionOperationsCollectionItemDatabase { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database resides. */ compartmentId: string; /** * The infrastructure used to deploy the Oracle Database. */ dbDeploymentType: string; /** * The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ dbSubType: string; /** * The type of Oracle Database installation. */ dbType: string; /** * The version of the Oracle Database. */ dbVersion: string; /** * The ID of the operation. */ id: string; /** * The name of the Managed Database. */ name: string; } interface GetManagedDatabaseOptimizerStatisticsCollectionOperationsOptimizerStatisticsCollectionOperationsCollectionItemTask { /** * The status of the Optimizer Statistics Collection task. */ status: string; /** * The name of the target object for which statistics are gathered. */ target: string; /** * The type of target object. */ targetType: string; /** * The end time of the Optimizer Statistics Collection task. */ timeEnd: string; /** * The start time of the Optimizer Statistics Collection task. */ timeStart: string; } interface GetManagedDatabaseSqlPlanBaselineConfigurationAutoCaptureFilter { /** * The database user who last updated the filter value. */ modifiedBy: string; /** * The name of the automatic capture filter. * * AUTO_CAPTURE_SQL_TEXT: Search pattern to apply to SQL text. * * AUTO_CAPTURE_PARSING_SCHEMA_NAME: Parsing schema to include or exclude for SQL plan management auto capture. * * AUTO_CAPTURE_MODULE: Module to include or exclude for SQL plan management auto capture. * * AUTO_CAPTURE_ACTION: Action to include or exclude for SQL plan management automatic capture. */ name: string; /** * The time the filter value was last updated. */ timeLastModified: string; /** * A list of filter values to exclude. */ valuesToExcludes: string[]; /** * A list of filter values to include. */ valuesToIncludes: string[]; } interface GetManagedDatabaseSqlPlanBaselineConfigurationAutoSpmEvolveTaskParameter { /** * The global time limit in seconds. This is the total time allowed for the task. */ allowedTimeLimit: number; /** * Determines which alternative plans should be loaded. */ alternatePlanBaselines: string[]; /** * Specifies the maximum number of plans to load in total (that is, not the limit for each SQL statement). A value of zero indicates `UNLIMITED` number of plans. */ alternatePlanLimit: number; /** * Determines which sources to search for additional plans. */ alternatePlanSources: string[]; /** * Specifies whether to accept recommended plans automatically. */ arePlansAutoAccepted: boolean; } interface GetManagedDatabaseSqlPlanBaselineJobsFilter { /** * A filter to return the SQL plan baseline jobs that match the name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseSqlPlanBaselineJobsSqlPlanBaselineJobCollection { /** * A list of SQL plan baseline jobs. */ items: outputs.DatabaseManagement.GetManagedDatabaseSqlPlanBaselineJobsSqlPlanBaselineJobCollectionItem[]; } interface GetManagedDatabaseSqlPlanBaselineJobsSqlPlanBaselineJobCollectionItem { /** * A filter to return the SQL plan baseline jobs that match the name. */ name: string; /** * The status of the job. */ status: string; /** * The date and time the job was created. */ timeCreated: string; /** * The type of the job. */ type: string; } interface GetManagedDatabaseSqlPlanBaselinesFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseSqlPlanBaselinesSqlPlanBaselineCollection { items: outputs.DatabaseManagement.GetManagedDatabaseSqlPlanBaselinesSqlPlanBaselineCollectionItem[]; } interface GetManagedDatabaseSqlPlanBaselinesSqlPlanBaselineCollectionItem { /** * Indicates whether the plan baseline is accepted (`YES`) or not (`NO`). */ accepted: string; /** * The application action. */ action: string; /** * Indicates whether a plan that is automatically captured by SQL plan management is marked adaptive or not. */ adaptive: string; /** * Indicates whether the plan baseline is auto-purged (`YES`) or not (`NO`). */ autoPurge: string; /** * Indicates whether the plan baseline is enabled (`YES`) or disabled (`NO`). */ enabled: string; /** * The execution plan for the SQL statement. */ executionPlan: string; /** * Indicates whether the plan baseline is fixed (`YES`) or not (`NO`). */ fixed: string; /** * The application module name. */ module: string; /** * A filter to return all the SQL plan baselines that match the origin. */ origin: string; /** * A filter to return only SQL plan baselines that match the plan name. */ planName: string; /** * Indicates whether the optimizer was able to reproduce the plan (`YES`) or not (`NO`). The value is set to `YES` when a plan is initially added to the plan baseline. */ reproduced: string; /** * A filter to return all the SQL plan baselines for the specified SQL handle. */ sqlHandle: string; /** * A filter to return all the SQL plan baselines that match the SQL text. By default, the search is case insensitive. To run an exact or case-sensitive search, double-quote the search string. You may also use the '%' symbol as a wildcard. */ sqlText: string; /** * The date and time when the plan baseline was created. */ timeCreated: string; /** * The date and time when the plan baseline was last executed. */ timeLastExecuted: string; /** * The date and time when the plan baseline was last modified. */ timeLastModified: string; } interface GetManagedDatabaseSqlTuningAdvisorTaskItem { /** * The number of days left before the task expires. If the value equals -1, then the task has no expiration time (UNLIMITED). */ daysToExpire: number; /** * The description of the SQL Tuning Advisor task. */ description: string; /** * The instance ID of the SQL Tuning Advisor task. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ instanceId: number; /** * The optional query parameter to filter the SQL Tuning Advisor task list by name. */ name: string; /** * The owner of the SQL Tuning Advisor task. */ owner: string; /** * The number of recommendations provided for the SQL Tuning Advisor task. */ recommendationCount: number; /** * The unique identifier of the SQL Tuning Advisor task. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskId: string; /** * The status of the SQL Tuning Advisor task. */ taskStatus: string; /** * The Creation date of the SQL Tuning Advisor task. */ timeCreated: string; /** * The end time of the task execution. */ timeExecutionEnded: string; /** * The start time of the task execution. */ timeExecutionStarted: string; /** * The total number of SQL statements related to the SQL Tuning Advisor task. */ totalSqlStatements: number; } interface GetManagedDatabaseSqlTuningAdvisorTasksExecutionPlanStatsComparisonModified { /** * A map contains the statistics for the SQL execution using the plan. The key of the map is the metric's name. The value of the map is the metric's value. */ planStats: { [key: string]: string; }; /** * The status of the execution using the plan. */ planStatus: string; /** * The type of the original or modified plan with profile, index, and so on. */ planType: string; } interface GetManagedDatabaseSqlTuningAdvisorTasksExecutionPlanStatsComparisonOriginal { /** * A map contains the statistics for the SQL execution using the plan. The key of the map is the metric's name. The value of the map is the metric's value. */ planStats: { [key: string]: string; }; /** * The status of the execution using the plan. */ planStatus: string; /** * The type of the original or modified plan with profile, index, and so on. */ planType: string; } interface GetManagedDatabaseSqlTuningAdvisorTasksFilter { /** * The optional query parameter to filter the SQL Tuning Advisor task list by name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseSqlTuningAdvisorTasksFindingItem { /** * The time benefit (in seconds) for the highest-rated finding for this object. */ dbTimeBenefit: number; /** * Indicates whether an alternative execution plan was reported for this SQL statement. */ isAlternativePlanFindingPresent: boolean; /** * Indicates whether there is an error in this SQL statement. */ isErrorFindingPresent: boolean; /** * Indicates whether an index recommendation was reported for this SQL statement. */ isIndexFindingPresent: boolean; /** * Indicates whether a miscellaneous finding was reported for this SQL statement. */ isMiscellaneousFindingPresent: boolean; /** * Indicates whether a restructure SQL recommendation was reported for this SQL statement. */ isRestructureSqlFindingPresent: boolean; /** * Indicates whether a SQL Profile recommendation has been implemented for this SQL statement. */ isSqlProfileFindingImplemented: boolean; /** * Indicates whether a SQL Profile recommendation was reported for this SQL statement. */ isSqlProfileFindingPresent: boolean; /** * Indicates whether a statistics recommendation was reported for this SQL statement. */ isStatsFindingPresent: boolean; /** * Indicates whether the task timed out. */ isTimeoutFindingPresent: boolean; /** * The parsing schema of the object. */ parsingSchema: string; /** * The per-execution percentage benefit. */ perExecutionPercentage: number; /** * The unique key of this SQL statement. */ sqlKey: string; /** * The text of the SQL statement. */ sqlText: string; /** * The SQL tuning task identifier. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskId: string; /** * The execution id of the analyzed SQL object. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskObjectExecutionId: string; /** * The key of the object to which these recommendations apply. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskObjectId: string; } interface GetManagedDatabaseSqlTuningAdvisorTasksFindingsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseSqlTuningAdvisorTasksFindingsSqlTuningAdvisorTaskFindingCollection { /** * An array of the findings for a tuning task. */ items: outputs.DatabaseManagement.GetManagedDatabaseSqlTuningAdvisorTasksFindingsSqlTuningAdvisorTaskFindingCollectionItem[]; } interface GetManagedDatabaseSqlTuningAdvisorTasksFindingsSqlTuningAdvisorTaskFindingCollectionItem { /** * The time benefit (in seconds) for the highest-rated finding for this object. */ dbTimeBenefit: number; /** * Indicates whether an alternative execution plan was reported for this SQL statement. */ isAlternativePlanFindingPresent: boolean; /** * Indicates whether there is an error in this SQL statement. */ isErrorFindingPresent: boolean; /** * Indicates whether an index recommendation was reported for this SQL statement. */ isIndexFindingPresent: boolean; /** * Indicates whether a miscellaneous finding was reported for this SQL statement. */ isMiscellaneousFindingPresent: boolean; /** * Indicates whether a restructure SQL recommendation was reported for this SQL statement. */ isRestructureSqlFindingPresent: boolean; /** * Indicates whether a SQL Profile recommendation has been implemented for this SQL statement. */ isSqlProfileFindingImplemented: boolean; /** * Indicates whether a SQL Profile recommendation was reported for this SQL statement. */ isSqlProfileFindingPresent: boolean; /** * Indicates whether a statistics recommendation was reported for this SQL statement. */ isStatsFindingPresent: boolean; /** * Indicates whether the task timed out. */ isTimeoutFindingPresent: boolean; /** * The parsing schema of the object. */ parsingSchema: string; /** * The per-execution percentage benefit. */ perExecutionPercentage: number; /** * The unique key of this SQL statement. */ sqlKey: string; /** * The text of the SQL statement. */ sqlText: string; /** * The SQL tuning task identifier. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskId: string; /** * The execution id of the analyzed SQL object. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskObjectExecutionId: string; /** * The key of the object to which these recommendations apply. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskObjectId: string; } interface GetManagedDatabaseSqlTuningAdvisorTasksRecommendationItem { /** * The percentage benefit of this implementation. */ benefit: number; /** * Summary of the issue found in the SQL statement. */ finding: string; /** * Action sql to be implemented based on the recommendation result. */ implementActionSql: string; /** * Indicates whether a SQL Profile recommendation uses parallel execution. */ isParallelExecution: boolean; /** * Describes the reasoning behind the recommendation and how it relates to the finding. */ rationale: string; /** * The recommendation for a specific finding. */ recommendation: string; /** * The unique identifier of the recommendation in the scope of the task. */ recommendationKey: number; /** * Type of recommendation. */ recommendationType: string; /** * The SQL tuning task identifier. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskId: string; /** * The key of the object to which these recommendations apply. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskObjectId: string; } interface GetManagedDatabaseSqlTuningAdvisorTasksRecommendationsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseSqlTuningAdvisorTasksRecommendationsSqlTuningAdvisorTaskRecommendationCollection { /** * A list of SQL Tuning Advisor recommendations. */ items: outputs.DatabaseManagement.GetManagedDatabaseSqlTuningAdvisorTasksRecommendationsSqlTuningAdvisorTaskRecommendationCollectionItem[]; } interface GetManagedDatabaseSqlTuningAdvisorTasksRecommendationsSqlTuningAdvisorTaskRecommendationCollectionItem { /** * The percentage benefit of this implementation. */ benefit: number; /** * Summary of the issue found in the SQL statement. */ finding: string; /** * Action sql to be implemented based on the recommendation result. */ implementActionSql: string; /** * Indicates whether a SQL Profile recommendation uses parallel execution. */ isParallelExecution: boolean; /** * Describes the reasoning behind the recommendation and how it relates to the finding. */ rationale: string; /** * The recommendation for a specific finding. */ recommendation: string; /** * The unique identifier of the recommendation in the scope of the task. */ recommendationKey: number; /** * Type of recommendation. */ recommendationType: string; /** * The SQL tuning task identifier. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskId: string; /** * The key of the object to which these recommendations apply. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskObjectId: string; } interface GetManagedDatabaseSqlTuningAdvisorTasksSqlExecutionPlanPlan { /** * The predicates used to locate rows in an access structure. For example, start or stop predicates for an index range scan. */ accessPredicates: string; /** * The attribute of the SQL execution plan. */ attribute: string; /** * The number of bytes returned by the current operation. */ bytes: string; /** * The number of rows returned by the current operation (estimated by the CBO). */ cardinality: string; /** * The cost of the current operation estimated by the cost-based optimizer (CBO). */ cost: number; /** * The CPU cost of the current operation. */ cpuCost: number; /** * The predicates used to filter rows before producing them. */ filterPredicates: string; /** * The I/O cost of the current operation. */ ioCost: number; /** * Number of index columns with start and stop keys (that is, the number of columns with matching predicates). */ numberOfSearchColumn: number; /** * The name of the object. */ object: string; /** * The name of the database link used to reference the object. */ objectNode: string; /** * The owner of the object. */ objectOwner: string; /** * The numbered position of the object name in the original SQL statement. */ objectPosition: number; /** * The descriptive modifier that further describes the type of object. */ objectType: string; /** * The name of the operation performed at this step. */ operation: string; /** * The current mode of the optimizer, such as all_rows, firstRowsN (where n = 1, 10, 100, 1000, and so on). */ optimizerMode: string; /** * The options used for the operation performed at this step. */ options: string; /** * Information about parallel execution servers and parallel queries */ other: string; /** * Describes the function of the SQL text in the OTHER column. */ otherTag: string; /** * The ID of the next step that operates on the results of this step. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ parentStepId: number; /** * The ID of the step in the execution plan that has computed the pair of values of partitionStart and partitionStop. */ partitionId: number; /** * A step may get data from a range of partitions of a partitioned object, such as table or index, based on predicates and sorting order. The partionStart is the starting partition of the range. The partitionStop is the ending partition of the range. */ partitionStart: string; /** * A step may get data from a range of partitions of a partitioned object, such as table or index, based on predicates and sorting order. The partionStart is the starting partition of the range. The partitionStop is the ending partition of the range. */ partitionStop: string; /** * The numerical representation of the SQL execution plan. */ planHashValue: string; /** * The order of processing for steps with the same parent ID. */ position: number; /** * The place for comments that can be added to the steps of the execution plan. */ remarks: string; /** * The identification number of a step in the SQL execution plan. This is unique within the SQL execution plan. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ stepId: number; /** * The temporary space usage (in bytes) of the operation (sort or hash-join) as estimated by the CBO. */ tempSpace: string; /** * The elapsed time (in seconds) of the operation as estimated by the CBO. */ time: string; } interface GetManagedDatabaseSqlTuningAdvisorTasksSqlTuningAdvisorTaskCollection { /** * A list of SQL Tuning Advisor tasks. */ items: outputs.DatabaseManagement.GetManagedDatabaseSqlTuningAdvisorTasksSqlTuningAdvisorTaskCollectionItem[]; } interface GetManagedDatabaseSqlTuningAdvisorTasksSqlTuningAdvisorTaskCollectionItem { /** * The number of days left before the task expires. If the value equals -1, then the task has no expiration time (UNLIMITED). */ daysToExpire: number; /** * The description of the SQL Tuning Advisor task. */ description: string; /** * The instance ID of the SQL Tuning Advisor task. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ instanceId: number; /** * The optional query parameter to filter the SQL Tuning Advisor task list by name. */ name: string; /** * The owner of the SQL Tuning Advisor task. */ owner: string; /** * The number of recommendations provided for the SQL Tuning Advisor task. */ recommendationCount: number; /** * The unique identifier of the SQL Tuning Advisor task. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sqlTuningAdvisorTaskId: string; /** * The status of the SQL Tuning Advisor task. */ taskStatus: string; /** * The Creation date of the SQL Tuning Advisor task. */ timeCreated: string; /** * The end time of the task execution. */ timeExecutionEnded: string; /** * The start time of the task execution. */ timeExecutionStarted: string; /** * The total number of SQL statements related to the SQL Tuning Advisor task. */ totalSqlStatements: number; } interface GetManagedDatabaseSqlTuningAdvisorTasksSummaryReportIndexFinding { /** * Columns of the index. */ indexColumns: string[]; /** * Numerical representation of the index. */ indexHashValue: string; /** * Name of the index. */ indexName: string; /** * The number of the times the object is referenced within the SQL Tuning advisor task findings. */ referenceCount: number; /** * Schema of the object. */ schema: string; /** * Table's name related to the index. */ tableName: string; } interface GetManagedDatabaseSqlTuningAdvisorTasksSummaryReportObjectStatFinding { /** * Name of the object. */ object: string; /** * Numerical representation of the object. */ objectHashValue: string; /** * Type of the object. */ objectType: string; /** * Type of statistics problem related to the object. */ problemType: string; /** * The number of the times the object is referenced within the SQL Tuning advisor task findings. */ referenceCount: number; /** * Schema of the object. */ schema: string; } interface GetManagedDatabaseSqlTuningAdvisorTasksSummaryReportStatistic { /** * The benefits of the findings in the SQL Tuning Advisor summary report. */ findingBenefits: outputs.DatabaseManagement.GetManagedDatabaseSqlTuningAdvisorTasksSummaryReportStatisticFindingBenefit[]; /** * The number of findings in the SQL Tuning Advisor summary report. */ findingCounts: outputs.DatabaseManagement.GetManagedDatabaseSqlTuningAdvisorTasksSummaryReportStatisticFindingCount[]; /** * The number of statements in the SQL Tuning Advisor summary report. */ statementCounts: outputs.DatabaseManagement.GetManagedDatabaseSqlTuningAdvisorTasksSummaryReportStatisticStatementCount[]; } interface GetManagedDatabaseSqlTuningAdvisorTasksSummaryReportStatisticFindingBenefit { /** * The actual database time of the SQL statements for which SQL Tuning Advisor recommendations are implemented. */ dbTimeAfterImplemented: number; /** * The estimated database time of the above SQL statements, if SQL Tuning Advisor recommendations are implemented. */ dbTimeAfterRecommended: number; /** * The actual database time of the above SQL statements, before SQL Tuning Advisor recommendations are implemented. */ dbTimeBeforeImplemented: number; /** * The actual database time of the SQL statements for which SQL Tuning Advisor recommendations are not implemented. */ dbTimeBeforeRecommended: number; } interface GetManagedDatabaseSqlTuningAdvisorTasksSummaryReportStatisticFindingCount { /** * The number of distinct SQL statements with alternative plan recommendations. */ alternatePlan: number; /** * The number of distinct SQL statements with implemented SQL profiles. */ implementedSqlProfile: number; /** * The number of distinct SQL statements with index recommendations. */ index: number; /** * The number of distinct SQL statements with recommended SQL profiles. */ recommendedSqlProfile: number; /** * The number of distinct SQL statements with restructured SQL recommendations. */ restructure: number; /** * The number of distinct SQL statements with stale or missing optimizer statistics recommendations. */ statistics: number; } interface GetManagedDatabaseSqlTuningAdvisorTasksSummaryReportStatisticStatementCount { /** * The number of distinct SQL statements. */ distinctSql: number; /** * The number of distinct SQL statements with errors. */ errorCount: number; /** * The number of distinct SQL statements with findings. */ findingCount: number; /** * The total number of SQL statements. */ totalSql: number; } interface GetManagedDatabaseSqlTuningAdvisorTasksSummaryReportTaskInfo { /** * The description of the SQL Tuning Advisor task. This is not defined for Auto SQL Tuning tasks. */ description: string; /** * The ID of the SQL Tuning Advisor task. This is not the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * The name of the SQL Tuning Advisor task. */ name: string; /** * The owner of the SQL Tuning Advisor task. */ owner: string; /** * The total running time in seconds. This is not defined for Auto SQL Tuning tasks. */ runningTime: number; /** * The status of the SQL Tuning Advisor task. This is not defined for Auto SQL Tuning tasks. */ status: string; /** * The end time of the task execution. */ timeEnded: string; /** * The start time of the task execution. */ timeStarted: string; } interface GetManagedDatabaseSqlTuningSetItem { /** * The description of the SQL tuning set. */ description: string; /** * The name of the SQL tuning set. */ name: string; /** * The owner of the SQL tuning set. */ owner: string; /** * The number of SQL statements in the SQL tuning set. */ statementCounts: number; } interface GetManagedDatabaseSqlTuningSetsFilter { /** * The name of the SQL tuning set. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseSqlTuningSetsSqlTuningSetCollection { /** * The details in the SQL tuning set summary. */ items: outputs.DatabaseManagement.GetManagedDatabaseSqlTuningSetsSqlTuningSetCollectionItem[]; } interface GetManagedDatabaseSqlTuningSetsSqlTuningSetCollectionItem { /** * The description of the SQL tuning set. */ description: string; /** * Latest execution error of the plsql that was submitted as a scheduler job. */ errorMessage: string; /** * The unique Sql tuning set identifier. This is not OCID. */ id: number; /** * The name of the SQL tuning set. */ name: string; /** * The owner of the SQL tuning set. */ owner: string; /** * Name of the Sql tuning set scheduler job. */ scheduledJobName: string; /** * The number of SQL statements in the SQL tuning set. */ statementCounts: number; /** * Current status of the Sql tuning set. */ status: string; /** * The created time of the Sql tuning set. */ timeCreated: string; /** * Last modified time of the Sql tuning set. */ timeLastModified: string; } interface GetManagedDatabaseTableStatisticsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseTableStatisticsTableStatisticsCollection { /** * The list of table statistics statuses. */ items: outputs.DatabaseManagement.GetManagedDatabaseTableStatisticsTableStatisticsCollectionItem[]; } interface GetManagedDatabaseTableStatisticsTableStatisticsCollectionItem { /** * The number of objects aggregated by status category. */ count: number; /** * The percentage of objects with a particular status. */ percentage: number; /** * The valid status categories of table statistics. */ type: string; } interface GetManagedDatabaseUserConsumerGroupPrivilegeItem { /** * Indicates whether the privilege is granted with the GRANT option (YES) or not (NO). */ grantOption: string; /** * Indicates whether the consumer group is designated as the default for this user or role (YES) or not (NO). */ initialGroup: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabaseUserConsumerGroupPrivilegesConsumerGroupPrivilegeCollection { /** * An array of consumer group privileges. */ items: outputs.DatabaseManagement.GetManagedDatabaseUserConsumerGroupPrivilegesConsumerGroupPrivilegeCollectionItem[]; } interface GetManagedDatabaseUserConsumerGroupPrivilegesConsumerGroupPrivilegeCollectionItem { /** * Indicates whether the privilege is granted with the GRANT option (YES) or not (NO). */ grantOption: string; /** * Indicates whether the consumer group is designated as the default for this user or role (YES) or not (NO). */ initialGroup: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabaseUserConsumerGroupPrivilegesFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseUserDataAccessContainerItem { /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabaseUserDataAccessContainersDataAccessContainerCollection { /** * An array of container resources. */ items: outputs.DatabaseManagement.GetManagedDatabaseUserDataAccessContainersDataAccessContainerCollectionItem[]; } interface GetManagedDatabaseUserDataAccessContainersDataAccessContainerCollectionItem { /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabaseUserDataAccessContainersFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseUserObjectPrivilegeItem { /** * Indicates how the object privilege was granted. Possible values: YES if the role is granted commonly (CONTAINER=ALL is used) NO if the role is granted locally (CONTAINER=ALL is not used) */ common: string; /** * Indicates whether the privilege is granted with the GRANT OPTION (YES) or not (NO). */ grantOption: string; /** * The name of the user who granted the object privilege. */ grantor: string; /** * Indicates whether the privilege is granted with the HIERARCHY OPTION (YES) or not (NO). */ hierarchy: string; /** * Indicates whether the granted privilege is inherited from another container (YES) or not (NO). */ inherited: string; /** * A filter to return only resources that match the entire name. */ name: string; /** * The name of the object. The object can be any object, including tables, packages, indexes, sequences, and so on. */ object: string; /** * The owner of the object. */ owner: string; /** * The type of object. */ schemaType: string; } interface GetManagedDatabaseUserObjectPrivilegesFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseUserObjectPrivilegesObjectPrivilegeCollection { /** * An array of object privileges. */ items: outputs.DatabaseManagement.GetManagedDatabaseUserObjectPrivilegesObjectPrivilegeCollectionItem[]; } interface GetManagedDatabaseUserObjectPrivilegesObjectPrivilegeCollectionItem { /** * Indicates how the object privilege was granted. Possible values: YES if the role is granted commonly (CONTAINER=ALL is used) NO if the role is granted locally (CONTAINER=ALL is not used) */ common: string; /** * Indicates whether the privilege is granted with the GRANT OPTION (YES) or not (NO). */ grantOption: string; /** * The name of the user who granted the object privilege. */ grantor: string; /** * Indicates whether the privilege is granted with the HIERARCHY OPTION (YES) or not (NO). */ hierarchy: string; /** * Indicates whether the granted privilege is inherited from another container (YES) or not (NO). */ inherited: string; /** * A filter to return only resources that match the entire name. */ name: string; /** * The name of the object. The object can be any object, including tables, packages, indexes, sequences, and so on. */ object: string; /** * The owner of the object. */ owner: string; /** * The type of object. */ schemaType: string; } interface GetManagedDatabaseUserProxiedForUserItem { /** * Indicates whether the proxy is required to supply the client credentials (YES) or not (NO). */ authentication: string; /** * The flags associated with the proxy/client pair. */ flags: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabaseUserProxiedForUsersFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseUserProxiedForUsersProxiedForUserCollection { /** * An array of user resources. */ items: outputs.DatabaseManagement.GetManagedDatabaseUserProxiedForUsersProxiedForUserCollectionItem[]; } interface GetManagedDatabaseUserProxiedForUsersProxiedForUserCollectionItem { /** * Indicates whether the proxy is required to supply the client credentials (YES) or not (NO). */ authentication: string; /** * The flags associated with the proxy/client pair. */ flags: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabaseUserRoleItem { /** * Indicates whether the role is granted with the ADMIN OPTION (YES) or not (NO). */ adminOption: string; /** * Indicates how the role was granted. Possible values: YES if the role is granted commonly (CONTAINER=ALL is used) NO if the role is granted locally (CONTAINER=ALL is not used) */ common: string; /** * Indicates whether the role is designated as a DEFAULT ROLE for the user (YES) or not (NO). */ defaultRole: string; /** * Indicates whether the role is granted with the DELEGATE OPTION (YES) or not (NO). */ delegateOption: string; /** * Indicates whether the granted role is inherited from another container (YES) or not (NO). */ inherited: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabaseUserRolesFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseUserRolesRoleCollection { /** * An array of roles. */ items: outputs.DatabaseManagement.GetManagedDatabaseUserRolesRoleCollectionItem[]; } interface GetManagedDatabaseUserRolesRoleCollectionItem { /** * Indicates whether the role is granted with the ADMIN OPTION (YES) or not (NO). */ adminOption: string; /** * Indicates how the role was granted. Possible values: YES if the role is granted commonly (CONTAINER=ALL is used) NO if the role is granted locally (CONTAINER=ALL is not used) */ common: string; /** * Indicates whether the role is designated as a DEFAULT ROLE for the user (YES) or not (NO). */ defaultRole: string; /** * Indicates whether the role is granted with the DELEGATE OPTION (YES) or not (NO). */ delegateOption: string; /** * Indicates whether the granted role is inherited from another container (YES) or not (NO). */ inherited: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabaseUsersFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabaseUsersUserCollection { items: outputs.DatabaseManagement.GetManagedDatabaseUsersUserCollectionItem[]; } interface GetManagedDatabaseUsersUserCollectionItem { /** * In a sharded database, indicates whether the user is created with shard DDL enabled (YES) or not (NO). */ allShared: string; /** * The authentication mechanism for the user. */ authentication: string; /** * Indicates whether a given user is common(Y) or local(N). */ common: string; /** * The initial resource consumer group for the User. */ consumerGroup: string; /** * The default collation for the user schema. */ defaultCollation: string; /** * The default tablespace for data. */ defaultTablespace: string; /** * Indicates whether editions have been enabled for the corresponding user (Y) or not (N). */ editionsEnabled: string; /** * The external name of the user. */ externalName: string; /** * In a federated sharded database, indicates whether the user is an external shard user (YES) or not (NO). */ externalShared: string; /** * Indicates whether the user is a common user created by an implicit application (YES) or not (NO). */ implicit: string; /** * Indicates whether the user definition is inherited from another container (YES) or not (NO). */ inherited: string; /** * The default local temporary tablespace for the user. */ localTempTablespace: string; /** * A filter to return only resources that match the entire name. */ name: string; /** * Indicates whether the user was created and is maintained by Oracle-supplied scripts (such as catalog.sql or catproc.sql). */ oracleMaintained: string; /** * The list of existing versions of the password hashes (also known as "verifiers") for the account. */ passwordVersions: string; /** * The profile name of the user. */ profile: string; /** * Indicates whether a user can connect directly (N) or whether the account can only be proxied (Y) by users who have proxy privileges for this account (that is, by users who have been granted the "connect through" privilege for this account). */ proxyConnect: string; /** * The status of the user account. */ status: string; /** * The name of the default tablespace for temporary tables or the name of a tablespace group. */ tempTablespace: string; /** * The date and time the user was created. */ timeCreated: string; /** * The date and time of the expiration of the user account. */ timeExpiring: string; /** * The date and time of the last user login. This column is not populated when a user connects to the database with administrative privileges, that is, AS { SYSASM | SYSBACKUP | SYSDBA | SYSDG | SYSOPER | SYSRAC | SYSKM }. */ timeLastLogin: string; /** * The date the account was locked, if the status of the account is LOCKED. */ timeLocked: string; /** * The date and time when the user password was last set. This column is populated only when the value of the AUTHENTICATION_TYPE column is PASSWORD. Otherwise, this column is null. */ timePasswordChanged: string; } interface GetManagedDatabasesAsmPropertiesAsmPropertyCollection { /** * An array of AsmPropertySummary resources. */ items: outputs.DatabaseManagement.GetManagedDatabasesAsmPropertiesAsmPropertyCollectionItem[]; } interface GetManagedDatabasesAsmPropertiesAsmPropertyCollectionItem { /** * The name of the disk group. */ diskGroup: string; } interface GetManagedDatabasesAsmPropertiesFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabasesAsmPropertyItem { /** * The name of the disk group. */ diskGroup: string; } interface GetManagedDatabasesDatabaseParameterItem { /** * A list of allowed values for this parameter. */ allowedValues: outputs.DatabaseManagement.GetManagedDatabasesDatabaseParameterItemAllowedValue[]; /** * The parameter category. */ category: string; /** * Applicable in case of Oracle Real Application Clusters (Oracle RAC) databases. A `UNIQUE` parameter is one which is unique to each Oracle Real Application Clusters (Oracle RAC) instance. For example, the parameter `INSTANCE_NUMBER` must have different values in each instance. An `IDENTICAL` parameter must have the same value for every instance. For example, the parameter `DB_BLOCK_SIZE` must have the same value in all instances. */ constraint: string; /** * The ID of the database container to which the data pertains. Possible values include: */ containerId: number; /** * The description of the parameter. */ description: string; /** * The parameter value in a user-friendly format. For example, if the `value` property shows the value 262144 for a big integer parameter, then the `displayValue` property will show the value 256K. */ displayValue: string; /** * Indicates whether Oracle adjusted the input value to a more suitable value. */ isAdjusted: boolean; /** * Indicates whether the parameter is a basic parameter (`TRUE`) or not (`FALSE`). */ isBasic: boolean; /** * Indicates whether the parameter is set to the default value (`TRUE`) or the parameter value was specified in the parameter file (`FALSE`). */ isDefault: boolean; /** * Indicates whether the parameter has been deprecated (`TRUE`) or not (`FALSE`). */ isDeprecated: boolean; /** * For parameters that can be changed with `ALTER SYSTEM`, indicates whether the value of the parameter can be different for every instance (`TRUE`) or whether the parameter must have the same value for all Real Application Clusters instances (`FALSE`). For other parameters, this is always `FALSE`. */ isInstanceModifiable: boolean; /** * Indicates how the parameter was modified. If an `ALTER SYSTEM` was performed, the value will be `MODIFIED`. */ isModified: string; /** * Indicates whether the parameter can be modified on a per-PDB basis (`TRUE`) or not (`FALSE`). In a non-CDB, the value of this property is `null`. */ isPdbModifiable: boolean; /** * Indicates whether the parameter can be changed with `ALTER SESSION` (`TRUE`) or not (`FALSE`) */ isSessionModifiable: boolean; /** * Indicates whether the parameter was specified in the server parameter file (`TRUE`) or not (`FALSE`). Applicable only when the parameter source is `SPFILE`. */ isSpecified: boolean; /** * Indicates whether the parameter can be changed with `ALTER SYSTEM` and when the change takes effect: * * IMMEDIATE: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect immediately. * * DEFERRED: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect in subsequent sessions. * * FALSE: Parameter cannot be changed with `ALTER SYSTEM` unless a server parameter file was used to start the instance. The change takes effect in subsequent instances. */ isSystemModifiable: string; /** * A filter to return all parameters that have the text given in their names. */ name: string; /** * The parameter number. */ number: number; /** * The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings. */ ordinal: number; /** * The database instance SID for which the parameter is defined. */ sid: string; /** * The parameter type. */ type: string; /** * The comments associated with the most recent update. */ updateComment: string; /** * The parameter value. */ value: string; } interface GetManagedDatabasesDatabaseParameterItemAllowedValue { /** * Indicates whether the parameter is set to the default value (`TRUE`) or the parameter value was specified in the parameter file (`FALSE`). */ isDefault: boolean; /** * The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings. */ ordinal: number; /** * The parameter value. */ value: string; } interface GetManagedDatabasesDatabaseParametersDatabaseParametersCollection { /** * The name of the Managed Database. */ databaseName: string; /** * The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The Oracle Database version. */ databaseVersion: string; /** * An array of DatabaseParameterSummary objects. */ items: outputs.DatabaseManagement.GetManagedDatabasesDatabaseParametersDatabaseParametersCollectionItem[]; } interface GetManagedDatabasesDatabaseParametersDatabaseParametersCollectionItem { /** * A list of allowed values for this parameter. */ allowedValues: outputs.DatabaseManagement.GetManagedDatabasesDatabaseParametersDatabaseParametersCollectionItemAllowedValue[]; /** * The parameter category. */ category: string; /** * Applicable in case of Oracle Real Application Clusters (Oracle RAC) databases. A `UNIQUE` parameter is one which is unique to each Oracle Real Application Clusters (Oracle RAC) instance. For example, the parameter `INSTANCE_NUMBER` must have different values in each instance. An `IDENTICAL` parameter must have the same value for every instance. For example, the parameter `DB_BLOCK_SIZE` must have the same value in all instances. */ constraint: string; /** * The ID of the database container to which the data pertains. Possible values include: */ containerId: number; /** * The description of the parameter. */ description: string; /** * The parameter value in a user-friendly format. For example, if the `value` property shows the value 262144 for a big integer parameter, then the `displayValue` property will show the value 256K. */ displayValue: string; /** * Indicates whether Oracle adjusted the input value to a more suitable value. */ isAdjusted: boolean; /** * Indicates whether the parameter is a basic parameter (`TRUE`) or not (`FALSE`). */ isBasic: boolean; /** * Indicates whether the parameter is set to the default value (`TRUE`) or the parameter value was specified in the parameter file (`FALSE`). */ isDefault: boolean; /** * Indicates whether the parameter has been deprecated (`TRUE`) or not (`FALSE`). */ isDeprecated: boolean; /** * For parameters that can be changed with `ALTER SYSTEM`, indicates whether the value of the parameter can be different for every instance (`TRUE`) or whether the parameter must have the same value for all Real Application Clusters instances (`FALSE`). For other parameters, this is always `FALSE`. */ isInstanceModifiable: boolean; /** * Indicates how the parameter was modified. If an `ALTER SYSTEM` was performed, the value will be `MODIFIED`. */ isModified: string; /** * Indicates whether the parameter can be modified on a per-PDB basis (`TRUE`) or not (`FALSE`). In a non-CDB, the value of this property is `null`. */ isPdbModifiable: boolean; /** * Indicates whether the parameter can be changed with `ALTER SESSION` (`TRUE`) or not (`FALSE`) */ isSessionModifiable: boolean; /** * Indicates whether the parameter was specified in the server parameter file (`TRUE`) or not (`FALSE`). Applicable only when the parameter source is `SPFILE`. */ isSpecified: boolean; /** * Indicates whether the parameter can be changed with `ALTER SYSTEM` and when the change takes effect: * * IMMEDIATE: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect immediately. * * DEFERRED: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect in subsequent sessions. * * FALSE: Parameter cannot be changed with `ALTER SYSTEM` unless a server parameter file was used to start the instance. The change takes effect in subsequent instances. */ isSystemModifiable: string; /** * A filter to return all parameters that have the text given in their names. */ name: string; /** * The parameter number. */ number: number; /** * The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings. */ ordinal: number; /** * The database instance SID for which the parameter is defined. */ sid: string; /** * The parameter type. */ type: string; /** * The comments associated with the most recent update. */ updateComment: string; /** * The parameter value. */ value: string; } interface GetManagedDatabasesDatabaseParametersDatabaseParametersCollectionItemAllowedValue { /** * Indicates whether the parameter is set to the default value (`TRUE`) or the parameter value was specified in the parameter file (`FALSE`). */ isDefault: boolean; /** * The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings. */ ordinal: number; /** * The parameter value. */ value: string; } interface GetManagedDatabasesDatabaseParametersFilter { /** * A filter to return all parameters that have the text given in their names. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabasesFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabasesManagedDatabaseCollection { items: outputs.DatabaseManagement.GetManagedDatabasesManagedDatabaseCollectionItem[]; } interface GetManagedDatabasesManagedDatabaseCollectionItem { /** * The additional details specific to a type of database defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}` */ additionalDetails: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The operating system of database. */ databasePlatformName: string; /** * The status of the Oracle Database. Indicates whether the status of the database is UP, DOWN, or UNKNOWN at the current time. */ databaseStatus: string; /** * The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * The Oracle Database version. */ databaseVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB system that this Managed Database is part of. */ dbSystemId: string; /** * The list of feature configurations */ dbmgmtFeatureConfigs: outputs.DatabaseManagement.GetManagedDatabasesManagedDatabaseCollectionItemDbmgmtFeatureConfig[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Managed Databases of the specified deployment type. */ deploymentType: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The identifier of the resource. */ id: string; /** * Indicates whether the Oracle Database is part of a cluster. */ isCluster: boolean; /** * A list of Managed Database Groups that the Managed Database belongs to. */ managedDatabaseGroups: outputs.DatabaseManagement.GetManagedDatabasesManagedDatabaseCollectionItemManagedDatabaseGroup[]; /** * A filter to return Managed Databases with the specified management option. */ managementOption: string; /** * A filter to return only resources that match the entire name. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent Container Database if Managed Database is a Pluggable Database. */ parentContainerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the storage DB system. */ storageSystemId: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Managed Database was created. */ timeCreated: string; /** * The workload type of the Autonomous Database. */ workloadType: string; } interface GetManagedDatabasesManagedDatabaseCollectionItemDbmgmtFeatureConfig { /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails: outputs.DatabaseManagement.GetManagedDatabasesManagedDatabaseCollectionItemDbmgmtFeatureConfigConnectorDetail[]; /** * The connection details required to connect to the database. */ databaseConnectionDetails: outputs.DatabaseManagement.GetManagedDatabasesManagedDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetail[]; /** * The name of the Database Management feature. */ feature: string; /** * The list of statuses for Database Management features. */ featureStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface GetManagedDatabasesManagedDatabaseCollectionItemDbmgmtFeatureConfigConnectorDetail { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector */ connectorType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId: string; } interface GetManagedDatabasesManagedDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetail { /** * The credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.GetManagedDatabasesManagedDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionCredential[]; /** * The details of the Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.GetManagedDatabasesManagedDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionString[]; } interface GetManagedDatabasesManagedDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the database. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the database. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the database. */ userName: string; } interface GetManagedDatabasesManagedDatabaseCollectionItemDbmgmtFeatureConfigDatabaseConnectionDetailConnectionString { /** * The list of supported connection types: * * BASIC: Basic connection details */ connectionType: string; /** * The port number used to connect to the database. */ port: number; /** * The protocol used to connect to the database. */ protocol: string; /** * The service name of the database. */ service: string; } interface GetManagedDatabasesManagedDatabaseCollectionItemManagedDatabaseGroup { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The identifier of the resource. */ id: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabasesUserProxyUserItem { /** * Indicates whether the proxy is required to supply the client credentials (YES) or not (NO). */ authentication: string; /** * The flags associated with the proxy/client pair. */ flags: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabasesUserProxyUsersFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabasesUserProxyUsersProxyUserCollection { /** * An array of user resources. */ items: outputs.DatabaseManagement.GetManagedDatabasesUserProxyUsersProxyUserCollectionItem[]; } interface GetManagedDatabasesUserProxyUsersProxyUserCollectionItem { /** * Indicates whether the proxy is required to supply the client credentials (YES) or not (NO). */ authentication: string; /** * The flags associated with the proxy/client pair. */ flags: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabasesUserSystemPrivilegeItem { /** * Indicates whether the system privilege is granted with the ADMIN option (YES) or not (NO). */ adminOption: string; /** * Indicates how the system privilege was granted. Possible values: YES if the system privilege is granted commonly (CONTAINER=ALL is used) NO if the system privilege is granted locally (CONTAINER=ALL is not used) */ common: string; /** * Indicates whether the granted system privilege is inherited from another container (YES) or not (NO). */ inherited: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedDatabasesUserSystemPrivilegesFilter { /** * A filter to return only resources that match the entire name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedDatabasesUserSystemPrivilegesSystemPrivilegeCollection { /** * An array of system privileges. */ items: outputs.DatabaseManagement.GetManagedDatabasesUserSystemPrivilegesSystemPrivilegeCollectionItem[]; } interface GetManagedDatabasesUserSystemPrivilegesSystemPrivilegeCollectionItem { /** * Indicates whether the system privilege is granted with the ADMIN option (YES) or not (NO). */ adminOption: string; /** * Indicates how the system privilege was granted. Possible values: YES if the system privilege is granted commonly (CONTAINER=ALL is used) NO if the system privilege is granted locally (CONTAINER=ALL is not used) */ common: string; /** * Indicates whether the granted system privilege is inherited from another container (YES) or not (NO). */ inherited: string; /** * A filter to return only resources that match the entire name. */ name: string; } interface GetManagedMySqlDatabaseConfigurationDataFilter { /** * The name of variable */ name: string; regex?: boolean; values: string[]; } interface GetManagedMySqlDatabaseConfigurationDataMySqlConfigurationDataCollection { /** * List of ConfigurationDataSummary. */ items: outputs.DatabaseManagement.GetManagedMySqlDatabaseConfigurationDataMySqlConfigurationDataCollectionItem[]; } interface GetManagedMySqlDatabaseConfigurationDataMySqlConfigurationDataCollectionItem { /** * default value of variable */ defaultValue: string; /** * Description of the variable */ description: string; /** * Host from where this value was set. Empty for MySql Database System */ hostSet: string; /** * Whether this variable is configurable */ isConfigurable: boolean; /** * Whether variable can be set dynamically or not */ isDynamic: boolean; /** * whether variable is set at server startup */ isInit: boolean; /** * Maximum value of variable */ maxValue: number; /** * Minimum value of variable */ minValue: number; /** * The name of variable */ name: string; /** * If the variable was set from an option file, VARIABLE_PATH is the path name of that file. Otherwise, the value is the empty string. */ path: string; /** * Comma separated list of possible values for the variable in value:valueDescription format */ possibleValues: string; /** * The source from which the variable was most recently set */ source: string; /** * Comma separated list of MySql versions where this variable is supported */ supportedVersions: string; /** * Time when value was set */ timeSet: string; /** * type of variable */ type: string; /** * User who set this value. Empty for MySql Database System */ userSet: string; /** * The value of variable */ value: string; } interface GetManagedMySqlDatabaseDigestErrorsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedMySqlDatabaseDigestErrorsMySqlDigestErrorsCollection { /** * The unique set of errors for a given digest. */ items: outputs.DatabaseManagement.GetManagedMySqlDatabaseDigestErrorsMySqlDigestErrorsCollectionItem[]; } interface GetManagedMySqlDatabaseDigestErrorsMySqlDigestErrorsCollectionItem { /** * The MySQL error, warning, or note raised when a query is run, if any. MySQL support within Oracle Cloud Infrastructure Database Management service has been deprecated as of January 29, 2026. */ errors: outputs.DatabaseManagement.GetManagedMySqlDatabaseDigestErrorsMySqlDigestErrorsCollectionItemError[]; /** * The number of times a MySQL error is encountered. */ occurrenceCount: number; } interface GetManagedMySqlDatabaseDigestErrorsMySqlDigestErrorsCollectionItemError { /** * The MySQL code of the raised error, warning, or note. */ code: number; /** * The level of severity of the MySQL message. */ level: string; /** * The MySQL message text of the raised error, warning, or note. */ messageText: string; } interface GetManagedMySqlDatabaseHeatWaveNode { /** * The ID associated with the HeatWave node. */ id: string; /** * The status of the HeatWave node. Indicates whether the status of the node is UP, DOWN, or UNKNOWN at the current time. */ status: string; /** * The date and time the HeatWave node was created. */ timeCreated: string; } interface GetManagedMySqlDatabaseHighAvailabilityMembersFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollection { /** * The mode used for flow control. */ flowControl: string; /** * The interval between successive values for auto-incremented columns for transactions that execute on this server instance. */ groupAutoIncrement: number; /** * The name of the group to which this server instance belongs. */ groupName: string; /** * A list of MySqlHighAvailabilityMember records. */ items: outputs.DatabaseManagement.GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionItem[]; /** * The role of this server as a group replication member. */ memberRole: string; /** * The state of this server as a group replication member. */ memberState: string; /** * Indicates if the replication group is running in single-primary mode. */ singlePrimaryMode: string; /** * High availability status summary of a MySQL server. MySQL support within Oracle Cloud Infrastructure Database Management service has been deprecated as of January 29, 2026. */ statusSummaries: outputs.DatabaseManagement.GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummary[]; /** * The number of transactions that were replicated within the cluster. */ transactionsInGtidExecuted: string; /** * The current view identifier for this group. */ viewId: string; } interface GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionItem { /** * The host name of the group member that clients use to connect to it. */ memberHost: string; /** * The port number of the group member that clients use to connect to it. */ memberPort: number; /** * The role of this server as a group replication member. */ memberRole: string; /** * The state of this server as a group replication member. */ memberState: string; /** * The Universally Unique Identifier (UUID) of the member server. */ memberUuid: string; } interface GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummary { /** * A list of MySqlChannelApplyError records. */ channelApplyErrors: outputs.DatabaseManagement.GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummaryChannelApplyError[]; /** * A list of MySqlChannelFetchError records. */ channelFetchErrors: outputs.DatabaseManagement.GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummaryChannelFetchError[]; } interface GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummaryChannelApplyError { /** * Error from the apply operation of a MySQL server replication channel. MySQL support within Oracle Cloud Infrastructure Database Management service has been deprecated as of January 29, 2026. */ applyErrors: outputs.DatabaseManagement.GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummaryChannelApplyErrorApplyError[]; /** * The name of the replication channel. */ channelName: string; } interface GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummaryChannelApplyErrorApplyError { /** * The error message of the most recent error that caused the I/O thread to stop. */ lastErrorMessage: string; /** * The error number of the most recent error that caused the I/O thread to stop. */ lastErrorNumber: number; /** * The timestamp when the most recent I/O error occurred. */ timeLastError: string; /** * A list of MySqlApplyErrorWorker records. */ workerErrors: outputs.DatabaseManagement.GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummaryChannelApplyErrorApplyErrorWorkerError[]; } interface GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummaryChannelApplyErrorApplyErrorWorkerError { /** * The error message of the most recent error that caused the I/O thread to stop. */ lastErrorMessage: string; /** * The error number of the most recent error that caused the I/O thread to stop. */ lastErrorNumber: number; /** * The timestamp when the most recent I/O error occurred. */ timeLastError: string; } interface GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummaryChannelFetchError { /** * The name of the replication channel. */ channelName: string; /** * Error from the fetch operation of a MySQL server replication channel. MySQL support within Oracle Cloud Infrastructure Database Management service has been deprecated as of January 29, 2026. */ fetchErrors: outputs.DatabaseManagement.GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummaryChannelFetchErrorFetchError[]; } interface GetManagedMySqlDatabaseHighAvailabilityMembersManagedMySqlDatabaseHighAvailabilityMemberCollectionStatusSummaryChannelFetchErrorFetchError { /** * The error message of the most recent error that caused the I/O thread to stop. */ lastErrorMessage: string; /** * The error number of the most recent error that caused the I/O thread to stop. */ lastErrorNumber: number; /** * The timestamp when the most recent I/O error occurred. */ timeLastError: string; } interface GetManagedMySqlDatabaseInboundReplicationsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollection { /** * The number of sources this server is replicating from. */ inboundReplicationsCount: number; /** * A list of ManagedMySqlDatabaseInboundReplicationSummary records. */ items: outputs.DatabaseManagement.GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollectionItem[]; /** * The number of applier threads for executing replication transactions in parallel. */ parallelWorkers: number; /** * For multi-threaded replicas, indicates if transactions are executed and committed on the replica in the same order as they appear in the relay log. */ preserveCommitOrder: string; /** * The server ID value of this replica. */ replicaServerId: string; /** * The Universally Unique Identifier (UUID) value of this replica server. */ replicaUuid: string; } interface GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollectionItem { /** * A list of MySqlReplicationApplierFilter records. */ applierFilters: outputs.DatabaseManagement.GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollectionItemApplierFilter[]; /** * The time in seconds that the current transaction took between being committed on the source and being applied on the replica. */ applyDelay: number; /** * Error from the apply operation of a MySQL server replication channel. MySQL support within Oracle Cloud Infrastructure Database Management service has been deprecated as of January 29, 2026. */ applyErrors: outputs.DatabaseManagement.GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollectionItemApplyError[]; /** * The current status of apply operations. */ applyStatus: string; /** * The number of workers currently busy applying transactions from the source server. */ busyWorkers: number; /** * The name of the replication channel. */ channelName: string; /** * The desired number of seconds that the replica must lag the source. */ desiredDelaySeconds: string; /** * Error from the fetch operation of a MySQL server replication channel. MySQL support within Oracle Cloud Infrastructure Database Management service has been deprecated as of January 29, 2026. */ fetchErrors: outputs.DatabaseManagement.GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollectionItemFetchError[]; /** * The current status of fetch operations. */ fetchStatus: string; /** * Indicates whether the channel assigns global transaction identifiers (GTIDs) to anonymous replicated transactions. OFF means no GTIDs are assigned. LOCAL means a GTID is assigned that includes this replica's own universally unique identifier (UUID). A UUID as value indicates that a GTID is assigned, which includes that manually set UUID value. */ gtidAssignment: string; /** * The total size in bytes of all the existing relay log files pertaining to this channel. */ relayLogStorageSpaceUsed: string; /** * If the replica is waiting for the desired delay seconds to pass since the source applied an event, this field contains the number of delay seconds remaining. */ remainingDelaySeconds: string; /** * The set of global transaction IDs corresponding to all transactions received by this replica from the source server. Empty if GTIDs are not in use. */ retrievedGtidSet: string; /** * The number of seconds the replica is behind the source server. */ secondsBehindSource: string; /** * The host name or IP address of the source this replica is connected to. */ sourceHost: string; /** * The port used to connect to the source. */ sourcePort: number; /** * The server ID value from the source server. */ sourceServerId: string; /** * The Universally Unique Identifier (UUID) value from the source server. */ sourceUuid: string; /** * The number of transactions received by this replica from the source server. */ transactionsReceived: string; } interface GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollectionItemApplierFilter { /** * The type of replication filter that has been configured for the replication channel. */ filterName: string; /** * The rules configured for the replication filter type. */ filterRule: string; } interface GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollectionItemApplyError { /** * The error message of the most recent error that caused the I/O thread to stop. */ lastErrorMessage: string; /** * The error number of the most recent error that caused the I/O thread to stop. */ lastErrorNumber: number; /** * The timestamp when the most recent I/O error occurred. */ timeLastError: string; /** * A list of MySqlApplyErrorWorker records. */ workerErrors: outputs.DatabaseManagement.GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollectionItemApplyErrorWorkerError[]; } interface GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollectionItemApplyErrorWorkerError { /** * The error message of the most recent error that caused the I/O thread to stop. */ lastErrorMessage: string; /** * The error number of the most recent error that caused the I/O thread to stop. */ lastErrorNumber: number; /** * The timestamp when the most recent I/O error occurred. */ timeLastError: string; } interface GetManagedMySqlDatabaseInboundReplicationsManagedMySqlDatabaseInboundReplicationCollectionItemFetchError { /** * The error message of the most recent error that caused the I/O thread to stop. */ lastErrorMessage: string; /** * The error number of the most recent error that caused the I/O thread to stop. */ lastErrorNumber: number; /** * The timestamp when the most recent I/O error occurred. */ timeLastError: string; } interface GetManagedMySqlDatabaseOutboundReplicationsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedMySqlDatabaseOutboundReplicationsManagedMySqlDatabaseOutboundReplicationCollection { /** * The list of ManagedMySqlDatabaseOutboundReplicationSummary records. */ items: outputs.DatabaseManagement.GetManagedMySqlDatabaseOutboundReplicationsManagedMySqlDatabaseOutboundReplicationCollectionItem[]; /** * The number of outbound replications from the MySQL server. */ outboundReplicationsCount: number; } interface GetManagedMySqlDatabaseOutboundReplicationsManagedMySqlDatabaseOutboundReplicationCollectionItem { /** * The host name of the replica server, as specified on the replica with the --report-host option. This can differ from the machine name as configured in the operating system. */ replicaHost: string; /** * The port on the replica server, as specified on the replica with the --report-port option. A zero in this column means that the replica port (--report-port) was not set. */ replicaPort: number; /** * The server ID value of the replica. */ replicaServerId: string; /** * The Universally Unique Identifier (UUID) value of the replica server. */ replicaUuid: string; } interface GetManagedMySqlDatabaseQueryDetailQueryExplainPlan { /** * The JSON format of the explain plan. */ jsonExplain: string; /** * The version of the JSON format of the MySQL explain plan. */ jsonExplainVersion: string; } interface GetManagedMySqlDatabaseQueryDetailQueryMessage { /** * The MySQL code of the raised error, warning, or note. */ code: number; /** * The level of severity of the MySQL message. */ level: string; /** * The MySQL message text of the raised error, warning, or note. */ messageText: string; } interface GetManagedMySqlDatabaseQueryDetailQuerySampleDetail { /** * The total amount of time that has been spent executing the query sample. */ executionTime: string; /** * The host from which the query sample was run. */ host: string; /** * The MySQL instance against which the query sample was run. */ mysqlInstance: string; /** * The query sample mapped by MySQL to a given normalized query. */ querySampleText: string; /** * The thread ID of the connection. */ threadId: number; /** * The date and time the query sample was last seen. */ timeQuerySampleSeen: string; /** * The user who ran the query sample. */ user: string; } interface GetManagedMySqlDatabaseSqlDataFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedMySqlDatabaseSqlDataMySqlDataCollection { /** * The list of SQLDataSummary records. */ items: outputs.DatabaseManagement.GetManagedMySqlDatabaseSqlDataMySqlDataCollectionItem[]; } interface GetManagedMySqlDatabaseSqlDataMySqlDataCollectionItem { /** * The average execution time. */ avgTimerWait: number; /** * The number Of times the query has been executed. */ countStar: number; /** * The digest information of the normalized query. */ digest: string; /** * The normalized query. */ digestText: string; /** * The date and time the query was first seen. If the table is truncated, the first seen value is reset. */ firstSeen: string; /** * The number of query executions offloaded to HeatWave. */ heatWaveOffloaded: number; /** * The number of query executions with HeatWave out-of-memory errors. */ heatWaveOutOfMemory: number; /** * The date and time the query was last seen. */ lastSeen: string; /** * The maximum amount of controlled memory used by a statement during execution. */ maxControlledMemory: string; /** * The slowest the query has been executed. */ maxTimerWait: number; /** * The maximum amount of memory used by a statement during execution. */ maxTotalMemory: string; /** * The fastest the query has been executed. */ minTimerWait: number; /** * The 95th percentile of the query latency. That is, 95% of the queries complete in the time given or in less time. */ quantile95: number; /** * The 99th percentile of the query latency. */ quantile99: number; /** * The 99.9th percentile of the query latency. */ quantile999: number; /** * The name of the default schema when executing the query. If a schema is not set as the default, then the value is NULL. */ schemaName: string; /** * The total amount of time spent on CPU for this statement. */ sumCpuTime: string; /** * The total number of On-Disk internal temporary tables that have been created by the query. */ sumCreatedTempDiskTables: number; /** * The total number of internal temporary tables (in memory or on disk), which have been created by the query. */ sumCreatedTempTables: number; /** * The total number of errors that have been encountered executing the query. */ sumErrors: number; /** * The total amount of time that has been spent waiting for table locks. */ sumLockTime: number; /** * The total number of times no good index was used. This means that the extra column in The EXPLAIN output includes “Range Checked For Each Record.” */ sumNoGoodIndexUsed: number; /** * The total number of times no index was used to execute the query. */ sumNoIndexUsed: number; /** * The total number of rows that have been modified by the query. */ sumRowsAffected: number; /** * The total number of rows that have been examined by the query. */ sumRowsExamined: number; /** * The total number of rows that have been returned (sent) to the client. */ sumRowsSent: number; /** * The total number of joins that have performed full table scans as there was no join condition or no index for the join condition. This is the same as the selectFullJoin status variable. */ sumSelectFullJoin: number; /** * The total number of joins that use a full range search. This is the same as the selectFullRangeJoin status variable. */ sumSelectFullRangeJoin: number; /** * The total number of times the query has used a range search. This is the same as the selectRange status variable. */ sumSelectRange: number; /** * The total number of joins by the query where the join does not have an index that checks for the index usage after each row. This is the same as the selectRangeCheck status variable. */ sumSelectRangeCheck: number; /** * The total number of times the query has performed a full table scan on the first table in the join. This is the same as the selectScan status variable. */ sumSelectScan: number; /** * The total number of sort merge passes that have been done to sort the result of the query. This is the same as the sortMergePasses status variable. */ sumSortMergePasses: number; /** * The total number of times a sort was done using ranges. This is the same as the sortRange status variable. */ sumSortRange: number; /** * The total number of rows sorted. This is the same as the sort_rowsStatus variable. */ sumSortRows: number; /** * The total number of times a sort was done by scanning the table. This is the same as the sortScan status variable. */ sumSortScan: number; /** * The total amount of time that has been spent executing the query. */ sumTimerWait: number; /** * The total number of warnings that have been encountered executing the query. */ sumWarnings: number; } interface GetManagedMySqlDatabasesFilter { /** * The name of the Managed MySQL Database. */ name: string; regex?: boolean; values: string[]; } interface GetManagedMySqlDatabasesManagedMySqlDatabaseCollection { items: outputs.DatabaseManagement.GetManagedMySqlDatabasesManagedMySqlDatabaseCollectionItem[]; } interface GetManagedMySqlDatabasesManagedMySqlDatabaseCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The type of the MySQL Database. Indicates whether the database is external or MDS. */ databaseType: string; /** * The name of the MySQL Database. */ dbName: string; /** * The version of the MySQL Database. */ dbVersion: string; /** * The name of the HeatWave cluster. */ heatWaveClusterDisplayName: string; /** * The selected management type for a HeatWave MySQL DB system. */ heatWaveManagementType: string; /** * The total memory belonging to the HeatWave cluster in GBs. */ heatWaveMemorySize: number; /** * Shape of the nodes in the HeatWave cluster. */ heatWaveNodeShape: string; /** * The information about an individual HeatWave nodes in the cluster. */ heatWaveNodes: outputs.DatabaseManagement.GetManagedMySqlDatabasesManagedMySqlDatabaseCollectionItemHeatWaveNode[]; /** * The ID associated with the HeatWave node. */ id: string; /** * If the HeatWave cluster is active or not. */ isHeatWaveActive: boolean; /** * If HeatWave is enabled for this db system or not. */ isHeatWaveEnabled: boolean; /** * If HeatWave Lakehouse is enabled for the db system or not. */ isLakehouseEnabled: boolean; /** * Indicates database management status. */ managementState: string; /** * The name of the Managed MySQL Database. */ name: string; state: string; /** * The date and time the node was created. */ timeCreated: string; /** * The date and time the Managed MySQL Database was created. */ timeCreatedHeatWave: string; /** * The date and time the Managed MySQL Database was updated. */ timeUpdated: string; } interface GetManagedMySqlDatabasesManagedMySqlDatabaseCollectionItemHeatWaveNode { /** * The ID associated with the HeatWave node. */ id: string; /** * The status of the HeatWave node. Indicates whether the status of the node is UP, DOWN, or UNKNOWN at the current time. */ status: string; /** * The date and time the node was created. */ timeCreated: string; } interface GetNamedCredentialContent { /** * The type of named credential. Only 'BASIC' is supported currently. */ credentialType: string; /** * The mechanism used to access the password plain text value. */ passwordSecretAccessMode: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Vault service secret that contains the database user password. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user name used to connect to the database. */ userName: string; } interface GetNamedCredentialsFilter { /** * The name of the named credential. */ name: string; regex?: boolean; values: string[]; } interface GetNamedCredentialsNamedCredentialCollection { items: outputs.DatabaseManagement.GetNamedCredentialsNamedCredentialCollectionItem[]; } interface GetNamedCredentialsNamedCredentialCollectionItem { /** * The resource associated to the named credential. */ associatedResource: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The details of the named credential. */ contents: outputs.DatabaseManagement.GetNamedCredentialsNamedCredentialCollectionItemContent[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The information specified by the user about the named credential. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential. */ id: string; /** * The details of the lifecycle state. */ lifecycleDetails: string; /** * The name of the named credential. */ name: string; /** * The scope of named credential. */ scope: string; /** * The current lifecycle state of the named credential. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the named credential was created. */ timeCreated: string; /** * The date and time the named credential was last updated. */ timeUpdated: string; /** * The type of database that is associated to the named credential. */ type: string; } interface GetNamedCredentialsNamedCredentialCollectionItemContent { /** * The type of named credential. Only 'BASIC' is supported currently. */ credentialType: string; /** * The mechanism used to access the password plain text value. */ passwordSecretAccessMode: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Vault service secret that contains the database user password. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user name used to connect to the database. */ userName: string; } interface ManagedDatabaseDbmgmtFeatureConfig { /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails: outputs.DatabaseManagement.ManagedDatabaseDbmgmtFeatureConfigConnectorDetail[]; /** * The connection details required to connect to the database. */ databaseConnectionDetails: outputs.DatabaseManagement.ManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetail[]; /** * The name of the Database Management feature. */ feature: string; /** * The list of statuses for Database Management features. */ featureStatus: string; /** * The Oracle license model that applies to the external database. */ licenseModel: string; } interface ManagedDatabaseDbmgmtFeatureConfigConnectorDetail { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector */ connectorType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId: string; } interface ManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetail { /** * The credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials: outputs.DatabaseManagement.ManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetailConnectionCredential[]; /** * The details of the Oracle Database connection string. */ connectionStrings: outputs.DatabaseManagement.ManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetailConnectionString[]; } interface ManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetailConnectionCredential { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. */ credentialName: string; /** * The type of credential used to connect to the database. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId: string; /** * The role of the user connecting to the database. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId: string; /** * The user name used to connect to the database. */ userName: string; } interface ManagedDatabaseDbmgmtFeatureConfigDatabaseConnectionDetailConnectionString { /** * The list of supported connection types: * * BASIC: Basic connection details */ connectionType: string; /** * The port number used to connect to the database. */ port: number; /** * The protocol used to connect to the database. */ protocol: string; /** * The service name of the database. */ service: string; } interface ManagedDatabaseGroupManagedDatabase { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database Group resides. */ compartmentId: string; /** * The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database. */ databaseSubType: string; /** * The type of Oracle Database installation. */ databaseType: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * The infrastructure used to deploy the Oracle Database. */ deploymentType: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed database that needs to be added to the Managed Database Group. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ id: string; /** * The name of the Managed Database Group. Valid characters are uppercase or lowercase letters, numbers, and "_". The name of the Managed Database Group cannot be modified. It must be unique in the compartment and must begin with an alphabetic character. */ name: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Managed Database was added to the group. */ timeAdded: string; /** * The workload type of the Autonomous Database. */ workloadType: string; } interface ManagedDatabaseManagedDatabaseGroup { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database Group resides. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Managed Database Group. */ id: string; /** * The name of the Managed Database. */ name: string; } interface ManagedDatabasesChangeDatabaseParameterCredentials { /** * The password for the database user name. */ password: string; /** * The role of the database user. Indicates whether the database user is a normal user or sysdba. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * The database user name used to perform management activity. */ userName: string; } interface ManagedDatabasesChangeDatabaseParameterDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface ManagedDatabasesChangeDatabaseParameterParameter { /** * The parameter name. */ name: string; /** * A comment string to associate with the change in parameter value. It cannot contain control characters or a line break. */ updateComment: string; /** * The parameter value. */ value: string; } interface ManagedDatabasesResetDatabaseParameterCredentials { /** * The password for the database user name. */ password: string; /** * The role of the database user. Indicates whether the database user is a normal user or sysdba. */ role: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * The database user name used to perform management activity. */ userName: string; } interface ManagedDatabasesResetDatabaseParameterDatabaseCredential { /** * The type of the credential for tablespace administration tasks. */ credentialType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the named credential where the database password metadata is stored. */ namedCredentialId: string; /** * The database user's password encoded using BASE64 scheme. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database password is stored. */ passwordSecretId: string; /** * The role of the database user. */ role: string; /** * The user to connect to the database. */ username: string; } interface NamedCredentialContent { /** * (Updatable) The type of named credential. Only 'BASIC' is supported currently. */ credentialType: string; /** * (Updatable) The mechanism used to access the password plain text value. */ passwordSecretAccessMode: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Vault service secret that contains the database user password. */ passwordSecretId: string; /** * (Updatable) The role of the database user. */ role: string; /** * (Updatable) The user name used to connect to the database. */ userName: string; } interface PluggabledatabasePluggableDatabaseDbmFeaturesManagementFeatureDetails { /** * Indicates whether Diagnostics & Management should be enabled for all the current pluggable databases in the container database. */ canEnableAllCurrentPdbs: boolean; /** * The connector details required to connect to an Oracle cloud database. */ connectorDetails?: outputs.DatabaseManagement.PluggabledatabasePluggableDatabaseDbmFeaturesManagementFeatureDetailsConnectorDetails; /** * The connection details required to connect to the database. */ databaseConnectionDetails?: outputs.DatabaseManagement.PluggabledatabasePluggableDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetails; /** * The name of the Database Management feature. */ feature: string; /** * Indicates whether Diagnostics & Management should be enabled automatically for all the pluggable databases in the container database. */ isAutoEnablePluggableDatabase?: boolean; /** * The management type for the database. Use "BASIC" for basic management. Use "ADVANCED" for full management. */ managementType?: string; } interface PluggabledatabasePluggableDatabaseDbmFeaturesManagementFeatureDetailsConnectorDetails { /** * The list of supported connection types: * * PE: Private endpoint * * MACS: Management agent * * EXTERNAL: External database connector * * DIRECT: Direct connection */ connectorType?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the external database connector. */ databaseConnectorId?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management agent. */ managementAgentId?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ privateEndPointId?: string; } interface PluggabledatabasePluggableDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetails { /** * The credentials used to connect to the database. Currently only the `DETAILS` type is supported for creating MACS connector credentials. */ connectionCredentials?: outputs.DatabaseManagement.PluggabledatabasePluggableDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionCredentials; /** * The details of the Oracle Database connection string. */ connectionString?: outputs.DatabaseManagement.PluggabledatabasePluggableDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionString; } interface PluggabledatabasePluggableDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionCredentials { /** * The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the Oracle Cloud Infrastructure region the credential is being created in. If you specify a name that duplicates the name of another credential within the same Oracle Cloud Infrastructure region, you may overwrite or corrupt the credential that is already using the name. * * For example: inventorydb.abc112233445566778899 */ credentialName?: string; /** * The type of credential used to connect to the database. */ credentialType?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Named Credential where the database password metadata is stored. */ namedCredentialId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ passwordSecretId?: string; /** * The role of the user connecting to the database. */ role?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the SSL keystore and truststore details. */ sslSecretId?: string; /** * The user name used to connect to the database. */ userName?: string; } interface PluggabledatabasePluggableDatabaseDbmFeaturesManagementFeatureDetailsDatabaseConnectionDetailsConnectionString { /** * The list of supported connection types: * * BASIC: Basic connection details */ connectionType?: string; /** * The port number used to connect to the database. */ port?: number; /** * The protocol used to connect to the database. */ protocol?: string; /** * The service name of the database. */ service?: string; } } export declare namespace DatabaseMigration { interface AssessmentAssessorActionItem { /** * The property name. */ name: string; /** * The property value. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface AssessmentExcludeObject { /** * Whether an excluded table should be omitted from replication. Only valid for database objects that have are of type TABLE and object status EXCLUDE. */ isOmitExcludedTableFromReplication: boolean; /** * Name of the object (regular expression is allowed) */ object: string; /** * Owner of the object (regular expression is allowed) */ owner: string; /** * Schema of the object (regular expression is allowed) */ schema: string; /** * Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded. */ type: string; } interface AssessmentIncludeObject { /** * Whether an excluded table should be omitted from replication. Only valid for database objects that have are of type TABLE and object status EXCLUDE. */ isOmitExcludedTableFromReplication: boolean; /** * Name of the object (regular expression is allowed) */ object: string; /** * Owner of the object (regular expression is allowed) */ owner: string; /** * Schema of the object (regular expression is allowed) */ schema: string; /** * Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded. */ type: string; } interface AssessmentSourceDatabaseConnection { /** * (Updatable) The OCID of the resource being referenced. */ id: string; } interface AssessmentTargetDatabaseConnection { /** * (Updatable) Defines the type of connection. For example, ORACLE. */ connectionType: string; /** * (Updatable) The database version */ databaseVersion: string; /** * (Updatable) The OCID of the resource being referenced. */ id: string; /** * (Updatable) Technology sub-type e.g. ADW_SHARED, ADW_DEDICATED, ATP_SHARED, ATP_DEDICATED */ technologySubType: string; /** * (Updatable) The technology type. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ technologyType: string; } interface ConnectionAdditionalAttribute { /** * (Updatable) The name of the property entry. */ name: string; /** * (Updatable) The value of the property entry. */ value: string; } interface ConnectionIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface GetAssessmentAssessorAction { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Defines if the action is enabled or disabled. */ isDisabled: boolean; /** * The Assessor Name. */ name: string; /** * The OCID of the resource being referenced. */ resourceId: string; /** * The Assessor Action Title. */ title: string; /** * User defined properties */ userDefinedProperties: outputs.DatabaseMigration.GetAssessmentAssessorActionUserDefinedProperty[]; } interface GetAssessmentAssessorActionUserDefinedProperty { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The Help link text. */ helpLinkText: string; /** * The Help URL. */ helpLinkUrl: string; /** * Array of user defined properties. */ properties: outputs.DatabaseMigration.GetAssessmentAssessorActionUserDefinedPropertyProperty[]; } interface GetAssessmentAssessorActionUserDefinedPropertyProperty { /** * The default value of the property. */ defaultValue: string; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * True if the property is required, false otherwise */ isRequired: boolean; /** * Maximum length of the text */ maxLength: number; /** * Minimum length of the text */ minLength: number; /** * The Assessor Name. */ name: string; /** * User defined property options. */ options: outputs.DatabaseMigration.GetAssessmentAssessorActionUserDefinedPropertyPropertyOption[]; /** * The type of the user defined property. */ type: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorActionUserDefinedPropertyPropertyOption { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorAssessorGroup { /** * Assessor group actions. */ actions: outputs.DatabaseMigration.GetAssessmentAssessorAssessorGroupAction[]; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The Assessor Name. */ name: string; } interface GetAssessmentAssessorAssessorGroupAction { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * Defines if the action is enabled or disabled. */ isDisabled: boolean; /** * The Assessor Name. */ name: string; /** * The OCID of the resource being referenced. */ resourceId: string; /** * The Assessor Action Title. */ title: string; /** * User defined properties */ userDefinedProperties: outputs.DatabaseMigration.GetAssessmentAssessorAssessorGroupActionUserDefinedProperty[]; } interface GetAssessmentAssessorAssessorGroupActionUserDefinedProperty { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The Help link text. */ helpLinkText: string; /** * The Help URL. */ helpLinkUrl: string; /** * Array of user defined properties. */ properties: outputs.DatabaseMigration.GetAssessmentAssessorAssessorGroupActionUserDefinedPropertyProperty[]; } interface GetAssessmentAssessorAssessorGroupActionUserDefinedPropertyProperty { /** * The default value of the property. */ defaultValue: string; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * True if the property is required, false otherwise */ isRequired: boolean; /** * Maximum length of the text */ maxLength: number; /** * Minimum length of the text */ minLength: number; /** * The Assessor Name. */ name: string; /** * User defined property options. */ options: outputs.DatabaseMigration.GetAssessmentAssessorAssessorGroupActionUserDefinedPropertyPropertyOption[]; /** * The type of the user defined property. */ type: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorAssessorGroupActionUserDefinedPropertyPropertyOption { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorCheckAffectedObjectsAffectedObjectsCollection { /** * Items in collection. */ items: outputs.DatabaseMigration.GetAssessmentAssessorCheckAffectedObjectsAffectedObjectsCollectionItem[]; } interface GetAssessmentAssessorCheckAffectedObjectsAffectedObjectsCollectionItem { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; fields: { [key: string]: string; }; /** * 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. Example: {"Department": "Finance"} */ freeformTags: { [key: string]: string; }; /** * If the object was excluded from migration, then it is true. */ isExcluded: boolean; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetAssessmentAssessorCheckAffectedObjectsFilter { name: string; regex?: boolean; values: string[]; } interface GetAssessmentAssessorCheckAssessorCheckGroup { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * True if the group is expanded, false otherwise. */ isExpanded: boolean; /** * The Name of the Check. */ name: string; } interface GetAssessmentAssessorCheckCheckAction { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The Name of the Check. */ name: string; /** * User defined properties */ userDefinedProperties: outputs.DatabaseMigration.GetAssessmentAssessorCheckCheckActionUserDefinedProperty[]; } interface GetAssessmentAssessorCheckCheckActionUserDefinedProperty { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The Help link text. */ helpLinkText: string; /** * The Help URL. */ helpLinkUrl: string; /** * Array of user defined properties. */ properties: outputs.DatabaseMigration.GetAssessmentAssessorCheckCheckActionUserDefinedPropertyProperty[]; } interface GetAssessmentAssessorCheckCheckActionUserDefinedPropertyProperty { /** * The default value of the property. */ defaultValue: string; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * True if the property is required, false otherwise */ isRequired: boolean; /** * Maximum length of the text */ maxLength: number; /** * Minimum length of the text */ minLength: number; /** * The Name of the Check. */ name: string; /** * User defined property options. */ options: outputs.DatabaseMigration.GetAssessmentAssessorCheckCheckActionUserDefinedPropertyPropertyOption[]; /** * The type of the user defined property. */ type: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorCheckCheckActionUserDefinedPropertyPropertyOption { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorCheckColumn { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Pre-Migration сheck id. */ key: string; } interface GetAssessmentAssessorCheckLogLocation { /** * Name of the bucket containing the log file. */ bucket: string; /** * Object Storage namespace. */ namespace: string; /** * Log object name. */ object: string; } interface GetAssessmentAssessorCheckMetadata { /** * The field that stores the name of the object. */ objectNameColumn: string; /** * The field that stores the type of the object. */ objectTypeColumn: string; /** * The field that stores the fixed type of the object. */ objectTypeFixed: string; /** * The field that stores the owner of the object. */ schemaOwnerColumn: string; } interface GetAssessmentAssessorChecksAssessorCheckSummaryCollection { items: outputs.DatabaseMigration.GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItem[]; } interface GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItem { /** * Fixing the issue. */ action: string; /** * Assessor Check Group */ assessorCheckGroups: outputs.DatabaseMigration.GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemAssessorCheckGroup[]; /** * The current state of the Assessor Check. */ assessorCheckState: string; /** * Assessor Check Action */ checkActions: outputs.DatabaseMigration.GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemCheckAction[]; /** * Array of the column of the objects table. */ columns: outputs.DatabaseMigration.GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemColumn[]; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The path to the fixup script for this check. */ fixupScriptLocation: string; /** * The Help link text. */ helpLinkText: string; /** * The Help URL. */ helpLinkUrl: string; /** * Impact of the issue on data migration. */ impact: string; /** * If false, objects cannot be excluded from migration. */ isExclusionAllowed: boolean; /** * Description of the issue. */ issue: string; /** * Pre-Migration сheck id. */ key: string; /** * Details to access log file in the specified Object Storage bucket, if any. */ logLocations: outputs.DatabaseMigration.GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemLogLocation[]; /** * Metadata of object. */ metadatas: outputs.DatabaseMigration.GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemMetadata[]; /** * The Name of the Check. */ name: string; /** * Number of database objects to migrate. */ objectCount: number; /** * The objects display name. */ objectsDisplayName: string; } interface GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemAssessorCheckGroup { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * True if the group is expanded, false otherwise. */ isExpanded: boolean; /** * The Name of the Check. */ name: string; } interface GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemCheckAction { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The Name of the Check. */ name: string; /** * User defined properties */ userDefinedProperties: outputs.DatabaseMigration.GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemCheckActionUserDefinedProperty[]; } interface GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemCheckActionUserDefinedProperty { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The Help link text. */ helpLinkText: string; /** * The Help URL. */ helpLinkUrl: string; /** * Array of user defined properties. */ properties: outputs.DatabaseMigration.GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemCheckActionUserDefinedPropertyProperty[]; } interface GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemCheckActionUserDefinedPropertyProperty { /** * The default value of the property. */ defaultValue: string; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * True if the property is required, false otherwise */ isRequired: boolean; /** * Maximum length of the text */ maxLength: number; /** * Minimum length of the text */ minLength: number; /** * The Name of the Check. */ name: string; /** * User defined property options. */ options: outputs.DatabaseMigration.GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemCheckActionUserDefinedPropertyPropertyOption[]; /** * The type of the user defined property. */ type: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemCheckActionUserDefinedPropertyPropertyOption { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemColumn { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Pre-Migration сheck id. */ key: string; } interface GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemLogLocation { /** * Name of the bucket containing the log file. */ bucket: string; /** * Object Storage namespace. */ namespace: string; /** * Log object name. */ object: string; } interface GetAssessmentAssessorChecksAssessorCheckSummaryCollectionItemMetadata { /** * The field that stores the name of the object. */ objectNameColumn: string; /** * The field that stores the type of the object. */ objectTypeColumn: string; /** * The field that stores the fixed type of the object. */ objectTypeFixed: string; /** * The field that stores the owner of the object. */ schemaOwnerColumn: string; } interface GetAssessmentAssessorChecksFilter { /** * The Name of the Check. */ name: string; regex?: boolean; values: string[]; } interface GetAssessmentAssessorsAssessorSummaryCollection { items: outputs.DatabaseMigration.GetAssessmentAssessorsAssessorSummaryCollectionItem[]; } interface GetAssessmentAssessorsAssessorSummaryCollectionItem { /** * Assessor group actions. */ actions: outputs.DatabaseMigration.GetAssessmentAssessorsAssessorSummaryCollectionItemAction[]; /** * The OCID of the Assessment */ assessmentId: string; /** * Assessor Group */ assessorGroups: outputs.DatabaseMigration.GetAssessmentAssessorsAssessorSummaryCollectionItemAssessorGroup[]; /** * The Assessor Result text. */ assessorResult: string; /** * The Summary of all Checks. */ checksSummary: string; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * True if DB restart required after running the script, false otherwise. */ doesScriptRequireRestart: boolean; /** * True if script is available either from 'script' property of through download, false otherwise. */ hasScript: boolean; /** * The Help link text. */ helpLinkText: string; /** * The Help URL. */ helpLinkUrl: string; /** * The Assessor Name. */ name: string; /** * The generated SQL script. Can be empty if the script exceeds maxLength. In this case the property 'hasScript' indicates that the script is available for download. */ script: string; /** * The lifecycle state of the Assessor. */ state: string; } interface GetAssessmentAssessorsAssessorSummaryCollectionItemAction { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Defines if the action is enabled or disabled. */ isDisabled: boolean; /** * The Assessor Name. */ name: string; /** * The OCID of the resource being referenced. */ resourceId: string; /** * The Assessor Action Title. */ title: string; /** * User defined properties */ userDefinedProperties: outputs.DatabaseMigration.GetAssessmentAssessorsAssessorSummaryCollectionItemActionUserDefinedProperty[]; } interface GetAssessmentAssessorsAssessorSummaryCollectionItemActionUserDefinedProperty { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The Help link text. */ helpLinkText: string; /** * The Help URL. */ helpLinkUrl: string; /** * Array of user defined properties. */ properties: outputs.DatabaseMigration.GetAssessmentAssessorsAssessorSummaryCollectionItemActionUserDefinedPropertyProperty[]; } interface GetAssessmentAssessorsAssessorSummaryCollectionItemActionUserDefinedPropertyProperty { /** * The default value of the property. */ defaultValue: string; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * True if the property is required, false otherwise */ isRequired: boolean; /** * Maximum length of the text */ maxLength: number; /** * Minimum length of the text */ minLength: number; /** * The Assessor Name. */ name: string; /** * User defined property options. */ options: outputs.DatabaseMigration.GetAssessmentAssessorsAssessorSummaryCollectionItemActionUserDefinedPropertyPropertyOption[]; /** * The type of the user defined property. */ type: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorsAssessorSummaryCollectionItemActionUserDefinedPropertyPropertyOption { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorsAssessorSummaryCollectionItemAssessorGroup { /** * Assessor group actions. */ actions: outputs.DatabaseMigration.GetAssessmentAssessorsAssessorSummaryCollectionItemAssessorGroupAction[]; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The Assessor Name. */ name: string; } interface GetAssessmentAssessorsAssessorSummaryCollectionItemAssessorGroupAction { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Defines if the action is enabled or disabled. */ isDisabled: boolean; /** * The Assessor Name. */ name: string; /** * The OCID of the resource being referenced. */ resourceId: string; /** * The Assessor Action Title. */ title: string; /** * User defined properties */ userDefinedProperties: outputs.DatabaseMigration.GetAssessmentAssessorsAssessorSummaryCollectionItemAssessorGroupActionUserDefinedProperty[]; } interface GetAssessmentAssessorsAssessorSummaryCollectionItemAssessorGroupActionUserDefinedProperty { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The Help link text. */ helpLinkText: string; /** * The Help URL. */ helpLinkUrl: string; /** * Array of user defined properties. */ properties: outputs.DatabaseMigration.GetAssessmentAssessorsAssessorSummaryCollectionItemAssessorGroupActionUserDefinedPropertyProperty[]; } interface GetAssessmentAssessorsAssessorSummaryCollectionItemAssessorGroupActionUserDefinedPropertyProperty { /** * The default value of the property. */ defaultValue: string; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * True if the property is required, false otherwise */ isRequired: boolean; /** * Maximum length of the text */ maxLength: number; /** * Minimum length of the text */ minLength: number; /** * The Assessor Name. */ name: string; /** * User defined property options. */ options: outputs.DatabaseMigration.GetAssessmentAssessorsAssessorSummaryCollectionItemAssessorGroupActionUserDefinedPropertyPropertyOption[]; /** * The type of the user defined property. */ type: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorsAssessorSummaryCollectionItemAssessorGroupActionUserDefinedPropertyPropertyOption { /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The value of the property. */ value: string; } interface GetAssessmentAssessorsFilter { /** * The Assessor Name. */ name: string; regex?: boolean; values: string[]; } interface GetAssessmentExcludeObject { isOmitExcludedTableFromReplication: boolean; object: string; owner: string; schema: string; type: string; } interface GetAssessmentIncludeObject { isOmitExcludedTableFromReplication: boolean; object: string; owner: string; schema: string; type: string; } interface GetAssessmentObjectTypesAssessmentObjectTypeSummaryCollection { /** * Items in collection. */ items: outputs.DatabaseMigration.GetAssessmentObjectTypesAssessmentObjectTypeSummaryCollectionItem[]; } interface GetAssessmentObjectTypesAssessmentObjectTypeSummaryCollectionItem { /** * Object type name */ name: string; } interface GetAssessmentObjectTypesFilter { /** * Object type name */ name: string; regex?: boolean; values: string[]; } interface GetAssessmentSourceDatabaseConnection { /** * The OCID of the resource being referenced. */ id: string; } interface GetAssessmentTargetDatabaseConnection { /** * Defines the type of connection. For example, ORACLE. */ connectionType: string; /** * The database version */ databaseVersion: string; /** * The OCID of the resource being referenced. */ id: string; /** * Technology sub-type e.g. ADW_SHARED, ADW_DEDICATED, ATP_SHARED, ATP_DEDICATED */ technologySubType: string; /** * The technology type. */ technologyType: string; } interface GetAssessmentsAssessmentCollection { items: outputs.DatabaseMigration.GetAssessmentsAssessmentCollectionItem[]; } interface GetAssessmentsAssessmentCollectionItem { /** * Time allowed for the application downtime. */ acceptableDowntime: string; /** * The migration type of the migration to be performed. */ assessmentMigrationType: string; bulkIncludeExcludeData: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The type of assessment creation. */ creationType: string; /** * The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. */ databaseCombination: string; /** * The size of a source database. */ databaseDataSize: string; /** * DDL expectation values. */ ddlExpectation: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; excludeObjects: outputs.DatabaseMigration.GetAssessmentsAssessmentCollectionItemExcludeObject[]; /** * 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. Example: {"Department": "Finance"} */ freeformTags: { [key: string]: string; }; /** * The OCID of the resource being referenced. */ id: string; includeObjects: outputs.DatabaseMigration.GetAssessmentsAssessmentCollectionItemIncludeObject[]; /** * True if CDB should be defined, false otherwise. */ isCdbSupported: boolean; /** * The OCID of the resource being referenced. */ migrationId: string; /** * A network speed in Megabits per second. */ networkSpeedMegabitPerSecond: string; /** * Source Assessment Connection object */ sourceDatabaseConnections: outputs.DatabaseMigration.GetAssessmentsAssessmentCollectionItemSourceDatabaseConnection[]; /** * The lifecycle state of the Assessment. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Target Assessment Connection object */ targetDatabaseConnections: outputs.DatabaseMigration.GetAssessmentsAssessmentCollectionItemTargetDatabaseConnection[]; /** * An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. */ timeUpdated: string; } interface GetAssessmentsAssessmentCollectionItemExcludeObject { isOmitExcludedTableFromReplication: boolean; object: string; owner: string; schema: string; type: string; } interface GetAssessmentsAssessmentCollectionItemIncludeObject { isOmitExcludedTableFromReplication: boolean; object: string; owner: string; schema: string; type: string; } interface GetAssessmentsAssessmentCollectionItemSourceDatabaseConnection { /** * The OCID of the resource being referenced. */ id: string; } interface GetAssessmentsAssessmentCollectionItemTargetDatabaseConnection { /** * Defines the type of connection. For example, ORACLE. */ connectionType: string; /** * The database version */ databaseVersion: string; /** * The OCID of the resource being referenced. */ id: string; /** * Technology sub-type e.g. ADW_SHARED, ADW_DEDICATED, ATP_SHARED, ATP_DEDICATED */ technologySubType: string; /** * The technology type. */ technologyType: string; } interface GetAssessmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetConnectionAdditionalAttribute { /** * The name of the property entry. */ name: string; /** * The value of the property entry. */ value: string; } interface GetConnectionDatabaseconnectiontypesDatabaseConnectionTypeCollection { /** * Items in collection. */ items: outputs.DatabaseMigration.GetConnectionDatabaseconnectiontypesDatabaseConnectionTypeCollectionItem[]; } interface GetConnectionDatabaseconnectiontypesDatabaseConnectionTypeCollectionItem { /** * The array of connection types. */ connectionType: string; /** * Array of technology type objects */ technologyTypes: outputs.DatabaseMigration.GetConnectionDatabaseconnectiontypesDatabaseConnectionTypeCollectionItemTechnologyType[]; } interface GetConnectionDatabaseconnectiontypesDatabaseConnectionTypeCollectionItemTechnologyType { /** * Array of database versions */ databaseVersions: string[]; /** * Array of technology sub-types e.g. ADW_SHARED. */ technologySubTypes: outputs.DatabaseMigration.GetConnectionDatabaseconnectiontypesDatabaseConnectionTypeCollectionItemTechnologyTypeTechnologySubType[]; /** * The array of technology types. */ technologyType: string; } interface GetConnectionDatabaseconnectiontypesDatabaseConnectionTypeCollectionItemTechnologyTypeTechnologySubType { /** * Array of database versions */ databaseVersions: string[]; /** * Technology sub-type e.g. ADW_SHARED. */ technologySubType: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ technologySubTypeDisplayName: string; } interface GetConnectionDatabaseconnectiontypesFilter { name: string; regex?: boolean; values: string[]; } interface GetConnectionIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface GetConnectionsConnectionCollection { items: outputs.DatabaseMigration.GetConnectionsConnectionCollectionItem[]; } interface GetConnectionsConnectionCollectionItem { /** * An array of name-value pair attribute entries. */ additionalAttributes: outputs.DatabaseMigration.GetConnectionsConnectionCollectionItemAdditionalAttribute[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Connect descriptor or Easy Connect Naming method used to connect to a database. */ connectionString: string; /** * The array of connection types. */ connectionType: string; /** * The OCID of the database being referenced. */ databaseId: string; /** * The name of the database being referenced. */ databaseName: string; /** * The OCID of the database system being referenced. */ dbSystemId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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. Example: {"Department": "Finance"} */ freeformTags: { [key: string]: string; }; /** * The IP Address of the host. */ host: string; /** * The OCID of the connection being referenced. */ id: string; /** * List of ingress IP addresses from where to connect to this connection's privateIp. */ ingressIps: outputs.DatabaseMigration.GetConnectionsConnectionCollectionItemIngressIp[]; /** * The OCID of the key used in cryptographic operations. */ keyId: string; /** * The message describing the current state of the connection's lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state. */ lifecycleDetails: string; /** * An array of Network Security Group OCIDs used to define network access for Connections. */ nsgIds: string[]; /** * The password (credential) used when creating or updating this resource. */ password: string; /** * The port to be used for the connection. */ port: number; /** * The OCID of the resource being referenced. */ privateEndpointId: string; /** * The password (credential) used when creating or updating this resource. */ replicationPassword: string; /** * The username (credential) used when creating or updating this resource. */ replicationUsername: string; /** * The OCID of the resource being referenced. */ secretId: string; /** * Security Protocol to be used for the connection. */ securityProtocol: string; /** * Name of the host the SSH key is valid for. */ sshHost: string; /** * Private SSH key string. */ sshKey: string; /** * Sudo location */ sshSudoLocation: string; /** * The username (credential) used when creating or updating this resource. */ sshUser: string; sslCa: string; sslCert: string; sslCrl: string; sslKey: string; /** * SSL mode to be used for the connection. */ sslMode: string; /** * The current state of the Database Migration Deployment. */ state: string; /** * Oracle Cloud Infrastructure resource ID. */ subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The array of technology types. */ technologyType: string; /** * The time when this resource was created. An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * The time when this resource was updated. An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. */ timeUpdated: string; /** * The username (credential) used when creating or updating this resource. */ username: string; /** * Oracle Cloud Infrastructure resource ID. */ vaultId: string; wallet: string; } interface GetConnectionsConnectionCollectionItemAdditionalAttribute { /** * The name of the property entry. */ name: string; /** * The value of the property entry. */ value: string; } interface GetConnectionsConnectionCollectionItemIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface GetConnectionsFilter { /** * The name of the property entry. */ name: string; regex?: boolean; values: string[]; } interface GetJobAdvisorReportCheckObjectsAdvisorReportCheckObjectsCollection { /** * Array of check objects. */ items: outputs.DatabaseMigration.GetJobAdvisorReportCheckObjectsAdvisorReportCheckObjectsCollectionItem[]; } interface GetJobAdvisorReportCheckObjectsAdvisorReportCheckObjectsCollectionItem { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; fields: { [key: string]: string; }; /** * 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. Example: {"Department": "Finance"} */ freeformTags: { [key: string]: string; }; /** * If the object was excluded from migration, then it is true. */ isExcluded: boolean; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetJobAdvisorReportCheckObjectsFilter { name: string; regex?: boolean; values: string[]; } interface GetJobAdvisorReportChecksAdvisorReportCheckCollection { /** * Array of advisor check items. */ items: outputs.DatabaseMigration.GetJobAdvisorReportChecksAdvisorReportCheckCollectionItem[]; /** * Pre-Migration extended advisor report summary. */ summaries: outputs.DatabaseMigration.GetJobAdvisorReportChecksAdvisorReportCheckCollectionSummary[]; } interface GetJobAdvisorReportChecksAdvisorReportCheckCollectionItem { advisorReportCheckId: string; /** * User flag for advisor report check. */ isReviewed: boolean; /** * Array of advisor check items. */ items: outputs.DatabaseMigration.GetJobAdvisorReportChecksAdvisorReportCheckCollectionItemItem[]; /** * The OCID of the job */ jobId: string; /** * Pre-Migration extended advisor report summary. */ summaries: outputs.DatabaseMigration.GetJobAdvisorReportChecksAdvisorReportCheckCollectionItemSummary[]; } interface GetJobAdvisorReportChecksAdvisorReportCheckCollectionItemItem { /** * Fixing the issue. */ action: string; /** * Array of the column of the objects table. */ columns: outputs.DatabaseMigration.GetJobAdvisorReportChecksAdvisorReportCheckCollectionItemItemColumn[]; /** * Pre-Migration сheck display name. */ displayName: string; /** * The path to the fixup script for this check. */ fixupScriptLocation: string; /** * Impact of the issue on data migration. */ impact: string; /** * If false, objects cannot be excluded from migration. */ isExclusionAllowed: boolean; /** * User flag for advisor report check. */ isReviewed: boolean; /** * Description of the issue. */ issue: string; /** * Pre-Migration сheck id. */ key: string; /** * Metadata of object. */ metadatas: outputs.DatabaseMigration.GetJobAdvisorReportChecksAdvisorReportCheckCollectionItemItemMetadata[]; /** * Number of database objects to migrate. */ objectCount: number; /** * Pre-Migration advisor result. */ resultType: string; } interface GetJobAdvisorReportChecksAdvisorReportCheckCollectionItemItemColumn { /** * Pre-Migration сheck display name. */ displayName: string; /** * Pre-Migration сheck id. */ key: string; } interface GetJobAdvisorReportChecksAdvisorReportCheckCollectionItemItemMetadata { /** * The field that stores the name of the object. */ objectNameColumn: string; /** * The field that stores the type of the object. */ objectTypeColumn: string; /** * The field that stores the fixed type of the object. */ objectTypeFixed: string; /** * The field that stores the owner of the object. */ schemaOwnerColumn: string; } interface GetJobAdvisorReportChecksAdvisorReportCheckCollectionItemSummary { /** * Number of BLOCKER results in the extended advisor report. */ blockerResultsTotalCount: number; /** * Number of FATAL results in the extended advisor report. */ fatalResultsTotalCount: number; /** * Number of INFORMATIONAL results in the extended advisor report. */ informationalResultsTotalCount: number; /** * Number of PASS results in the extended advisor report. */ passResultsTotalCount: number; /** * Number of WARNING results in the extended advisor report. */ warningResultsTotalCount: number; } interface GetJobAdvisorReportChecksAdvisorReportCheckCollectionSummary { /** * Number of BLOCKER results in the extended advisor report. */ blockerResultsTotalCount: number; /** * Number of FATAL results in the extended advisor report. */ fatalResultsTotalCount: number; /** * Number of INFORMATIONAL results in the extended advisor report. */ informationalResultsTotalCount: number; /** * Number of PASS results in the extended advisor report. */ passResultsTotalCount: number; /** * Number of WARNING results in the extended advisor report. */ warningResultsTotalCount: number; } interface GetJobAdvisorReportChecksFilter { name: string; regex?: boolean; values: string[]; } interface GetJobAdvisorReportReportLocationDetail { /** * File system path on the Source Database host where the Premigration Advisor report can be accessed. */ locationInSource: string; /** * Details to access Premigration Advisor report in the specified Object Storage bucket. */ objectStorageDetails: outputs.DatabaseMigration.GetJobAdvisorReportReportLocationDetailObjectStorageDetail[]; } interface GetJobAdvisorReportReportLocationDetailObjectStorageDetail { /** * Name of the bucket containing the Premigration Advisor report. */ bucket: string; /** * Object Storage namespace. */ namespace: string; /** * Premigration Advisor report object name. */ object: string; } interface GetJobOutputItem { /** * Job output line. */ message: string; } interface GetMigrationAdvancedParameter { /** * Parameter data type. */ dataType: string; /** * Name of directory object in database */ name: string; /** * If a STRING data type then the value should be an array of characters, if a INTEGER data type then the value should be an integer value, if a FLOAT data type then the value should be an float value, if a BOOLEAN data type then the value should be TRUE or FALSE. */ value: string; } interface GetMigrationAdvisorSetting { /** * True to not interrupt migration execution due to Pre-Migration Advisor errors. Default is false. */ isIgnoreErrors: boolean; /** * True to skip the Pre-Migration Advisor execution. Default is false. */ isSkipAdvisor: boolean; } interface GetMigrationDataTransferMediumDetail { /** * AWS access key credentials identifier Details: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys */ accessKeyId: string; /** * Name of directory object in database */ name: string; /** * In lieu of a network database link, Oracle Cloud Infrastructure Object Storage bucket will be used to store Data Pump dump files for the migration. Additionally, it can be specified alongside a database link data transfer medium. */ objectStorageBuckets: outputs.DatabaseMigration.GetMigrationDataTransferMediumDetailObjectStorageBucket[]; /** * AWS region code where the S3 bucket is located. Region code should match the documented available regions: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions */ region: string; /** * AWS secret access key credentials Details: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys */ secretAccessKey: string; /** * OCID of the shared storage mount target */ sharedStorageMountTargetId: string; /** * Optional additional properties for dump transfer in source or target host. Default kind is CURL. */ sources: outputs.DatabaseMigration.GetMigrationDataTransferMediumDetailSource[]; /** * Optional additional properties for dump transfer in source or target host. Default kind is CURL. */ targets: outputs.DatabaseMigration.GetMigrationDataTransferMediumDetailTarget[]; /** * The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. */ type: string; } interface GetMigrationDataTransferMediumDetailObjectStorageBucket { /** * Bucket name. */ bucket: string; /** * Namespace name of the object store bucket. */ namespace: string; } interface GetMigrationDataTransferMediumDetailSource { /** * Type of dump transfer to use during migration in source or target host. Default kind is CURL */ kind: string; /** * Path to the Oracle Cloud Infrastructure CLI installation in the node. */ ociHome: string; /** * Directory path to Oracle Cloud Infrastructure SSL wallet location on Db server node. */ walletLocation: string; } interface GetMigrationDataTransferMediumDetailTarget { /** * Type of dump transfer to use during migration in source or target host. Default kind is CURL */ kind: string; /** * Path to the Oracle Cloud Infrastructure CLI installation in the node. */ ociHome: string; /** * Directory path to Oracle Cloud Infrastructure SSL wallet location on Db server node. */ walletLocation: string; } interface GetMigrationExcludeObject { isOmitExcludedTableFromReplication: boolean; object: string; owner: string; schema: string; /** * The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. */ type: string; } interface GetMigrationGgsDetail { /** * ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. */ acceptableLag: number; /** * Parameters for Extract processes. */ extracts: outputs.DatabaseMigration.GetMigrationGgsDetailExtract[]; /** * Details about Oracle GoldenGate GGS Deployment. */ ggsDeployments: outputs.DatabaseMigration.GetMigrationGgsDetailGgsDeployment[]; /** * Parameters for Replicat processes. */ replicats: outputs.DatabaseMigration.GetMigrationGgsDetailReplicat[]; } interface GetMigrationGgsDetailExtract { /** * Length of time (in seconds) that a transaction can be open before Extract generates a warning message that the transaction is long-running. If not specified, Extract will not generate a warning on long-running transactions. */ longTransDuration: number; /** * Replicat performance. */ performanceProfile: string; } interface GetMigrationGgsDetailGgsDeployment { /** * The OCID of the resource being referenced. */ deploymentId: string; /** * The OCID of the resource being referenced. */ ggsAdminCredentialsSecretId: string; } interface GetMigrationGgsDetailReplicat { /** * Replicat performance. */ performanceProfile: string; } interface GetMigrationHubDetail { /** * ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. */ acceptableLag: number; /** * The OCID of the resource being referenced. */ computeId: string; /** * Parameters for Extract processes. */ extracts: outputs.DatabaseMigration.GetMigrationHubDetailExtract[]; /** * The OCID of the resource being referenced. */ keyId: string; /** * Parameters for Replicat processes. */ replicats: outputs.DatabaseMigration.GetMigrationHubDetailReplicat[]; /** * Database Administrator Credentials details. */ restAdminCredentials: outputs.DatabaseMigration.GetMigrationHubDetailRestAdminCredential[]; /** * Endpoint URL. */ url: string; /** * The OCID of the resource being referenced. */ vaultId: string; } interface GetMigrationHubDetailExtract { /** * Length of time (in seconds) that a transaction can be open before Extract generates a warning message that the transaction is long-running. If not specified, Extract will not generate a warning on long-running transactions. */ longTransDuration: number; /** * Replicat performance. */ performanceProfile: string; } interface GetMigrationHubDetailReplicat { /** * Replicat performance. */ performanceProfile: string; } interface GetMigrationHubDetailRestAdminCredential { password: string; /** * Administrator username */ username: string; } interface GetMigrationIncludeObject { isOmitExcludedTableFromReplication: boolean; object: string; owner: string; schema: string; /** * The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. */ type: string; } interface GetMigrationInitialLoadSetting { /** * Apply the specified requirements for compatibility with MySQL Database Service for all tables in the dump output, altering the dump files as necessary. */ compatibilities: string[]; /** * Optional parameters for Data Pump Export and Import. */ dataPumpParameters: outputs.DatabaseMigration.GetMigrationInitialLoadSettingDataPumpParameter[]; /** * Directory object details, used to define either import or export directory objects in Data Pump Settings. */ exportDirectoryObjects: outputs.DatabaseMigration.GetMigrationInitialLoadSettingExportDirectoryObject[]; /** * The action taken in the event of errors related to GRANT or REVOKE errors. */ handleGrantErrors: string; /** * Directory object details, used to define either import or export directory objects in Data Pump Settings. */ importDirectoryObjects: outputs.DatabaseMigration.GetMigrationInitialLoadSettingImportDirectoryObject[]; /** * Enable (true) or disable (false) consistent data dumps by locking the instance for backup during the dump. */ isConsistent: boolean; /** * Import the dump even if it contains objects that already exist in the target schema in the MySQL instance. */ isIgnoreExistingObjects: boolean; /** * Include a statement at the start of the dump to set the time zone to UTC. */ isTzUtc: boolean; /** * Oracle Job Mode */ jobMode: string; /** * Defines remapping to be applied to objects as they are processed. */ metadataRemaps: outputs.DatabaseMigration.GetMigrationInitialLoadSettingMetadataRemap[]; /** * Primary key compatibility option */ primaryKeyCompatibility: string; /** * Migration tablespace settings. */ tablespaceDetails: outputs.DatabaseMigration.GetMigrationInitialLoadSettingTablespaceDetail[]; } interface GetMigrationInitialLoadSettingDataPumpParameter { /** * Estimate size of dumps that will be generated. */ estimate: string; /** * Exclude paratemers for Export and Import. */ excludeParameters: string[]; /** * Maximum number of worker processes that can be used for a Data Pump Export job. */ exportParallelismDegree: number; /** * Maximum number of worker processes that can be used for a Data Pump Import job. For an Autonomous Database, ODMS will automatically query its CPU core count and set this property. */ importParallelismDegree: number; /** * Set to false to force Data Pump worker process to run on one instance. */ isCluster: boolean; /** * IMPORT: Specifies the action to be performed when data is loaded into a preexisting table. */ tableExistsAction: string; } interface GetMigrationInitialLoadSettingExportDirectoryObject { /** * Name of directory object in database */ name: string; /** * Absolute path of directory on database server */ path: string; } interface GetMigrationInitialLoadSettingImportDirectoryObject { /** * Name of directory object in database */ name: string; /** * Absolute path of directory on database server */ path: string; } interface GetMigrationInitialLoadSettingMetadataRemap { /** * Specifies the new value that oldValue should be translated into. */ newValue: string; /** * Specifies the value which needs to be reset. */ oldValue: string; /** * The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. */ type: string; } interface GetMigrationInitialLoadSettingTablespaceDetail { /** * Size of Oracle database blocks in KB. */ blockSizeInKbs: string; /** * Size to extend the tablespace in MB. Note: Only applicable if 'isBigFile' property is set to true. */ extendSizeInMbs: number; /** * Set this property to true to auto-create tablespaces in the target Database. Note: This is not applicable for Autonomous Database Serverless databases. */ isAutoCreate: boolean; /** * Set this property to true to enable tablespace of the type big file. */ isBigFile: boolean; /** * Name of the tablespace on the target database to which the source database tablespace is to be remapped. */ remapTarget: string; /** * Type of Database Base Migration Target. */ targetType: string; } interface GetMigrationObjectTypesFilter { /** * Object type name */ name: string; regex?: boolean; values: string[]; } interface GetMigrationObjectTypesMigrationObjectTypeSummaryCollection { /** * Items in collection. */ items: outputs.DatabaseMigration.GetMigrationObjectTypesMigrationObjectTypeSummaryCollectionItem[]; } interface GetMigrationObjectTypesMigrationObjectTypeSummaryCollectionItem { /** * Object type name */ name: string; } interface GetMigrationsAdvancedParameter { /** * Parameter data type. */ dataType: string; /** * Name of directory object in database */ name: string; /** * If a STRING data type then the value should be an array of characters, if a INTEGER data type then the value should be an integer value, if a FLOAT data type then the value should be an float value, if a BOOLEAN data type then the value should be TRUE or FALSE. */ value: string; } interface GetMigrationsAdvisorSetting { /** * True to not interrupt migration execution due to Pre-Migration Advisor errors. Default is false. */ isIgnoreErrors: boolean; /** * True to skip the Pre-Migration Advisor execution. Default is false. */ isSkipAdvisor: boolean; } interface GetMigrationsDataTransferMediumDetail { /** * AWS access key credentials identifier Details: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys */ accessKeyId: string; /** * Name of directory object in database */ name: string; /** * In lieu of a network database link, Oracle Cloud Infrastructure Object Storage bucket will be used to store Data Pump dump files for the migration. Additionally, it can be specified alongside a database link data transfer medium. */ objectStorageBuckets: outputs.DatabaseMigration.GetMigrationsDataTransferMediumDetailObjectStorageBucket[]; /** * AWS region code where the S3 bucket is located. Region code should match the documented available regions: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions */ region: string; /** * AWS secret access key credentials Details: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys */ secretAccessKey: string; /** * OCID of the shared storage mount target */ sharedStorageMountTargetId: string; /** * Optional additional properties for dump transfer in source or target host. Default kind is CURL. */ sources: outputs.DatabaseMigration.GetMigrationsDataTransferMediumDetailSource[]; /** * Optional additional properties for dump transfer in source or target host. Default kind is CURL. */ targets: outputs.DatabaseMigration.GetMigrationsDataTransferMediumDetailTarget[]; /** * The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. */ type: string; } interface GetMigrationsDataTransferMediumDetailObjectStorageBucket { /** * Bucket name. */ bucket: string; /** * Namespace name of the object store bucket. */ namespace: string; } interface GetMigrationsDataTransferMediumDetailSource { /** * Type of dump transfer to use during migration in source or target host. Default kind is CURL */ kind: string; /** * Path to the Oracle Cloud Infrastructure CLI installation in the node. */ ociHome: string; /** * Directory path to Oracle Cloud Infrastructure SSL wallet location on Db server node. */ walletLocation: string; } interface GetMigrationsDataTransferMediumDetailTarget { /** * Type of dump transfer to use during migration in source or target host. Default kind is CURL */ kind: string; /** * Path to the Oracle Cloud Infrastructure CLI installation in the node. */ ociHome: string; /** * Directory path to Oracle Cloud Infrastructure SSL wallet location on Db server node. */ walletLocation: string; } interface GetMigrationsExcludeObject { isOmitExcludedTableFromReplication: boolean; object: string; owner: string; schema: string; /** * The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. */ type: string; } interface GetMigrationsGgsDetail { /** * ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. */ acceptableLag: number; /** * Parameters for Extract processes. */ extracts: outputs.DatabaseMigration.GetMigrationsGgsDetailExtract[]; /** * Details about Oracle GoldenGate GGS Deployment. */ ggsDeployments: outputs.DatabaseMigration.GetMigrationsGgsDetailGgsDeployment[]; /** * Parameters for Replicat processes. */ replicats: outputs.DatabaseMigration.GetMigrationsGgsDetailReplicat[]; } interface GetMigrationsGgsDetailExtract { /** * Length of time (in seconds) that a transaction can be open before Extract generates a warning message that the transaction is long-running. If not specified, Extract will not generate a warning on long-running transactions. */ longTransDuration: number; /** * Replicat performance. */ performanceProfile: string; } interface GetMigrationsGgsDetailGgsDeployment { /** * The OCID of the resource being referenced. */ deploymentId: string; /** * The OCID of the resource being referenced. */ ggsAdminCredentialsSecretId: string; } interface GetMigrationsGgsDetailReplicat { /** * Replicat performance. */ performanceProfile: string; } interface GetMigrationsHubDetail { /** * ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. */ acceptableLag: number; /** * The OCID of the resource being referenced. */ computeId: string; /** * Parameters for Extract processes. */ extracts: outputs.DatabaseMigration.GetMigrationsHubDetailExtract[]; /** * The OCID of the resource being referenced. */ keyId: string; /** * Parameters for Replicat processes. */ replicats: outputs.DatabaseMigration.GetMigrationsHubDetailReplicat[]; /** * Database Administrator Credentials details. */ restAdminCredentials: outputs.DatabaseMigration.GetMigrationsHubDetailRestAdminCredential[]; /** * Endpoint URL. */ url: string; /** * The OCID of the resource being referenced. */ vaultId: string; } interface GetMigrationsHubDetailExtract { /** * Length of time (in seconds) that a transaction can be open before Extract generates a warning message that the transaction is long-running. If not specified, Extract will not generate a warning on long-running transactions. */ longTransDuration: number; /** * Replicat performance. */ performanceProfile: string; } interface GetMigrationsHubDetailReplicat { /** * Replicat performance. */ performanceProfile: string; } interface GetMigrationsHubDetailRestAdminCredential { password: string; /** * Administrator username */ username: string; } interface GetMigrationsIncludeObject { isOmitExcludedTableFromReplication: boolean; object: string; owner: string; schema: string; /** * The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. */ type: string; } interface GetMigrationsInitialLoadSetting { /** * Apply the specified requirements for compatibility with MySQL Database Service for all tables in the dump output, altering the dump files as necessary. */ compatibilities: string[]; /** * Optional parameters for Data Pump Export and Import. */ dataPumpParameters: outputs.DatabaseMigration.GetMigrationsInitialLoadSettingDataPumpParameter[]; /** * Directory object details, used to define either import or export directory objects in Data Pump Settings. */ exportDirectoryObjects: outputs.DatabaseMigration.GetMigrationsInitialLoadSettingExportDirectoryObject[]; /** * The action taken in the event of errors related to GRANT or REVOKE errors. */ handleGrantErrors: string; /** * Directory object details, used to define either import or export directory objects in Data Pump Settings. */ importDirectoryObjects: outputs.DatabaseMigration.GetMigrationsInitialLoadSettingImportDirectoryObject[]; /** * Enable (true) or disable (false) consistent data dumps by locking the instance for backup during the dump. */ isConsistent: boolean; /** * Import the dump even if it contains objects that already exist in the target schema in the MySQL instance. */ isIgnoreExistingObjects: boolean; /** * Include a statement at the start of the dump to set the time zone to UTC. */ isTzUtc: boolean; /** * Oracle Job Mode */ jobMode: string; /** * Defines remapping to be applied to objects as they are processed. */ metadataRemaps: outputs.DatabaseMigration.GetMigrationsInitialLoadSettingMetadataRemap[]; /** * Primary key compatibility option */ primaryKeyCompatibility: string; /** * Migration tablespace settings. */ tablespaceDetails: outputs.DatabaseMigration.GetMigrationsInitialLoadSettingTablespaceDetail[]; } interface GetMigrationsInitialLoadSettingDataPumpParameter { /** * Estimate size of dumps that will be generated. */ estimate: string; /** * Exclude paratemers for Export and Import. */ excludeParameters: string[]; /** * Maximum number of worker processes that can be used for a Data Pump Export job. */ exportParallelismDegree: number; /** * Maximum number of worker processes that can be used for a Data Pump Import job. For an Autonomous Database, ODMS will automatically query its CPU core count and set this property. */ importParallelismDegree: number; /** * Set to false to force Data Pump worker process to run on one instance. */ isCluster: boolean; /** * IMPORT: Specifies the action to be performed when data is loaded into a preexisting table. */ tableExistsAction: string; } interface GetMigrationsInitialLoadSettingExportDirectoryObject { /** * Name of directory object in database */ name: string; /** * Absolute path of directory on database server */ path: string; } interface GetMigrationsInitialLoadSettingImportDirectoryObject { /** * Name of directory object in database */ name: string; /** * Absolute path of directory on database server */ path: string; } interface GetMigrationsInitialLoadSettingMetadataRemap { /** * Specifies the new value that oldValue should be translated into. */ newValue: string; /** * Specifies the value which needs to be reset. */ oldValue: string; /** * The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. */ type: string; } interface GetMigrationsInitialLoadSettingTablespaceDetail { /** * Size of Oracle database blocks in KB. */ blockSizeInKbs: string; /** * Size to extend the tablespace in MB. Note: Only applicable if 'isBigFile' property is set to true. */ extendSizeInMbs: number; /** * Set this property to true to auto-create tablespaces in the target Database. Note: This is not applicable for Autonomous Database Serverless databases. */ isAutoCreate: boolean; /** * Set this property to true to enable tablespace of the type big file. */ isBigFile: boolean; /** * Name of the tablespace on the target database to which the source database tablespace is to be remapped. */ remapTarget: string; /** * Type of Database Base Migration Target. */ targetType: string; } interface JobAdvisorReportCheckItem { /** * Fixing the issue. */ action: string; /** * Array of the column of the objects table. */ columns: outputs.DatabaseMigration.JobAdvisorReportCheckItemColumn[]; /** * Pre-Migration сheck display name. */ displayName: string; /** * The path to the fixup script for this check. */ fixupScriptLocation: string; /** * Impact of the issue on data migration. */ impact: string; /** * If false, objects cannot be excluded from migration. */ isExclusionAllowed: boolean; /** * (Updatable) User flag for advisor report check. */ isReviewed: boolean; /** * Description of the issue. */ issue: string; /** * Pre-Migration сheck id. */ key: string; /** * Metadata of object. */ metadatas: outputs.DatabaseMigration.JobAdvisorReportCheckItemMetadata[]; /** * Number of database objects to migrate. */ objectCount: number; /** * Pre-Migration advisor result. */ resultType: string; } interface JobAdvisorReportCheckItemColumn { /** * Pre-Migration сheck display name. */ displayName: string; /** * Pre-Migration сheck id. */ key: string; } interface JobAdvisorReportCheckItemMetadata { /** * The field that stores the name of the object. */ objectNameColumn: string; /** * The field that stores the type of the object. */ objectTypeColumn: string; /** * The field that stores the fixed type of the object. */ objectTypeFixed: string; /** * The field that stores the owner of the object. */ schemaOwnerColumn: string; } interface JobAdvisorReportCheckSummary { /** * Number of BLOCKER results in the extended advisor report. */ blockerResultsTotalCount: number; /** * Number of FATAL results in the extended advisor report. */ fatalResultsTotalCount: number; /** * Number of INFORMATIONAL results in the extended advisor report. */ informationalResultsTotalCount: number; /** * Number of PASS results in the extended advisor report. */ passResultsTotalCount: number; /** * Number of WARNING results in the extended advisor report. */ warningResultsTotalCount: number; } interface JobCollectTracesData { /** * Name of the bucket containing the log file. */ bucket: string; /** * Status of trace collection process. */ collectTracesState: string; /** * Object Storage namespace. */ namespace: string; /** * Name of the object (regular expression is allowed) */ object: string; } interface JobParameterFileVersion { /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A description to discribe the current parameter file version */ description: string; /** * (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. Example: {"Department": "Finance"} */ freeformTags: { [key: string]: string; }; /** * Return boolean true/false for the currently in-use parameter file (factory or a versioned file) */ isCurrent: boolean; /** * Return true/false for whether the parameter file is oracle provided (Factory) */ isFactory: boolean; /** * Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT) */ kind: string; /** * Phase name */ name: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Migration Job was created. An RFC3339 formatted datetime string */ timeCreated: string; } interface JobProgress { /** * Current phase of the job. */ currentPhase: string; /** * Current status of the job. */ currentStatus: string; /** * List of phase status for the job. */ phases: outputs.DatabaseMigration.JobProgressPhase[]; } interface JobProgressPhase { /** * The text describing the action required to fix the issue */ action: string; /** * Duration of the phase in milliseconds */ durationInMs: number; /** * Attribute that returns an array of names and types of GoldenGate configuration files that are available for read or update. */ editableParameterFiles: string[]; /** * Summary of phase status results. */ extracts: outputs.DatabaseMigration.JobProgressPhaseExtract[]; /** * Job Phase group display name e.g. 'Step 1: Migration' */ groupDisplayName: string; /** * True if a Pre-Migration Advisor report is available for this phase. False or null if no report is available. */ isAdvisorReportAvailable: boolean; /** * This is returned as true if the current phase can be suspended. */ isSuspendAvailable: boolean; /** * The text describing the root cause of the reported issue */ issue: string; /** * Details to access log file in the specified Object Storage bucket, if any. */ logLocations: outputs.DatabaseMigration.JobProgressPhaseLogLocation[]; /** * Phase name */ name: string; /** * Percent progress of job phase. */ progress: number; /** * Phase status */ status: string; } interface JobProgressPhaseExtract { /** * Message in entry. */ message: string; /** * Type of unsupported object */ type: string; } interface JobProgressPhaseLogLocation { /** * Name of the bucket containing the log file. */ bucket: string; /** * Object Storage namespace. */ namespace: string; /** * Name of the object (regular expression is allowed) */ object: string; } interface JobUnsupportedObject { /** * Name of the object (regular expression is allowed) */ object: string; /** * Owner of the object (regular expression is allowed) */ owner: string; /** * Type of unsupported object */ type: string; } interface MigrationAdvancedParameter { /** * (Updatable) Parameter data type. */ dataType: string; /** * (Updatable) Parameter name. */ name: string; /** * (Updatable) If a STRING data type then the value should be an array of characters, if a INTEGER data type then the value should be an integer value, if a FLOAT data type then the value should be an float value, if a BOOLEAN data type then the value should be TRUE or FALSE. */ value: string; } interface MigrationAdvisorSettings { /** * (Updatable) True to not interrupt migration execution due to Pre-Migration Advisor errors. Default is false. */ isIgnoreErrors: boolean; /** * (Updatable) True to skip the Pre-Migration Advisor execution. Default is false. */ isSkipAdvisor: boolean; } interface MigrationDataTransferMediumDetails { /** * (Updatable) AWS access key credentials identifier Details: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys */ accessKeyId: string; /** * (Updatable) Name of database link from Oracle Cloud Infrastructure database to on-premise database. ODMS will create link, if the link does not already exist. */ name: string; /** * (Updatable) In lieu of a network database link, Oracle Cloud Infrastructure Object Storage bucket will be used to store Data Pump dump files for the migration. Additionally, it can be specified alongside a database link data transfer medium. */ objectStorageBucket: outputs.DatabaseMigration.MigrationDataTransferMediumDetailsObjectStorageBucket; /** * (Updatable) AWS region code where the S3 bucket is located. Region code should match the documented available regions: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions */ region: string; /** * (Updatable) AWS secret access key credentials Details: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys */ secretAccessKey: string; /** * (Updatable) OCID of the shared storage mount target */ sharedStorageMountTargetId: string; /** * (Updatable) Optional additional properties for dump transfer in source or target host. Default kind is CURL. */ source: outputs.DatabaseMigration.MigrationDataTransferMediumDetailsSource; /** * (Updatable) Optional additional properties for dump transfer in source or target host. Default kind is CURL. */ target: outputs.DatabaseMigration.MigrationDataTransferMediumDetailsTarget; /** * (Updatable) Type of the data transfer medium to use. */ type: string; } interface MigrationDataTransferMediumDetailsObjectStorageBucket { /** * (Updatable) Bucket name. */ bucket: string; /** * (Updatable) Namespace name of the object store bucket. */ namespace: string; } interface MigrationDataTransferMediumDetailsSource { /** * (Updatable) Type of dump transfer to use during migration in source or target host. Default kind is CURL */ kind: string; /** * (Updatable) Path to the Oracle Cloud Infrastructure CLI installation in the node. */ ociHome: string; /** * (Updatable) Directory path to Oracle Cloud Infrastructure SSL wallet location on Db server node. */ walletLocation: string; } interface MigrationDataTransferMediumDetailsTarget { /** * (Updatable) Type of dump transfer to use during migration in source or target host. Default kind is CURL */ kind: string; /** * (Updatable) Path to the Oracle Cloud Infrastructure CLI installation in the node. */ ociHome: string; /** * (Updatable) Directory path to Oracle Cloud Infrastructure SSL wallet location on Db server node. */ walletLocation: string; } interface MigrationExcludeObject { /** * Whether an excluded table should be omitted from replication. Only valid for database objects that have are of type TABLE and object status EXCLUDE. */ isOmitExcludedTableFromReplication: boolean; /** * Name of the object (regular expression is allowed) */ object: string; /** * Owner of the object (regular expression is allowed) */ owner: string; /** * Schema of the object (regular expression is allowed) */ schema: string; /** * Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded. */ type: string; } interface MigrationGgsDetails { /** * (Updatable) ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. */ acceptableLag: number; /** * (Updatable) Parameters for GoldenGate Extract processes. */ extract: outputs.DatabaseMigration.MigrationGgsDetailsExtract; /** * Details about Oracle GoldenGate GGS Deployment. */ ggsDeployments: outputs.DatabaseMigration.MigrationGgsDetailsGgsDeployment[]; /** * (Updatable) Parameters for GoldenGate Replicat processes. */ replicat: outputs.DatabaseMigration.MigrationGgsDetailsReplicat; } interface MigrationGgsDetailsExtract { /** * (Updatable) Length of time (in seconds) that a transaction can be open before Extract generates a warning message that the transaction is long-running. If not specified, Extract will not generate a warning on long-running transactions. */ longTransDuration: number; /** * (Updatable) Extract performance. */ performanceProfile: string; } interface MigrationGgsDetailsGgsDeployment { /** * The OCID of the resource being referenced. */ deploymentId: string; /** * The OCID of the resource being referenced. */ ggsAdminCredentialsSecretId: string; } interface MigrationGgsDetailsReplicat { /** * (Updatable) Replicat performance. */ performanceProfile: string; } interface MigrationHubDetails { /** * (Updatable) ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. */ acceptableLag: number; /** * (Updatable) The OCID of the resource being referenced. */ computeId: string; /** * (Updatable) Parameters for GoldenGate Extract processes. */ extract: outputs.DatabaseMigration.MigrationHubDetailsExtract; /** * (Updatable) The OCID of the resource being referenced. */ keyId: string; /** * (Updatable) Parameters for GoldenGate Replicat processes. */ replicat: outputs.DatabaseMigration.MigrationHubDetailsReplicat; /** * (Updatable) Database Administrator Credentials details. */ restAdminCredentials: outputs.DatabaseMigration.MigrationHubDetailsRestAdminCredentials; /** * (Updatable) Endpoint URL. */ url: string; /** * (Updatable) The OCID of the resource being referenced. */ vaultId: string; } interface MigrationHubDetailsExtract { /** * (Updatable) Length of time (in seconds) that a transaction can be open before Extract generates a warning message that the transaction is long-running. If not specified, Extract will not generate a warning on long-running transactions. */ longTransDuration: number; /** * (Updatable) Extract performance. */ performanceProfile: string; } interface MigrationHubDetailsReplicat { /** * (Updatable) Replicat performance. */ performanceProfile: string; } interface MigrationHubDetailsRestAdminCredentials { /** * (Updatable) Administrator password */ password: string; /** * (Updatable) Administrator username */ username: string; } interface MigrationIncludeObject { /** * Whether an excluded table should be omitted from replication. Only valid for database objects that have are of type TABLE and object status EXCLUDE. */ isOmitExcludedTableFromReplication: boolean; /** * Name of the object (regular expression is allowed) */ object: string; /** * Owner of the object (regular expression is allowed) */ owner: string; /** * Schema of the object (regular expression is allowed) */ schema: string; /** * Type of object to exclude. If not specified, matching owners and object names of type TABLE would be excluded. */ type: string; } interface MigrationInitialLoadSettings { /** * (Updatable) Apply the specified requirements for compatibility with MySQL Database Service for all tables in the dump output, altering the dump files as necessary. */ compatibilities: string[]; /** * (Updatable) Optional parameters for Data Pump Export and Import. */ dataPumpParameters: outputs.DatabaseMigration.MigrationInitialLoadSettingsDataPumpParameters; /** * (Updatable) Directory object details, used to define either import or export directory objects in Data Pump Settings. Import directory is required for Non-Autonomous target connections. If specified for an autonomous target, it will show an error. Export directory will error if there are database link details specified. */ exportDirectoryObject: outputs.DatabaseMigration.MigrationInitialLoadSettingsExportDirectoryObject; /** * (Updatable) The action taken in the event of errors related to GRANT or REVOKE errors. */ handleGrantErrors: string; /** * (Updatable) Directory object details, used to define either import or export directory objects in Data Pump Settings. Import directory is required for Non-Autonomous target connections. If specified for an autonomous target, it will show an error. Export directory will error if there are database link details specified. */ importDirectoryObject: outputs.DatabaseMigration.MigrationInitialLoadSettingsImportDirectoryObject; /** * (Updatable) Enable (true) or disable (false) consistent data dumps by locking the instance for backup during the dump. */ isConsistent: boolean; /** * (Updatable) Import the dump even if it contains objects that already exist in the target schema in the MySQL instance. */ isIgnoreExistingObjects: boolean; /** * (Updatable) Include a statement at the start of the dump to set the time zone to UTC. */ isTzUtc: boolean; /** * (Updatable) Oracle Job Mode */ jobMode: string; /** * (Updatable) Defines remapping to be applied to objects as they are processed. */ metadataRemaps: outputs.DatabaseMigration.MigrationInitialLoadSettingsMetadataRemap[]; /** * (Updatable) Primary key compatibility option */ primaryKeyCompatibility: string; /** * (Updatable) Migration tablespace settings. */ tablespaceDetails: outputs.DatabaseMigration.MigrationInitialLoadSettingsTablespaceDetails; } interface MigrationInitialLoadSettingsDataPumpParameters { /** * (Updatable) Estimate size of dumps that will be generated. */ estimate: string; /** * (Updatable) Exclude paratemers for Export and Import. */ excludeParameters: string[]; /** * (Updatable) Maximum number of worker processes that can be used for a Data Pump Export job. */ exportParallelismDegree: number; /** * (Updatable) Maximum number of worker processes that can be used for a Data Pump Import job. For an Autonomous Database, ODMS will automatically query its CPU core count and set this property. */ importParallelismDegree: number; /** * (Updatable) Set to false to force Data Pump worker process to run on one instance. */ isCluster: boolean; /** * (Updatable) IMPORT: Specifies the action to be performed when data is loaded into a preexisting table. */ tableExistsAction: string; } interface MigrationInitialLoadSettingsExportDirectoryObject { /** * (Updatable) Name of directory object in database */ name: string; /** * (Updatable) Absolute path of directory on database server */ path: string; } interface MigrationInitialLoadSettingsImportDirectoryObject { /** * (Updatable) Name of directory object in database */ name: string; /** * (Updatable) Absolute path of directory on database server */ path: string; } interface MigrationInitialLoadSettingsMetadataRemap { /** * (Updatable) Specifies the new value that oldValue should be translated into. */ newValue: string; /** * (Updatable) Specifies the value which needs to be reset. */ oldValue: string; /** * (Updatable) Type of remap. Refer to [METADATA_REMAP Procedure ](https://docs.oracle.com/en/database/oracle/oracle-database/19/arpls/DBMS_DATAPUMP.html#GUID-0FC32790-91E6-4781-87A3-229DE024CB3D) */ type: string; } interface MigrationInitialLoadSettingsTablespaceDetails { /** * (Updatable) Size of Oracle database blocks in KB. */ blockSizeInKbs: string; /** * (Updatable) Size to extend the tablespace in MB. Note: Only applicable if 'isBigFile' property is set to true. */ extendSizeInMbs: number; /** * (Updatable) Set this property to true to auto-create tablespaces in the target Database. Note: This is not applicable for Autonomous Database Serverless databases. */ isAutoCreate: boolean; /** * (Updatable) Set this property to true to enable tablespace of the type big file. */ isBigFile: boolean; /** * (Updatable) Name of the tablespace on the target database to which the source database tablespace is to be remapped. */ remapTarget: string; /** * (Updatable) Type of Database Base Migration Target. */ targetType: string; } } export declare namespace DatabaseTools { interface DatabaseToolsConnectionKeyStore { /** * (Updatable) The key store content. */ keyStoreContent: outputs.DatabaseTools.DatabaseToolsConnectionKeyStoreKeyStoreContent; /** * (Updatable) The key store password. */ keyStorePassword: outputs.DatabaseTools.DatabaseToolsConnectionKeyStoreKeyStorePassword; /** * (Updatable) The key store type. */ keyStoreType: string; } interface DatabaseToolsConnectionKeyStoreKeyStoreContent { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the key store. */ secretId: string; /** * (Updatable) The value type of the key store content. */ valueType: string; } interface DatabaseToolsConnectionKeyStoreKeyStorePassword { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the key store password. */ secretId: string; /** * (Updatable) The value type of the key store password. */ valueType: string; } interface DatabaseToolsConnectionLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DatabaseToolsConnectionProxyClient { /** * (Updatable) The proxy authentication type. */ proxyAuthenticationType: string; /** * (Updatable) A list of database roles for the client. These roles are enabled if the proxy is authorized to use the roles on behalf of the client. */ roles: string[]; /** * (Updatable) The user name. */ userName: string; /** * (Updatable) The database user password. */ userPassword: outputs.DatabaseTools.DatabaseToolsConnectionProxyClientUserPassword; } interface DatabaseToolsConnectionProxyClientUserPassword { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * (Updatable) The value type of the user password. */ valueType: string; } interface DatabaseToolsConnectionRelatedResource { /** * (Updatable) The resource entity type. */ entityType: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; } interface DatabaseToolsConnectionUserPassword { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * (Updatable) The value type of the user password. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ valueType: string; } interface DatabaseToolsDatabaseApiGatewayConfigLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DatabaseToolsIdentityLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message?: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DatabaseToolsMcpServerBuiltInRole { /** * (Updatable) A human-readable description of the Database Tools MCP server. */ description: string; /** * (Updatable) A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information. */ displayName: string; } interface DatabaseToolsMcpServerCustomRole { /** * (Updatable) The description of the custom role. */ description: string; /** * (Updatable) The display name of the custom role. */ displayName: string; } interface DatabaseToolsMcpServerEndpoint { /** * The URI endpoint of the MCP server */ endpoint: string; /** * (Updatable) The Database Tools MCP server type. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface DatabaseToolsMcpServerLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DatabaseToolsMcpServerRelatedResource { /** * The resource entity type. */ entityType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; } interface DatabaseToolsMcpServerStorage { /** * (Updatable) A Cloud Storage bucket for an MCP Server. */ bucket: outputs.DatabaseTools.DatabaseToolsMcpServerStorageBucket; /** * (Updatable) The type of storage used for asynchronous tool calls. */ type: string; } interface DatabaseToolsMcpServerStorageBucket { /** * (Updatable) The Object Storage bucket to use. */ bucket: string; /** * (Updatable) The Object Storage namespace to use. */ namespace: string; } interface DatabaseToolsMcpToolsetLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DatabaseToolsMcpToolsetReport { /** * (Updatable) The roles granted access to this report */ allowedRoles: string[]; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the report OCID of sql report. */ databaseToolsSqlReportId: string; } interface DatabaseToolsMcpToolsetSource { /** * (Updatable) The sql toolset sources type. INLINE is the only possible value. */ type: string; /** * (Updatable) The SQL source. Can contain multiple statements with a mix of queries, DML, DCL, DLL and scripts. */ value: string; } interface DatabaseToolsMcpToolsetTool { /** * (Updatable) The roles granted access to this tool */ allowedRoles: string[]; /** * (Updatable) A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information. */ displayName: string; /** * (Updatable) The name of the tool */ name: string; /** * (Updatable) The status of the tool */ status: string; } interface DatabaseToolsMcpToolsetVariable { /** * (Updatable) The description of the variable */ description: string; /** * (Updatable) The name of the variable */ name: string; /** * (Updatable) The type of the variable */ type: string; } interface DatabaseToolsPrivateEndpointLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DatabaseToolsPrivateEndpointReverseConnectionConfiguration { /** * A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN. */ reverseConnectionsSourceIps: outputs.DatabaseTools.DatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp[]; } interface DatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp { /** * The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN. */ sourceIp: string; } interface DatabaseToolsSqlReportColumn { /** * (Updatable) The description of the column */ description: string; /** * (Updatable) The name of the column */ name: string; /** * (Updatable) The type of the column */ type: string; } interface DatabaseToolsSqlReportLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DatabaseToolsSqlReportVariable { /** * (Updatable) The description of the variable */ description: string; /** * (Updatable) The name of the variable */ name: string; /** * (Updatable) The type of the variable * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface GetDatabaseToolsConnectionKeyStore { /** * The key store content. */ keyStoreContents: outputs.DatabaseTools.GetDatabaseToolsConnectionKeyStoreKeyStoreContent[]; /** * The key store password. */ keyStorePasswords: outputs.DatabaseTools.GetDatabaseToolsConnectionKeyStoreKeyStorePassword[]; /** * The key store type. */ keyStoreType: string; } interface GetDatabaseToolsConnectionKeyStoreKeyStoreContent { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * The value type of the user password. */ valueType: string; } interface GetDatabaseToolsConnectionKeyStoreKeyStorePassword { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * The value type of the user password. */ valueType: string; } interface GetDatabaseToolsConnectionLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools connection was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The Database Tools connection type. */ type: string; } interface GetDatabaseToolsConnectionProxyClient { /** * The proxy authentication type. */ proxyAuthenticationType: string; /** * A list of database roles for the client. These roles are enabled if the proxy is authorized to use the roles on behalf of the client. */ roles: string[]; /** * The database user name. When authenticationType is TOKEN, if provided, userName must be in square brackets (for example, [proxyClient]). */ userName: string; /** * The database user password. */ userPasswords: outputs.DatabaseTools.GetDatabaseToolsConnectionProxyClientUserPassword[]; } interface GetDatabaseToolsConnectionProxyClientUserPassword { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * The value type of the user password. */ valueType: string; } interface GetDatabaseToolsConnectionRelatedResource { /** * The resource entity type. */ entityType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; } interface GetDatabaseToolsConnectionUserPassword { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * The value type of the user password. */ valueType: string; } interface GetDatabaseToolsConnectionsDatabaseToolsConnectionCollection { items: outputs.DatabaseTools.GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItem[]; } interface GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItem { /** * The advanced connection properties key-value pair (for example, `oracle.net.ssl_server_dn_match`). */ advancedProperties: { [key: string]: string; }; /** * Specifies the authentication type used to connect to the database. */ authenticationType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The connect descriptor or Easy Connect Naming method used to connect to the database. */ connectionString: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools connection. */ id: string; /** * The Oracle wallet or Java Keystores containing trusted certificates for authenticating the server's public certificate and the client private key and associated certificates required for client authentication. */ keyStores: outputs.DatabaseTools.GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemKeyStore[]; /** * A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.DatabaseTools.GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemLock[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools private endpoint used to access the database in the customer VCN. */ privateEndpointId: string; /** * The proxy client information. */ proxyClients: outputs.DatabaseTools.GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemProxyClient[]; /** * A related resource */ relatedResources: outputs.DatabaseTools.GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemRelatedResource[]; /** * Specifies the Database Tools Runtime endpoint. */ runtimeEndpoint: string; /** * A filter to return only resources with one of the specified runtimeIdentity values. */ runtimeIdentity: string; /** * A filter to return only resources with one of the specified type values. */ runtimeSupport: string; /** * A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Database Tools connection was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the Database Tools connection was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return only resources their type matches the specified type. */ type: string; /** * The JDBC URL used to connect to the Generic JDBC database system. */ url: string; /** * The database user name. When authenticationType is TOKEN, if provided, userName must be in square brackets (for example, [proxyClient]). */ userName: string; /** * The database user password. */ userPasswords: outputs.DatabaseTools.GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemUserPassword[]; } interface GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemKeyStore { /** * The key store content. */ keyStoreContents: outputs.DatabaseTools.GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemKeyStoreKeyStoreContent[]; /** * The key store password. */ keyStorePasswords: outputs.DatabaseTools.GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemKeyStoreKeyStorePassword[]; /** * The key store type. */ keyStoreType: string; } interface GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemKeyStoreKeyStoreContent { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * The value type of the user password. */ valueType: string; } interface GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemKeyStoreKeyStorePassword { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * The value type of the user password. */ valueType: string; } interface GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools connection was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * A filter to return only resources their type matches the specified type. */ type: string; } interface GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemProxyClient { /** * The proxy authentication type. */ proxyAuthenticationType: string; /** * A list of database roles for the client. These roles are enabled if the proxy is authorized to use the roles on behalf of the client. */ roles: string[]; /** * The database user name. When authenticationType is TOKEN, if provided, userName must be in square brackets (for example, [proxyClient]). */ userName: string; /** * The database user password. */ userPasswords: outputs.DatabaseTools.GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemProxyClientUserPassword[]; } interface GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemProxyClientUserPassword { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * The value type of the user password. */ valueType: string; } interface GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemRelatedResource { /** * The resource entity type. */ entityType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; } interface GetDatabaseToolsConnectionsDatabaseToolsConnectionCollectionItemUserPassword { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret containing the user password. */ secretId: string; /** * The value type of the user password. */ valueType: string; } interface GetDatabaseToolsConnectionsFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabaseToolsDatabaseApiGatewayConfigLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The Database Tools database API gateway config type. */ type: string; } interface GetDatabaseToolsDatabaseApiGatewayConfigsDatabaseToolsDatabaseApiGatewayConfigCollection { items: outputs.DatabaseTools.GetDatabaseToolsDatabaseApiGatewayConfigsDatabaseToolsDatabaseApiGatewayConfigCollectionItem[]; } interface GetDatabaseToolsDatabaseApiGatewayConfigsDatabaseToolsDatabaseApiGatewayConfigCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools database API gateway config. */ id: string; /** * A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.DatabaseTools.GetDatabaseToolsDatabaseApiGatewayConfigsDatabaseToolsDatabaseApiGatewayConfigCollectionItemLock[]; /** * The RESTful service definition location. */ metadataSource: string; /** * A filter to return resources only when their `lifecycleState` matches the specified `lifecycleState`. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the Database Tools database API gateway config was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsDatabaseApiGatewayConfigsDatabaseToolsDatabaseApiGatewayConfigCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools database API gateway config was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsDatabaseApiGatewayConfigsFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollection { items: outputs.DatabaseTools.GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollectionItem[]; } interface GetDatabaseToolsEndpointServicesDatabaseToolsEndpointServiceCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A description of the Database Tools Endpoint Service. */ description: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Endpoint Service. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter to return only resources that match the entire specified name. */ name: string; /** * A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Database Tools Endpoint Service was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Database Tools Endpoint Service was updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetDatabaseToolsEndpointServicesFilter { /** * A filter to return only resources that match the entire specified name. */ name: string; regex?: boolean; values: string[]; } interface GetDatabaseToolsIdentitiesDatabaseToolsIdentityCollection { items: outputs.DatabaseTools.GetDatabaseToolsIdentitiesDatabaseToolsIdentityCollectionItem[]; } interface GetDatabaseToolsIdentitiesDatabaseToolsIdentityCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The name of the credential object created in the Oracle Database. */ credentialKey: string; /** * A filter to return only resources when their `databaseToolsConnectionId` matches the specified `databaseToolsConnectionId`. */ databaseToolsConnectionId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools identity. */ id: string; /** * A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.DatabaseTools.GetDatabaseToolsIdentitiesDatabaseToolsIdentityCollectionItemLock[]; /** * A filter to return resources only when their `databaseToolsIdentityLifecycleState` matches the specified `databaseToolsIdentityLifecycleState`. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Database Tools identity was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the Database Tools identity was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsIdentitiesDatabaseToolsIdentityCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools identity was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsIdentitiesFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabaseToolsIdentityLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools identity was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The Database Tools identity type. */ type: string; } interface GetDatabaseToolsMcpServerBuiltInRole { /** * A human-readable description of the Database Tools MCP server. */ description: string; /** * A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information. */ displayName: string; } interface GetDatabaseToolsMcpServerCustomRole { /** * A human-readable description of the Database Tools MCP server. */ description: string; /** * A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information. */ displayName: string; } interface GetDatabaseToolsMcpServerEndpoint { /** * The URI endpoint of the MCP server */ endpoint: string; /** * The Database Tools MCP server type. */ type: string; } interface GetDatabaseToolsMcpServerLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools MCP server was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The Database Tools MCP server type. */ type: string; } interface GetDatabaseToolsMcpServerRelatedResource { /** * The resource entity type. */ entityType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; } interface GetDatabaseToolsMcpServerStorage { /** * The Object Storage bucket to use. */ buckets: outputs.DatabaseTools.GetDatabaseToolsMcpServerStorageBucket[]; /** * The Database Tools MCP server type. */ type: string; } interface GetDatabaseToolsMcpServerStorageBucket { /** * The Object Storage bucket to use. */ bucket: string; /** * The Object Storage namespace to use. */ namespace: string; } interface GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollection { items: outputs.DatabaseTools.GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItem[]; } interface GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItem { /** * Access token expiry in seconds */ accessTokenExpiryInSeconds: number; /** * Built-in roles associated with the MCP Server. */ builtInRoles: outputs.DatabaseTools.GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemBuiltInRole[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Custom roles associated with the MCP Server. */ customRoles: outputs.DatabaseTools.GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemCustomRole[]; /** * A filter to return only resources when their `databaseToolsConnectionId` matches the specified `databaseToolsConnectionId`. */ databaseToolsConnectionId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A human-readable description of the Database Tools MCP server. */ description: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated domain application (Oracle Cloud Service). */ domainAppId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated identity domain. */ domainId: string; /** * Invoke endpoints for the MCP server. */ endpoints: outputs.DatabaseTools.GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemEndpoint[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools MCP server. */ id: string; /** * A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.DatabaseTools.GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemLock[]; /** * Refresh token expiry in seconds */ refreshTokenExpiryInSeconds: number; /** * A related resource */ relatedResources: outputs.DatabaseTools.GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemRelatedResource[]; /** * Specifies the identity used by the Database Tools MCP server to issue requests to other Oracle Cloud Infrastructure services (e.g., Secrets in Vault). */ runtimeIdentity: string; /** * A filter to return resources only when their `databaseToolsMcpServerLifecycleState` matches the specified `databaseToolsMcpServerLifecycleState`. */ state: string; /** * The storage option used when running a tool asynchronously. */ storages: outputs.DatabaseTools.GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemStorage[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Database Tools MCP server was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the Database Tools MCP server was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemBuiltInRole { /** * A human-readable description of the Database Tools MCP server. */ description: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; } interface GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemCustomRole { /** * A human-readable description of the Database Tools MCP server. */ description: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; } interface GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemEndpoint { /** * The URI endpoint of the MCP server */ endpoint: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools MCP server was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemRelatedResource { /** * The resource entity type. */ entityType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; } interface GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemStorage { /** * The Object Storage bucket to use. */ buckets: outputs.DatabaseTools.GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemStorageBucket[]; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsMcpServersDatabaseToolsMcpServerCollectionItemStorageBucket { /** * The Object Storage bucket to use. */ bucket: string; /** * The Object Storage namespace to use. */ namespace: string; } interface GetDatabaseToolsMcpServersFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabaseToolsMcpToolsetLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools MCP server was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The type of the variable */ type: string; } interface GetDatabaseToolsMcpToolsetReport { /** * The roles granted access to this MCP tool */ allowedRoles: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the report OCID of sql report. */ databaseToolsSqlReportId: string; } interface GetDatabaseToolsMcpToolsetSource { /** * The type of the variable */ type: string; /** * The SQL source. Can contain multiple statements with a mix of queries, DML, DCL, DLL and scripts. */ value: string; } interface GetDatabaseToolsMcpToolsetTool { /** * The roles granted access to this MCP tool */ allowedRoles: string[]; /** * The display name of the tool */ displayName: string; /** * The name of the variable */ name: string; /** * The status of the tool */ status: string; } interface GetDatabaseToolsMcpToolsetVariable { /** * The description of the variable */ description: string; /** * The name of the variable */ name: string; /** * The type of the variable */ type: string; } interface GetDatabaseToolsMcpToolsetVersionsDatabaseToolsMcpToolsetVersionCollection { /** * Array of MCP toolset type version summary items. */ items: outputs.DatabaseTools.GetDatabaseToolsMcpToolsetVersionsDatabaseToolsMcpToolsetVersionCollectionItem[]; } interface GetDatabaseToolsMcpToolsetVersionsDatabaseToolsMcpToolsetVersionCollectionItem { /** * The default version for this toolset type. */ defaultVersion: number; /** * The MCP toolset type. */ type: string; /** * The version configurations available for this toolset type. */ versions: outputs.DatabaseTools.GetDatabaseToolsMcpToolsetVersionsDatabaseToolsMcpToolsetVersionCollectionItemVersion[]; } interface GetDatabaseToolsMcpToolsetVersionsDatabaseToolsMcpToolsetVersionCollectionItemVersion { /** * The roles granted access to this tool by default. */ defaultAllowedRoles: string[]; /** * The roles granted access to this toolset version by default. */ defaultReportAllowedRoles: string[]; /** * The description of the tool. */ description: string; /** * Optional feature flags or attributes for this version. */ features: string[]; /** * The tools available in this version. */ tools: outputs.DatabaseTools.GetDatabaseToolsMcpToolsetVersionsDatabaseToolsMcpToolsetVersionCollectionItemVersionTool[]; /** * The version number. */ version: number; } interface GetDatabaseToolsMcpToolsetVersionsDatabaseToolsMcpToolsetVersionCollectionItemVersionTool { /** * The roles granted access to this tool by default. */ defaultAllowedRoles: string[]; /** * The default status of the tool in this version. */ defaultStatus: string; /** * The description of the tool. */ description: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * The unique name of the tool. */ name: string; } interface GetDatabaseToolsMcpToolsetVersionsFilter { /** * The unique name of the tool. */ name: string; regex?: boolean; values: string[]; } interface GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollection { items: outputs.DatabaseTools.GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItem[]; } interface GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItem { /** * The roles granted access to this MCP tool */ allowedRoles: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * A filter to return only resources matching the specified `databaseToolsMcpServerId`. */ databaseToolsMcpServerId: string; /** * The default execution type for the toolset. The default value is SYNCHRONOUS. */ defaultExecutionType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The description of the variable */ description: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related Generative AI Semantic Store. */ generativeAiSemanticStoreId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools MCP Toolsets. */ id: string; /** * A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.DatabaseTools.GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItemLock[]; /** * List of Database Tools Customizable reporting tools */ reports: outputs.DatabaseTools.GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItemReport[]; /** * The SQL source. Can contain multiple statements with a mix of queries, DML, DCL, DLL and scripts. */ sources: outputs.DatabaseTools.GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItemSource[]; /** * A filter to return resources only when their `databaseToolsMcpToolsetLifecycleState` matches the specified `databaseToolsMcpToolsetLifecycleState`. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Database Tools MCP server was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the Database Tools MCP server was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Instructions describing how to use the MCP toolset and its features. This can be used to improve the LLM's understanding of the tool. */ toolDescription: string; /** * Name of the tool returned by the MCP Server */ toolName: string; /** * List of Database Tools Customizable reporting tools */ tools: outputs.DatabaseTools.GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItemTool[]; /** * A filter to return only resources with one of the specified type values. */ type: string; /** * The variables to use with the query */ variables: outputs.DatabaseTools.GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItemVariable[]; /** * The MCP toolset version */ version: number; } interface GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools MCP server was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItemReport { /** * The roles granted access to this MCP tool */ allowedRoles: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the report OCID of sql report. */ databaseToolsSqlReportId: string; } interface GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItemSource { /** * A filter to return only resources with one of the specified type values. */ type: string; /** * The SQL source. Can contain multiple statements with a mix of queries, DML, DCL, DLL and scripts. */ value: string; } interface GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItemTool { /** * The roles granted access to this MCP tool */ allowedRoles: string[]; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * The name of the variable */ name: string; /** * The status of the tool */ status: string; } interface GetDatabaseToolsMcpToolsetsDatabaseToolsMcpToolsetCollectionItemVariable { /** * The description of the variable */ description: string; /** * The name of the variable */ name: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsMcpToolsetsFilter { /** * The name of the variable */ name: string; regex?: boolean; values: string[]; } interface GetDatabaseToolsPrivateEndpointLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetDatabaseToolsPrivateEndpointReverseConnectionConfiguration { /** * A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN. */ reverseConnectionsSourceIps: outputs.DatabaseTools.GetDatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp[]; } interface GetDatabaseToolsPrivateEndpointReverseConnectionConfigurationReverseConnectionsSourceIp { /** * The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN. */ sourceIp: string; } interface GetDatabaseToolsPrivateEndpointsDatabaseToolsPrivateEndpointCollection { items: outputs.DatabaseTools.GetDatabaseToolsPrivateEndpointsDatabaseToolsPrivateEndpointCollectionItem[]; } interface GetDatabaseToolsPrivateEndpointsDatabaseToolsPrivateEndpointCollectionItem { /** * A list of additional FQDNs that can be also be used for the private endpoint. */ additionalFqdns: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A description of the Database Tools private endpoint. */ description: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * Then FQDN to use for the private endpoint. */ endpointFqdn: string; /** * A filter to return only resources their `endpointServiceId` matches the specified `endpointServiceId`. */ endpointServiceId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools private endpoint. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.DatabaseTools.GetDatabaseToolsPrivateEndpointsDatabaseToolsPrivateEndpointCollectionItemLock[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups that the private endpoint's VNIC belongs to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/). */ nsgIds: string[]; /** * The private IP address that represents the access point for the associated endpoint service. */ privateEndpointIp: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint's VNIC. */ privateEndpointVnicId: string; /** * Reverse connection configuration details of the private endpoint. */ reverseConnectionConfigurations: outputs.DatabaseTools.GetDatabaseToolsPrivateEndpointsDatabaseToolsPrivateEndpointCollectionItemReverseConnectionConfiguration[]; /** * Zero trust Packet Routing (ZPR) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`. */ state: string; /** * A filter to return only resources their `subnetId` matches the specified `subnetId`. */ subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Database Tools private endpoint was updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN that the private endpoint belongs to. */ vcnId: string; } interface GetDatabaseToolsPrivateEndpointsDatabaseToolsPrivateEndpointCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools private endpoint was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetDatabaseToolsPrivateEndpointsDatabaseToolsPrivateEndpointCollectionItemReverseConnectionConfiguration { /** * A list of IP addresses in the customer VCN to be used as the source IPs for reverse connection packets traveling from the service's VCN to the customer's VCN. */ reverseConnectionsSourceIps: outputs.DatabaseTools.GetDatabaseToolsPrivateEndpointsDatabaseToolsPrivateEndpointCollectionItemReverseConnectionConfigurationReverseConnectionsSourceIp[]; } interface GetDatabaseToolsPrivateEndpointsDatabaseToolsPrivateEndpointCollectionItemReverseConnectionConfigurationReverseConnectionsSourceIp { /** * The IP address in the customer's VCN to be used as the source IP for reverse connection packets traveling from the customer's VCN to the service's VCN. */ sourceIp: string; } interface GetDatabaseToolsPrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetDatabaseToolsSqlReportColumn { /** * The description of the variable */ description: string; /** * The name of the variable */ name: string; /** * The type of the variable */ type: string; } interface GetDatabaseToolsSqlReportLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools SQL report was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The type of the variable */ type: string; } interface GetDatabaseToolsSqlReportVariable { /** * The description of the variable */ description: string; /** * The name of the variable */ name: string; /** * The type of the variable */ type: string; } interface GetDatabaseToolsSqlReportsDatabaseToolsSqlReportCollection { items: outputs.DatabaseTools.GetDatabaseToolsSqlReportsDatabaseToolsSqlReportCollectionItem[]; } interface GetDatabaseToolsSqlReportsDatabaseToolsSqlReportCollectionItem { /** * Descriptive information on columns referenced in the Database Tools SQL Report source. */ columns: outputs.DatabaseTools.GetDatabaseToolsSqlReportsDatabaseToolsSqlReportCollectionItemColumn[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The description of the variable */ description: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools SQL report. */ id: string; /** * Instructions on how to use the SQL report. Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report. */ instructions: string; /** * A message describing the current state in more detail. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.DatabaseTools.GetDatabaseToolsSqlReportsDatabaseToolsSqlReportCollectionItemLock[]; /** * Purpose of the Database Tools SQL report. Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy. */ purpose: string; /** * SQL query executed to generate the report. */ source: string; /** * A filter to return resources only when their `databaseToolsSqlReportLifecycleState` matches the specified `databaseToolsSqlReportLifecycleState`. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Database Tools SQL report was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the Database Tools SQL report was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return only resources with one of the specified type values. */ type: string; /** * Variables referenced in the Database Tools SQL Report source. */ variables: outputs.DatabaseTools.GetDatabaseToolsSqlReportsDatabaseToolsSqlReportCollectionItemVariable[]; } interface GetDatabaseToolsSqlReportsDatabaseToolsSqlReportCollectionItemColumn { /** * The description of the variable */ description: string; /** * The name of the variable */ name: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsSqlReportsDatabaseToolsSqlReportCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the Database Tools SQL report was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsSqlReportsDatabaseToolsSqlReportCollectionItemVariable { /** * The description of the variable */ description: string; /** * The name of the variable */ name: string; /** * A filter to return only resources with one of the specified type values. */ type: string; } interface GetDatabaseToolsSqlReportsFilter { /** * The name of the variable */ name: string; regex?: boolean; values: string[]; } interface GetRuntimeDatabaseToolsConnectionCredentialExecuteGranteesCredentialExecuteGranteeCollection { items: outputs.DatabaseTools.GetRuntimeDatabaseToolsConnectionCredentialExecuteGranteesCredentialExecuteGranteeCollectionItem[]; } interface GetRuntimeDatabaseToolsConnectionCredentialExecuteGranteesCredentialExecuteGranteeCollectionItem { /** * The name of the credential */ credentialKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools connection. */ databaseToolsConnectionId: string; /** * The name of the user to grant the EXECUTE privilege on the credential. */ key: string; } interface GetRuntimeDatabaseToolsConnectionCredentialExecuteGranteesFilter { name: string; regex?: boolean; values: string[]; } interface GetRuntimeDatabaseToolsConnectionCredentialPublicSynonymsCredentialPublicSynonymCollection { items: outputs.DatabaseTools.GetRuntimeDatabaseToolsConnectionCredentialPublicSynonymsCredentialPublicSynonymCollectionItem[]; } interface GetRuntimeDatabaseToolsConnectionCredentialPublicSynonymsCredentialPublicSynonymCollectionItem { /** * The name of the credential */ credentialKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools connection. */ databaseToolsConnectionId: string; /** * The name of the public synonym for the credential */ key: string; } interface GetRuntimeDatabaseToolsConnectionCredentialPublicSynonymsFilter { name: string; regex?: boolean; values: string[]; } interface GetRuntimeDatabaseToolsConnectionCredentialRelatedResource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; /** * The related resource type. */ type: string; } interface GetRuntimeDatabaseToolsConnectionCredentialsCredentialCollection { items: outputs.DatabaseTools.GetRuntimeDatabaseToolsConnectionCredentialsCredentialCollectionItem[]; } interface GetRuntimeDatabaseToolsConnectionCredentialsCredentialCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools connection. */ databaseToolsConnectionId: string; /** * Indicates whether this credential is enabled (TRUE) or not (FALSE) */ enabled: string; /** * Name of the credential */ key: string; /** * Indicates whether this refers to a public synonym or not. */ keyType: string; /** * Owner of the credential */ owner: string; password: string; /** * A related resource for a credential. */ relatedResources: outputs.DatabaseTools.GetRuntimeDatabaseToolsConnectionCredentialsCredentialCollectionItemRelatedResource[]; /** * The related resource type. */ type: string; /** * Name of the user that will be used to log in to the remote database or the remote or local operating system */ userName: string; /** * For a Windows target, the Windows domain to use when logging in */ windowsDomain: string; } interface GetRuntimeDatabaseToolsConnectionCredentialsCredentialCollectionItemRelatedResource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; /** * The related resource type. */ type: string; } interface GetRuntimeDatabaseToolsConnectionCredentialsFilter { name: string; regex?: boolean; values: string[]; } interface GetRuntimeDatabaseToolsConnectionPropertySetIdentityProvider { /** * External identity provider configuration parameters. Simple key-value pair Example: { "tenantId": "...", "applicationIdUri": "...", ... } */ configs: { [key: string]: string; }; /** * External identity type provider. Supported values - OCI_IAM, AZURE_AD, NONE. */ type: string; } interface GetRuntimeDatabaseToolsConnectionPropertySetPrerequisitesCheck { /** * Status indicating the outcome of the prerequisites check. */ status: string; /** * Messages describing the prerequisites check outcome. Messages can provide actionable information when the status indicates a failure. */ statusDetails: string[]; } interface GetRuntimeDatabaseToolsConnectionUserCredentialRelatedResource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; /** * The related resource type. */ type: string; } interface GetRuntimeDatabaseToolsConnectionUserCredentialsFilter { name: string; regex?: boolean; values: string[]; } interface GetRuntimeDatabaseToolsConnectionUserCredentialsUserCredentialCollection { items: outputs.DatabaseTools.GetRuntimeDatabaseToolsConnectionUserCredentialsUserCredentialCollectionItem[]; } interface GetRuntimeDatabaseToolsConnectionUserCredentialsUserCredentialCollectionItem { /** * Indicates whether this credential is enabled (TRUE) or not (FALSE) */ enabled: string; /** * Name of the credential */ key: string; /** * Indicates whether this refers to a public synonym or not. */ keyType: string; /** * Owner of the credential */ owner: string; /** * A related resource for a credential. */ relatedResources: outputs.DatabaseTools.GetRuntimeDatabaseToolsConnectionUserCredentialsUserCredentialCollectionItemRelatedResource[]; /** * Name of the user that will be used to log in to the remote database or the remote or local operating system */ userName: string; /** * For a Windows target, the Windows domain to use when logging in */ windowsDomain: string; } interface GetRuntimeDatabaseToolsConnectionUserCredentialsUserCredentialCollectionItemRelatedResource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; /** * The related resource type. */ type: string; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertiesDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryCollection { /** * List of database API gateway config setting descriptions to be provided as advanced properties. */ items: outputs.DatabaseTools.GetRuntimeDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertiesDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryCollectionItem[]; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertiesDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryCollectionItem { /** * A user-friendly name of a category. */ categoryDisplayName: string; /** * The category of the Database Tools database API gateway config global setting. */ categoryKey: string; /** * The config types that support this advanced property. The supported types are GLOBAL and POOL. */ configTypes: string[]; /** * The data type of a database API gateway config setting. */ dataType: string; /** * The type of database (as determined by a type of Database Tools connection) to which this setting applies. The advancedProperty applies to all types of Database Tools connection when null. This is only applicable when configTypes includes POOL. */ databaseToolsConnectionTypes: string[]; /** * The default value (if applicable) of a database API gateway config setting. */ defaultValue: string; /** * A user-friendly description of a database API gateway config setting. */ description: string; /** * A user-friendly name. */ displayName: string; /** * Uniform resource locator (URL) of documentation related to this setting. */ documentationUrl: string; /** * Hint text for a database API gateway config setting. */ hintText: string; /** * A string that uniquely identifies a Database Tools database API gateway config global settings resource. */ key: string; /** * A list of string values (if applicable) supported by this database API gateway config setting. */ listOfValues: string[]; /** * A maximum numeric value (if applicable) of a database API gateway config setting. */ maxValue: number; /** * A minimum numeric value (if applicable) of a database API gateway config setting. */ minValue: number; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigAdvancedPropertiesFilter { name: string; regex?: boolean; values: string[]; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigGlobalCertificateBundle { /** * Describes a certificate private key file to be used with SSL */ certificatePrivateKeys: outputs.DatabaseTools.GetRuntimeDatabaseToolsDatabaseApiGatewayConfigGlobalCertificateBundleCertificatePrivateKey[]; /** * Describes a certificate file to be used with SSL. Ignored if the httpsPort is 0. */ certificatePublics: outputs.DatabaseTools.GetRuntimeDatabaseToolsDatabaseApiGatewayConfigGlobalCertificateBundleCertificatePublic[]; /** * The type of the Database Tools database API gateway config global settings resource. */ type: string; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigGlobalCertificateBundleCertificatePrivateKey { /** * The format of the file */ format: string; /** * The path to the file */ path: string; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigGlobalCertificateBundleCertificatePublic { /** * The format of the file */ format: string; /** * The path to the file */ path: string; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecCollection { items: outputs.DatabaseTools.GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecCollectionItem[]; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecCollectionItem { /** * The content of a string-escaped Open API spec in JSON format. */ content: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config. */ databaseToolsDatabaseApiGatewayConfigId: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; id: string; /** * A system generated string that uniquely identifies an API spec sub resource within a given pool. */ key: string; /** * The key of the pool config. */ poolKey: string; /** * The time the resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the resource was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The type of the Database Tools database API gateway config API spec sub resource. */ type: string; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecsFilter { name: string; regex?: boolean; values: string[]; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecCollection { items: outputs.DatabaseTools.GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecCollectionItem[]; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecCollectionItem { /** * Used as the URI path element for this object. When not specified the objectName lowercase is the default value. */ alias: string; /** * The name of the database object. */ databaseObjectName: string; /** * The type of the database object. */ databaseObjectType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config. */ databaseToolsDatabaseApiGatewayConfigId: string; /** * Description of the autoApiSpec. */ description: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * A system generated string that uniquely identifies an auto API spec sub resource within a given pool. */ key: string; /** * The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"]. */ operations: string[]; /** * The key of the pool config. */ poolKey: string; /** * The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes. */ roles: string[]; /** * The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes. */ scope: string; /** * The security schemes that can access this resource. If not specified then the resource is public. */ securitySchemes: string[]; /** * The time the resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the resource was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The type of the Database Tools database API gateway config auto API spec sub resource. */ type: string; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecsFilter { name: string; regex?: boolean; values: string[]; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolsDatabaseToolsDatabaseApiGatewayConfigPoolCollection { items: outputs.DatabaseTools.GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolsDatabaseToolsDatabaseApiGatewayConfigPoolCollectionItem[]; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolsDatabaseToolsDatabaseApiGatewayConfigPoolCollectionItem { /** * Advanced pool properties. */ advancedProperties: { [key: string]: string; }; /** * Specifies to enable the Database Actions feature. */ databaseActionsStatus: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related Database Tools connection. Specifies the Oracle Cloud Infrastructure database tools connection ocid to build the connection pool from. */ databaseToolsConnectionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config. */ databaseToolsDatabaseApiGatewayConfigId: string; /** * A filter to return only resources that match the entire specified display name. */ displayName: string; /** * Specifies the initial size for the number of database connections that will be created for the pool. */ initialPoolSize: number; /** * Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token. */ jwtProfileAudience: string; /** * Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token. */ jwtProfileIssuer: string; /** * Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token. */ jwtProfileJwkUrl: string; /** * Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users. */ jwtProfileRoleClaimName: string; /** * A system generated string that uniquely identifies a pool sub resource. */ key: string; /** * Specifies the maximum number of database connections allowed for the pool. */ maxPoolSize: number; /** * Specifies the minimum number of database connections allowed for the pool. */ minPoolSize: number; /** * The pool route value provided in requests to target this pool. */ poolRouteValue: string; /** * Specifies whether the REST-Enabled SQL service is active. */ restEnabledSqlStatus: string; /** * The time the resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the resource was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The type of the Database Tools database API gateway config pool sub resource. */ type: string; } interface GetRuntimeDatabaseToolsDatabaseApiGatewayConfigPoolsFilter { name: string; regex?: boolean; values: string[]; } interface RuntimeDatabaseToolsConnectionCredentialRelatedResource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related resource. */ identifier: string; /** * (Updatable) The type of credential. */ type: string; } interface RuntimeDatabaseToolsConnectionPropertySetIdentityProvider { /** * (Updatable) External identity provider configuration parameters. Simple key-value pair Example: { "tenantId": "...", "applicationIdUri": "...", ... } */ configs: { [key: string]: string; }; /** * (Updatable) External identity type provider. Supported values - OCI_IAM, AZURE_AD, NONE. */ type: string; } interface RuntimeDatabaseToolsConnectionPropertySetPrerequisitesCheck { /** * Status indicating the outcome of the prerequisites check. */ status: string; /** * Messages describing the prerequisites check outcome. Messages can provide actionable information when the status indicates a failure. */ statusDetails: string[]; } interface RuntimeDatabaseToolsDatabaseApiGatewayConfigGlobalCertificateBundle { /** * (Updatable) Describes a certificate private key file to be used with SSL */ certificatePrivateKey: outputs.DatabaseTools.RuntimeDatabaseToolsDatabaseApiGatewayConfigGlobalCertificateBundleCertificatePrivateKey; /** * (Updatable) Describes a certificate file to be used with SSL. Ignored if the httpsPort is 0. */ certificatePublic: outputs.DatabaseTools.RuntimeDatabaseToolsDatabaseApiGatewayConfigGlobalCertificateBundleCertificatePublic; /** * (Updatable) The type of the certificate. */ type: string; } interface RuntimeDatabaseToolsDatabaseApiGatewayConfigGlobalCertificateBundleCertificatePrivateKey { /** * (Updatable) The format of the file */ format: string; /** * (Updatable) The path to the file */ path: string; } interface RuntimeDatabaseToolsDatabaseApiGatewayConfigGlobalCertificateBundleCertificatePublic { /** * (Updatable) The format of the file */ format: string; /** * (Updatable) The path to the file */ path: string; } } export declare namespace Dblm { interface GetPatchManagementDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetPatchManagementDatabasesPatchDatabasesCollection { /** * List of patchDatabases. */ items: outputs.Dblm.GetPatchManagementDatabasesPatchDatabasesCollectionItem[]; } interface GetPatchManagementDatabasesPatchDatabasesCollectionItem { /** * List of additional patches on database. */ additionalPatches: outputs.Dblm.GetPatchManagementDatabasesPatchDatabasesCollectionItemAdditionalPatch[]; /** * This is the hashcode representing the list of patches applied. */ currentPatchWatermark: string; /** * Database ocid. */ databaseId: string; /** * Database name. */ databaseName: string; /** * Filter by database type. Possible values Single Instance or RAC. */ databaseType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * For SI, hosted on host and for RAC, host on cluster. */ hostOrCluster: string; /** * Image details containing the subscribed image, its status, version, owner and time of creation. */ imageDetails: outputs.Dblm.GetPatchManagementDatabasesPatchDatabasesCollectionItemImageDetail[]; /** * Path to the Oracle home. */ oracleHomePath: string; /** * Details of deploy, update and migrate-listener(only for single Instance database) operations for this resource. */ patchActivityDetails: outputs.Dblm.GetPatchManagementDatabasesPatchDatabasesCollectionItemPatchActivityDetail[]; /** * Patch Compliance Status */ patchComplianceDetails: outputs.Dblm.GetPatchManagementDatabasesPatchDatabasesCollectionItemPatchComplianceDetail[]; /** * Intermediate user to be used for patching, created and maintained by customers. This user requires sudo access to switch as Oracle home owner and root user */ patchUser: string; /** * Database release. */ release: string; /** * Database release full version. */ releaseFullVersion: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * Path to sudo binary (executable) file */ sudoFilePath: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Summary of vulnerabilities found in registered resources grouped by severity. */ vulnerabilitiesSummaries: outputs.Dblm.GetPatchManagementDatabasesPatchDatabasesCollectionItemVulnerabilitiesSummary[]; } interface GetPatchManagementDatabasesPatchDatabasesCollectionItemAdditionalPatch { /** * Shows if patch is recommended or is an additional patch from an existing database. */ category: string; /** * Description of the patch recommendation. */ description: string; /** * Id for the patch recommendation. */ patchId: number; /** * Name for the patch recommendation. */ patchName: string; } interface GetPatchManagementDatabasesPatchDatabasesCollectionItemImageDetail { /** * Name of the person who created the image. */ createdBy: string; /** * Name of the image version marked as current of the image. */ currentVersion: string; /** * Subscribed image */ imageId: string; /** * Owner of the image. */ imageOwner: string; /** * Image status. */ imageStatus: string; /** * Release version of the image. */ imageVersion: string; /** * Subscribed image. */ subscribedImage: string; /** * Date when the image was created. */ timeImageCreation: string; /** * An image version name, that is up to date and has no recommendations. */ upToDateImageVersion: string; } interface GetPatchManagementDatabasesPatchDatabasesCollectionItemPatchActivityDetail { /** * Operation Identifier for deploy operation. */ deployOperationId: string; /** * Status of deploy operation. */ deployStatus: string; /** * Task identifier for deploy operation. */ deployTaskId: string; /** * Operation Identifier for migrate listener operation. */ migrateListenerOperationId: string; /** * Status of migrate listener operation. */ migrateListenerStatus: string; /** * Task identifier for migrate listener operation. */ migrateListenerTaskId: string; /** * Operation Identifier for update operation. */ updateOperationId: string; /** * Status of update operation. */ updateStatus: string; /** * Task identifier for update operation. */ updateTaskId: string; } interface GetPatchManagementDatabasesPatchDatabasesCollectionItemPatchComplianceDetail { /** * Patch compliance status. */ patchComplianceStatus: string; /** * Resource patch compliance version name. */ patchComplianceVersion: string; } interface GetPatchManagementDatabasesPatchDatabasesCollectionItemVulnerabilitiesSummary { critical: number; high: number; info: number; low: number; medium: number; total: number; } interface GetPatchManagementImagesPatchRecommendationSummary { imagePatchRecommendationsCount: number; totalImagesCount: number; upToDateImagesCount: number; } interface GetPatchManagementPatchOperationsSummary { failedPatchOpsCount: number; runningPatchOpsCount: number; scheduledPatchOpsCount: number; successfulPatchOpsCount: number; warningsPatchOpsCount: number; } interface GetPatchManagementResource { /** * The agent Id of the agent managing the resource. */ agentId: string; /** * The connector Id of the resource. */ connectorId: string; /** * The platform type of the resource. */ dbPlatformType: string; /** * The version of the resource. */ dbVersion: string; /** * The deployment type of the resource. */ deploymentType: string; /** * host info objects */ hostInfos: outputs.Dblm.GetPatchManagementResourceHostInfo[]; /** * True if it is a cluster db. */ isClusterDb: boolean; /** * The License Type of the resource. */ licenseType: string; /** * The compartmentId of the resource. */ resourceCompartmentId: string; /** * The Id of the resource. */ resourceId: string; /** * The name of the resource. */ resourceName: string; /** * The type of the resource. */ resourceType: string; } interface GetPatchManagementResourceHostInfo { /** * Number of host cores. */ hostCores: number; /** * The name of the host. */ hostName: string; } interface GetPatchManagementResourcesPatchComplianceSummary { nonCompliantResourcesCount: number; notDblmRegisteredResourcesCount: number; notSubscribedResourcesCount: number; totalResourcesCount: number; upToDateResourcesCount: number; } interface GetVulnerabilityAggregatedVulnerabilityDataAggregatedVulnerabilityCollection { /** * List of data */ items: outputs.Dblm.GetVulnerabilityAggregatedVulnerabilityDataAggregatedVulnerabilityCollectionItem[]; } interface GetVulnerabilityAggregatedVulnerabilityDataAggregatedVulnerabilityCollectionItem { /** * Registered databases against which the scan ran. */ registeredResourcesCount: number; /** * UTC timestamp when the scan completed. */ timestamp: string; /** * Unresolved vulnerabilities that were found by the scan. */ vulnerabilitiesCount: number; } interface GetVulnerabilityAggregatedVulnerabilityDataFilter { name: string; regex?: boolean; values: string[]; } interface GetVulnerabilityNotificationsFilter { name: string; regex?: boolean; values: string[]; } interface GetVulnerabilityNotificationsNotificationCollection { /** * Items for notifications. */ items: outputs.Dblm.GetVulnerabilityNotificationsNotificationCollectionItem[]; } interface GetVulnerabilityNotificationsNotificationCollectionItem { /** * Notification identifier. */ id: string; /** * Notification text */ notificationText: string; /** * Notification type */ notificationType: string; /** * Published date */ timePublished: string; } interface GetVulnerabilityPatchRecommendationsSummary { patchAvailable: number; total: number; upToDate: number; } interface GetVulnerabilityResource { /** * The agent Id of the agent managing the resource. */ agentId: string; /** * The connector Id of the resource. */ connectorId: string; /** * The platform type of the resource. */ dbPlatformType: string; /** * The version of the resource. */ dbVersion: string; /** * The deployment type of the resource. */ deploymentType: string; /** * host info objects */ hostInfos: outputs.Dblm.GetVulnerabilityResourceHostInfo[]; /** * True if it is a cluster db. */ isClusterDb: boolean; /** * The License Type of the resource. */ licenseType: string; /** * The compartmentId of the resource. */ resourceCompartmentId: string; /** * The Id of the resource. */ resourceId: string; /** * The name of the resource. */ resourceName: string; /** * The type of the resource. */ resourceType: string; } interface GetVulnerabilityResourceHostInfo { /** * Number of host cores. */ hostCores: number; /** * The name of the host. */ hostName: string; } interface GetVulnerabilityResourcesFilter { /** * The name of the resource. */ name: string; regex?: boolean; values: string[]; } interface GetVulnerabilityResourcesSummary { cleanResourcesCount?: number; errorResourcesCount?: number; notRegisteredResourcesCount: number; registeredResourcesCount: number; totalResourcesCount: number; vulnerableResourcesCount: number; } interface GetVulnerabilityResourcesVulnerabilityResourceCollection { /** * Collection of assessed resources */ items: outputs.Dblm.GetVulnerabilityResourcesVulnerabilityResourceCollectionItem[]; } interface GetVulnerabilityResourcesVulnerabilityResourceCollectionItem { /** * PDBs for a CDB. */ childPdbs: outputs.Dblm.GetVulnerabilityResourcesVulnerabilityResourceCollectionItemChildPdb[]; /** * The resource ID for this resource. */ id: string; /** * Identifier for the resource is subscribed to. */ imageId: string; /** * Metric errors. */ metricErrors: outputs.Dblm.GetVulnerabilityResourcesVulnerabilityResourceCollectionItemMetricError[]; /** * The name of the resource. */ name: string; /** * List of the patch recommendations for databases */ patchRecommendationsDetails: outputs.Dblm.GetVulnerabilityResourcesVulnerabilityResourceCollectionItemPatchRecommendationsDetail[]; /** * Summary of the patch recommendations for databases. */ patchRecommendationsSummaries: outputs.Dblm.GetVulnerabilityResourcesVulnerabilityResourceCollectionItemPatchRecommendationsSummary[]; /** * A string representing the platform of the resource. */ platform: string; /** * A string representing the release of the resource. */ release: string; /** * Image the resource is subscribed to. */ subscribedImage: string; /** * Time when the latest configuration collection happened. */ timeConfigCollected: string; /** * Time when the latest scan happened for the resource. */ timeScanEnded: string; /** * A string representing the version of the resource. */ version: string; /** * Summary of the resources that are registered and may or may not have vulnerabilities. */ vulnerabilitiesSummaries: outputs.Dblm.GetVulnerabilityResourcesVulnerabilityResourceCollectionItemVulnerabilitiesSummary[]; } interface GetVulnerabilityResourcesVulnerabilityResourceCollectionItemChildPdb { /** * Last changed by */ lastChangedBy: string; /** * The name of the resource. */ name: string; /** * Open mode */ openMode: string; /** * Identifier for the pluggable database. */ pdbId: string; /** * Recovery status */ recoveryStatus: string; /** * Restricted */ restricted: string; } interface GetVulnerabilityResourcesVulnerabilityResourceCollectionItemMetricError { /** * Content type */ contentType: string; /** * Data */ data: string; /** * Error type */ errorType: string; /** * Level */ level: string; /** * Subject */ subject: string; /** * Time the error record was generated */ timeGenerated: string; } interface GetVulnerabilityResourcesVulnerabilityResourceCollectionItemPatchRecommendationsDetail { /** * Description of the patch recommendation. */ abstractText: string; /** * Classification of the patch recommendation. */ classificationName: string; /** * If the patch has a fix for a CVE. */ hasFixForCve: boolean; /** * Name of the patch recommendation. */ patchName: string; /** * Evaluation date for the patch recommendation. */ timeEvaluated: string; /** * Release date for the patch. */ timeReleased: string; } interface GetVulnerabilityResourcesVulnerabilityResourceCollectionItemPatchRecommendationsSummary { patchAvailable: number; total: number; upToDate: number; } interface GetVulnerabilityResourcesVulnerabilityResourceCollectionItemVulnerabilitiesSummary { critical: number; high: number; info: number; low: number; medium: number; total: number; } interface GetVulnerabilityScansFilter { name: string; regex?: boolean; values: string[]; } interface GetVulnerabilityScansVulnerabilityScanCollection { items: outputs.Dblm.GetVulnerabilityScansVulnerabilityScanCollectionItem[]; } interface GetVulnerabilityScansVulnerabilityScanCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VulnerabilityScan. */ id: string; /** * The current state of the VulnerabilityScan. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the VulnerabilityScan was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the VulnerabilityScan was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeEnded: string; /** * The message of the vulnerability scan status. */ vulnerabilityScanMessage: string; /** * Filter by one or more vulnerability scan status. Possible values are completed, running, completed with error, aborted. */ vulnerabilityScanStatus: string; /** * The scan type to use is 'CVE', 'PATCH' or 'IMAGE_PATCH'. */ vulnerabilityScanType: string; } interface GetVulnerabilityVulnerabilitiesFilter { name: string; regex?: boolean; values: string[]; } interface GetVulnerabilityVulnerabilitiesSummary { critical: number; high: number; info: number; low: number; medium: number; total: number; } interface GetVulnerabilityVulnerabilitiesVulnerabilityCollection { /** * Collection of vulnerability summary items. */ items: outputs.Dblm.GetVulnerabilityVulnerabilitiesVulnerabilityCollectionItem[]; } interface GetVulnerabilityVulnerabilitiesVulnerabilityCollectionItem { /** * CVE vulnerability ID */ cveId: string; /** * Vulnerability description */ description: string; /** * Risk level enumeration */ riskLevel: string; /** * Vulnerability score */ score: string; /** * Number of vulnerable resources */ vulnerableResourcesCount: number; } } export declare namespace DelegateAccessControl { interface GetDelegatedResourceAccessRequestApprovalInfo { /** * Indicated whether the request is approved or rejected. */ approvalAction: string; /** * approval type, initial or extension */ approvalType: string; /** * Additional message specified by the approver of the request. */ approverAdditionalMessage: string; /** * Comment specified by the approver of the request. */ approverComment: string; /** * User ID of the approver. */ approverId: string; /** * Access start time that is actually approved by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeApprovedForAccess: string; /** * Time when the access request was approved or rejected by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeOfAction: string; } interface GetDelegatedResourceAccessRequestHistoriesDelegatedResourceAccessRequestHistoryCollection { /** * List of DelegatedResourceAccessRequestHistorySummary objects. */ items: outputs.DelegateAccessControl.GetDelegatedResourceAccessRequestHistoriesDelegatedResourceAccessRequestHistoryCollectionItem[]; } interface GetDelegatedResourceAccessRequestHistoriesDelegatedResourceAccessRequestHistoryCollectionItem { /** * Comment about the status change. */ comment: string; /** * The current status of the Delegated Resource Access Request. */ requestStatus: string; /** * The current lifecycle state of the Delegated Resource Access Request. */ state: string; /** * Time when the respective action happened in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timestamp: string; /** * ID of user who modified the Delegated Resource Access Request. For operator, this field is "Operator". */ userId: string; } interface GetDelegatedResourceAccessRequestHistoriesFilter { name: string; regex?: boolean; values: string[]; } interface GetDelegatedResourceAccessRequestsDelegatedResourceAccessRequestSummaryCollection { items: outputs.DelegateAccessControl.GetDelegatedResourceAccessRequestsDelegatedResourceAccessRequestSummaryCollectionItem[]; } interface GetDelegatedResourceAccessRequestsDelegatedResourceAccessRequestSummaryCollectionItem { /** * In case of single approval, this will have only one item. Else, a list of approvals. */ approvalInfos: outputs.DelegateAccessControl.GetDelegatedResourceAccessRequestsDelegatedResourceAccessRequestSummaryCollectionItemApprovalInfo[]; /** * Specifies the type of auditing to be enabled. There are two levels of auditing: command-level and keystroke-level. By default, both command-level and keystroke-level auditing are enabled, i.e. commands and key strokes issued by the support operator are logged. */ auditTypes: string[]; /** * The comment entered by the support operator while closing the request. */ closureComment: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * List of Database ID for which access is requested. This parameter is required when database access is needed. */ databaseIdLists: string[]; /** * List of Database unique names for which access is requested. This parameter is required when database access in needed. */ databaseNameLists: string[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * unique Delegation Control identifier */ delegationControlId: string; /** * List of Delegation Subscription OCID that are associated with this Delegated Resource Access Request based on the service types being requested. */ delegationSubscriptionIds: string[]; /** * Detailed description of this Delegated Resource Access Request. */ description: string; /** * Display name. This is generated by the system automatically. */ displayName: string; /** * Duration in hours for which access is sought on the target resource. */ durationInHours: number; /** * Duration in hours for which extension access is sought on the target resource. */ extendDurationInHours: number; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Delegated Resource Access Request. */ id: string; /** * Set to true if the request is approved automatically based on preApprovedServiceProviderActionNames or isAutoApproveDuringMaintenance in the associated Delegation Control. */ isAutoApproved: boolean; /** * Indicates if the delegated resource access request is waiting on more information from the operator */ isPendingMoreInfo: boolean; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * Number of extension approvals that have been obtained so far. */ numExtensionApprovals: number; /** * Number of initial approvals that have been obtained so far. */ numInitialApprovals: number; /** * List of Service Provider Service Types being provided by the support operator user. */ providedServiceTypes: string[]; /** * A short description explaining why this Delegated Resource Access Request is needed by the support operator. */ reasonForRequest: string; /** * A filter to return only Delegated Resource Access Requests whose status matches the given Delegated Resource Access Request status. */ requestStatus: string; /** * List of Service Provider Action names for which approval is sought by the support operator user. The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API. */ requestedActionNames: string[]; /** * Requester type */ requesterType: string; /** * A filter to return only Delegated Resource Access Requests for the given resource identifier. */ resourceId: string; /** * The name of the target resource associated with the Delegated Resource Access Request. The support operator raises a Delegated Resource Access Request to get approval to access the target resource. */ resourceName: string; /** * Resource type for which the associated Delegation Control is applicable to. */ resourceType: string; /** * Priority assigned to the Delegated Resource Access Request by the support operator */ severity: string; /** * A filter to return only Delegated Resource Access Requests whose lifecycleState matches the given Delegated Resource Access Request lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A list of ticket numbers related to this Delegated Resource Access Request, e.g. Service Request (SR) number and JIRA ticket number. */ ticketNumbers: string[]; /** * Requested access start time in UTC. */ timeAccessRequested: string; /** * Time when the Delegated Resource Access Request was created in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeCreated: string; /** * Time when the Delegated Resource Access Request was last modified in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeUpdated: string; } interface GetDelegatedResourceAccessRequestsDelegatedResourceAccessRequestSummaryCollectionItemApprovalInfo { /** * Indicated whether the request is approved or rejected. */ approvalAction: string; /** * approval type, initial or extension */ approvalType: string; /** * Additional message specified by the approver of the request. */ approverAdditionalMessage: string; /** * Comment specified by the approver of the request. */ approverComment: string; /** * User ID of the approver. */ approverId: string; /** * Access start time that is actually approved by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeApprovedForAccess: string; /** * Time when the access request was approved or rejected by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeOfAction: string; } interface GetDelegatedResourceAccessRequestsFilter { name: string; regex?: boolean; values: string[]; } interface GetDelegationControlResourcesDelegationControlResourceCollection { /** * List of DelegationControlResourceSummary objects. */ items: outputs.DelegateAccessControl.GetDelegationControlResourcesDelegationControlResourceCollectionItem[]; } interface GetDelegationControlResourcesDelegationControlResourceCollectionItem { /** * OCID of the resource. */ id: string; /** * The current status of the resource in Delegation Control. */ resourceStatus: string; } interface GetDelegationControlResourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetDelegationControlsDelegationControlSummaryCollection { items: outputs.DelegateAccessControl.GetDelegationControlsDelegationControlSummaryCollectionItem[]; } interface GetDelegationControlsDelegationControlSummaryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * List of Delegation Subscription OCID that are allowed for this Delegation Control. The allowed subscriptions will determine the available Service Provider Actions. Only support operators for the allowed subscriptions are allowed to create Delegated Resource Access Request. */ delegationSubscriptionIds: string[]; /** * Description of the Delegation Control. */ description: string; /** * A filter to return Delegation Control resources that match the given display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Delegation Control. */ id: string; /** * Set to true to allow all Delegated Resource Access Request to be approved automatically during maintenance. */ isAutoApproveDuringMaintenance: boolean; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * The format of the Oracle Cloud Infrastructure Notification messages for this Delegation Control. */ notificationMessageFormat: string; /** * The OCID of the Oracle Cloud Infrastructure Notification topic to publish messages related to this Delegation Control. */ notificationTopicId: string; /** * number of approvals required. */ numApprovalsRequired: number; /** * List of pre-approved Service Provider Action names. The list of pre-defined Service Provider Actions can be obtained from the ListServiceProviderActions API. Delegated Resource Access Requests associated with a resource governed by this Delegation Control will be automatically approved if the Delegated Resource Access Request only contain Service Provider Actions in the pre-approved list. */ preApprovedServiceProviderActionNames: string[]; /** * The OCID of the selected resources that this Delegation Control is applicable to. */ resourceIds: string[]; /** * A filter to return only resources that match the given resource type. */ resourceType: string; /** * A filter to return only Delegation Control resources whose lifecycleState matches the given Delegation Control lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Delegation Control was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Delegation Control was deleted expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format, e.g. '2020-05-22T21:10:29.600Z'. Note a deleted Delegation Control still stays in the system, so that you can still audit Service Provider Actions associated with Delegated Resource Access Requests raised on target resources governed by the deleted Delegation Control. */ timeDeleted: string; /** * Time when the Delegation Control was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; /** * The OCID of the Oracle Cloud Infrastructure Vault that will store the secrets containing the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. Delegate Access Control Service will generate the SSH keys and store them as secrets in the Oracle Cloud Infrastructure Vault. This property is optional when the Delegation Control is created for Oracle Managed Software Updates. Otherwise, it is required when resourceType is CLOUDVMCLUSTER or EXADBVMCLUSTER. */ vaultId: string; /** * The OCID of the Master Encryption Key in the Oracle Cloud Infrastructure Vault specified by vaultId. This key will be used to encrypt the SSH keys to access the resource governed by this Delegation Control by Delegate Access Control Service. This property is optional when the Delegation Control is created for Oracle Managed Software Updates. Otherwise, it is required when resourceType is CLOUDVMCLUSTER or EXADBVMCLUSTER. */ vaultKeyId: string; } interface GetDelegationControlsFilter { name: string; regex?: boolean; values: string[]; } interface GetDelegationSubscriptionsDelegationSubscriptionSummaryCollection { items: outputs.DelegateAccessControl.GetDelegationSubscriptionsDelegationSubscriptionSummaryCollectionItem[]; } interface GetDelegationSubscriptionsDelegationSubscriptionSummaryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of the Delegation Subscription. */ description: string; /** * A filter to return Delegation Subscription resources that match the given display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier for the Delegation Subscription. */ id: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * Unique identifier of the Service Provider. */ serviceProviderId: string; /** * A filter to return only Delegation Subscription resources whose lifecycleState matches the given Delegation Subscription lifecycle state. */ state: string; /** * Subscribed Service Provider Service Type. */ subscribedServiceType: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Service Provider was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Service Provider was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } interface GetDelegationSubscriptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetServiceProviderActionProperty { /** * Name of the property */ name: string; /** * value of the property */ value: string; } interface GetServiceProviderActionsFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetServiceProviderActionsServiceProviderActionSummaryCollection { items: outputs.DelegateAccessControl.GetServiceProviderActionsServiceProviderActionSummaryCollectionItem[]; } interface GetServiceProviderActionsServiceProviderActionSummaryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Name of the infrastructure layer associated with the Service Provider Action. */ component: string; /** * Display Name of the Service Provider Action. */ customerDisplayName: string; /** * Description of the Service Provider Action in terms of associated risk profile, and characteristics of the operating system commands made available to the support operator under this Service Provider Action. */ description: string; /** * Unique Oracle assigned identifier for the Service Provider Action. */ id: string; /** * Indicates whether the service provider action allows SSH access. */ isSshAccessAllowed: boolean; /** * A filter to return only resources that match the entire name given. */ name: string; /** * Fine grained properties associated with the Delegation Control. */ properties: outputs.DelegateAccessControl.GetServiceProviderActionsServiceProviderActionSummaryCollectionItemProperty[]; /** * A filter to return only resources that match the given resource type. */ resourceType: string; /** * List of Service Provider Service Types that this Service Provider Action is applicable to. */ serviceProviderServiceTypes: string[]; /** * A filter to return only resources whose lifecycleState matches the given Service Provider Action lifecycleState. */ state: string; } interface GetServiceProviderActionsServiceProviderActionSummaryCollectionItemProperty { /** * A filter to return only resources that match the entire name given. */ name: string; /** * value of the property */ value: string; } interface GetServiceProvidersFilter { /** * A filter to return Service Provider resources that match the given name. */ name: string; regex?: boolean; values: string[]; } interface GetServiceProvidersServiceProviderSummaryCollection { items: outputs.DelegateAccessControl.GetServiceProvidersServiceProviderSummaryCollectionItem[]; } interface GetServiceProvidersServiceProviderSummaryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of the Service Provider. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier for the Service Provider. */ id: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * A filter to return Service Provider resources that match the given name. */ name: string; /** * A filter to return only Service Provider resources whose provider type matches the given provider type. */ serviceProviderType: string; /** * Types of services offered by this provider. */ serviceTypes: string[]; /** * A filter to return only Service Provider resources whose lifecycleState matches the given Service Provider lifecycle state. */ state: string; /** * Resource types for which this provider will provide service. Default to all if not specified. */ supportedResourceTypes: string[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Service Provider was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Service Provider was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } } export declare namespace DemandSignal { interface GetOccDemandSignalOccDemandSignal { /** * The name of the resource for the data. */ resourceType: string; /** * The units of the data. */ units: string; /** * The values of forecast. */ values: outputs.DemandSignal.GetOccDemandSignalOccDemandSignalValue[]; } interface GetOccDemandSignalOccDemandSignalValue { /** * Space provided for users to make comments regarding the value. */ comments: string; /** * The date of the Demand Signal Value. */ timeExpected: string; /** * The Demand Signal Value. */ value: number; } interface GetOccDemandSignalPatchOperation { from: string; operation: string; position: string; selectedItem: string; selection: string; /** * The Demand Signal Value. */ value: { [key: string]: string; }; } interface GetOccDemandSignalsFilter { name: string; regex?: boolean; /** * The values of forecast. */ values: string[]; } interface GetOccDemandSignalsOccDemandSignalCollection { items: outputs.DemandSignal.GetOccDemandSignalsOccDemandSignalCollectionItem[]; } interface GetOccDemandSignalsOccDemandSignalCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OccDemandSignal. */ id: string; /** * Indicator of whether to share the data with Oracle. */ isActive: boolean; /** * A message that describes the current state of the OccDemandSignal in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; occDemandSignalId: string; /** * The OccDemandSignal data. */ occDemandSignals: outputs.DemandSignal.GetOccDemandSignalsOccDemandSignalCollectionItemOccDemandSignal[]; patchOperations: outputs.DemandSignal.GetOccDemandSignalsOccDemandSignalCollectionItemPatchOperation[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the OccDemandSignal was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the OccDemandSignal was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetOccDemandSignalsOccDemandSignalCollectionItemOccDemandSignal { /** * The name of the resource for the data. */ resourceType: string; /** * The units of the data. */ units: string; /** * The values of forecast. */ values: outputs.DemandSignal.GetOccDemandSignalsOccDemandSignalCollectionItemOccDemandSignalValue[]; } interface GetOccDemandSignalsOccDemandSignalCollectionItemOccDemandSignalValue { /** * Space provided for users to make comments regarding the value. */ comments: string; /** * The date of the Demand Signal Value. */ timeExpected: string; /** * The Demand Signal Value. */ value: number; } interface GetOccDemandSignalsOccDemandSignalCollectionItemPatchOperation { from: string; operation: string; position: string; selectedItem: string; selection: string; /** * The Demand Signal Value. */ value: { [key: string]: string; }; } interface GetOccMetricAlarmResourceConfiguration { /** * The hardware generation of the compute resource. */ computeHwGeneration: string; /** * The hardware generation of the Exadata system. */ hwGeneration: string; /** * The role of the link in the network. */ linkRole: string; /** * The type of node in the Exadata system. */ nodeType: string; /** * The provider of the network service. */ occMetricAlarmProvider: string; /** * Resources like COMPUTE, STORAGE, EXADATA etc. */ resource: string; /** * The shape of the compute instance. */ shape: string; /** * The type of storage resource. */ storageType: string; /** * The type of usage for the resource. */ usageType: string; } interface GetOccMetricAlarmsFilter { name: string; regex?: boolean; values: string[]; } interface GetOccMetricAlarmsOccMetricAlarmCollection { items: outputs.DemandSignal.GetOccMetricAlarmsOccMetricAlarmCollectionItem[]; } interface GetOccMetricAlarmsOccMetricAlarmCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Optional description for the alarm. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Frequency at which notifications should be sent. */ frequency: string; /** * Unique OCID for this alarm configuration. */ id: string; /** * Filter to list only active or inactive alarms. */ isActive: boolean; /** * Configuration for a given 'resource' */ resourceConfigurations: outputs.DemandSignal.GetOccMetricAlarmsOccMetricAlarmCollectionItemResourceConfiguration[]; /** * The current lifecycle state of the resource. */ state: string; /** * List of topic OCIDs for notifications. */ subscribers: string[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Threshold at which alarm must be triggered. */ threshold: number; /** * Units in which threshold is being stored. */ thresholdType: string; /** * Creation timestamp (RFC 3339). */ timeCreated: string; /** * Last update timestamp (RFC 3339). */ timeUpdated: string; } interface GetOccMetricAlarmsOccMetricAlarmCollectionItemResourceConfiguration { /** * The hardware generation of the compute resource. */ computeHwGeneration: string; /** * The hardware generation of the Exadata system. */ hwGeneration: string; /** * The role of the link in the network. */ linkRole: string; /** * The type of node in the Exadata system. */ nodeType: string; /** * The provider of the network service. */ occMetricAlarmProvider: string; /** * Resources like COMPUTE, STORAGE, EXADATA etc. */ resource: string; /** * The shape of the compute instance. */ shape: string; /** * The type of storage resource. */ storageType: string; /** * The type of usage for the resource. */ usageType: string; } interface OccDemandSignalOccDemandSignal { /** * The name of the resource for the data. */ resourceType: string; /** * The units of the data. */ units: string; /** * The values of forecast. */ values: outputs.DemandSignal.OccDemandSignalOccDemandSignalValue[]; } interface OccDemandSignalOccDemandSignalValue { /** * Space provided for users to make comments regarding the value. */ comments: string; /** * The date of the Demand Signal Value. */ timeExpected: string; /** * The Demand Signal Value. */ value: number; } interface OccDemandSignalPatchOperation { /** * (Updatable) */ from: string; /** * (Updatable) The operation can be one of these values: `INSERT`, `INSERT_MULTIPLE`, `MERGE`, `MOVE`, `PROHIBIT`, `REMOVE`, `REPLACE`, `REQUIRE` */ operation: string; /** * (Updatable) */ position?: string; /** * (Updatable) */ selectedItem?: string; /** * (Updatable) */ selection: string; /** * (Updatable) */ value: { [key: string]: string; }; } interface OccMetricAlarmResourceConfiguration { /** * The hardware generation of the compute resource. */ computeHwGeneration: string; /** * The hardware generation of the Exadata system. */ hwGeneration: string; /** * The role of the link in the network. */ linkRole: string; /** * The type of node in the Exadata system. */ nodeType: string; /** * The provider of the network service. */ occMetricAlarmProvider: string; /** * Resources like COMPUTE, STORAGE, EXADATA etc. */ resource: string; /** * The shape of the compute instance. */ shape: string; /** * The type of storage resource. */ storageType: string; /** * The type of usage for the resource. */ usageType: string; } } export declare namespace Desktops { interface DesktopPoolAvailabilityPolicy { /** * (Updatable) Provides the schedule information for a desktop. */ startSchedule?: outputs.Desktops.DesktopPoolAvailabilityPolicyStartSchedule; /** * (Updatable) Provides the schedule information for a desktop. */ stopSchedule?: outputs.Desktops.DesktopPoolAvailabilityPolicyStopSchedule; } interface DesktopPoolAvailabilityPolicyStartSchedule { /** * (Updatable) A cron expression describing the desktop's schedule. */ cronExpression: string; /** * (Updatable) The timezone of the desktop's schedule. */ timezone: string; } interface DesktopPoolAvailabilityPolicyStopSchedule { /** * (Updatable) A cron expression describing the desktop's schedule. */ cronExpression: string; /** * (Updatable) The timezone of the desktop's schedule. */ timezone: string; } interface DesktopPoolDevicePolicy { /** * (Updatable) The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop. */ audioMode: string; /** * (Updatable) The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop. */ cdmMode: string; /** * (Updatable) The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop. */ clipboardMode: string; /** * (Updatable) Indicates whether the display is enabled. */ isDisplayEnabled: boolean; /** * (Updatable) Indicates whether the keyboard is enabled. */ isKeyboardEnabled: boolean; /** * (Updatable) Indicates whether the pointer is enabled. */ isPointerEnabled: boolean; /** * (Updatable) Indicates whether printing is enabled. */ isPrintingEnabled: boolean; /** * (Updatable) Indicates whether video input is enabled. */ isVideoInputEnabled: boolean; } interface DesktopPoolImage { /** * (Updatable) The OCID of the desktop image. */ imageId: string; /** * The name of the desktop image. */ imageName: string; /** * The operating system of the desktop image, e.g. "Oracle Linux", "Windows". */ operatingSystem: string; } interface DesktopPoolNetworkConfiguration { /** * (Updatable) [Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) for this resource. Each attribute 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-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer VCN. */ vcnId: string; } interface DesktopPoolPrivateAccessDetails { /** * The three-label FQDN to use for the private endpoint. The customer VCN's DNS records are updated with this FQDN. This enables the customer to use the FQDN instead of the private endpoint's private IP address to access the service (for example, xyz.oraclecloud.com). */ endpointFqdn: string; /** * A list of network security groups for the private access. */ nsgIds?: string[]; /** * The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet. */ privateIp?: string; /** * (Updatable) [Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) for this resource. Each attribute 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-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer VCN. */ vcnId: string; } interface DesktopPoolSessionLifecycleActions { /** * (Updatable) Action and grace period for disconnect */ disconnect: outputs.Desktops.DesktopPoolSessionLifecycleActionsDisconnect; /** * (Updatable) Action and grace period for inactivity */ inactivity: outputs.Desktops.DesktopPoolSessionLifecycleActionsInactivity; } interface DesktopPoolSessionLifecycleActionsDisconnect { /** * (Updatable) a disconnect action to be triggered */ action: string; /** * (Updatable) The period of time (in minutes) after disconnect before any action occurs. If the value is not provided, a default value is used. */ gracePeriodInMinutes: number; } interface DesktopPoolSessionLifecycleActionsInactivity { /** * (Updatable) an inactivity action to be triggered */ action: string; /** * (Updatable) The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used. */ gracePeriodInMinutes: number; } interface DesktopPoolShapeConfig { /** * The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`. The following values are supported: * * `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. * * `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. * * `BASELINE_1_1` - baseline usage is the entire OCPU. This represents a non-burstable instance. */ baselineOcpuUtilization: string; /** * The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool. */ memoryInGbs: string; /** * The total number of OCPUs available for each desktop compute instance in the desktop pool. */ ocpus: string; } interface GetDesktopDesktopConnection { /** * The platform on which the Secure Desktops client runs. */ clientPlatform: string; /** * The type of Secure Desktops client connected to a desktop. */ clientType: string; /** * The version of the Secure Desktops client connected to a desktop, applicable only to the installed client type. */ clientVersion: string; /** * Provides information about actions performed on a desktop, including type and time. */ lastActions: outputs.Desktops.GetDesktopDesktopConnectionLastAction[]; /** * Provides information about actions performed on a desktop, including type and time. */ nextActions: outputs.Desktops.GetDesktopDesktopConnectionNextAction[]; /** * The time when the last connection to a desktop started. */ timeConnected: string; /** * The time when the last connection to a desktop ended. */ timeDisconnected: string; } interface GetDesktopDesktopConnectionLastAction { /** * An action performed on a desktop. */ action: string; /** * The time of an action performed on a desktop. */ timeApplied: string; } interface GetDesktopDesktopConnectionNextAction { /** * An action performed on a desktop. */ action: string; /** * The time of an action performed on a desktop. */ timeApplied: string; } interface GetDesktopDevicePolicy { /** * The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop. */ audioMode: string; /** * The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop. */ cdmMode: string; /** * The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop. */ clipboardMode: string; /** * Indicates whether the display is enabled. */ isDisplayEnabled: boolean; /** * Indicates whether the keyboard is enabled. */ isKeyboardEnabled: boolean; /** * Indicates whether the pointer is enabled. */ isPointerEnabled: boolean; /** * Indicates whether printing is enabled. */ isPrintingEnabled: boolean; /** * Indicates whether video input is enabled. */ isVideoInputEnabled: boolean; } interface GetDesktopHostingOption { /** * The connection address of the desktop. */ connectAddress: string; /** * Provides information about the desktop image. */ images: outputs.Desktops.GetDesktopHostingOptionImage[]; } interface GetDesktopHostingOptionImage { /** * The OCID of the desktop image. */ imageId: string; /** * The name of the desktop image. */ imageName: string; /** * The operating system of the desktop image, e.g. "Oracle Linux", "Windows". */ operatingSystem: string; } interface GetDesktopPoolAvailabilityPolicy { /** * Provides the schedule information for a desktop. */ startSchedules: outputs.Desktops.GetDesktopPoolAvailabilityPolicyStartSchedule[]; /** * Provides the schedule information for a desktop. */ stopSchedules: outputs.Desktops.GetDesktopPoolAvailabilityPolicyStopSchedule[]; } interface GetDesktopPoolAvailabilityPolicyStartSchedule { /** * A cron expression describing the desktop's schedule. */ cronExpression: string; /** * The timezone of the desktop's schedule. */ timezone: string; } interface GetDesktopPoolAvailabilityPolicyStopSchedule { /** * A cron expression describing the desktop's schedule. */ cronExpression: string; /** * The timezone of the desktop's schedule. */ timezone: string; } interface GetDesktopPoolDesktopsDesktopPoolDesktopCollection { /** * A list of desktops. */ items: outputs.Desktops.GetDesktopPoolDesktopsDesktopPoolDesktopCollectionItem[]; } interface GetDesktopPoolDesktopsDesktopPoolDesktopCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Provides information about a connection to a desktop, including connect and disconnect time, and client properties. */ desktopConnections: outputs.Desktops.GetDesktopPoolDesktopsDesktopPoolDesktopCollectionItemDesktopConnection[]; /** * The OCID of the desktop. */ desktopId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Provides information about the desktop image. */ images: outputs.Desktops.GetDesktopPoolDesktopsDesktopPoolDesktopCollectionItemImage[]; /** * The OCID of the compute resource used by this desktop. */ instanceId: string; /** * Indicates whether the desktop is assigned to a user. */ isAssigned: boolean; /** * A filter to return only results with the given lifecycleState. */ state: string; /** * The date and time the resource was created. */ timeCreated: string; /** * The owner of the desktop. */ userName: string; } interface GetDesktopPoolDesktopsDesktopPoolDesktopCollectionItemDesktopConnection { /** * The platform on which the Secure Desktops client runs. */ clientPlatform: string; /** * The type of Secure Desktops client connected to a desktop. */ clientType: string; /** * The version of the Secure Desktops client connected to a desktop, applicable only to the installed client type. */ clientVersion: string; /** * Provides information about actions performed on a desktop, including type and time. */ lastActions: outputs.Desktops.GetDesktopPoolDesktopsDesktopPoolDesktopCollectionItemDesktopConnectionLastAction[]; /** * Provides information about actions performed on a desktop, including type and time. */ nextActions: outputs.Desktops.GetDesktopPoolDesktopsDesktopPoolDesktopCollectionItemDesktopConnectionNextAction[]; /** * The time when the last connection to a desktop started. */ timeConnected: string; /** * The time when the last connection to a desktop ended. */ timeDisconnected: string; } interface GetDesktopPoolDesktopsDesktopPoolDesktopCollectionItemDesktopConnectionLastAction { /** * An action performed on a desktop. */ action: string; /** * The time of an action performed on a desktop. */ timeApplied: string; } interface GetDesktopPoolDesktopsDesktopPoolDesktopCollectionItemDesktopConnectionNextAction { /** * An action performed on a desktop. */ action: string; /** * The time of an action performed on a desktop. */ timeApplied: string; } interface GetDesktopPoolDesktopsDesktopPoolDesktopCollectionItemImage { /** * The OCID of the desktop image. */ imageId: string; /** * The name of the desktop image. */ imageName: string; /** * The operating system of the desktop image, e.g. "Oracle Linux", "Windows". */ operatingSystem: string; } interface GetDesktopPoolDesktopsFilter { name: string; regex?: boolean; values: string[]; } interface GetDesktopPoolDevicePolicy { /** * The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop. */ audioMode: string; /** * The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop. */ cdmMode: string; /** * The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop. */ clipboardMode: string; /** * Indicates whether the display is enabled. */ isDisplayEnabled: boolean; /** * Indicates whether the keyboard is enabled. */ isKeyboardEnabled: boolean; /** * Indicates whether the pointer is enabled. */ isPointerEnabled: boolean; /** * Indicates whether printing is enabled. */ isPrintingEnabled: boolean; /** * Indicates whether video input is enabled. */ isVideoInputEnabled: boolean; } interface GetDesktopPoolImage { /** * The OCID of the desktop image. */ imageId: string; /** * The name of the desktop image. */ imageName: string; /** * The operating system of the desktop image, e.g. "Oracle Linux", "Windows". */ operatingSystem: string; } interface GetDesktopPoolNetworkConfiguration { /** * [Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) for this resource. Each attribute 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-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer VCN. */ vcnId: string; } interface GetDesktopPoolPrivateAccessDetail { /** * The three-label FQDN to use for the private endpoint. The customer VCN's DNS records are updated with this FQDN. This enables the customer to use the FQDN instead of the private endpoint's private IP address to access the service (for example, xyz.oraclecloud.com). */ endpointFqdn: string; /** * A list of network security groups for the private access. */ nsgIds: string[]; /** * The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet. */ privateIp: string; /** * [Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) for this resource. Each attribute 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-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer VCN. */ vcnId: string; } interface GetDesktopPoolSessionLifecycleAction { /** * Action and grace period for disconnect */ disconnects: outputs.Desktops.GetDesktopPoolSessionLifecycleActionDisconnect[]; /** * Action and grace period for inactivity */ inactivities: outputs.Desktops.GetDesktopPoolSessionLifecycleActionInactivity[]; } interface GetDesktopPoolSessionLifecycleActionDisconnect { /** * an inactivity action to be triggered */ action: string; /** * The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used. */ gracePeriodInMinutes: number; } interface GetDesktopPoolSessionLifecycleActionInactivity { /** * an inactivity action to be triggered */ action: string; /** * The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used. */ gracePeriodInMinutes: number; } interface GetDesktopPoolShapeConfig { /** * The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`. The following values are supported: * * `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. * * `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. * * `BASELINE_1_1` - baseline usage is the entire OCPU. This represents a non-burstable instance. */ baselineOcpuUtilization: string; /** * The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool. */ memoryInGbs: string; /** * The total number of OCPUs available for each desktop compute instance in the desktop pool. */ ocpus: string; } interface GetDesktopPoolVolumesDesktopPoolVolumeCollection { /** * A list of desktop pool volumes. */ items: outputs.Desktops.GetDesktopPoolVolumesDesktopPoolVolumeCollectionItem[]; } interface GetDesktopPoolVolumesDesktopPoolVolumeCollectionItem { /** * The name of the availability domain. */ availabilityDomain: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only results with the given OCID. */ id: string; /** * The name of the desktop pool volume. */ name: string; /** * The OCID of the desktop pool to which this volume belongs. */ poolId: string; /** * A filter to return only results with the given lifecycleState. */ state: string; /** * The owner of the desktop pool volume. */ userName: string; } interface GetDesktopPoolVolumesFilter { /** * The name of the desktop pool volume. */ name: string; regex?: boolean; values: string[]; } interface GetDesktopPoolsDesktopPoolCollection { items: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItem[]; } interface GetDesktopPoolsDesktopPoolCollectionItem { /** * The number of active desktops in the desktop pool. */ activeDesktops: number; /** * Indicates whether desktop pool users have administrative privileges on their desktop. */ arePrivilegedUsers: boolean; areVolumesPreserved: boolean; /** * The name of the availability domain. */ availabilityDomain: string; /** * Provides the start and stop schedule information for desktop availability of the desktop pool. */ availabilityPolicies: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicy[]; /** * The size in GBs of the boot volume for the desktop pool. */ bootVolumeSizeInGbs: number; /** * The OCID of the compartment of the desktop pool. */ compartmentId: string; /** * Contact information of the desktop pool administrator. Avoid entering confidential information. */ contactDetails: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user friendly description providing additional information about the resource. Avoid entering confidential information. */ description: string; /** * Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access. */ devicePolicies: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemDevicePolicy[]; /** * A filter to return only results with the given displayName. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only results with the given OCID. */ id: string; /** * Provides information about the desktop image. */ images: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemImage[]; /** * Indicates whether storage is enabled for the desktop pool. */ isStorageEnabled: boolean; /** * The maximum number of desktops permitted in the desktop pool. */ maximumSize: number; /** * Provides information about the network configuration of the desktop pool. */ networkConfigurations: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemNetworkConfiguration[]; /** * A list of network security groups for the private access. */ nsgIds: string[]; /** * The details of the desktop's private access network connectivity that were used to create the pool. */ privateAccessDetails: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemPrivateAccessDetail[]; /** * [Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) for this resource. Each attribute 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-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * Action to be triggered on inactivity or disconnect */ sessionLifecycleActions: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemSessionLifecycleAction[]; /** * The shape configuration used for each desktop compute instance in the desktop pool. */ shapeConfigs: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemShapeConfig[]; /** * The shape of the desktop pool. */ shapeName: string; /** * The maximum number of standby desktops available in the desktop pool. */ standbySize: number; /** * A filter to return only results with the given lifecycleState. */ state: string; /** * The backup policy OCID of the storage. */ storageBackupPolicyId: string; /** * The size in GBs of the storage for the desktop pool. */ storageSizeInGbs: number; /** * The date and time the resource was created. */ timeCreated: string; /** * The start time of the desktop pool. */ timeStartScheduled: string; /** * The stop time of the desktop pool. */ timeStopScheduled: string; /** * Indicates whether the desktop pool uses dedicated virtual machine hosts. */ useDedicatedVmHost: string; } interface GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicy { /** * Provides the schedule information for a desktop. */ startSchedules: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicyStartSchedule[]; /** * Provides the schedule information for a desktop. */ stopSchedules: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicyStopSchedule[]; } interface GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicyStartSchedule { /** * A cron expression describing the desktop's schedule. */ cronExpression: string; /** * The timezone of the desktop's schedule. */ timezone: string; } interface GetDesktopPoolsDesktopPoolCollectionItemAvailabilityPolicyStopSchedule { /** * A cron expression describing the desktop's schedule. */ cronExpression: string; /** * The timezone of the desktop's schedule. */ timezone: string; } interface GetDesktopPoolsDesktopPoolCollectionItemDevicePolicy { /** * The audio mode. NONE: No access to the local audio devices is permitted. TODESKTOP: The user may record audio on their desktop. FROMDESKTOP: The user may play audio on their desktop. FULL: The user may play and record audio on their desktop. */ audioMode: string; /** * The client local drive access mode. NONE: No access to local drives permitted. READONLY: The user may read from local drives on their desktop. FULL: The user may read from and write to their local drives on their desktop. */ cdmMode: string; /** * The clipboard mode. NONE: No access to the local clipboard is permitted. TODESKTOP: The clipboard can be used to transfer data to the desktop only. FROMDESKTOP: The clipboard can be used to transfer data from the desktop only. FULL: The clipboard can be used to transfer data to and from the desktop. */ clipboardMode: string; /** * Indicates whether the display is enabled. */ isDisplayEnabled: boolean; /** * Indicates whether the keyboard is enabled. */ isKeyboardEnabled: boolean; /** * Indicates whether the pointer is enabled. */ isPointerEnabled: boolean; /** * Indicates whether printing is enabled. */ isPrintingEnabled: boolean; /** * Indicates whether video input is enabled. */ isVideoInputEnabled: boolean; } interface GetDesktopPoolsDesktopPoolCollectionItemImage { /** * The OCID of the desktop image. */ imageId: string; /** * The name of the desktop image. */ imageName: string; /** * The operating system of the desktop image, e.g. "Oracle Linux", "Windows". */ operatingSystem: string; } interface GetDesktopPoolsDesktopPoolCollectionItemNetworkConfiguration { /** * [Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) for this resource. Each attribute 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-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer VCN. */ vcnId: string; } interface GetDesktopPoolsDesktopPoolCollectionItemPrivateAccessDetail { /** * The three-label FQDN to use for the private endpoint. The customer VCN's DNS records are updated with this FQDN. This enables the customer to use the FQDN instead of the private endpoint's private IP address to access the service (for example, xyz.oraclecloud.com). */ endpointFqdn: string; /** * A list of network security groups for the private access. */ nsgIds: string[]; /** * The IPv4 address from the provided Oracle Cloud Infrastructure subnet which needs to be assigned to the VNIC. If not provided, it will be auto-assigned with an available IPv4 address from the subnet. */ privateIp: string; /** * [Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) for this resource. Each attribute 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-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer VCN. */ vcnId: string; } interface GetDesktopPoolsDesktopPoolCollectionItemSessionLifecycleAction { /** * Action and grace period for disconnect */ disconnects: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemSessionLifecycleActionDisconnect[]; /** * Action and grace period for inactivity */ inactivities: outputs.Desktops.GetDesktopPoolsDesktopPoolCollectionItemSessionLifecycleActionInactivity[]; } interface GetDesktopPoolsDesktopPoolCollectionItemSessionLifecycleActionDisconnect { /** * an inactivity action to be triggered */ action: string; /** * The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used. */ gracePeriodInMinutes: number; } interface GetDesktopPoolsDesktopPoolCollectionItemSessionLifecycleActionInactivity { /** * an inactivity action to be triggered */ action: string; /** * The period of time (in minutes) during which the session must remain inactive before any action occurs. If the value is not provided, a default value is used. */ gracePeriodInMinutes: number; } interface GetDesktopPoolsDesktopPoolCollectionItemShapeConfig { /** * The baseline OCPU utilization for a subcore burstable VM instance used for each desktop compute instance in the desktop pool. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`. The following values are supported: * * `BASELINE_1_8` - baseline usage is 1/8 of an OCPU. * * `BASELINE_1_2` - baseline usage is 1/2 of an OCPU. * * `BASELINE_1_1` - baseline usage is the entire OCPU. This represents a non-burstable instance. */ baselineOcpuUtilization: string; /** * The total amount of memory available in gigabytes for each desktop compute instance in the desktop pool. */ memoryInGbs: string; /** * The total number of OCPUs available for each desktop compute instance in the desktop pool. */ ocpus: string; } interface GetDesktopPoolsFilter { name: string; regex?: boolean; values: string[]; } interface GetDesktopsDesktopCollection { items: outputs.Desktops.GetDesktopsDesktopCollectionItem[]; } interface GetDesktopsDesktopCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Provides information about a connection to a desktop, including connect and disconnect time, and client properties. */ desktopConnections: outputs.Desktops.GetDesktopsDesktopCollectionItemDesktopConnection[]; /** * A filter to return only results with the given displayName. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only results with the given OCID. */ id: string; images: outputs.Desktops.GetDesktopsDesktopCollectionItemImage[]; /** * The OCID of the desktop pool the desktop is a member of. */ poolId: string; /** * A filter to return only results with the given lifecycleState. */ state: string; /** * The date and time the resource was created. */ timeCreated: string; /** * The owner of the desktop. */ userName: string; } interface GetDesktopsDesktopCollectionItemDesktopConnection { /** * The platform on which the Secure Desktops client runs. */ clientPlatform: string; /** * The type of Secure Desktops client connected to a desktop. */ clientType: string; /** * The version of the Secure Desktops client connected to a desktop, applicable only to the installed client type. */ clientVersion: string; /** * Provides information about actions performed on a desktop, including type and time. */ lastActions: outputs.Desktops.GetDesktopsDesktopCollectionItemDesktopConnectionLastAction[]; /** * Provides information about actions performed on a desktop, including type and time. */ nextActions: outputs.Desktops.GetDesktopsDesktopCollectionItemDesktopConnectionNextAction[]; /** * The time when the last connection to a desktop started. */ timeConnected: string; /** * The time when the last connection to a desktop ended. */ timeDisconnected: string; } interface GetDesktopsDesktopCollectionItemDesktopConnectionLastAction { /** * An action performed on a desktop. */ action: string; /** * The time of an action performed on a desktop. */ timeApplied: string; } interface GetDesktopsDesktopCollectionItemDesktopConnectionNextAction { /** * An action performed on a desktop. */ action: string; /** * The time of an action performed on a desktop. */ timeApplied: string; } interface GetDesktopsDesktopCollectionItemImage { imageId: string; imageName: string; operatingSystem: string; } interface GetDesktopsFilter { name: string; regex?: boolean; values: string[]; } } export declare namespace DevOps { interface BuildPipelineBuildPipelineParameters { /** * (Updatable) List of parameters defined for a build pipeline. */ items: outputs.DevOps.BuildPipelineBuildPipelineParametersItem[]; } interface BuildPipelineBuildPipelineParametersItem { /** * (Updatable) Default value of the parameter. */ defaultValue: string; /** * (Updatable) Description of the parameter. */ description: string; /** * (Updatable) Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param' */ name: string; } interface BuildPipelineStageBuildPipelineStagePredecessorCollection { /** * (Updatable) A list of build pipeline stage predecessors for a stage. */ items: outputs.DevOps.BuildPipelineStageBuildPipelineStagePredecessorCollectionItem[]; } interface BuildPipelineStageBuildPipelineStagePredecessorCollectionItem { /** * (Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID. */ id: string; } interface BuildPipelineStageBuildRunnerShapeConfig { /** * (Updatable) Name of the build runner shape in which the execution occurs. If not specified, the default shape is chosen. */ buildRunnerType: string; /** * (Updatable) The total amount of memory set for the instance in gigabytes. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs set for the instance. */ ocpus: number; } interface BuildPipelineStageBuildSourceCollection { /** * (Updatable) Collection of build sources. In case of UPDATE operation, replaces existing build sources list. Merging with existing build sources is not supported. */ items: outputs.DevOps.BuildPipelineStageBuildSourceCollectionItem[]; } interface BuildPipelineStageBuildSourceCollectionItem { /** * (Updatable) Branch name. */ branch: string; /** * (Updatable) Connection identifier pertinent to Bitbucket Server source provider */ connectionId: string; /** * (Updatable) The type of source provider. */ connectionType: string; /** * (Updatable) Name of the build source. This must be unique within a build source collection. The name can be used by customers to locate the working directory pertinent to this repository. */ name: string; /** * (Updatable) The DevOps code repository ID. */ repositoryId: string; /** * (Updatable) URL for the repository. */ repositoryUrl: string; } interface BuildPipelineStageDeliverArtifactCollection { /** * (Updatable) Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. */ items: outputs.DevOps.BuildPipelineStageDeliverArtifactCollectionItem[]; } interface BuildPipelineStageDeliverArtifactCollectionItem { /** * (Updatable) Artifact identifier that contains the artifact definition. */ artifactId: string; /** * (Updatable) Name of the artifact specified in the build_spec.yaml file. */ artifactName: string; } interface BuildPipelineStagePrivateAccessConfig { /** * (Updatable) Network channel type. */ networkChannelType: string; /** * (Updatable) An array of network security group OCIDs. */ nsgIds: string[]; /** * (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint. */ subnetId: string; } interface BuildPipelineStageWaitCriteria { /** * (Updatable) The absolute wait duration. Minimum wait duration must be 5 seconds. Maximum wait duration can be up to 2 days. */ waitDuration: string; /** * (Updatable) Wait criteria type. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ waitType: string; } interface BuildRunBuildOutput { /** * Specifies the list of artifact override arguments at the time of deployment. */ artifactOverrideParameters: outputs.DevOps.BuildRunBuildOutputArtifactOverrideParameter[]; /** * Specifies the list of artifacts delivered through the Deliver Artifacts stage. */ deliveredArtifacts: outputs.DevOps.BuildRunBuildOutputDeliveredArtifact[]; /** * Specifies list of exported variables. */ exportedVariables: outputs.DevOps.BuildRunBuildOutputExportedVariable[]; /** * List of vulnerability audit summary. */ vulnerabilityAuditSummaryCollections: outputs.DevOps.BuildRunBuildOutputVulnerabilityAuditSummaryCollection[]; } interface BuildRunBuildOutputArtifactOverrideParameter { /** * List of exported variables. */ items: outputs.DevOps.BuildRunBuildOutputArtifactOverrideParameterItem[]; } interface BuildRunBuildOutputArtifactOverrideParameterItem { /** * The OCID of the deployment artifact definition. */ deployArtifactId: string; /** * Name of the step. */ name: string; /** * Value of the argument. */ value: string; } interface BuildRunBuildOutputDeliveredArtifact { /** * List of exported variables. */ items: outputs.DevOps.BuildRunBuildOutputDeliveredArtifactItem[]; } interface BuildRunBuildOutputDeliveredArtifactItem { /** * The OCID of the artifact registry repository used by the DeliverArtifactStage */ artifactRepositoryId: string; /** * Type of artifact delivered. */ artifactType: string; /** * The hash of the container registry artifact pushed by the Deliver Artifacts stage. */ deliveredArtifactHash: string; /** * The OCID of the artifact pushed by the Deliver Artifacts stage. */ deliveredArtifactId: string; /** * The OCID of the deployment artifact definition. */ deployArtifactId: string; /** * The imageUri of the OCIR artifact pushed by the DeliverArtifactStage */ imageUri: string; /** * Name of the output artifact defined in the build specification file. */ outputArtifactName: string; /** * Path of the repository where artifact was pushed */ path: string; /** * Version of the artifact pushed */ version: string; } interface BuildRunBuildOutputExportedVariable { /** * List of exported variables. */ items: outputs.DevOps.BuildRunBuildOutputExportedVariableItem[]; } interface BuildRunBuildOutputExportedVariableItem { /** * Name of the step. */ name: string; /** * Value of the argument. */ value: string; } interface BuildRunBuildOutputVulnerabilityAuditSummaryCollection { /** * List of exported variables. */ items: outputs.DevOps.BuildRunBuildOutputVulnerabilityAuditSummaryCollectionItem[]; } interface BuildRunBuildOutputVulnerabilityAuditSummaryCollectionItem { /** * Build stage OCID where scan was configured. */ buildStageId: string; /** * Commit hash pertinent to the repository URL and the specified branch. */ commitHash: string; /** * The OCID of the vulnerability audit. */ vulnerabilityAuditId: string; } interface BuildRunBuildRunArguments { /** * List of arguments provided at the time of running the build. */ items: outputs.DevOps.BuildRunBuildRunArgumentsItem[]; } interface BuildRunBuildRunArgumentsItem { /** * Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param' */ name: string; /** * Value of the argument. */ value: string; } interface BuildRunBuildRunProgress { /** * Map of stage OCIDs to build pipeline stage run progress model. */ buildPipelineStageRunProgress: { [key: string]: string; }; /** * The time the build run finished. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeFinished: string; /** * The time the build run started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeStarted: string; } interface BuildRunBuildRunSource { /** * The DevOps code repository identifier that invoked the build run. */ repositoryId: string; /** * The source from which the build run is triggered. */ sourceType: string; /** * The trigger that invoked the build run. */ triggerId: string; /** * Trigger details that need to be used for the BuildRun */ triggerInfos: outputs.DevOps.BuildRunBuildRunSourceTriggerInfo[]; } interface BuildRunBuildRunSourceTriggerInfo { /** * The list of actions that are to be performed for this Trigger */ actions: outputs.DevOps.BuildRunBuildRunSourceTriggerInfoAction[]; /** * (Updatable) Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. */ displayName: string; } interface BuildRunBuildRunSourceTriggerInfoAction { /** * The OCID of the build pipeline. */ buildPipelineId: string; filters: outputs.DevOps.BuildRunBuildRunSourceTriggerInfoActionFilter[]; /** * The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE. */ type: string; } interface BuildRunBuildRunSourceTriggerInfoActionFilter { /** * The events, for example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED. */ events: string[]; /** * Attributes to filter GitLab self-hosted server events. File filter criteria - Changes only affecting excluded files will not invoke a build. if both include and exclude filter are used then exclusion filter will be applied on the result set of inclusion filter. */ excludes: outputs.DevOps.BuildRunBuildRunSourceTriggerInfoActionFilterExclude[]; /** * Attributes to filter GitLab self-hosted server events. */ includes: outputs.DevOps.BuildRunBuildRunSourceTriggerInfoActionFilterInclude[]; /** * Source of the trigger. Allowed values are, GITHUB and GITLAB. */ triggerSource: string; } interface BuildRunBuildRunSourceTriggerInfoActionFilterExclude { /** * Attributes to support include/exclude files for triggering build runs. */ fileFilters: outputs.DevOps.BuildRunBuildRunSourceTriggerInfoActionFilterExcludeFileFilter[]; } interface BuildRunBuildRunSourceTriggerInfoActionFilterExcludeFileFilter { /** * The file paths/glob pattern for files. */ filePaths: string[]; } interface BuildRunBuildRunSourceTriggerInfoActionFilterInclude { /** * The target branch for pull requests; not applicable for push requests. */ baseRef: string; /** * Attributes to support include/exclude files for triggering build runs. */ fileFilters: outputs.DevOps.BuildRunBuildRunSourceTriggerInfoActionFilterIncludeFileFilter[]; /** * Branch for push event; source branch for pull requests. */ headRef: string; /** * The repository name for trigger events. */ repositoryName: string; } interface BuildRunBuildRunSourceTriggerInfoActionFilterIncludeFileFilter { /** * The file paths/glob pattern for files. */ filePaths: string[]; } interface BuildRunCommitInfo { /** * Commit hash pertinent to the repository URL and the specified branch. */ commitHash: string; /** * Name of the repository branch. */ repositoryBranch: string; /** * Repository URL. */ repositoryUrl: string; } interface ConnectionLastConnectionValidationResult { /** * A message describing the result of connection validation in more detail. */ message: string; /** * The latest result of whether the credentials pass the validation. */ result: string; /** * The latest timestamp when the connection was validated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeValidated: string; } interface ConnectionTlsVerifyConfig { /** * (Updatable) The OCID of Oracle Cloud Infrastructure certificate service CA bundle. */ caCertificateBundleId: string; /** * (Updatable) The type of TLS verification. */ tlsVerifyMode: string; } interface DeployArtifactDeployArtifactSource { /** * (Updatable) The Helm commands to be executed, base 64 encoded */ base64encodedContent: string; /** * (Updatable) The URL of an OCIR repository. */ chartUrl: string; /** * (Updatable) Specifies the artifact path in the repository. */ deployArtifactPath: string; /** * (Updatable) Specifies types of artifact sources. */ deployArtifactSourceType: string; /** * (Updatable) Users can set this as a placeholder value that refers to a pipeline parameter, for example, ${appVersion}. */ deployArtifactVersion: string; /** * (Updatable) Specifies types of artifact sources. */ helmArtifactSourceType: string; /** * (Updatable) The source of the verification material. */ helmVerificationKeySource?: outputs.DevOps.DeployArtifactDeployArtifactSourceHelmVerificationKeySource; /** * (Updatable) Specifies image digest for the version of the image. */ imageDigest: string; /** * (Updatable) Specifies OCIR Image Path - optionally include tag. */ imageUri: string; /** * (Updatable) The OCID of a repository */ repositoryId: string; } interface DeployArtifactDeployArtifactSourceHelmVerificationKeySource { /** * (Updatable) Current version of Base64 encoding of the public key which is in binary GPG exported format. */ currentPublicKey?: string; /** * (Updatable) Previous version of Base64 encoding of the public key which is in binary GPG exported format. This would be used for key rotation scenarios. */ previousPublicKey?: string; /** * (Updatable) The OCID of the Vault Secret containing the verification key versions. */ vaultSecretId?: string; /** * (Updatable) Specifies type of verification material. */ verificationKeySourceType: string; } interface DeployEnvironmentComputeInstanceGroupSelectors { /** * (Updatable) A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector. */ items: outputs.DevOps.DeployEnvironmentComputeInstanceGroupSelectorsItem[]; } interface DeployEnvironmentComputeInstanceGroupSelectorsItem { /** * (Updatable) Compute instance OCID identifiers that are members of this group. */ computeInstanceIds: string[]; /** * (Updatable) Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm */ query: string; /** * (Updatable) Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm */ region: string; /** * (Updatable) Defines the type of the instance selector for the group. */ selectorType: string; } interface DeployEnvironmentNetworkChannel { /** * (Updatable) Network channel type. */ networkChannelType: string; /** * (Updatable) An array of network security group OCIDs. */ nsgIds: string[]; /** * (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint. */ subnetId: string; } interface DeployPipelineDeployPipelineArtifact { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.DeployPipelineDeployPipelineArtifactItem[]; } interface DeployPipelineDeployPipelineArtifactItem { /** * The OCID of an artifact */ deployArtifactId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.DeployPipelineDeployPipelineArtifactItemDeployPipelineStage[]; /** * (Updatable) Deployment pipeline display name. Avoid entering confidential information. */ displayName: string; } interface DeployPipelineDeployPipelineArtifactItemDeployPipelineStage { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.DeployPipelineDeployPipelineArtifactItemDeployPipelineStageItem[]; } interface DeployPipelineDeployPipelineArtifactItemDeployPipelineStageItem { /** * The OCID of a stage */ deployStageId: string; /** * (Updatable) Deployment pipeline display name. Avoid entering confidential information. */ displayName: string; } interface DeployPipelineDeployPipelineEnvironment { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.DeployPipelineDeployPipelineEnvironmentItem[]; } interface DeployPipelineDeployPipelineEnvironmentItem { /** * The OCID of an Environment */ deployEnvironmentId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStage[]; /** * (Updatable) Deployment pipeline display name. Avoid entering confidential information. */ displayName: string; } interface DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStage { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageItem[]; } interface DeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageItem { /** * The OCID of a stage */ deployStageId: string; /** * (Updatable) Deployment pipeline display name. Avoid entering confidential information. */ displayName: string; } interface DeployPipelineDeployPipelineParameters { /** * (Updatable) List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.DeployPipelineDeployPipelineParametersItem[]; } interface DeployPipelineDeployPipelineParametersItem { /** * (Updatable) Default value of the parameter. */ defaultValue: string; /** * (Updatable) Description of the parameter. */ description: string; /** * (Updatable) Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. */ name: string; } interface DeployStageApprovalPolicy { /** * (Updatable) Approval policy type. */ approvalPolicyType: string; /** * (Updatable) A minimum number of approvals required for stage to proceed. */ numberOfApprovalsRequired: number; } interface DeployStageBlueBackendIps { /** * (Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer. */ items: string[]; } interface DeployStageBlueGreenStrategy { /** * Name of the Ingress resource. */ ingressName: string; /** * First Namespace for deployment. */ namespaceA: string; /** * Second Namespace for deployment. */ namespaceB: string; /** * Blue Green strategy type */ strategyType: string; } interface DeployStageCanaryStrategy { /** * Name of the Ingress resource. */ ingressName: string; /** * Canary namespace to be used for Kubernetes canary deployment. */ namespace: string; /** * Canary strategy type. */ strategyType: string; } interface DeployStageContainerConfig { /** * (Updatable) Availability domain where the ContainerInstance will be created. */ availabilityDomain: string; /** * (Updatable) The OCID of the compartment where the ContainerInstance will be created. */ compartmentId: string; /** * (Updatable) Container configuration type. */ containerConfigType: string; /** * (Updatable) Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network. */ networkChannel: outputs.DevOps.DeployStageContainerConfigNetworkChannel; /** * (Updatable) Determines the size and amount of resources available to the instance. */ shapeConfig: outputs.DevOps.DeployStageContainerConfigShapeConfig; /** * (Updatable) The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance. */ shapeName: string; } interface DeployStageContainerConfigNetworkChannel { /** * (Updatable) Network channel type. */ networkChannelType: string; /** * (Updatable) An array of network security group OCIDs. */ nsgIds: string[]; /** * (Updatable) The OCID of the subnet where VNIC resources will be created for private endpoint. */ subnetId: string; } interface DeployStageContainerConfigShapeConfig { /** * (Updatable) The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs available to the instance. */ ocpus: number; } interface DeployStageDeployStagePredecessorCollection { /** * (Updatable) A list of stage predecessors for a stage. */ items: outputs.DevOps.DeployStageDeployStagePredecessorCollectionItem[]; } interface DeployStageDeployStagePredecessorCollectionItem { /** * (Updatable) The OCID of the predecessor stage. If a stage is the first stage in the pipeline, then the ID is the pipeline's OCID. */ id: string; } interface DeployStageFailurePolicy { /** * (Updatable) The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED. */ failureCount: number; /** * (Updatable) The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group. */ failurePercentage: number; /** * (Updatable) Specifies if the failure instance size is given by absolute number or by percentage. */ policyType: string; } interface DeployStageGreenBackendIps { /** * (Updatable) The IP address of the backend server. A server could be a compute instance or a load balancer. */ items: string[]; } interface DeployStageLoadBalancerConfig { /** * (Updatable) Listen port for the backend server. */ backendPort: number; /** * (Updatable) Name of the load balancer listener. */ listenerName: string; /** * (Updatable) The OCID of the load balancer. */ loadBalancerId: string; /** * The current state of the deployment stage. */ state: string; } interface DeployStageProductionLoadBalancerConfig { /** * Listen port for the backend server. */ backendPort: number; /** * Name of the load balancer listener. */ listenerName: string; /** * The OCID of the load balancer. */ loadBalancerId: string; /** * The current state of the deployment stage. */ state: string; } interface DeployStageRollbackPolicy { /** * (Updatable) Specifies type of the deployment stage rollback policy. */ policyType: string; } interface DeployStageRolloutPolicy { /** * (Updatable) The number that will be used to determine how many instances will be deployed concurrently. */ batchCount: number; /** * (Updatable) The duration of delay between batch rollout. The default delay is 1 minute. */ batchDelayInSeconds: number; /** * (Updatable) The percentage that will be used to determine how many instances will be deployed concurrently. */ batchPercentage: number; /** * (Updatable) The type of policy used for rolling out a deployment stage. */ policyType?: string; /** * (Updatable) Indicates the criteria to stop. */ rampLimitPercent: number; } interface DeployStageSetString { /** * (Updatable) List of parameters defined to set helm value. */ items?: outputs.DevOps.DeployStageSetStringItem[]; } interface DeployStageSetStringItem { /** * (Updatable) Name of the parameter (case-sensitive). */ name: string; /** * (Updatable) Value of the parameter. */ value: string; } interface DeployStageSetValues { /** * (Updatable) List of parameters defined to set helm value. */ items?: outputs.DevOps.DeployStageSetValuesItem[]; } interface DeployStageSetValuesItem { /** * (Updatable) Name of the parameter (case-sensitive). */ name: string; /** * (Updatable) Value of the parameter. */ value: string; } interface DeployStageTestLoadBalancerConfig { /** * (Updatable) Listen port for the backend server. */ backendPort: number; /** * (Updatable) Name of the load balancer listener. */ listenerName: string; /** * (Updatable) The OCID of the load balancer. */ loadBalancerId: string; /** * The current state of the deployment stage. */ state: string; } interface DeployStageWaitCriteria { /** * (Updatable) The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days. */ waitDuration: string; /** * (Updatable) Wait criteria type. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ waitType: string; } interface DeploymentDeployArtifactOverrideArguments { /** * List of artifact override arguments at the time of deployment. */ items: outputs.DevOps.DeploymentDeployArtifactOverrideArgumentsItem[]; } interface DeploymentDeployArtifactOverrideArgumentsItem { /** * The OCID of the artifact to which this parameter applies. */ deployArtifactId: string; /** * Name of the parameter (case-sensitive). */ name: string; /** * Value of the parameter. */ value?: string; } interface DeploymentDeployPipelineArtifact { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.DeploymentDeployPipelineArtifactItem[]; } interface DeploymentDeployPipelineArtifactItem { /** * The OCID of an artifact */ deployArtifactId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.DeploymentDeployPipelineArtifactItemDeployPipelineStage[]; /** * (Updatable) Deployment display name. Avoid entering confidential information. */ displayName: string; } interface DeploymentDeployPipelineArtifactItemDeployPipelineStage { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.DeploymentDeployPipelineArtifactItemDeployPipelineStageItem[]; } interface DeploymentDeployPipelineArtifactItemDeployPipelineStageItem { /** * Specifies the OCID of the stage to be redeployed. */ deployStageId: string; /** * (Updatable) Deployment display name. Avoid entering confidential information. */ displayName: string; } interface DeploymentDeployPipelineEnvironment { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.DeploymentDeployPipelineEnvironmentItem[]; } interface DeploymentDeployPipelineEnvironmentItem { /** * The OCID of an Environment */ deployEnvironmentId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.DeploymentDeployPipelineEnvironmentItemDeployPipelineStage[]; /** * (Updatable) Deployment display name. Avoid entering confidential information. */ displayName: string; } interface DeploymentDeployPipelineEnvironmentItemDeployPipelineStage { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.DeploymentDeployPipelineEnvironmentItemDeployPipelineStageItem[]; } interface DeploymentDeployPipelineEnvironmentItemDeployPipelineStageItem { /** * Specifies the OCID of the stage to be redeployed. */ deployStageId: string; /** * (Updatable) Deployment display name. Avoid entering confidential information. */ displayName: string; } interface DeploymentDeployStageOverrideArguments { /** * List of stage override arguments at the time of deployment. */ items: outputs.DevOps.DeploymentDeployStageOverrideArgumentsItem[]; } interface DeploymentDeployStageOverrideArgumentsItem { /** * The OCID of the stage. */ deployStageId: string; /** * Name of the parameter (case-sensitive). */ name: string; /** * Value of the parameter. */ value: string; } interface DeploymentDeploymentArguments { /** * List of arguments provided at the time of deployment. */ items: outputs.DevOps.DeploymentDeploymentArgumentsItem[]; } interface DeploymentDeploymentArgumentsItem { /** * Name of the parameter (case-sensitive). */ name: string; /** * value of the argument. * * To retrieve Helm Diff for Helm stages in the pipeline add deploymentArguments with name=PLAN_DRY_RUN and value=true */ value: string; } interface DeploymentDeploymentExecutionProgress { /** * Map of stage OCIDs to deploy stage execution progress model. */ deployStageExecutionProgress: { [key: string]: string; }; /** * Time the deployment is finished. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeFinished: string; /** * Time the deployment is started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeStarted: string; } interface GetBuildPipelineBuildPipelineParameter { /** * List of parameters defined for a build pipeline. */ items: outputs.DevOps.GetBuildPipelineBuildPipelineParameterItem[]; } interface GetBuildPipelineBuildPipelineParameterItem { /** * Default value of the parameter. */ defaultValue: string; /** * Optional description about the build pipeline. */ description: string; /** * Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param' */ name: string; } interface GetBuildPipelineStageBuildPipelineStagePredecessorCollection { /** * Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. */ items: outputs.DevOps.GetBuildPipelineStageBuildPipelineStagePredecessorCollectionItem[]; } interface GetBuildPipelineStageBuildPipelineStagePredecessorCollectionItem { /** * Unique identifier that is immutable on creation. */ id: string; } interface GetBuildPipelineStageBuildRunnerShapeConfig { /** * Name of the build runner shape in which the execution occurs. If not specified, the default shape is chosen. */ buildRunnerType: string; /** * The total amount of memory set for the instance in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs set for the instance. */ ocpus: number; } interface GetBuildPipelineStageBuildSourceCollection { /** * Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. */ items: outputs.DevOps.GetBuildPipelineStageBuildSourceCollectionItem[]; } interface GetBuildPipelineStageBuildSourceCollectionItem { /** * Branch name. */ branch: string; /** * Connection identifier pertinent to Bitbucket Server source provider */ connectionId: string; /** * The type of source provider. */ connectionType: string; /** * Name of the build source. This must be unique within a build source collection. The name can be used by customers to locate the working directory pertinent to this repository. */ name: string; /** * The DevOps code repository ID. */ repositoryId: string; /** * URL for the repository. */ repositoryUrl: string; } interface GetBuildPipelineStageDeliverArtifactCollection { /** * Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. */ items: outputs.DevOps.GetBuildPipelineStageDeliverArtifactCollectionItem[]; } interface GetBuildPipelineStageDeliverArtifactCollectionItem { /** * Artifact identifier that contains the artifact definition. */ artifactId: string; /** * Name of the artifact specified in the build_spec.yaml file. */ artifactName: string; } interface GetBuildPipelineStagePrivateAccessConfig { /** * Network channel type. */ networkChannelType: string; /** * An array of network security group OCIDs. */ nsgIds: string[]; /** * The OCID of the subnet where VNIC resources will be created for private endpoint. */ subnetId: string; } interface GetBuildPipelineStageWaitCriteria { /** * The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days. */ waitDuration: string; /** * Wait criteria type. */ waitType: string; } interface GetBuildPipelineStagesBuildPipelineStageCollection { /** * Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. */ items: outputs.DevOps.GetBuildPipelineStagesBuildPipelineStageCollectionItem[]; } interface GetBuildPipelineStagesBuildPipelineStageCollectionItem { /** * The OCID of the parent build pipeline. */ buildPipelineId: string; /** * The collection containing the predecessors of a stage. */ buildPipelineStagePredecessorCollections: outputs.DevOps.GetBuildPipelineStagesBuildPipelineStageCollectionItemBuildPipelineStagePredecessorCollection[]; /** * Defines the stage type, which is one of the following: BUILD, DELIVER_ARTIFACT, WAIT, and TRIGGER_DEPLOYMENT_PIPELINE. */ buildPipelineStageType: string; /** * The information about build runner. */ buildRunnerShapeConfig: outputs.DevOps.GetBuildPipelineStagesBuildPipelineStageCollectionItemBuildRunnerShapeConfig; /** * Collection of build sources. */ buildSourceCollection: outputs.DevOps.GetBuildPipelineStagesBuildPipelineStageCollectionItemBuildSourceCollection; /** * The path to the build specification file for this environment. The default location of the file if not specified is build_spec.yaml. */ buildSpecFile: string; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * The type of source provider. */ connectionType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Specifies an array of artifacts that need to be pushed to the artifactory stores. */ deliverArtifactCollection: outputs.DevOps.GetBuildPipelineStagesBuildPipelineStageCollectionItemDeliverArtifactCollection; /** * A target deployment pipeline OCID that will run in this stage. */ deployPipelineId: string; /** * Optional description about the build stage. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; /** * Image name for the build environment. */ image: string; /** * A boolean flag that specifies whether all the parameters must be passed when the deployment is triggered. */ isPassAllParametersEnabled: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Name of the build source where the build_spec.yml file is located. If not specified, then the first entry in the build source collection is chosen as primary build source. */ primaryBuildSource: string; /** * Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network. */ privateAccessConfig: outputs.DevOps.GetBuildPipelineStagesBuildPipelineStageCollectionItemPrivateAccessConfig; /** * The OCID of the DevOps project. */ projectId: string; /** * Timeout for the build stage execution. Specify value in seconds. */ stageExecutionTimeoutInSeconds: number; /** * A filter to return the stages that matches the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the stage was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * The time the stage was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; /** * Specifies wait criteria for the Wait stage. */ waitCriteria: outputs.DevOps.GetBuildPipelineStagesBuildPipelineStageCollectionItemWaitCriteria; } interface GetBuildPipelineStagesBuildPipelineStageCollectionItemBuildPipelineStagePredecessorCollection { /** * Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. */ items: outputs.DevOps.GetBuildPipelineStagesBuildPipelineStageCollectionItemBuildPipelineStagePredecessorCollectionItem[]; } interface GetBuildPipelineStagesBuildPipelineStageCollectionItemBuildPipelineStagePredecessorCollectionItem { /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; } interface GetBuildPipelineStagesBuildPipelineStageCollectionItemBuildRunnerShapeConfig { /** * Name of the build runner shape in which the execution occurs. If not specified, the default shape is chosen. */ buildRunnerType: string; /** * The total amount of memory set for the instance in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs set for the instance. */ ocpus: number; } interface GetBuildPipelineStagesBuildPipelineStageCollectionItemBuildSourceCollection { /** * Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. */ items: outputs.DevOps.GetBuildPipelineStagesBuildPipelineStageCollectionItemBuildSourceCollectionItem[]; } interface GetBuildPipelineStagesBuildPipelineStageCollectionItemBuildSourceCollectionItem { /** * Branch name. */ branch: string; /** * Connection identifier pertinent to Bitbucket Server source provider */ connectionId: string; /** * The type of source provider. */ connectionType: string; /** * Name of the build source. This must be unique within a build source collection. The name can be used by customers to locate the working directory pertinent to this repository. */ name: string; /** * The DevOps code repository ID. */ repositoryId: string; /** * URL for the repository. */ repositoryUrl: string; } interface GetBuildPipelineStagesBuildPipelineStageCollectionItemDeliverArtifactCollection { /** * Collection of artifacts that were generated in the Build stage and need to be pushed to the artifactory stores. In case of UPDATE operation, replaces existing artifacts list. Merging with existing artifacts is not supported. */ items: outputs.DevOps.GetBuildPipelineStagesBuildPipelineStageCollectionItemDeliverArtifactCollectionItem[]; } interface GetBuildPipelineStagesBuildPipelineStageCollectionItemDeliverArtifactCollectionItem { /** * Artifact identifier that contains the artifact definition. */ artifactId: string; /** * Name of the artifact specified in the build_spec.yaml file. */ artifactName: string; } interface GetBuildPipelineStagesBuildPipelineStageCollectionItemPrivateAccessConfig { /** * Network channel type. */ networkChannelType: string; /** * An array of network security group OCIDs. */ nsgIds: string[]; /** * The OCID of the subnet where VNIC resources will be created for private endpoint. */ subnetId: string; } interface GetBuildPipelineStagesBuildPipelineStageCollectionItemWaitCriteria { /** * The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days. */ waitDuration: string; /** * Wait criteria type. */ waitType: string; } interface GetBuildPipelineStagesFilter { /** * Name of the build source. This must be unique within a build source collection. The name can be used by customers to locate the working directory pertinent to this repository. */ name: string; regex?: boolean; values: string[]; } interface GetBuildPipelinesBuildPipelineCollection { /** * List of parameters defined for a build pipeline. */ items: outputs.DevOps.GetBuildPipelinesBuildPipelineCollectionItem[]; } interface GetBuildPipelinesBuildPipelineCollectionItem { /** * Specifies list of parameters present in a build pipeline. An UPDATE operation replaces the existing parameters list entirely. */ buildPipelineParameters: outputs.DevOps.GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameter[]; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Optional description about the build pipeline. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * unique project identifier */ projectId: string; /** * A filter to return only build pipelines that matches the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the build pipeline was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * The time the build pipeline was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; } interface GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameter { /** * List of parameters defined for a build pipeline. */ items: outputs.DevOps.GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameterItem[]; } interface GetBuildPipelinesBuildPipelineCollectionItemBuildPipelineParameterItem { /** * Default value of the parameter. */ defaultValue: string; /** * Optional description about the build pipeline. */ description: string; /** * Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param' */ name: string; } interface GetBuildPipelinesFilter { /** * Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param' */ name: string; regex?: boolean; values: string[]; } interface GetBuildRunBuildOutput { /** * Specifies the list of artifact override arguments at the time of deployment. */ artifactOverrideParameters: outputs.DevOps.GetBuildRunBuildOutputArtifactOverrideParameter[]; /** * Specifies the list of artifacts delivered through the Deliver Artifacts stage. */ deliveredArtifacts: outputs.DevOps.GetBuildRunBuildOutputDeliveredArtifact[]; /** * Specifies list of exported variables. */ exportedVariables: outputs.DevOps.GetBuildRunBuildOutputExportedVariable[]; /** * List of vulnerability audit summary. */ vulnerabilityAuditSummaryCollections: outputs.DevOps.GetBuildRunBuildOutputVulnerabilityAuditSummaryCollection[]; } interface GetBuildRunBuildOutputArtifactOverrideParameter { /** * List of exported variables. */ items: outputs.DevOps.GetBuildRunBuildOutputArtifactOverrideParameterItem[]; } interface GetBuildRunBuildOutputArtifactOverrideParameterItem { /** * The OCID of the deployment artifact definition. */ deployArtifactId: string; /** * Name of the step. */ name: string; /** * Value of the argument. */ value: string; } interface GetBuildRunBuildOutputDeliveredArtifact { /** * List of exported variables. */ items: outputs.DevOps.GetBuildRunBuildOutputDeliveredArtifactItem[]; } interface GetBuildRunBuildOutputDeliveredArtifactItem { /** * The OCID of the artifact registry repository used by the DeliverArtifactStage */ artifactRepositoryId: string; /** * Type of artifact delivered. */ artifactType: string; /** * The hash of the container registry artifact pushed by the Deliver Artifacts stage. */ deliveredArtifactHash: string; /** * The OCID of the artifact pushed by the Deliver Artifacts stage. */ deliveredArtifactId: string; /** * The OCID of the deployment artifact definition. */ deployArtifactId: string; /** * The imageUri of the OCIR artifact pushed by the DeliverArtifactStage */ imageUri: string; /** * Name of the output artifact defined in the build specification file. */ outputArtifactName: string; /** * Path of the repository where artifact was pushed */ path: string; /** * Version of the artifact pushed */ version: string; } interface GetBuildRunBuildOutputExportedVariable { /** * List of exported variables. */ items: outputs.DevOps.GetBuildRunBuildOutputExportedVariableItem[]; } interface GetBuildRunBuildOutputExportedVariableItem { /** * Name of the step. */ name: string; /** * Value of the argument. */ value: string; } interface GetBuildRunBuildOutputVulnerabilityAuditSummaryCollection { /** * List of exported variables. */ items: outputs.DevOps.GetBuildRunBuildOutputVulnerabilityAuditSummaryCollectionItem[]; } interface GetBuildRunBuildOutputVulnerabilityAuditSummaryCollectionItem { /** * Build stage OCID where scan was configured. */ buildStageId: string; /** * Commit hash pertinent to the repository URL and the specified branch. */ commitHash: string; /** * The OCID of the vulnerability audit. */ vulnerabilityAuditId: string; } interface GetBuildRunBuildRunArgument { /** * List of exported variables. */ items: outputs.DevOps.GetBuildRunBuildRunArgumentItem[]; } interface GetBuildRunBuildRunArgumentItem { /** * Name of the step. */ name: string; /** * Value of the argument. */ value: string; } interface GetBuildRunBuildRunProgress { /** * Map of stage OCIDs to build pipeline stage run progress model. */ buildPipelineStageRunProgress: { [key: string]: string; }; /** * The time the build run finished. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeFinished: string; /** * The time the build run started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeStarted: string; } interface GetBuildRunBuildRunSource { /** * The DevOps code repository identifier that invoked the build run. */ repositoryId: string; /** * The source from which the build run is triggered. */ sourceType: string; /** * The trigger that invoked the build run. */ triggerId: string; /** * Trigger details that need to be used for the BuildRun */ triggerInfos: outputs.DevOps.GetBuildRunBuildRunSourceTriggerInfo[]; } interface GetBuildRunBuildRunSourceTriggerInfo { /** * The list of actions that are to be performed for this Trigger */ actions: outputs.DevOps.GetBuildRunBuildRunSourceTriggerInfoAction[]; /** * Build run display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. */ displayName: string; } interface GetBuildRunBuildRunSourceTriggerInfoAction { /** * The OCID of the build pipeline to be triggered. */ buildPipelineId: string; filters: outputs.DevOps.GetBuildRunBuildRunSourceTriggerInfoActionFilter[]; /** * The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE. */ type: string; } interface GetBuildRunBuildRunSourceTriggerInfoActionFilter { /** * The events, for example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED. */ events: string[]; /** * Attributes to filter GitLab self-hosted server events. File filter criteria - Changes only affecting excluded files will not invoke a build. if both include and exclude filter are used then exclusion filter will be applied on the result set of inclusion filter. */ excludes: outputs.DevOps.GetBuildRunBuildRunSourceTriggerInfoActionFilterExclude[]; /** * Attributes to filter GitLab self-hosted server events. */ includes: outputs.DevOps.GetBuildRunBuildRunSourceTriggerInfoActionFilterInclude[]; /** * Source of the trigger. Allowed values are, GITHUB and GITLAB. */ triggerSource: string; } interface GetBuildRunBuildRunSourceTriggerInfoActionFilterExclude { /** * Attributes to support include/exclude files for triggering build runs. */ fileFilters: outputs.DevOps.GetBuildRunBuildRunSourceTriggerInfoActionFilterExcludeFileFilter[]; } interface GetBuildRunBuildRunSourceTriggerInfoActionFilterExcludeFileFilter { /** * The file paths/glob pattern for files. */ filePaths: string[]; } interface GetBuildRunBuildRunSourceTriggerInfoActionFilterInclude { /** * The target branch for pull requests; not applicable for push requests. */ baseRef: string; /** * Attributes to support include/exclude files for triggering build runs. */ fileFilters: outputs.DevOps.GetBuildRunBuildRunSourceTriggerInfoActionFilterIncludeFileFilter[]; /** * Branch for push event; source branch for pull requests. */ headRef: string; /** * The repository name for trigger events. */ repositoryName: string; } interface GetBuildRunBuildRunSourceTriggerInfoActionFilterIncludeFileFilter { /** * The file paths/glob pattern for files. */ filePaths: string[]; } interface GetBuildRunCommitInfo { /** * Commit hash pertinent to the repository URL and the specified branch. */ commitHash: string; /** * Name of the repository branch. */ repositoryBranch: string; /** * Repository URL. */ repositoryUrl: string; } interface GetBuildRunsBuildRunSummaryCollection { /** * List of exported variables. */ items: outputs.DevOps.GetBuildRunsBuildRunSummaryCollectionItem[]; } interface GetBuildRunsBuildRunSummaryCollectionItem { /** * Unique build pipeline identifier. */ buildPipelineId: string; /** * Specifies list of arguments passed along with the build run. */ buildRunArguments: outputs.DevOps.GetBuildRunsBuildRunSummaryCollectionItemBuildRunArguments; buildRunProgressSummaries: outputs.DevOps.GetBuildRunsBuildRunSummaryCollectionItemBuildRunProgressSummary[]; /** * The source from which the build run is triggered. */ buildRunSources: outputs.DevOps.GetBuildRunsBuildRunSummaryCollectionItemBuildRunSource[]; /** * Commit details that need to be used for the build run. */ commitInfo: outputs.DevOps.GetBuildRunsBuildRunSummaryCollectionItemCommitInfo; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * unique project identifier */ projectId: string; /** * A filter to return only build runs that matches the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the build run was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * The time the build run was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; } interface GetBuildRunsBuildRunSummaryCollectionItemBuildRunArguments { /** * List of exported variables. */ items: outputs.DevOps.GetBuildRunsBuildRunSummaryCollectionItemBuildRunArgumentsItem[]; } interface GetBuildRunsBuildRunSummaryCollectionItemBuildRunArgumentsItem { /** * Name of the step. */ name: string; /** * Value of the argument. */ value: string; } interface GetBuildRunsBuildRunSummaryCollectionItemBuildRunProgressSummary { /** * The time the build run finished. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeFinished: string; /** * The time the build run started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeStarted: string; } interface GetBuildRunsBuildRunSummaryCollectionItemBuildRunSource { /** * The DevOps code repository identifier that invoked the build run. */ repositoryId: string; /** * The source from which the build run is triggered. */ sourceType: string; /** * Trigger details that need to be used for the BuildRun */ triggerInfos: outputs.DevOps.GetBuildRunsBuildRunSummaryCollectionItemBuildRunSourceTriggerInfo[]; } interface GetBuildRunsBuildRunSummaryCollectionItemBuildRunSourceTriggerInfo { /** * The list of actions that are to be performed for this Trigger */ actions: outputs.DevOps.GetBuildRunsBuildRunSummaryCollectionItemBuildRunSourceTriggerInfoAction[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The trigger that invoked the build run. */ triggerId: string; } interface GetBuildRunsBuildRunSummaryCollectionItemBuildRunSourceTriggerInfoAction { /** * Unique build pipeline identifier. */ buildPipelineId: string; filters: outputs.DevOps.GetBuildRunsBuildRunSummaryCollectionItemBuildRunSourceTriggerInfoActionFilter[]; /** * The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE. */ type: string; } interface GetBuildRunsBuildRunSummaryCollectionItemBuildRunSourceTriggerInfoActionFilter { /** * The events, for example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED. */ events: string[]; /** * Attributes to filter GitLab self-hosted server events. */ includes: outputs.DevOps.GetBuildRunsBuildRunSummaryCollectionItemBuildRunSourceTriggerInfoActionFilterInclude[]; /** * Source of the trigger. Allowed values are, GITHUB and GITLAB. */ triggerSource: string; } interface GetBuildRunsBuildRunSummaryCollectionItemBuildRunSourceTriggerInfoActionFilterInclude { /** * The target branch for pull requests; not applicable for push requests. */ baseRef: string; /** * Branch for push event; source branch for pull requests. */ headRef: string; } interface GetBuildRunsBuildRunSummaryCollectionItemCommitInfo { /** * Commit hash pertinent to the repository URL and the specified branch. */ commitHash: string; /** * Name of the repository branch. */ repositoryBranch: string; /** * Repository URL. */ repositoryUrl: string; } interface GetBuildRunsFilter { /** * Name of the step. */ name: string; regex?: boolean; values: string[]; } interface GetConnectionLastConnectionValidationResult { /** * A message describing the result of connection validation in more detail. */ message: string; /** * The latest result of whether the credentials pass the validation. */ result: string; /** * The latest timestamp when the connection was validated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeValidated: string; } interface GetConnectionTlsVerifyConfig { /** * The OCID of Oracle Cloud Infrastructure certificate service CA bundle. */ caCertificateBundleId: string; /** * The type of TLS verification. */ tlsVerifyMode: string; } interface GetConnectionsConnectionCollection { items: outputs.DevOps.GetConnectionsConnectionCollectionItem[]; } interface GetConnectionsConnectionCollectionItem { /** * The OCID of personal access token saved in secret store. */ accessToken: string; /** * OCID of personal Bitbucket Cloud AppPassword saved in secret store */ appPassword: string; /** * The Base URL of the hosted BitbucketServer/Visual Builder Studio server. */ baseUrl: string; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * A filter to return only resources that match the given connection type. */ connectionType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Optional description about the connection. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; /** * The result of validating the credentials of a connection. */ lastConnectionValidationResults: outputs.DevOps.GetConnectionsConnectionCollectionItemLastConnectionValidationResult[]; /** * unique project identifier */ projectId: string; /** * A filter to return only connections that matches the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the connection was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * The time the connection was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; /** * TLS configuration used by build service to verify TLS connection. */ tlsVerifyConfigs: outputs.DevOps.GetConnectionsConnectionCollectionItemTlsVerifyConfig[]; /** * Public Bitbucket Cloud Username in plain text */ username: string; } interface GetConnectionsConnectionCollectionItemLastConnectionValidationResult { /** * A message describing the result of connection validation in more detail. */ message: string; /** * The latest result of whether the credentials pass the validation. */ result: string; /** * The latest timestamp when the connection was validated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeValidated: string; } interface GetConnectionsConnectionCollectionItemTlsVerifyConfig { /** * The OCID of Oracle Cloud Infrastructure certificate service CA bundle. */ caCertificateBundleId: string; /** * The type of TLS verification. */ tlsVerifyMode: string; } interface GetConnectionsFilter { name: string; regex?: boolean; values: string[]; } interface GetDeployArtifactDeployArtifactSource { /** * The Helm commands to be executed, base 64 encoded */ base64encodedContent: string; /** * The URL of an OCIR repository. */ chartUrl: string; /** * Specifies the artifact path in the repository. */ deployArtifactPath: string; /** * Specifies types of artifact sources. */ deployArtifactSourceType: string; /** * Users can set this as a placeholder value that refers to a pipeline parameter, for example, ${appVersion}. */ deployArtifactVersion: string; /** * Specifies types of artifact sources. */ helmArtifactSourceType: string; /** * The source of the verification material. */ helmVerificationKeySources: outputs.DevOps.GetDeployArtifactDeployArtifactSourceHelmVerificationKeySource[]; /** * Specifies image digest for the version of the image. */ imageDigest: string; /** * Specifies OCIR Image Path - optionally include tag. */ imageUri: string; /** * The OCID of a repository */ repositoryId: string; } interface GetDeployArtifactDeployArtifactSourceHelmVerificationKeySource { /** * Current version of Base64 encoding of the public key which is in binary GPG exported format. */ currentPublicKey: string; /** * Previous version of Base64 encoding of the public key which is in binary GPG exported format. This would be used for key rotation scenarios. */ previousPublicKey: string; /** * The OCID of the Vault Secret containing the verification key versions. */ vaultSecretId: string; /** * Specifies type of verification material. */ verificationKeySourceType: string; } interface GetDeployArtifactsDeployArtifactCollection { items: outputs.DevOps.GetDeployArtifactsDeployArtifactCollectionItem[]; } interface GetDeployArtifactsDeployArtifactCollectionItem { /** * Mode for artifact parameter substitution. Options: `"NONE", "SUBSTITUTE_PLACEHOLDERS"` For Helm Deployments only "NONE" is supported. */ argumentSubstitutionMode: string; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Specifies source of an artifact. */ deployArtifactSources: outputs.DevOps.GetDeployArtifactsDeployArtifactCollectionItemDeployArtifactSource[]; /** * Type of the deployment artifact. */ deployArtifactType: string; /** * Optional description about the artifact to be deployed. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; /** * A detailed message describing the current state. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * unique project identifier */ projectId: string; /** * A filter to return only DeployArtifacts that matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time the deployment artifact was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * Time the deployment artifact was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; } interface GetDeployArtifactsDeployArtifactCollectionItemDeployArtifactSource { /** * The Helm commands to be executed, base 64 encoded */ base64encodedContent: string; /** * The URL of an OCIR repository. */ chartUrl: string; /** * Specifies the artifact path in the repository. */ deployArtifactPath: string; /** * Specifies types of artifact sources. */ deployArtifactSourceType: string; /** * Users can set this as a placeholder value that refers to a pipeline parameter, for example, ${appVersion}. */ deployArtifactVersion: string; /** * Specifies types of artifact sources. */ helmArtifactSourceType: string; /** * The source of the verification material. */ helmVerificationKeySources: outputs.DevOps.GetDeployArtifactsDeployArtifactCollectionItemDeployArtifactSourceHelmVerificationKeySource[]; /** * Specifies image digest for the version of the image. */ imageDigest: string; /** * Specifies OCIR Image Path - optionally include tag. */ imageUri: string; /** * The OCID of a repository */ repositoryId: string; } interface GetDeployArtifactsDeployArtifactCollectionItemDeployArtifactSourceHelmVerificationKeySource { /** * Current version of Base64 encoding of the public key which is in binary GPG exported format. */ currentPublicKey: string; /** * Previous version of Base64 encoding of the public key which is in binary GPG exported format. This would be used for key rotation scenarios. */ previousPublicKey: string; /** * The OCID of the Vault Secret containing the verification key versions. */ vaultSecretId: string; /** * Specifies type of verification material. */ verificationKeySourceType: string; } interface GetDeployArtifactsFilter { name: string; regex?: boolean; values: string[]; } interface GetDeployEnvironmentComputeInstanceGroupSelector { /** * A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector. */ items: outputs.DevOps.GetDeployEnvironmentComputeInstanceGroupSelectorItem[]; } interface GetDeployEnvironmentComputeInstanceGroupSelectorItem { /** * Compute instance OCID identifiers that are members of this group. */ computeInstanceIds: string[]; /** * Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm */ query: string; /** * Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm */ region: string; /** * Defines the type of the instance selector for the group. */ selectorType: string; } interface GetDeployEnvironmentNetworkChannel { /** * Network channel type. */ networkChannelType: string; /** * An array of network security group OCIDs. */ nsgIds: string[]; /** * The OCID of the subnet where VNIC resources will be created for private endpoint. */ subnetId: string; } interface GetDeployEnvironmentsDeployEnvironmentCollection { /** * A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector. */ items: outputs.DevOps.GetDeployEnvironmentsDeployEnvironmentCollectionItem[]; } interface GetDeployEnvironmentsDeployEnvironmentCollectionItem { /** * The OCID of the Kubernetes cluster. */ clusterId: string; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * A collection of selectors. The combination of instances matching the selectors are included in the instance group. */ computeInstanceGroupSelectors: outputs.DevOps.GetDeployEnvironmentsDeployEnvironmentCollectionItemComputeInstanceGroupSelector[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Deployment environment type. */ deployEnvironmentType: string; /** * Optional description about the deployment environment. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Function. */ functionId: string; /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network. */ networkChannels: outputs.DevOps.GetDeployEnvironmentsDeployEnvironmentCollectionItemNetworkChannel[]; /** * unique project identifier */ projectId: string; /** * Security attributes to be added in to the deployment environment */ securityAttributes: { [key: string]: string; }; /** * A filter to return only DeployEnvironments that matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time the deployment environment was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * Time the deployment environment was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; } interface GetDeployEnvironmentsDeployEnvironmentCollectionItemComputeInstanceGroupSelector { /** * A list of selectors for the instance group. UNION operator is used for combining the instances selected by each selector. */ items: outputs.DevOps.GetDeployEnvironmentsDeployEnvironmentCollectionItemComputeInstanceGroupSelectorItem[]; } interface GetDeployEnvironmentsDeployEnvironmentCollectionItemComputeInstanceGroupSelectorItem { /** * Compute instance OCID identifiers that are members of this group. */ computeInstanceIds: string[]; /** * Query expression confirming to the Oracle Cloud Infrastructure Search Language syntax to select compute instances for the group. The language is documented at https://docs.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm */ query: string; /** * Region identifier referred by the deployment environment. Region identifiers are listed at https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm */ region: string; /** * Defines the type of the instance selector for the group. */ selectorType: string; } interface GetDeployEnvironmentsDeployEnvironmentCollectionItemNetworkChannel { /** * Network channel type. */ networkChannelType: string; /** * An array of network security group OCIDs. */ nsgIds: string[]; /** * The OCID of the subnet where VNIC resources will be created for private endpoint. */ subnetId: string; } interface GetDeployEnvironmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetDeployPipelineDeployPipelineArtifact { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelineDeployPipelineArtifactItem[]; } interface GetDeployPipelineDeployPipelineArtifactItem { /** * The OCID of an artifact */ deployArtifactId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.GetDeployPipelineDeployPipelineArtifactItemDeployPipelineStage[]; /** * Deployment pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. */ displayName: string; } interface GetDeployPipelineDeployPipelineArtifactItemDeployPipelineStage { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelineDeployPipelineArtifactItemDeployPipelineStageItem[]; } interface GetDeployPipelineDeployPipelineArtifactItemDeployPipelineStageItem { /** * The OCID of a stage */ deployStageId: string; /** * Deployment pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. */ displayName: string; } interface GetDeployPipelineDeployPipelineEnvironment { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelineDeployPipelineEnvironmentItem[]; } interface GetDeployPipelineDeployPipelineEnvironmentItem { /** * The OCID of an Environment */ deployEnvironmentId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.GetDeployPipelineDeployPipelineEnvironmentItemDeployPipelineStage[]; /** * Deployment pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. */ displayName: string; } interface GetDeployPipelineDeployPipelineEnvironmentItemDeployPipelineStage { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageItem[]; } interface GetDeployPipelineDeployPipelineEnvironmentItemDeployPipelineStageItem { /** * The OCID of a stage */ deployStageId: string; /** * Deployment pipeline display name, which can be renamed and is not necessarily unique. Avoid entering confidential information. */ displayName: string; } interface GetDeployPipelineDeployPipelineParameter { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelineDeployPipelineParameterItem[]; } interface GetDeployPipelineDeployPipelineParameterItem { /** * Default value of the parameter. */ defaultValue: string; /** * Optional description about the deployment pipeline. */ description: string; /** * Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. */ name: string; } interface GetDeployPipelinesDeployPipelineCollection { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItem[]; } interface GetDeployPipelinesDeployPipelineCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * List of all artifacts used in the pipeline. */ deployPipelineArtifacts: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineArtifact[]; /** * List of all environments used in the pipeline. */ deployPipelineEnvironments: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineEnvironment[]; /** * Specifies list of parameters present in the deployment pipeline. In case of Update operation, replaces existing parameters list. Merging with existing parameters is not supported. */ deployPipelineParameters: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineParameter[]; /** * Optional description about the deployment pipeline. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * unique project identifier */ projectId: string; /** * A filter to return only DeployPipelines that matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time the deployment pipeline was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * Time the deployment pipeline was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; } interface GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineArtifact { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineArtifactItem[]; } interface GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineArtifactItem { /** * The OCID of an artifact */ deployArtifactId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineArtifactItemDeployPipelineStage[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; } interface GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineArtifactItemDeployPipelineStage { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineArtifactItemDeployPipelineStageItem[]; } interface GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineArtifactItemDeployPipelineStageItem { /** * The OCID of a stage */ deployStageId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; } interface GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineEnvironment { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineEnvironmentItem[]; } interface GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineEnvironmentItem { /** * The OCID of an Environment */ deployEnvironmentId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineEnvironmentItemDeployPipelineStage[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; } interface GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineEnvironmentItemDeployPipelineStage { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineEnvironmentItemDeployPipelineStageItem[]; } interface GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineEnvironmentItemDeployPipelineStageItem { /** * The OCID of a stage */ deployStageId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; } interface GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineParameter { /** * List of parameters defined for a deployment pipeline. */ items: outputs.DevOps.GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineParameterItem[]; } interface GetDeployPipelinesDeployPipelineCollectionItemDeployPipelineParameterItem { /** * Default value of the parameter. */ defaultValue: string; /** * Optional description about the deployment pipeline. */ description: string; /** * Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. */ name: string; } interface GetDeployPipelinesFilter { /** * Name of the parameter (case-sensitive). Parameter name must be ^[a-zA-Z][a-zA-Z_0-9]*$. */ name: string; regex?: boolean; values: string[]; } interface GetDeployStageApprovalPolicy { /** * Approval policy type. */ approvalPolicyType: string; /** * A minimum number of approvals required for stage to proceed. */ numberOfApprovalsRequired: number; } interface GetDeployStageBlueBackendIp { /** * List of parameters defined to set helm value. */ items: string[]; } interface GetDeployStageBlueGreenStrategy { /** * Name of the Ingress resource. */ ingressName: string; /** * First Namespace for deployment. */ namespaceA: string; /** * Second Namespace for deployment. */ namespaceB: string; /** * Canary strategy type. */ strategyType: string; } interface GetDeployStageCanaryStrategy { /** * Name of the Ingress resource. */ ingressName: string; /** * Default Namespace to be used for Kubernetes deployment when not specified in the manifest. */ namespace: string; /** * Canary strategy type. */ strategyType: string; } interface GetDeployStageContainerConfig { /** * Availability domain where the ContainerInstance will be created. */ availabilityDomain: string; /** * The OCID of the compartment where the ContainerInstance will be created. */ compartmentId: string; /** * Container configuration type. */ containerConfigType: string; /** * Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network. */ networkChannels: outputs.DevOps.GetDeployStageContainerConfigNetworkChannel[]; /** * Determines the size and amount of resources available to the instance. */ shapeConfigs: outputs.DevOps.GetDeployStageContainerConfigShapeConfig[]; /** * The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance. */ shapeName: string; } interface GetDeployStageContainerConfigNetworkChannel { /** * Network channel type. */ networkChannelType: string; /** * An array of network security group OCIDs. */ nsgIds: string[]; /** * The OCID of the subnet where VNIC resources will be created for private endpoint. */ subnetId: string; } interface GetDeployStageContainerConfigShapeConfig { /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; } interface GetDeployStageDeployStagePredecessorCollection { /** * List of parameters defined to set helm value. */ items: outputs.DevOps.GetDeployStageDeployStagePredecessorCollectionItem[]; } interface GetDeployStageDeployStagePredecessorCollectionItem { /** * Unique identifier that is immutable on creation. */ id: string; } interface GetDeployStageFailurePolicy { /** * The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED. */ failureCount: number; /** * The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group. */ failurePercentage: number; /** * The type of policy used for rolling out a deployment stage. */ policyType: string; } interface GetDeployStageGreenBackendIp { /** * List of parameters defined to set helm value. */ items: string[]; } interface GetDeployStageLoadBalancerConfig { /** * Listen port for the backend server. */ backendPort: number; /** * Name of the load balancer listener. */ listenerName: string; /** * The OCID of the load balancer. */ loadBalancerId: string; /** * The current state of the deployment stage. */ state: string; } interface GetDeployStageProductionLoadBalancerConfig { /** * Listen port for the backend server. */ backendPort: number; /** * Name of the load balancer listener. */ listenerName: string; /** * The OCID of the load balancer. */ loadBalancerId: string; /** * The current state of the deployment stage. */ state: string; } interface GetDeployStageRollbackPolicy { /** * The type of policy used for rolling out a deployment stage. */ policyType: string; } interface GetDeployStageRolloutPolicy { /** * The number that will be used to determine how many instances will be deployed concurrently. */ batchCount: number; /** * The duration of delay between batch rollout. The default delay is 1 minute. */ batchDelayInSeconds: number; /** * The percentage that will be used to determine how many instances will be deployed concurrently. */ batchPercentage: number; /** * The type of policy used for rolling out a deployment stage. */ policyType: string; /** * Indicates the criteria to stop. */ rampLimitPercent: number; } interface GetDeployStageSetString { /** * List of parameters defined to set helm value. */ items: outputs.DevOps.GetDeployStageSetStringItem[]; } interface GetDeployStageSetStringItem { /** * Name of the parameter (case-sensitive). */ name: string; /** * Value of the parameter. */ value: string; } interface GetDeployStageSetValue { /** * List of parameters defined to set helm value. */ items: outputs.DevOps.GetDeployStageSetValueItem[]; } interface GetDeployStageSetValueItem { /** * Name of the parameter (case-sensitive). */ name: string; /** * Value of the parameter. */ value: string; } interface GetDeployStageTestLoadBalancerConfig { /** * Listen port for the backend server. */ backendPort: number; /** * Name of the load balancer listener. */ listenerName: string; /** * The OCID of the load balancer. */ loadBalancerId: string; /** * The current state of the deployment stage. */ state: string; } interface GetDeployStageWaitCriteria { /** * The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days. */ waitDuration: string; /** * Wait criteria type. */ waitType: string; } interface GetDeployStagesDeployStageCollection { /** * List of parameters defined to set helm value. */ items: outputs.DevOps.GetDeployStagesDeployStageCollectionItem[]; } interface GetDeployStagesDeployStageCollectionItem { /** * Specifies the approval policy. */ approvalPolicies: outputs.DevOps.GetDeployStagesDeployStageCollectionItemApprovalPolicy[]; /** * Disable pre/post upgrade hooks. Set to false by default. */ areHooksEnabled: boolean; /** * Collection of backend environment IP addresses. */ blueBackendIps: outputs.DevOps.GetDeployStagesDeployStageCollectionItemBlueBackendIp[]; /** * Specifies the required blue green release strategy for OKE deployment. */ blueGreenStrategies: outputs.DevOps.GetDeployStagesDeployStageCollectionItemBlueGreenStrategy[]; /** * Specifies the required canary release strategy for OKE deployment. */ canaryStrategies: outputs.DevOps.GetDeployStagesDeployStageCollectionItemCanaryStrategy[]; /** * The OCID of the artifact that contains the command specification. */ commandSpecDeployArtifactId: string; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * The OCID of the upstream compute instance group blue-green deployment stage in this pipeline. */ computeInstanceGroupBlueGreenDeploymentDeployStageId: string; /** * The OCID of an upstream compute instance group canary deployment stage ID in this pipeline. */ computeInstanceGroupCanaryDeployStageId: string; /** * A compute instance group canary traffic shift stage OCID for load balancer. */ computeInstanceGroupCanaryTrafficShiftDeployStageId: string; /** * A compute instance group environment OCID for rolling deployment. */ computeInstanceGroupDeployEnvironmentId: string; /** * User provided key and value pair configuration, which is assigned through constants or parameter. */ config: { [key: string]: string; }; /** * Specifies the container configuration. */ containerConfigs: outputs.DevOps.GetDeployStagesDeployStageCollectionItemContainerConfig[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content. */ deployArtifactId: string; /** * The list of file artifact OCIDs to deploy. */ deployArtifactIds: string[]; /** * First compute instance group environment OCID for deployment. */ deployEnvironmentIdA: string; /** * Second compute instance group environment OCID for deployment. */ deployEnvironmentIdB: string; /** * The ID of the parent pipeline. */ deployPipelineId: string; /** * Collection containing the predecessors of a stage. */ deployStagePredecessorCollections: outputs.DevOps.GetDeployStagesDeployStageCollectionItemDeployStagePredecessorCollection[]; /** * Deployment stage type. */ deployStageType: string; /** * The OCID of the artifact that contains the deployment specification. */ deploymentSpecDeployArtifactId: string; /** * Optional description about the deployment stage. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * A Docker image artifact OCID. */ dockerImageDeployArtifactId: string; /** * Specifies a failure policy for a compute instance group rolling deployment stage. */ failurePolicies: outputs.DevOps.GetDeployStagesDeployStageCollectionItemFailurePolicy[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Function environment OCID. */ functionDeployEnvironmentId: string; /** * Timeout for execution of the Function. Value in seconds. */ functionTimeoutInSeconds: number; /** * Collection of backend environment IP addresses. */ greenBackendIps: outputs.DevOps.GetDeployStagesDeployStageCollectionItemGreenBackendIp[]; /** * Helm chart artifact OCID. */ helmChartDeployArtifactId: string; /** * List of Helm command artifact OCIDs. */ helmCommandArtifactIds: string[]; /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; /** * A boolean flag specifies whether this stage executes asynchronously. */ isAsync: boolean; /** * Enables helm --debug option to stream output to tf stdout. Set to false by default. */ isDebugEnabled: boolean; /** * Force resource update through delete; or if required, recreate. Set to false by default. */ isForceEnabled: boolean; /** * Uninstall the Helm chart release on deleting the stage. */ isUninstallOnStageDelete: boolean; /** * A boolean flag specifies whether the invoked function must be validated. */ isValidationEnabled: boolean; /** * List of Kubernetes manifest artifact OCIDs. */ kubernetesManifestDeployArtifactIds: string[]; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported. */ loadBalancerConfigs: outputs.DevOps.GetDeployStagesDeployStageCollectionItemLoadBalancerConfig[]; /** * Limit the maximum number of revisions saved per release. Use 0 for no limit. Set to 10 by default */ maxHistory: number; /** * Maximum usable memory for the Function (in MB). */ maxMemoryInMbs: string; /** * Default Namespace to be used for Kubernetes deployment when not specified in the manifest. */ namespace: string; /** * The OCID of the upstream OKE blue-green deployment stage in this pipeline. */ okeBlueGreenDeployStageId: string; /** * The OCID of an upstream OKE canary deployment stage in this pipeline. */ okeCanaryDeployStageId: string; /** * The OCID of an upstream OKE canary deployment traffic shift stage in this pipeline. */ okeCanaryTrafficShiftDeployStageId: string; /** * Kubernetes cluster environment OCID for deployment. */ okeClusterDeployEnvironmentId: string; /** * Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported. */ productionLoadBalancerConfigs: outputs.DevOps.GetDeployStagesDeployStageCollectionItemProductionLoadBalancerConfig[]; /** * The OCID of a project. */ projectId: string; /** * The purpose of running this Helm stage */ purpose: string; /** * Release name of the Helm chart. */ releaseName: string; /** * Specifies the rollback policy. This is initiated on the failure of certain stage types. */ rollbackPolicies: outputs.DevOps.GetDeployStagesDeployStageCollectionItemRollbackPolicy[]; /** * Description of rollout policy for load balancer traffic shift stage. */ rolloutPolicies: outputs.DevOps.GetDeployStagesDeployStageCollectionItemRolloutPolicy[]; /** * Specifies the name and value pairs to set helm values. */ setStrings: outputs.DevOps.GetDeployStagesDeployStageCollectionItemSetString[]; /** * Specifies the name and value pairs to set helm values. */ setValues: outputs.DevOps.GetDeployStagesDeployStageCollectionItemSetValue[]; /** * Allow deletion of new resources created during when an upgrade fails. Set to false by default. */ shouldCleanupOnFail: boolean; /** * Waits until all the resources are in a ready state to mark the release as successful. Set to false by default. */ shouldNotWait: boolean; /** * During upgrade, reset the values to the ones built into the chart. It overrides shouldReuseValues. Set to false by default. */ shouldResetValues: boolean; /** * During upgrade, reuse the values of the last release and merge overrides from the command line. Set to false by default. */ shouldReuseValues: boolean; /** * If set, no CRDs are installed. By default, CRDs are installed only if they are not present already. Set to false by default. */ shouldSkipCrds: boolean; /** * If set, renders subchart notes along with the parent. Set to false by default. */ shouldSkipRenderSubchartNotes: boolean; /** * A filter to return only deployment stages that matches the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Specifies config for load balancer traffic shift stages. The Load Balancer specified here should be an Application Load Balancer type. Network Load Balancers are not supported. */ testLoadBalancerConfigs: outputs.DevOps.GetDeployStagesDeployStageCollectionItemTestLoadBalancerConfig[]; /** * Time the deployment stage was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * Time the deployment stage was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; /** * Time to wait for execution of a Shell/Helm stage. Defaults to 36000 seconds for Shell and 300 seconds for Helm Stage */ timeoutInSeconds: number; /** * Specifies the target or destination backend set. */ trafficShiftTarget: string; /** * List of values.yaml file artifact OCIDs. */ valuesArtifactIds: string[]; /** * Specifies wait criteria for the Wait stage. */ waitCriterias: outputs.DevOps.GetDeployStagesDeployStageCollectionItemWaitCriteria[]; } interface GetDeployStagesDeployStageCollectionItemApprovalPolicy { /** * Approval policy type. */ approvalPolicyType: string; /** * A minimum number of approvals required for stage to proceed. */ numberOfApprovalsRequired: number; } interface GetDeployStagesDeployStageCollectionItemBlueBackendIp { /** * List of parameters defined to set helm value. */ items: string[]; } interface GetDeployStagesDeployStageCollectionItemBlueGreenStrategy { /** * Name of the Ingress resource. */ ingressName: string; /** * First Namespace for deployment. */ namespaceA: string; /** * Second Namespace for deployment. */ namespaceB: string; /** * Canary strategy type. */ strategyType: string; } interface GetDeployStagesDeployStageCollectionItemCanaryStrategy { /** * Name of the Ingress resource. */ ingressName: string; /** * Default Namespace to be used for Kubernetes deployment when not specified in the manifest. */ namespace: string; /** * Canary strategy type. */ strategyType: string; } interface GetDeployStagesDeployStageCollectionItemContainerConfig { /** * Availability domain where the ContainerInstance will be created. */ availabilityDomain: string; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Container configuration type. */ containerConfigType: string; /** * Specifies the configuration needed when the target Oracle Cloud Infrastructure resource, i.e., OKE cluster, resides in customer's private network. */ networkChannels: outputs.DevOps.GetDeployStagesDeployStageCollectionItemContainerConfigNetworkChannel[]; /** * Determines the size and amount of resources available to the instance. */ shapeConfigs: outputs.DevOps.GetDeployStagesDeployStageCollectionItemContainerConfigShapeConfig[]; /** * The shape of the ContainerInstance. The shape determines the resources available to the ContainerInstance. */ shapeName: string; } interface GetDeployStagesDeployStageCollectionItemContainerConfigNetworkChannel { /** * Network channel type. */ networkChannelType: string; /** * An array of network security group OCIDs. */ nsgIds: string[]; /** * The OCID of the subnet where VNIC resources will be created for private endpoint. */ subnetId: string; } interface GetDeployStagesDeployStageCollectionItemContainerConfigShapeConfig { /** * The total amount of memory available to the instance, in gigabytes. */ memoryInGbs: number; /** * The total number of OCPUs available to the instance. */ ocpus: number; } interface GetDeployStagesDeployStageCollectionItemDeployStagePredecessorCollection { /** * List of parameters defined to set helm value. */ items: outputs.DevOps.GetDeployStagesDeployStageCollectionItemDeployStagePredecessorCollectionItem[]; } interface GetDeployStagesDeployStageCollectionItemDeployStagePredecessorCollectionItem { /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; } interface GetDeployStagesDeployStageCollectionItemFailurePolicy { /** * The threshold count of failed instances in the group, which when reached or exceeded sets the stage as FAILED. */ failureCount: number; /** * The failure percentage threshold, which when reached or exceeded sets the stage as FAILED. Percentage is computed as the ceiling value of the number of failed instances over the total count of the instances in the group. */ failurePercentage: number; /** * The type of policy used for rolling out a deployment stage. */ policyType: string; } interface GetDeployStagesDeployStageCollectionItemGreenBackendIp { /** * List of parameters defined to set helm value. */ items: string[]; } interface GetDeployStagesDeployStageCollectionItemLoadBalancerConfig { /** * Listen port for the backend server. */ backendPort: number; /** * Name of the load balancer listener. */ listenerName: string; /** * The OCID of the load balancer. */ loadBalancerId: string; /** * A filter to return only deployment stages that matches the given lifecycle state. */ state: string; } interface GetDeployStagesDeployStageCollectionItemProductionLoadBalancerConfig { /** * Listen port for the backend server. */ backendPort: number; /** * Name of the load balancer listener. */ listenerName: string; /** * The OCID of the load balancer. */ loadBalancerId: string; /** * A filter to return only deployment stages that matches the given lifecycle state. */ state: string; } interface GetDeployStagesDeployStageCollectionItemRollbackPolicy { /** * The type of policy used for rolling out a deployment stage. */ policyType: string; } interface GetDeployStagesDeployStageCollectionItemRolloutPolicy { /** * The number that will be used to determine how many instances will be deployed concurrently. */ batchCount: number; /** * The duration of delay between batch rollout. The default delay is 1 minute. */ batchDelayInSeconds: number; /** * The percentage that will be used to determine how many instances will be deployed concurrently. */ batchPercentage: number; /** * The type of policy used for rolling out a deployment stage. */ policyType: string; /** * Indicates the criteria to stop. */ rampLimitPercent: number; } interface GetDeployStagesDeployStageCollectionItemSetString { /** * List of parameters defined to set helm value. */ items: outputs.DevOps.GetDeployStagesDeployStageCollectionItemSetStringItem[]; } interface GetDeployStagesDeployStageCollectionItemSetStringItem { /** * Name of the parameter (case-sensitive). */ name: string; /** * Value of the parameter. */ value: string; } interface GetDeployStagesDeployStageCollectionItemSetValue { /** * List of parameters defined to set helm value. */ items: outputs.DevOps.GetDeployStagesDeployStageCollectionItemSetValueItem[]; } interface GetDeployStagesDeployStageCollectionItemSetValueItem { /** * Name of the parameter (case-sensitive). */ name: string; /** * Value of the parameter. */ value: string; } interface GetDeployStagesDeployStageCollectionItemTestLoadBalancerConfig { /** * Listen port for the backend server. */ backendPort: number; /** * Name of the load balancer listener. */ listenerName: string; /** * The OCID of the load balancer. */ loadBalancerId: string; /** * A filter to return only deployment stages that matches the given lifecycle state. */ state: string; } interface GetDeployStagesDeployStageCollectionItemWaitCriteria { /** * The absolute wait duration. An ISO 8601 formatted duration string. Minimum waitDuration should be 5 seconds. Maximum waitDuration can be up to 2 days. */ waitDuration: string; /** * Wait criteria type. */ waitType: string; } interface GetDeployStagesFilter { /** * Name of the parameter (case-sensitive). */ name: string; regex?: boolean; values: string[]; } interface GetDeploymentDeployArtifactOverrideArgument { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentDeployArtifactOverrideArgumentItem[]; } interface GetDeploymentDeployArtifactOverrideArgumentItem { /** * The OCID of an artifact */ deployArtifactId: string; /** * Name of the step. */ name: string; /** * value of the argument. */ value: string; } interface GetDeploymentDeployPipelineArtifact { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentDeployPipelineArtifactItem[]; } interface GetDeploymentDeployPipelineArtifactItem { /** * The OCID of an artifact */ deployArtifactId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.GetDeploymentDeployPipelineArtifactItemDeployPipelineStage[]; /** * Deployment identifier which can be renamed and is not necessarily unique. Avoid entering confidential information. */ displayName: string; } interface GetDeploymentDeployPipelineArtifactItemDeployPipelineStage { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentDeployPipelineArtifactItemDeployPipelineStageItem[]; } interface GetDeploymentDeployPipelineArtifactItemDeployPipelineStageItem { /** * The OCID of the stage. */ deployStageId: string; /** * Deployment identifier which can be renamed and is not necessarily unique. Avoid entering confidential information. */ displayName: string; } interface GetDeploymentDeployPipelineEnvironment { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentDeployPipelineEnvironmentItem[]; } interface GetDeploymentDeployPipelineEnvironmentItem { /** * The OCID of an Environment */ deployEnvironmentId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.GetDeploymentDeployPipelineEnvironmentItemDeployPipelineStage[]; /** * Deployment identifier which can be renamed and is not necessarily unique. Avoid entering confidential information. */ displayName: string; } interface GetDeploymentDeployPipelineEnvironmentItemDeployPipelineStage { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentDeployPipelineEnvironmentItemDeployPipelineStageItem[]; } interface GetDeploymentDeployPipelineEnvironmentItemDeployPipelineStageItem { /** * The OCID of the stage. */ deployStageId: string; /** * Deployment identifier which can be renamed and is not necessarily unique. Avoid entering confidential information. */ displayName: string; } interface GetDeploymentDeployStageOverrideArgument { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentDeployStageOverrideArgumentItem[]; } interface GetDeploymentDeployStageOverrideArgumentItem { /** * The OCID of the stage. */ deployStageId: string; /** * Name of the step. */ name: string; /** * value of the argument. */ value: string; } interface GetDeploymentDeploymentArgument { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentDeploymentArgumentItem[]; } interface GetDeploymentDeploymentArgumentItem { /** * Name of the step. */ name: string; /** * value of the argument. */ value: string; } interface GetDeploymentDeploymentExecutionProgress { /** * Map of stage OCIDs to deploy stage execution progress model. */ deployStageExecutionProgress: { [key: string]: string; }; /** * Time the deployment is finished. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeFinished: string; /** * Time the deployment is started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeStarted: string; } interface GetDeploymentsDeploymentCollection { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentsDeploymentCollectionItem[]; } interface GetDeploymentsDeploymentCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Specifies the list of artifact override arguments at the time of deployment. */ deployArtifactOverrideArguments: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployArtifactOverrideArgument[]; /** * List of all artifacts used in the pipeline. */ deployPipelineArtifacts: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployPipelineArtifact[]; /** * List of all environments used in the pipeline. */ deployPipelineEnvironments: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployPipelineEnvironment[]; /** * The ID of the parent pipeline. */ deployPipelineId: string; /** * The OCID of the stage. */ deployStageId: string; /** * Specifies the list of arguments to be overriden per Stage at the time of deployment. */ deployStageOverrideArguments: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployStageOverrideArgument[]; /** * Specifies list of arguments passed along with the deployment. */ deploymentArguments: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeploymentArgument[]; /** * The execution progress details of a deployment. */ deploymentExecutionProgresses: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeploymentExecutionProgress[]; /** * Specifies type of Deployment */ deploymentType: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Specifies the OCID of the previous deployment to be redeployed. */ previousDeploymentId: string; /** * unique project identifier */ projectId: string; /** * A filter to return only Deployments that matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time the deployment was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * Time the deployment was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; triggerNewDevopsDeployment: boolean; } interface GetDeploymentsDeploymentCollectionItemDeployArtifactOverrideArgument { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployArtifactOverrideArgumentItem[]; } interface GetDeploymentsDeploymentCollectionItemDeployArtifactOverrideArgumentItem { /** * The OCID of an artifact */ deployArtifactId: string; /** * Name of the step. */ name: string; /** * value of the argument. */ value: string; } interface GetDeploymentsDeploymentCollectionItemDeployPipelineArtifact { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployPipelineArtifactItem[]; } interface GetDeploymentsDeploymentCollectionItemDeployPipelineArtifactItem { /** * The OCID of an artifact */ deployArtifactId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployPipelineArtifactItemDeployPipelineStage[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; } interface GetDeploymentsDeploymentCollectionItemDeployPipelineArtifactItemDeployPipelineStage { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployPipelineArtifactItemDeployPipelineStageItem[]; } interface GetDeploymentsDeploymentCollectionItemDeployPipelineArtifactItemDeployPipelineStageItem { /** * The OCID of the stage. */ deployStageId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; } interface GetDeploymentsDeploymentCollectionItemDeployPipelineEnvironment { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployPipelineEnvironmentItem[]; } interface GetDeploymentsDeploymentCollectionItemDeployPipelineEnvironmentItem { /** * The OCID of an Environment */ deployEnvironmentId: string; /** * List of stages. */ deployPipelineStages: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployPipelineEnvironmentItemDeployPipelineStage[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; } interface GetDeploymentsDeploymentCollectionItemDeployPipelineEnvironmentItemDeployPipelineStage { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployPipelineEnvironmentItemDeployPipelineStageItem[]; } interface GetDeploymentsDeploymentCollectionItemDeployPipelineEnvironmentItemDeployPipelineStageItem { /** * The OCID of the stage. */ deployStageId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; } interface GetDeploymentsDeploymentCollectionItemDeployStageOverrideArgument { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeployStageOverrideArgumentItem[]; } interface GetDeploymentsDeploymentCollectionItemDeployStageOverrideArgumentItem { /** * The OCID of the stage. */ deployStageId: string; /** * Name of the step. */ name: string; /** * value of the argument. */ value: string; } interface GetDeploymentsDeploymentCollectionItemDeploymentArgument { /** * A list of stage predecessors for a stage. */ items: outputs.DevOps.GetDeploymentsDeploymentCollectionItemDeploymentArgumentItem[]; } interface GetDeploymentsDeploymentCollectionItemDeploymentArgumentItem { /** * Name of the step. */ name: string; /** * value of the argument. */ value: string; } interface GetDeploymentsDeploymentCollectionItemDeploymentExecutionProgress { /** * Map of stage OCIDs to deploy stage execution progress model. */ deployStageExecutionProgress: { [key: string]: string; }; /** * Time the deployment is finished. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeFinished: string; /** * Time the deployment is started. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeStarted: string; } interface GetDeploymentsFilter { /** * Name of the step. */ name: string; regex?: boolean; values: string[]; } interface GetProjectNotificationConfig { /** * The topic ID for notifications. */ topicId: string; } interface GetProjectRepositorySettingApprovalRule { /** * List of approval rules. */ items: outputs.DevOps.GetProjectRepositorySettingApprovalRuleItem[]; } interface GetProjectRepositorySettingApprovalRuleItem { /** * Branch name where pull requests targeting the branch must satisfy the approval rule. This value being null means the rule applies to all pull requests */ destinationBranch: string; /** * Minimum number of approvals which must be provided by the reviewers specified in the list before the rule can be satisfied */ minApprovalsCount: number; /** * Name which is used to uniquely identify an approval rule. */ name: string; /** * List of users who must provide approvals up to the minApprovalsCount specified in the rule. An empty list means the approvals can come from any user. */ reviewers: outputs.DevOps.GetProjectRepositorySettingApprovalRuleItemReviewer[]; } interface GetProjectRepositorySettingApprovalRuleItemReviewer { /** * the OCID of the principal */ principalId: string; /** * the name of the principal */ principalName: string; /** * The state of the principal, it can be active or inactive or suppressed for emails */ principalState: string; /** * the type of principal */ principalType: string; } interface GetProjectRepositorySettingMergeSetting { /** * List of merge strategies which are allowed for a Project or Repository. */ allowedMergeStrategies: string[]; /** * Default type of merge strategy associated with the a Project or Repository. */ defaultMergeStrategy: string; } interface GetProjectsFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetProjectsProjectCollection { items: outputs.DevOps.GetProjectsProjectCollectionItem[]; } interface GetProjectsProjectCollectionItem { /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Project description. */ description: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single resource by ID. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter to return only resources that match the entire name given. */ name: string; /** * Namespace associated with the project. */ namespace: string; /** * Notification configuration for the project. */ notificationConfigs: outputs.DevOps.GetProjectsProjectCollectionItemNotificationConfig[]; /** * A filter to return only Projects that matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time the project was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * Time the project was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; } interface GetProjectsProjectCollectionItemNotificationConfig { /** * The topic ID for notifications. */ topicId: string; } interface GetRepoFileLineLine { /** * The content of the line. */ lineContent: string; /** * The line number. */ lineNumber: number; } interface GetRepositoriesFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetRepositoriesRepositoryCollection { items: outputs.DevOps.GetRepositoriesRepositoryCollectionItem[]; } interface GetRepositoriesRepositoryCollectionItem { /** * The count of the branches present in the repository. */ branchCount: number; /** * The count of the commits present in the repository. */ commitCount: number; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; /** * The default branch of the repository. */ defaultBranch: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Details of the repository. Avoid entering confidential information. */ description: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * HTTP URL that you use to git clone, pull and push. */ httpUrl: string; /** * The OCID of the repository. This value is unique and immutable. */ id: string; lifecycleDetails: string; /** * Configuration information for mirroring the repository. */ mirrorRepositoryConfig: outputs.DevOps.GetRepositoriesRepositoryCollectionItemMirrorRepositoryConfig; /** * A filter to return only resources that match the entire name given. */ name: string; /** * Tenancy unique namespace. */ namespace: string; /** * The OCID of the parent repository. */ parentRepositoryId: string; /** * unique project identifier */ projectId: string; /** * Unique project name in a namespace. */ projectName: string; /** * Type of repository: MIRRORED - Repository created by mirroring an existing repository. HOSTED - Repository created and hosted using Oracle Cloud Infrastructure DevOps code repository. FORKED - Repository created by forking an existing repository. */ repositoryType: string; /** * The size of the repository in bytes. */ sizeInBytes: string; /** * SSH URL that you use to git clone, pull and push. */ sshUrl: string; /** * A filter to return only resources whose lifecycle state matches the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the repository was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * The time the repository was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; /** * Trigger build events supported for this repository: PUSH - Build is triggered when a push event occurs. PULL_REQUEST_CREATED - Build is triggered when a pull request is created in the repository. PULL_REQUEST_UPDATED - Build is triggered when a push is made to a branch with an open pull request. COMMIT_UPDATES - Build is triggered when new commits are mirrored into a repository. */ triggerBuildEvents: string[]; } interface GetRepositoriesRepositoryCollectionItemMirrorRepositoryConfig { /** * Upstream git repository connection identifier. */ connectorId: string; /** * URL of external repository you want to mirror. */ repositoryUrl: string; /** * Specifies a trigger schedule. Timing information for when to initiate automated syncs. */ triggerSchedule: outputs.DevOps.GetRepositoriesRepositoryCollectionItemMirrorRepositoryConfigTriggerSchedule; } interface GetRepositoriesRepositoryCollectionItemMirrorRepositoryConfigTriggerSchedule { /** * Valid if type is CUSTOM. Following RFC 5545 recurrence rules, we can specify starting time, occurrence frequency, and interval size. Example for frequency could be DAILY/WEEKLY/HOURLY or any RFC 5545 supported frequency, which is followed by start time of this window. You can control the start time with BYHOUR, BYMINUTE and BYSECONDS. It is followed by the interval size. */ customSchedule: string; /** * Different types of trigger schedule: NONE - No automated synchronization schedule. DEFAULT - Trigger schedule is every 30 minutes. CUSTOM - Custom triggering schedule. */ scheduleType: string; } interface GetRepositoryAuthorItem { /** * Author name. */ authorName: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; } interface GetRepositoryAuthorsFilter { name: string; regex?: boolean; values: string[]; } interface GetRepositoryAuthorsRepositoryAuthorCollection { /** * List of author objects. */ items: outputs.DevOps.GetRepositoryAuthorsRepositoryAuthorCollectionItem[]; } interface GetRepositoryAuthorsRepositoryAuthorCollectionItem { /** * Author name. */ authorName: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetRepositoryCommitsFilter { name: string; regex?: boolean; values: string[]; } interface GetRepositoryCommitsRepositoryCommitCollection { items: outputs.DevOps.GetRepositoryCommitsRepositoryCommitCollectionItem[]; } interface GetRepositoryCommitsRepositoryCommitCollectionItem { /** * Email of the author of the repository. */ authorEmail: string; /** * A filter to return any commits that are pushed by the requested author. */ authorName: string; /** * Commit hash pointed to by reference name. */ commitId: string; /** * A filter to return any commits that contains the given message. */ commitMessage: string; /** * Email of who creates the commit. */ committerEmail: string; /** * Name of who creates the commit. */ committerName: string; definedTags: { [key: string]: string; }; freeformTags: { [key: string]: string; }; /** * An array of parent commit IDs of created commit. */ parentCommitIds: string[]; /** * The time at which commit was created. */ timeCreated: string; /** * Tree information for the specified commit. */ treeId: string; } interface GetRepositoryDiffChange { /** * The number of a line in the base version. */ baseLine: number; /** * Number of lines chunk spans in base version. */ baseSpan: number; /** * List of difference section. */ diffSections: outputs.DevOps.GetRepositoryDiffChangeDiffSection[]; /** * Line number in target version where changes begin. */ targetLine: number; /** * Number of lines chunk spans in target version. */ targetSpan: number; } interface GetRepositoryDiffChangeDiffSection { /** * The lines within changed section. */ lines: outputs.DevOps.GetRepositoryDiffChangeDiffSectionLine[]; /** * Type of change. */ type: string; } interface GetRepositoryDiffChangeDiffSectionLine { /** * The number of a line in the base version. */ baseLine: number; /** * Indicates whether a line in a conflicted section of the difference is from the base version, the target version, or if its just a marker indicating the beginning, middle, or end of a conflicted section. */ conflictMarker: string; /** * The contents of a line. */ lineContent: string; /** * Line number in target version where changes begin. */ targetLine: number; } interface GetRepositoryDiffsDiffCollection { items: outputs.DevOps.GetRepositoryDiffsDiffCollectionItem[]; } interface GetRepositoryDiffsDiffCollectionItem { /** * Indicates whether the changed file contains conflicts. */ areConflictsInFile: boolean; /** * List of changed section in the file. */ changes: outputs.DevOps.GetRepositoryDiffsDiffCollectionItemChange[]; freeformTags: { [key: string]: string; }; /** * Indicates whether the file is binary. */ isBinary: boolean; /** * Indicates whether the file is large. */ isLarge: boolean; /** * The ID of the changed object on the target version. */ newId: string; /** * The path on the target version to the changed object. */ newPath: string; /** * The ID of the changed object on the base version. */ oldId: string; /** * The path on the base version to the changed object. */ oldPath: string; } interface GetRepositoryDiffsDiffCollectionItemChange { /** * The number of a line in the base version. */ baseLine: number; /** * Number of lines chunk spans in base version. */ baseSpan: number; /** * List of difference section. */ diffSections: outputs.DevOps.GetRepositoryDiffsDiffCollectionItemChangeDiffSection[]; /** * Line number in target version where changes begin. */ targetLine: number; /** * Number of lines chunk spans in target version. */ targetSpan: number; } interface GetRepositoryDiffsDiffCollectionItemChangeDiffSection { /** * The lines within changed section. */ lines: outputs.DevOps.GetRepositoryDiffsDiffCollectionItemChangeDiffSectionLine[]; /** * Type of change. */ type: string; } interface GetRepositoryDiffsDiffCollectionItemChangeDiffSectionLine { /** * The number of a line in the base version. */ baseLine: number; /** * Indicates whether a line in a conflicted section of the difference is from the base version, the target version, or if its just a marker indicating the beginning, middle, or end of a conflicted section. */ conflictMarker: string; /** * The contents of a line. */ lineContent: string; /** * Line number in target version where changes begin. */ targetLine: number; } interface GetRepositoryDiffsFilter { name: string; regex?: boolean; values: string[]; } interface GetRepositoryFileDiffChange { /** * The number of a line in the base version. */ baseLine: number; /** * Number of lines chunk spans in base version. */ baseSpan: number; /** * List of difference section. */ diffSections: outputs.DevOps.GetRepositoryFileDiffChangeDiffSection[]; /** * Line number in target version where changes begin. */ targetLine: number; /** * Number of lines chunk spans in target version. */ targetSpan: number; } interface GetRepositoryFileDiffChangeDiffSection { /** * The lines within changed section. */ lines: outputs.DevOps.GetRepositoryFileDiffChangeDiffSectionLine[]; /** * Type of change. */ type: string; } interface GetRepositoryFileDiffChangeDiffSectionLine { /** * The number of a line in the base version. */ baseLine: number; /** * Indicates whether a line in a conflicted section of the difference is from the base version, the target version, or if its just a marker indicating the beginning, middle, or end of a conflicted section. */ conflictMarker: string; /** * The contents of a line. */ lineContent: string; /** * Line number in target version where changes begin. */ targetLine: number; } interface GetRepositoryFileLineLine { /** * The content of the line. */ lineContent: string; /** * The line number. */ lineNumber: number; } interface GetRepositoryMirrorRecordsFilter { name: string; regex?: boolean; values: string[]; } interface GetRepositoryMirrorRecordsRepositoryMirrorRecordCollection { items: outputs.DevOps.GetRepositoryMirrorRecordsRepositoryMirrorRecordCollectionItem[]; } interface GetRepositoryMirrorRecordsRepositoryMirrorRecordCollectionItem { freeformTags: { [key: string]: string; }; /** * Mirror status of current mirror entry. QUEUED - Mirroring Queued RUNNING - Mirroring is Running PASSED - Mirroring Passed FAILED - Mirroring Failed */ mirrorStatus: string; timeCompleted: string; /** * The time to enqueue a mirror operation. */ timeEnqueued: string; /** * The time to start a mirror operation. */ timeStarted: string; /** * Workrequest ID to track current mirror operation. */ workRequestId: string; } interface GetRepositoryMirrorRepositoryConfig { /** * Upstream git repository connection identifier. */ connectorId: string; /** * URL of external repository you want to mirror. */ repositoryUrl: string; /** * Specifies a trigger schedule. Timing information for when to initiate automated syncs. */ triggerSchedules: outputs.DevOps.GetRepositoryMirrorRepositoryConfigTriggerSchedule[]; } interface GetRepositoryMirrorRepositoryConfigTriggerSchedule { /** * Valid if type is CUSTOM. Following RFC 5545 recurrence rules, we can specify starting time, occurrence frequency, and interval size. Example for frequency could be DAILY/WEEKLY/HOURLY or any RFC 5545 supported frequency, which is followed by start time of this window. You can control the start time with BYHOUR, BYMINUTE and BYSECONDS. It is followed by the interval size. */ customSchedule: string; /** * Different types of trigger schedule: NONE - No automated synchronization schedule. DEFAULT - Trigger schedule is every 30 minutes. CUSTOM - Custom triggering schedule. */ scheduleType: string; } interface GetRepositoryPathItem { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Name of file or directory. */ name: string; /** * Path to file or directory in a repository. */ path: string; /** * SHA-1 checksum of blob or tree. */ sha: string; /** * Size of file or directory. */ sizeInBytes: string; /** * The git URL of the submodule. */ submoduleGitUrl: string; /** * File or directory. */ type: string; } interface GetRepositoryPathsFilter { /** * Name of file or directory. */ name: string; regex?: boolean; values: string[]; } interface GetRepositoryPathsRepositoryPathCollection { /** * List of objects describing files or directories in a repository. */ items: outputs.DevOps.GetRepositoryPathsRepositoryPathCollectionItem[]; } interface GetRepositoryPathsRepositoryPathCollectionItem { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Name of file or directory. */ name: string; /** * Path to file or directory in a repository. */ path: string; /** * SHA-1 checksum of blob or tree. */ sha: string; /** * Size of file or directory. */ sizeInBytes: string; /** * The git URL of the submodule. */ submoduleGitUrl: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * File or directory. */ type: string; } interface GetRepositoryProtectedBranchesFilter { /** * A filter to return only resources that match the given branch name. */ name: string; regex?: boolean; values: string[]; } interface GetRepositoryProtectedBranchesProtectedBranchCollection { /** * List of objects describing protected branches */ items: outputs.DevOps.GetRepositoryProtectedBranchesProtectedBranchCollectionItem[]; } interface GetRepositoryProtectedBranchesProtectedBranchCollectionItem { /** * Branch name inside a repository. */ branchName: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Protection level to be added on the branch. */ protectionLevels: string[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetRepositoryRefsFilter { name: string; regex?: boolean; values: string[]; } interface GetRepositoryRefsRepositoryRefCollection { items: outputs.DevOps.GetRepositoryRefsRepositoryRefCollectionItem[]; } interface GetRepositoryRefsRepositoryRefCollectionItem { /** * Commit ID in a repository. */ commitId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique full reference name inside a repository. */ fullRefName: string; id: string; /** * SHA-1 hash value of the object pointed to by the tag. */ objectId: string; /** * A filter to return only resources that match the given reference name. */ refName: string; /** * Reference type to distinguish between branch and tag. If it is not specified, all references are returned. */ refType: string; /** * Unique repository identifier. */ repositoryId: string; } interface GetRepositorySettingApprovalRule { /** * List of approval rules. */ items: outputs.DevOps.GetRepositorySettingApprovalRuleItem[]; } interface GetRepositorySettingApprovalRuleItem { /** * Branch name where pull requests targeting the branch must satisfy the approval rule. This value being null means the rule applies to all pull requests */ destinationBranch: string; /** * Minimum number of approvals which must be provided by the reviewers specified in the list before the rule can be satisfied */ minApprovalsCount: number; /** * Name which is used to uniquely identify an approval rule. */ name: string; /** * List of users who must provide approvals up to the minApprovalsCount specified in the rule. An empty list means the approvals can come from any user. */ reviewers: outputs.DevOps.GetRepositorySettingApprovalRuleItemReviewer[]; } interface GetRepositorySettingApprovalRuleItemReviewer { /** * the OCID of the principal */ principalId: string; /** * the name of the principal */ principalName: string; /** * The state of the principal, it can be active or inactive or suppressed for emails */ principalState: string; /** * the type of principal */ principalType: string; } interface GetRepositorySettingMergeCheck { /** * Indicates whether or not a pull request must have a successful build run and no queued builds before it can be merged */ lastBuildSucceeded: string; } interface GetRepositorySettingMergeSetting { /** * List of merge strategies which are allowed for a Project or Repository. */ allowedMergeStrategies: string[]; /** * Default type of merge strategy associated with the a Project or Repository. */ defaultMergeStrategy: string; } interface GetTriggerAction { /** * The OCID of the build pipeline to be triggered. */ buildPipelineId: string; filters: outputs.DevOps.GetTriggerActionFilter[]; /** * The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE. */ type: string; } interface GetTriggerActionFilter { /** * The events, for example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED. */ events: string[]; /** * Attributes to filter GitLab self-hosted server events. File filter criteria - Changes only affecting excluded files will not invoke a build. if both include and exclude filter are used then exclusion filter will be applied on the result set of inclusion filter. */ excludes: outputs.DevOps.GetTriggerActionFilterExclude[]; /** * Attributes to filter GitLab self-hosted server events. */ includes: outputs.DevOps.GetTriggerActionFilterInclude[]; /** * Source of the trigger. Allowed values are, GITHUB and GITLAB. */ triggerSource: string; } interface GetTriggerActionFilterExclude { /** * Attributes to support include/exclude files for triggering build runs. */ fileFilters: outputs.DevOps.GetTriggerActionFilterExcludeFileFilter[]; } interface GetTriggerActionFilterExcludeFileFilter { /** * The file paths/glob pattern for files. */ filePaths: string[]; } interface GetTriggerActionFilterInclude { /** * The target branch for pull requests; not applicable for push requests. */ baseRef: string; /** * Attributes to support include/exclude files for triggering build runs. */ fileFilters: outputs.DevOps.GetTriggerActionFilterIncludeFileFilter[]; /** * Branch for push event; source branch for pull requests. */ headRef: string; /** * The repository name for trigger events. */ repositoryName: string; } interface GetTriggerActionFilterIncludeFileFilter { /** * The file paths/glob pattern for files. */ filePaths: string[]; } interface GetTriggersFilter { name: string; regex?: boolean; values: string[]; } interface GetTriggersTriggerCollection { items: outputs.DevOps.GetTriggersTriggerCollectionItem[]; } interface GetTriggersTriggerCollectionItem { /** * The list of actions that are to be performed for this trigger. */ actions: outputs.DevOps.GetTriggersTriggerCollectionItemAction[]; /** * The OCID of the compartment in which to list resources. */ compartmentId: string; connectionId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description about the trigger. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique trigger identifier. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * unique project identifier */ projectId: string; /** * The OCID of the DevOps code repository. */ repositoryId: string; /** * A filter to return only triggers that matches the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the trigger was created. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeCreated: string; /** * The time the trigger was updated. Format defined by [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339). */ timeUpdated: string; /** * Source of the trigger. Allowed values are, GITHUB and GITLAB. */ triggerSource: string; /** * The endpoint that listens to trigger events. */ triggerUrl: string; } interface GetTriggersTriggerCollectionItemAction { /** * The OCID of the build pipeline to be triggered. */ buildPipelineId: string; filters: outputs.DevOps.GetTriggersTriggerCollectionItemActionFilter[]; /** * The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE. */ type: string; } interface GetTriggersTriggerCollectionItemActionFilter { /** * The events, for example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED. */ events: string[]; /** * Attributes to filter GitLab self-hosted server events. File filter criteria - Changes only affecting excluded files will not invoke a build. if both include and exclude filter are used then exclusion filter will be applied on the result set of inclusion filter. */ excludes: outputs.DevOps.GetTriggersTriggerCollectionItemActionFilterExclude[]; /** * Attributes to filter GitLab self-hosted server events. */ includes: outputs.DevOps.GetTriggersTriggerCollectionItemActionFilterInclude[]; /** * Source of the trigger. Allowed values are, GITHUB and GITLAB. */ triggerSource: string; } interface GetTriggersTriggerCollectionItemActionFilterExclude { /** * Attributes to support include/exclude files for triggering build runs. */ fileFilters: outputs.DevOps.GetTriggersTriggerCollectionItemActionFilterExcludeFileFilter[]; } interface GetTriggersTriggerCollectionItemActionFilterExcludeFileFilter { /** * The file paths/glob pattern for files. */ filePaths: string[]; } interface GetTriggersTriggerCollectionItemActionFilterInclude { /** * The target branch for pull requests; not applicable for push requests. */ baseRef: string; /** * Attributes to support include/exclude files for triggering build runs. */ fileFilters: outputs.DevOps.GetTriggersTriggerCollectionItemActionFilterIncludeFileFilter[]; /** * Branch for push event; source branch for pull requests. */ headRef: string; /** * The repository name for trigger events. */ repositoryName: string; } interface GetTriggersTriggerCollectionItemActionFilterIncludeFileFilter { /** * The file paths/glob pattern for files. */ filePaths: string[]; } interface ProjectNotificationConfig { /** * (Updatable) The topic ID for notifications. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ topicId: string; } interface ProjectRepositorySettingApprovalRules { /** * (Updatable) List of approval rules. */ items: outputs.DevOps.ProjectRepositorySettingApprovalRulesItem[]; } interface ProjectRepositorySettingApprovalRulesItem { /** * (Updatable) Branch name where pull requests targeting the branch must satisfy the approval rule. This value being null means the rule applies to all pull requests */ destinationBranch: string; /** * (Updatable) Minimum number of approvals which must be provided by the reviewers specified in the list before the rule can be satisfied */ minApprovalsCount: number; /** * (Updatable) Name which is used to uniquely identify an approval rule. */ name: string; /** * (Updatable) List of users who must provide approvals up to the minApprovalsCount specified in the rule. An empty list means the approvals can come from any user. */ reviewers: outputs.DevOps.ProjectRepositorySettingApprovalRulesItemReviewer[]; } interface ProjectRepositorySettingApprovalRulesItemReviewer { /** * (Updatable) Pull Request reviewer id */ principalId: string; /** * the name of the principal */ principalName: string; /** * The state of the principal, it can be active or inactive or suppressed for emails */ principalState: string; /** * the type of principal */ principalType: string; } interface ProjectRepositorySettingMergeSettings { /** * (Updatable) List of merge strategies which are allowed for a Project or Repository. */ allowedMergeStrategies: string[]; /** * (Updatable) Default type of merge strategy associated with the a Project or Repository. */ defaultMergeStrategy: string; } interface RepositoryMirrorRepositoryConfig { /** * (Updatable) Upstream git repository connection identifier. */ connectorId: string; /** * (Updatable) URL of external repository you want to mirror. */ repositoryUrl: string; /** * (Updatable) Specifies a trigger schedule. Timing information for when to initiate automated syncs. */ triggerSchedule: outputs.DevOps.RepositoryMirrorRepositoryConfigTriggerSchedule; } interface RepositoryMirrorRepositoryConfigTriggerSchedule { /** * (Updatable) Valid if type is CUSTOM. Following RFC 5545 recurrence rules, we can specify starting time, occurrence frequency, and interval size. Example for frequency could be DAILY/WEEKLY/HOURLY or any RFC 5545 supported frequency, which is followed by start time of this window. You can control the start time with BYHOUR, BYMINUTE and BYSECONDS. It is followed by the interval size. */ customSchedule: string; /** * (Updatable) Different types of trigger schedule: NONE - No automated synchronization schedule. DEFAULT - Trigger schedule is every 30 minutes. CUSTOM - Custom triggering schedule. */ scheduleType: string; } interface RepositorySettingApprovalRules { /** * (Updatable) List of approval rules. */ items: outputs.DevOps.RepositorySettingApprovalRulesItem[]; } interface RepositorySettingApprovalRulesItem { /** * (Updatable) Branch name where pull requests targeting the branch must satisfy the approval rule. This value being null means the rule applies to all pull requests */ destinationBranch: string; /** * (Updatable) Minimum number of approvals which must be provided by the reviewers specified in the list before the rule can be satisfied */ minApprovalsCount: number; /** * (Updatable) Name which is used to uniquely identify an approval rule. */ name: string; /** * (Updatable) List of users who must provide approvals up to the minApprovalsCount specified in the rule. An empty list means the approvals can come from any user. */ reviewers: outputs.DevOps.RepositorySettingApprovalRulesItemReviewer[]; } interface RepositorySettingApprovalRulesItemReviewer { /** * (Updatable) Pull Request reviewer id */ principalId: string; /** * the name of the principal */ principalName: string; /** * The state of the principal, it can be active or inactive or suppressed for emails */ principalState: string; /** * the type of principal */ principalType: string; } interface RepositorySettingMergeChecks { /** * (Updatable) Indicates whether or not a pull request must have a successful build run and no queued builds before it can be merged */ lastBuildSucceeded: string; } interface RepositorySettingMergeSettings { /** * (Updatable) List of merge strategies which are allowed for a Project or Repository. */ allowedMergeStrategies: string[]; /** * (Updatable) Default type of merge strategy associated with the a Project or Repository. */ defaultMergeStrategy: string; } interface TriggerAction { /** * (Updatable) The OCID of the build pipeline to be triggered. */ buildPipelineId: string; filter: outputs.DevOps.TriggerActionFilter; /** * (Updatable) The type of action that will be taken. Allowed value is TRIGGER_BUILD_PIPELINE. */ type: string; } interface TriggerActionFilter { /** * The events, for example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED. */ events: string[]; /** * Attributes to filter GitLab self-hosted server events. File filter criteria - Changes only affecting excluded files will not invoke a build. if both include and exclude filter are used then exclusion filter will be applied on the result set of inclusion filter. */ exclude: outputs.DevOps.TriggerActionFilterExclude; /** * Attributes to filter GitLab self-hosted server events. */ include: outputs.DevOps.TriggerActionFilterInclude; /** * (Updatable) Source of the trigger. Allowed values are, GITHUB, GITLAB, BITBUCKET_CLOUD, VBS and DEVOPS_CODE_REPOSITORY. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ triggerSource: string; } interface TriggerActionFilterExclude { /** * Attributes to support include/exclude files for triggering build runs. */ fileFilter: outputs.DevOps.TriggerActionFilterExcludeFileFilter; } interface TriggerActionFilterExcludeFileFilter { /** * The file paths/glob pattern for files. */ filePaths: string[]; } interface TriggerActionFilterInclude { /** * The target branch for pull requests; not applicable for push requests. */ baseRef: string; /** * Attributes to support include/exclude files for triggering build runs. */ fileFilter: outputs.DevOps.TriggerActionFilterIncludeFileFilter; /** * Branch for push event; source branch for pull requests. */ headRef: string; /** * The repository name for trigger events. */ repositoryName: string; } interface TriggerActionFilterIncludeFileFilter { /** * The file paths/glob pattern for files. */ filePaths: string[]; } } export declare namespace DisasterRecovery { interface AutomaticDrConfigurationMember { /** * (Updatable) A flag indicating if the automatic failover should be enabled for the Autonomous Database Serverless member in the Automatic DR configuration. Example: `false` */ isAutoFailoverEnabled: boolean; /** * (Updatable) A flag indicating if the automatic switchover should be enabled for the Autonomous Database Serverless member in the Automatic DR configuration. Example: `false` */ isAutoSwitchoverEnabled: boolean; /** * (Updatable) The OCID of the member. Example: `ocid1.database.oc1..uniqueID` */ memberId: string; /** * (Updatable) The type of the member. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ memberType: string; } interface DrPlanExecutionAutomaticExecutionDetail { /** * The name of the Oracle Cloud Infrastructure event that started the automatic DR plan execution. Example: `SwitchoverAutonomousDatabase` */ eventName: string; /** * The OCID of the member that emitted the event that started the automatic DR plan execution. Example: "ocid1.autonomousdatabase.oc1..uniqueID" */ memberId: string; } interface DrPlanExecutionExecutionOptions { /** * A flag indicating whether prechecks should be executed before the plan execution. Example: `false` */ arePrechecksEnabled: boolean; /** * A flag indicating whether warnings should be ignored during the switchover precheck. Example: `true` */ areWarningsIgnored: boolean; /** * The type of the plan execution. */ planExecutionType: string; } interface DrPlanExecutionGroupExecution { /** * (Updatable) The display name of the DR plan execution. Example: `Execution - EBS Switchover PHX to IAD` */ displayName: string; /** * The total duration in seconds taken to complete the step execution. Example: `35` */ executionDurationInSec: number; /** * The unique id of the group to which this step belongs. Must not be modified by user. Example: `sgid1.group..uniqueID` */ groupId: string; /** * The status of the step execution. */ status: string; /** * Additional details on the step execution status. Example: `This step failed to complete due to a timeout` */ statusDetails: string; /** * A list of step executions in the group. */ stepExecutions: outputs.DisasterRecovery.DrPlanExecutionGroupExecutionStepExecution[]; /** * The date and time at which DR plan execution succeeded, failed, was paused, or was canceled. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeEnded: string; /** * The date and time at which DR plan execution began. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeStarted: string; /** * The group type. Example: `BUILT_IN` */ type: string; } interface DrPlanExecutionGroupExecutionStepExecution { /** * (Updatable) The display name of the DR plan execution. Example: `Execution - EBS Switchover PHX to IAD` */ displayName: string; /** * The total duration in seconds taken to complete the step execution. Example: `35` */ executionDurationInSec: number; /** * The unique id of the group to which this step belongs. Must not be modified by user. Example: `sgid1.group..uniqueID` */ groupId: string; /** * The details of an object storage log location for a DR protection group. */ logLocations: outputs.DisasterRecovery.DrPlanExecutionGroupExecutionStepExecutionLogLocation[]; /** * The status of the step execution. */ status: string; /** * Additional details on the step execution status. Example: `This step failed to complete due to a timeout` */ statusDetails: string; /** * The unique id of the step. Must not be modified by user. Example: `sgid1.step..uniqueID` */ stepId: string; /** * The date and time at which DR plan execution succeeded, failed, was paused, or was canceled. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeEnded: string; /** * The date and time at which DR plan execution began. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeStarted: string; /** * The group type. Example: `BUILT_IN` */ type: string; /** * The display name of the DR Plan step type. Example: `Database Switchover` */ typeDisplayName: string; } interface DrPlanExecutionGroupExecutionStepExecutionLogLocation { /** * The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; /** * The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface DrPlanExecutionLogLocation { /** * The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; /** * The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface DrPlanExecutionStepStatusCount { /** * A summary of steps that failed during a DR plan execution, including failed and timed out steps. */ failedSteps: outputs.DisasterRecovery.DrPlanExecutionStepStatusCountFailedStep[]; /** * A summary of remaining steps in a DR plan execution, including queued, paused, and in-progress steps. */ remainingSteps: outputs.DisasterRecovery.DrPlanExecutionStepStatusCountRemainingStep[]; /** * A summary of steps that were skipped during a DR plan execution, including disabled, failed but ignored, timed out but ignored, and canceled steps. */ skippedSteps: outputs.DisasterRecovery.DrPlanExecutionStepStatusCountSkippedStep[]; /** * A summary of steps that completed successfully during a DR plan execution. */ successfulSteps: outputs.DisasterRecovery.DrPlanExecutionStepStatusCountSuccessfulStep[]; /** * The total number of steps in a DR plan execution. */ totalSteps: number; /** * A summary of steps that encountered warnings during a DR plan execution. */ warningSteps: outputs.DisasterRecovery.DrPlanExecutionStepStatusCountWarningStep[]; } interface DrPlanExecutionStepStatusCountFailedStep { /** * The total number of failed steps in a DR plan execution. */ failed: number; /** * The total number of steps that timed out during a DR plan execution. */ timedOut: number; /** * The total number of steps that failed during a DR plan execution. */ totalFailed: number; } interface DrPlanExecutionStepStatusCountRemainingStep { /** * The total number of steps in progress during a DR plan execution. */ inProgress: number; /** * The total number of paused steps in a DR plan execution. */ paused: number; /** * The total number of queued steps in a DR plan execution. */ queued: number; /** * The total number of remaining steps in a DR plan execution. */ totalRemaining: number; } interface DrPlanExecutionStepStatusCountSkippedStep { /** * The total number of canceled steps in a DR plan execution. */ canceled: number; /** * The total number of disabled steps in a DR plan execution. */ disabled: number; /** * The total number of steps that failed but were ignored during a DR plan execution. */ failedIgnored: number; /** * The total number of steps that timed out but were ignored during a DR plan execution. */ timedOutIgnored: number; /** * The total number of steps that were skipped during a DR plan execution. */ totalSkipped: number; } interface DrPlanExecutionStepStatusCountSuccessfulStep { /** * The total number of steps that succeeded during a DR plan execution. */ succeeded: number; /** * The total number of successful steps in a DR plan execution. */ totalSuccessful: number; } interface DrPlanExecutionStepStatusCountWarningStep { /** * The total number of steps that encountered warnings in a DR plan execution. */ totalWarnings: number; /** * The total number of steps with warnings that were ignored during a DR plan execution. */ warningsIgnored: number; } interface DrPlanPlanGroup { /** * (Updatable) The display name of the DR plan being created. Example: `EBS Switchover PHX to IAD` */ displayName: string; /** * The unique id of the step. Must not be modified by the user. Example: `sgid1.step..uniqueID` */ id: string; /** * A flag indicating whether this group should be enabled for execution. This flag is only applicable to the `USER_DEFINED_PAUSE` group. The flag should be null for the remaining group types. Example: `true` */ isPauseEnabled: boolean; /** * The DR plan step refresh status. Example: `STEP_ADDED` */ refreshStatus: string; /** * The list of steps in the group. */ steps: outputs.DisasterRecovery.DrPlanPlanGroupStep[]; /** * The type of DR plan to be created. */ type: string; } interface DrPlanPlanGroupStep { /** * (Updatable) The display name of the DR plan being created. Example: `EBS Switchover PHX to IAD` */ displayName: string; /** * The error mode for this step. */ errorMode: string; /** * The unique id of the group to which this step belongs. Must not be modified by user. Example: `sgid1.group..uniqueID` */ groupId: string; /** * The unique id of the step. Must not be modified by the user. Example: `sgid1.step..uniqueID` */ id: string; /** * A flag indicating whether this step should be enabled for execution. Example: `true` */ isEnabled: boolean; /** * The OCID of the member associated with this step. Example: `ocid1.database.oc1..uniqueID` */ memberId: string; /** * The DR plan step refresh status. Example: `STEP_ADDED` */ refreshStatus: string; /** * The timeout in seconds for executing this step. Example: `600` */ timeout: number; /** * The type of DR plan to be created. */ type: string; /** * The display name of the DR Plan step type. Example: `Database Switchover` */ typeDisplayName: string; /** * The details for a user-defined step in a DR plan. */ userDefinedSteps: outputs.DisasterRecovery.DrPlanPlanGroupStepUserDefinedStep[]; } interface DrPlanPlanGroupStepUserDefinedStep { /** * The OCID of function to be invoked. Example: `ocid1.fnfunc.oc1..uniqueID` */ functionId: string; /** * The region in which the function is deployed. Example: `us-ashburn-1` */ functionRegion: string; /** * The details of an object storage script location for a user-defined step in a DR plan. */ objectStorageScriptLocations: outputs.DisasterRecovery.DrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation[]; /** * The request body for the function. Example: `{ "FnParam1", "FnParam2" }` */ requestBody: string; /** * The user ID on the instance that will be used to execute the script specified in 'scriptCommand'. Example: `opc` */ runAsUser: string; /** * The OCID of the instance on which this script or command should be executed. */ runOnInstanceId: string; /** * The region of the instance where this script or command should be executed. Example: `us-ashburn-1` */ runOnInstanceRegion: string; /** * The entire path and arguments for the script that is stored in object store, or inside a compressed archive in object store. Example: `/usr/bin/python3.7 scripts/start_server.py --port 8080 --env "production" --max-connections 200 --log-level "INFO"` */ scriptCommand: string; /** * The type of the user-defined step. */ stepType: string; } interface DrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation { /** * The bucket name inside the object storage namespace. Example: `customDrScripts` */ bucket: string; /** * The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `validate_app_start.sh` */ object: string; } interface DrProtectionGroupAssociation { /** * The OCID of the peer DR protection group. Example: `ocid1.drprotectiongroup.oc1..uniqueID` */ peerId: string; /** * The region of the peer DR protection group. Example: `us-ashburn-1` */ peerRegion: string; /** * The role of the DR protection group. Example: `STANDBY` */ role: string; } interface DrProtectionGroupLogLocation { /** * (Updatable) The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; /** * (Updatable) The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface DrProtectionGroupMember { /** * (Updatable) This specifies the mechanism used to create a temporary Autonomous Database instance for DR Drills. See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-clone-about.html for information about these clone types. See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-data-guard-snapshot-standby.html for information about snapshot standby. */ autonomousDatabaseStandbyTypeForDrDrills: string; /** * (Updatable) A list of backend set mappings that are used to transfer or update backends during DR. */ backendSetMappings: outputs.DisasterRecovery.DrProtectionGroupMemberBackendSetMapping[]; /** * (Updatable) Create backup configuration properties for an OKE member. */ backupConfig: outputs.DisasterRecovery.DrProtectionGroupMemberBackupConfig; /** * (Updatable) The details for creating the backup location of an OKE Cluster. */ backupLocation: outputs.DisasterRecovery.DrProtectionGroupMemberBackupLocation; /** * (Updatable) The details for creating the operations performed on a block volume. */ blockVolumeAttachAndMountOperations: outputs.DisasterRecovery.DrProtectionGroupMemberBlockVolumeAttachAndMountOperations; /** * (Updatable) Deprecated. Use the 'blockVolumeAttachAndMountOperations' attribute instead of this. A list of operations performed on block volumes used by the compute instance. */ blockVolumeOperations: outputs.DisasterRecovery.DrProtectionGroupMemberBlockVolumeOperation[]; /** * (Updatable) The bucket name inside the object storage namespace. Example: `bucketName` */ bucket: string; /** * (Updatable) Create properties for a customer-managed vault and encryption key in the destination region. The customer-managed encryption key in this will be used to encrypt the resource or containing resources after they move to the destination region. */ commonDestinationKey: outputs.DisasterRecovery.DrProtectionGroupMemberCommonDestinationKey; /** * (Updatable) The type of connection strings used to connect to an Autonomous Container Database snapshot standby created during a DR Drill operation. See https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html for information about these service types. */ connectionStringType: string; /** * (Updatable) The credentials for the HeatWave MySQL DB System administrator user, containing the username and the OCID of the Vault secret that stores the password. */ dbSystemAdminUserDetails: outputs.DisasterRecovery.DrProtectionGroupMemberDbSystemAdminUserDetails; /** * (Updatable) The credentials for the HeatWave MySQL DB System replication user, containing the username and the OCID of the Vault secret that stores the password. */ dbSystemReplicationUserDetails: outputs.DisasterRecovery.DrProtectionGroupMemberDbSystemReplicationUserDetails; /** * (Updatable) The availability domain of the destination mount target. Example: `BBTh:region-AD` */ destinationAvailabilityDomain: string; /** * (Updatable) The OCID of the backup policy to use in the destination region. This policy will be used to create backups for this volume group after it moves the destination region. Example: `ocid1.volumebackuppolicy.oc1..uniqueID` */ destinationBackupPolicyId: string; /** * (Updatable) The OCID of a capacity reservation in the destination region which will be used to launch the compute instance. Example: `ocid1.capacityreservation.oc1..uniqueID` */ destinationCapacityReservationId: string; /** * (Updatable) The OCID of a compartment in the destination region in which the compute instance should be launched. Example: `ocid1.compartment.oc1..uniqueID` */ destinationCompartmentId: string; /** * (Updatable) The OCID of a dedicated VM host in the destination region where the compute instance should be launched. Example: `ocid1.dedicatedvmhost.oc1..uniqueID` */ destinationDedicatedVmHostId: string; /** * (Updatable) Create properties for a customer-managed vault and encryption key in the destination region. The customer-managed encryption key in this will be used to encrypt the resource or containing resources after they move to the destination region. */ destinationEncryptionKey: outputs.DisasterRecovery.DrProtectionGroupMemberDestinationEncryptionKey; /** * (Updatable) The OCID of the destination load balancer. Example: `ocid1.loadbalancer.oc1..uniqueID` */ destinationLoadBalancerId: string; /** * (Updatable) The OCID of the destination network load balancer. Example: `ocid1.networkloadbalancer.oc1..uniqueID` */ destinationNetworkLoadBalancerId: string; /** * (Updatable) The OCID of the snapshot policy to use in the destination region. This policy will be attached to the file system after it moves to the destination region. Example: `ocid1.filesystemsnapshotpolicy.oc1..uniqueID` */ destinationSnapshotPolicyId: string; /** * (Updatable) A list of mappings between file system exports in the primary region and mount targets in the standby region. */ exportMappings: outputs.DisasterRecovery.DrProtectionGroupMemberExportMapping[]; /** * (Updatable) A list of operations performed on file systems used by the compute instance. */ fileSystemOperations: outputs.DisasterRecovery.DrProtectionGroupMemberFileSystemOperation[]; /** * (Updatable) The maximum time (in seconds) to wait for the Global Transaction Identifier (GTID) synchronization process to complete before timing out. Example: `600` */ gtidReconciliationTimeout: number; /** * (Updatable) A flag indicating whether to continue with DR operation if the Global Transaction Identifier (GTID) reconciliation operation times out. Example: `false` */ isContinueOnGtidReconciliationTimeout: boolean; /** * (Updatable) A flag indicating if the compute instance should be moved during DR operations. Example: `false` */ isMovable: boolean; /** * (Updatable) A flag indicating if the compute instance should be moved to the same fault domain in the destination region. The compute instance launch will fail if this flag is set to true and capacity is not available in the specified fault domain in the destination region. Example: `false` */ isRetainFaultDomain: boolean; /** * (Updatable) A flag indicating whether the non-movable compute instance should be started and stopped during DR operations. *Prechecks cannot be executed on stopped instances that are configured to be started.* */ isStartStopEnabled: boolean; /** * (Updatable) The OCID of the compute instance member that is designated as a jump host. This compute instance will be used to perform DR operations on the cluster using Oracle Cloud Agent's Run Command feature. Example: `ocid1.instance.oc1..uniqueID` */ jumpHostId: string; /** * (Updatable) The list of source-to-destination load balancer mappings required for DR operations. This property applies to the OKE cluster member in primary region. */ loadBalancerMappings: outputs.DisasterRecovery.DrProtectionGroupMemberLoadBalancerMapping[]; /** * (Updatable) The list of managed node pools with configurations for minimum and maximum node counts. This property applies to the OKE cluster member in both the primary and standby region. */ managedNodePoolConfigs: outputs.DisasterRecovery.DrProtectionGroupMemberManagedNodePoolConfig[]; /** * (Updatable) The OCID of the member. Example: `ocid1.instance.oc1..uniqueID` */ memberId: string; /** * (Updatable) The type of the member. */ memberType: string; /** * (Updatable) The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * (Updatable) The list of source-to-destination network load balancer mappings required for DR operations. This property applies to the OKE cluster member in primary region. */ networkLoadBalancerMappings: outputs.DisasterRecovery.DrProtectionGroupMemberNetworkLoadBalancerMapping[]; /** * (Updatable) The OCID of the vault secret where the database SYSDBA password is stored. This password is required and used for performing database DR Drill operations when using full clone. Example: `ocid1.vaultsecret.oc1..uniqueID` */ passwordVaultSecretId: string; /** * (Updatable) The OCID of the peer OKE cluster. This property applies to the OKE cluster member in both the primary and standby region. Example: `ocid1.cluster.oc1..uniqueID` */ peerClusterId: string; /** * (Updatable) The OCID of the peer HeatWave MySQL DB System from the peer region. Example: `ocid1.mysqldbsystem.oc1..uniqueID` */ peerDbSystemId: string; /** * (Updatable) The list of config maps along with their corresponding namespaces. This property applies to the OKE cluster member in primary region. */ resourceModifierMappings: outputs.DisasterRecovery.DrProtectionGroupMemberResourceModifierMapping[]; /** * (Updatable) A list of mappings between source volume IDs in the volume group and customer-managed encryption keys in the destination region which will be used to encrypt the volume after it moves to the destination region. * * If you add the entry for source volumes and its corresponding vault and encryption keys here, you can not use 'commonDestinationKey' for encrypting all volumes with common encryption key. Similarly, if you specify common vault and encryption key using 'commonDestinationKey', you cannot specify vaults and encryption keys individually for each volume using 'sourceVolumeToDestinationEncryptionKeyMappings'. * * An entry for each volume in volume group should be added in this list. The encryption key will not be updated for the volumes that are part of volume group but missing in this list. */ sourceVolumeToDestinationEncryptionKeyMappings: outputs.DisasterRecovery.DrProtectionGroupMemberSourceVolumeToDestinationEncryptionKeyMapping[]; /** * (Updatable) The list of source-to-destination vault mappings required for DR operations. This property applies to the OKE cluster member in primary region. */ vaultMappings: outputs.DisasterRecovery.DrProtectionGroupMemberVaultMapping[]; /** * (Updatable) The list of virtual node pools with configurations for minimum and maximum node counts. This property applies to the OKE cluster member in both the primary and standby region. */ virtualNodePoolConfigs: outputs.DisasterRecovery.DrProtectionGroupMemberVirtualNodePoolConfig[]; /** * (Updatable) A list of compute instance VNIC mappings. */ vnicMapping: outputs.DisasterRecovery.DrProtectionGroupMemberVnicMapping[]; /** * (Updatable) A list of compute instance VNIC mappings. */ vnicMappings: outputs.DisasterRecovery.DrProtectionGroupMemberVnicMapping[]; } interface DrProtectionGroupMemberBackendSetMapping { /** * (Updatable) The name of the destination backend set. Example: `Destination-BackendSet-1` */ destinationBackendSetName: string; /** * (Updatable) This flag specifies if this backend set is used for traffic for non-movable compute instances. Backend sets that point to non-movable instances are only enabled or disabled during DR, their contents are not altered. For non-movable instances this flag should be set to 'true'. Backend sets that point to movable instances are emptied and their contents are transferred to the destination region load balancer. For movable instances this flag should be set to 'false'. Example: `true` */ isBackendSetForNonMovable: boolean; /** * (Updatable) The name of the source backend set. Example: `Source-BackendSet-1` */ sourceBackendSetName: string; } interface DrProtectionGroupMemberBackupConfig { /** * (Updatable) The schedule for backing up namespaces to the destination region. If a backup schedule is not specified, only a single backup will be created. This format of the string specifying the backup schedule must conform with RFC-5545 (see examples below). This schedule will use the UTC timezone. This property applies to the OKE cluster member in primary region. * * The backup frequency can be HOURLY, DAILY, WEEKLY or MONTHLY, and the upper and lower interval bounds are as follows HOURLY * * Minimum = 1 * * Maximum = 24 DAILY * * Minimum = 1 * * Maximum = 30 WEEKLY * * Minimum = 1 * * Maximum = 1 MONTHLY * * Minimum = 1 * * Maximum = 12 * * Examples: FREQ=WEEKLY;BYDAY=MO,WE;BYHOUR=10;INTERVAL=1 > Run a backup every Monday and Wednesday at 10:00 AM. FREQ=WEEKLY;BYDAY=MO,WE;BYHOUR=10;INTERVAL=2 > Invalid configuration (Cannot specify an interval of 2). * * FREQ=HOURLY;INTERVAL=25 > Invalid configuration (Cannot specify an interval of 25). FREQ=HOURLY;INTERVAL=0 > Invalid configuration (Cannot specify an interval of 0). FREQ=HOURLY;INTERVAL=24 > Run a backup every 24 hours. FREQ=HOURLY;INTERVAL=1 > Run a backup every hour. FREQ=HOURLY;BYMINUTE=30;INTERVAL=15 > Run a backup every 15 hours at the 30th minute. FREQ=DAILY;INTERVAL=31 > Invalid configuration (Cannot specify an interval of 31). FREQ=DAILY;INTERVAL=0 > Invalid configuration (Cannot specify an interval of 0). FREQ=DAILY;INTERVAL=30 > Run a backup every 30 days at 12:00 midnight. FREQ=DAILY;BYHOUR=17;BYMINUTE=10;INTERVAL=1 > Run a backup daily at 05:10 PM. */ backupSchedule: string; /** * (Updatable) A list of namespaces to be excluded from the backup. The default value is null. If a list of namespaces to exclude is not provided, all namespaces will be backed up. Specify either the `namespaces` or the `excludeNamespaces` parameter, but not both. This property applies to OKE cluster members in the primary region. Example: ["namespaceString3", "namespaceString4"] */ excludeNamespaces: string[]; /** * (Updatable) The OCID of the vault secret that stores the image credential. This property applies to the OKE cluster member in both the primary and standby region. */ imageReplicationVaultSecretId: string; /** * (Updatable) The maximum number of backups that should be retained. This property applies to the OKE cluster member in primary region. */ maxNumberOfBackupsRetained: number; /** * (Updatable) A list of namespaces to be included in the backup. The default value is null. If a list of namespaces to include is not provided, all namespaces will be backed up. Specify either the `namespaces` or the `excludeNamespaces` parameter, but not both. This property applies to the OKE cluster member in primary region. Example: ["default", "pv-nginx"] */ namespaces: string[]; /** * (Updatable) Controls the behaviour of image replication across regions. Image replication is enabled by default for DR Protection Groups with a primary role. This property applies to the OKE cluster member in primary region. */ replicateImages: string; } interface DrProtectionGroupMemberBackupLocation { /** * (Updatable) The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; /** * (Updatable) The namespace in the object storage bucket location (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface DrProtectionGroupMemberBlockVolumeAttachAndMountOperations { /** * (Updatable) A list of details of attach or detach operations performed on block volumes. */ attachments: outputs.DisasterRecovery.DrProtectionGroupMemberBlockVolumeAttachAndMountOperationsAttachment[]; /** * (Updatable) A list of details of mount operations performed on block volumes. */ mounts: outputs.DisasterRecovery.DrProtectionGroupMemberBlockVolumeAttachAndMountOperationsMount[]; } interface DrProtectionGroupMemberBlockVolumeAttachAndMountOperationsAttachment { /** * (Updatable) The OCID of the block volume. Example: `ocid1.volume.oc1..uniqueID` */ blockVolumeId: string; /** * (Updatable) The OCID of the reference compute instance needed to obtain the volume attachment details. This reference compute instance belongs to the peer DR protection group. Example: `ocid1.instance.oc1..uniqueID` */ volumeAttachmentReferenceInstanceId: string; } interface DrProtectionGroupMemberBlockVolumeAttachAndMountOperationsMount { /** * (Updatable) The physical mount point where the file system is mounted on the block volume. Example: `/mnt/yourmountpoint` */ mountPoint: string; } interface DrProtectionGroupMemberBlockVolumeOperation { /** * (Updatable) Deprecated. Use the 'CreateComputeInstanceNonMovableBlockVolumeAttachOperationDetails' definition instead of this. The details for creating a block volume attachment. */ attachmentDetails: outputs.DisasterRecovery.DrProtectionGroupMemberBlockVolumeOperationAttachmentDetails; /** * (Updatable) The OCID of the block volume. Example: `ocid1.volume.oc1..uniqueID` */ blockVolumeId: string; /** * (Updatable) The details for creating a mount for a file system on a block volume. */ mountDetails: outputs.DisasterRecovery.DrProtectionGroupMemberBlockVolumeOperationMountDetails; } interface DrProtectionGroupMemberBlockVolumeOperationAttachmentDetails { /** * (Updatable) The OCID of the reference compute instance needed to obtain the volume attachment details. This reference compute instance belongs to the peer DR protection group. Example: `ocid1.instance.oc1..uniqueID` */ volumeAttachmentReferenceInstanceId: string; } interface DrProtectionGroupMemberBlockVolumeOperationMountDetails { /** * (Updatable) The physical mount point used for mounting the file system on the block volume. Example: `/mnt/yourmountpoint` */ mountPoint: string; } interface DrProtectionGroupMemberCommonDestinationKey { /** * (Updatable) The OCID of the customer-managed encryption key in the destination region vault. Example: `ocid1.key.oc1..uniqueID` */ encryptionKeyId: string; /** * (Updatable) The OCID of the destination region vault for the customer-managed encryption key. Example: `ocid1.vault.oc1..uniqueID` */ vaultId: string; } interface DrProtectionGroupMemberDbSystemAdminUserDetails { /** * (Updatable) The OCID of the vault secret where the HeatWave MySQL DB System password is stored. Example: `ocid1.vaultsecret.oc1..uniqueID` */ passwordVaultSecretId: string; /** * (Updatable) The user name for connecting to the HeatWave MySQL DB System node. Example: `user` */ username: string; } interface DrProtectionGroupMemberDbSystemReplicationUserDetails { /** * (Updatable) The OCID of the vault secret where the HeatWave MySQL DB System password is stored. Example: `ocid1.vaultsecret.oc1..uniqueID` */ passwordVaultSecretId: string; /** * (Updatable) The user name for connecting to the HeatWave MySQL DB System node. Example: `user` */ username: string; } interface DrProtectionGroupMemberDestinationEncryptionKey { /** * (Updatable) The OCID of the customer-managed encryption key in the destination region vault. Example: `ocid1.key.oc1..uniqueID` */ encryptionKeyId: string; /** * (Updatable) The OCID of the destination region vault for the customer-managed encryption key. Example: `ocid1.vault.oc1..uniqueID` */ vaultId: string; } interface DrProtectionGroupMemberExportMapping { /** * (Updatable) The OCID of the destination mount target in the destination region which is used to export the file system. Example: `ocid1.mounttarget.oc1..uniqueID` */ destinationMountTargetId: string; /** * (Updatable) The OCID of the export path in the primary region used to mount or unmount the file system. Example: `ocid1.export.oc1..uniqueID` */ exportId: string; } interface DrProtectionGroupMemberFileSystemOperation { /** * (Updatable) The export path of the file system. Example: `/fs-export-path` */ exportPath: string; /** * (Updatable) The details for creating a file system mount. */ mountDetails: outputs.DisasterRecovery.DrProtectionGroupMemberFileSystemOperationMountDetails; /** * (Updatable) The physical mount point of the file system on a host. Example: `/mnt/yourmountpoint` */ mountPoint: string; /** * (Updatable) The OCID of the mount target. Example: `ocid1.mounttarget.oc1..uniqueID` */ mountTargetId: string; /** * (Updatable) The details for creating a file system unmount. */ unmountDetails: outputs.DisasterRecovery.DrProtectionGroupMemberFileSystemOperationUnmountDetails; } interface DrProtectionGroupMemberFileSystemOperationMountDetails { /** * (Updatable) The OCID of the mount target for this file system. Example: `ocid1.mounttarget.oc1..uniqueID` */ mountTargetId: string; } interface DrProtectionGroupMemberFileSystemOperationUnmountDetails { /** * (Updatable) The OCID of the mount target. Example: `ocid1.mounttarget.oc1..uniqueID` */ mountTargetId: string; } interface DrProtectionGroupMemberLoadBalancerMapping { /** * (Updatable) The OCID of the destination Load Balancer. Example: `ocid1.loadbalancer.oc1..uniqueID` */ destinationLoadBalancerId: string; /** * (Updatable) The OCID of the source Load Balancer. Example: `ocid1.loadbalancer.oc1..uniqueID` */ sourceLoadBalancerId: string; } interface DrProtectionGroupMemberManagedNodePoolConfig { /** * (Updatable) The OCID of the managed node pool in OKE cluster. */ id: string; /** * (Updatable) The maximum number to which nodes in the managed node pool could be scaled up. */ maximum: number; /** * (Updatable) The minimum number to which nodes in the managed node pool could be scaled down. */ minimum: number; } interface DrProtectionGroupMemberNetworkLoadBalancerMapping { /** * (Updatable) The OCID of the Network Load Balancer. Example: `ocid1.networkloadbalancer.oc1..uniqueID` */ destinationNetworkLoadBalancerId: string; /** * (Updatable) The OCID of the source Network Load Balancer. Example: `ocid1.networkloadbalancer.oc1..uniqueID` */ sourceNetworkLoadBalancerId: string; } interface DrProtectionGroupMemberResourceModifierMapping { /** * (Updatable) The name of the config map containing resource modification details. Example: `resource-modifier` */ configMap: string; /** * (Updatable) The OKE namespace where the config map resides. Example: `namespaceString5` */ namespace: string; } interface DrProtectionGroupMemberSourceVolumeToDestinationEncryptionKeyMapping { /** * (Updatable) Create properties for a customer-managed vault and encryption key in the destination region. The customer-managed encryption key in this will be used to encrypt the resource or containing resources after they move to the destination region. */ destinationEncryptionKey: outputs.DisasterRecovery.DrProtectionGroupMemberSourceVolumeToDestinationEncryptionKeyMappingDestinationEncryptionKey; /** * (Updatable) The OCID of the source boot volume or block volume. Example: `ocid1.volume.oc1..uniqueID` */ sourceVolumeId: string; } interface DrProtectionGroupMemberSourceVolumeToDestinationEncryptionKeyMappingDestinationEncryptionKey { /** * (Updatable) The OCID of the customer-managed encryption key in the destination region vault. Example: `ocid1.key.oc1..uniqueID` */ encryptionKeyId: string; /** * (Updatable) The OCID of the destination region vault for the customer-managed encryption key. Example: `ocid1.vault.oc1..uniqueID` */ vaultId: string; } interface DrProtectionGroupMemberVaultMapping { /** * (Updatable) The OCID of the destination Vault. Example: `ocid1.vault.oc1..uniqueID` */ destinationVaultId: string; /** * (Updatable) The OCID of the source Vault. Example: `ocid1.vault.oc1..uniqueID` */ sourceVaultId: string; } interface DrProtectionGroupMemberVirtualNodePoolConfig { /** * (Updatable) The OCID of the virtual node pool in OKE cluster. */ id: string; /** * (Updatable) The maximum number to which nodes in the virtual node pool could be scaled up. */ maximum: number; /** * (Updatable) The minimum number to which nodes in the virtual node pool could be scaled down. */ minimum: number; } interface DrProtectionGroupMemberVnicMapping { /** * (Updatable) A list of OCIDs of network security groups (NSG) in the destination region which should be assigned to the source VNIC. Example: `[ ocid1.networksecuritygroup.oc1..uniqueID, ocid1.networksecuritygroup.oc1..uniqueID ]` */ destinationNsgIdLists: string[]; /** * (Updatable) The primary private IP address to be assigned to the source VNIC in the destination subnet. This IP address must belong to the destination subnet. Example: `10.0.3.3` */ destinationPrimaryPrivateIpAddress: string; /** * (Updatable) The hostname label to be assigned in the destination subnet for the primary private IP of the source VNIC. This label is the hostname portion of the private IP's fully qualified domain name (FQDN) (for example, 'myhost1' in the FQDN 'myhost1.subnet123.vcn1.oraclevcn.com'). Example: `myhost1` */ destinationPrimaryPrivateIpHostnameLabel: string; /** * (Updatable) The OCID of the reserved public IP address to be assigned to the compute instance in the destination region. Example: `ocid1.publicip.oc1..uniqueID` */ destinationReservedPublicIpId: string; /** * (Updatable) The OCID of the destination subnet to which the source VNIC should connect. Example: `ocid1.subnet.oc1..uniqueID` */ destinationSubnetId: string; /** * (Updatable) The OCID of the source VNIC. Example: `ocid1.vnic.oc1..uniqueID` */ sourceVnicId: string; } interface GetAutomaticDrConfigurationMember { /** * A flag indicating if the automatic failover should be enabled for the Autonomous Database Serverless member in the Automatic DR configuration. Example: `false` */ isAutoFailoverEnabled: boolean; /** * A flag indicating if the automatic switchover should be enabled for the Autonomous Database Serverless member in the Automatic DR configuration. Example: `false` */ isAutoSwitchoverEnabled: boolean; /** * The unique id of the member. Must not be modified by user. Example: `ocid1.database.oc1..uniqueID` */ memberId: string; /** * The type of the member. */ memberType: string; } interface GetAutomaticDrConfigurationsAutomaticDrConfigurationCollection { items: outputs.DisasterRecovery.GetAutomaticDrConfigurationsAutomaticDrConfigurationCollectionItem[]; } interface GetAutomaticDrConfigurationsAutomaticDrConfigurationCollectionItem { /** * The OCID of the compartment containing the Automatic DR configuration. Example: `ocid1.compartment.oc1..uniqueID` */ compartmentId: string; /** * The unique id of a Failover DR Plan. Example: `ocid1.drplan.oc1..uniqueID` */ defaultFailoverDrPlanId: string; /** * The unique id of a Switchover DR Plan. Example: `ocid1.drplan.oc1..uniqueID` */ defaultSwitchoverDrPlanId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name. Example: `MyResourceDisplayName` */ displayName: string; /** * The OCID of the DR protection group. Mandatory query param. Example: `ocid1.drprotectiongroup.oc1..uniqueID` */ drProtectionGroupId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Automatic DR configuration. Example: `ocid1.automaticdrconfiguration.oc1..uniqueID` */ id: string; /** * A message describing the result of the most recent attempt made to submit an Automatic DR plan execution. */ lastAutomaticDrExecutionSubmitDetails: string; /** * The status of most recent attempt to submit Automatic DR plan execution. */ lastAutomaticDrExecutionSubmitStatus: string; /** * A message describing the Automatic DR configuration's current state in more detail. */ lifecycleDetails: string; /** * The list of members in this Automatic DR configuration. */ members: outputs.DisasterRecovery.GetAutomaticDrConfigurationsAutomaticDrConfigurationCollectionItemMember[]; /** * A filter to return only Automatic DR configurations that match the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Automatic DR configuration was created. An RFC3339 formatted datetime string. Example: `2024-03-29T09:36:42Z` */ timeCreated: string; /** * The date and time of the most recent attempt made to submit an Automatic DR plan execution. An RFC3339 formatted datetime string. Example: `2025-06-30T09:36:42Z` */ timeLastAutomaticDrExecutionSubmitAttempt: string; /** * The date and time the Automatic DR configuration was updated. An RFC3339 formatted datetime string. Example: `2024-03-29T09:36:42Z` */ timeUpdated: string; } interface GetAutomaticDrConfigurationsAutomaticDrConfigurationCollectionItemMember { /** * A flag indicating if the automatic failover should be enabled for the Autonomous Database Serverless member in the Automatic DR configuration. Example: `false` */ isAutoFailoverEnabled: boolean; /** * A flag indicating if the automatic switchover should be enabled for the Autonomous Database Serverless member in the Automatic DR configuration. Example: `false` */ isAutoSwitchoverEnabled: boolean; /** * The unique id of the member. Must not be modified by user. Example: `ocid1.database.oc1..uniqueID` */ memberId: string; /** * The type of the member. */ memberType: string; } interface GetAutomaticDrConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetDrPlanExecutionAutomaticExecutionDetail { /** * The name of the Oracle Cloud Infrastructure event that started the automatic DR plan execution. Example: `SwitchoverAutonomousDatabase` */ eventName: string; /** * The OCID of the member that emitted the event that started the automatic DR plan execution. Example: "ocid1.autonomousdatabase.oc1..uniqueID" */ memberId: string; } interface GetDrPlanExecutionExecutionOption { /** * A flag indicating whether a precheck should be executed before the plan execution. Example: `true` */ arePrechecksEnabled: boolean; /** * A flag indicating whether warnings should be ignored during the plan execution. Example: `false` */ areWarningsIgnored: boolean; /** * The type of the DR plan executed. */ planExecutionType: string; } interface GetDrPlanExecutionGroupExecution { /** * The display name of the step execution. Example: `DATABASE_SWITCHOVER` */ displayName: string; /** * The total duration in seconds taken to complete the step execution. Example: `35` */ executionDurationInSec: number; /** * The unique id of the group to which this step belongs. Must not be modified by user. Example: `sgid1.group..uniqueID` */ groupId: string; /** * The status of the step execution. */ status: string; /** * Additional details on the step execution status. Example: `This step failed to complete due to a timeout` */ statusDetails: string; /** * A list of step executions in the group. */ stepExecutions: outputs.DisasterRecovery.GetDrPlanExecutionGroupExecutionStepExecution[]; /** * The date and time at which DR plan execution succeeded, failed, was paused, or was canceled. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeEnded: string; /** * The date and time at which DR plan execution began. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeStarted: string; /** * The group type. Example: `BUILT_IN` */ type: string; } interface GetDrPlanExecutionGroupExecutionStepExecution { /** * The display name of the step execution. Example: `DATABASE_SWITCHOVER` */ displayName: string; /** * The total duration in seconds taken to complete the step execution. Example: `35` */ executionDurationInSec: number; /** * The unique id of the group to which this step belongs. Must not be modified by user. Example: `sgid1.group..uniqueID` */ groupId: string; /** * The details of an object storage log location for a DR protection group. */ logLocations: outputs.DisasterRecovery.GetDrPlanExecutionGroupExecutionStepExecutionLogLocation[]; /** * The status of the step execution. */ status: string; /** * Additional details on the step execution status. Example: `This step failed to complete due to a timeout` */ statusDetails: string; /** * The unique id of the step. Must not be modified by user. Example: `sgid1.step..uniqueID` */ stepId: string; /** * The date and time at which DR plan execution succeeded, failed, was paused, or was canceled. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeEnded: string; /** * The date and time at which DR plan execution began. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeStarted: string; /** * The group type. Example: `BUILT_IN` */ type: string; /** * The display name of the DR Plan step type. Example: `Database Switchover` */ typeDisplayName: string; } interface GetDrPlanExecutionGroupExecutionStepExecutionLogLocation { /** * The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; /** * The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface GetDrPlanExecutionLogLocation { /** * The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; /** * The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface GetDrPlanExecutionStepStatusCount { /** * A summary of steps that failed during a DR plan execution, including failed and timed out steps. */ failedSteps: outputs.DisasterRecovery.GetDrPlanExecutionStepStatusCountFailedStep[]; /** * A summary of remaining steps in a DR plan execution, including queued, paused, and in-progress steps. */ remainingSteps: outputs.DisasterRecovery.GetDrPlanExecutionStepStatusCountRemainingStep[]; /** * A summary of steps that were skipped during a DR plan execution, including disabled, failed but ignored, timed out but ignored, and canceled steps. */ skippedSteps: outputs.DisasterRecovery.GetDrPlanExecutionStepStatusCountSkippedStep[]; /** * A summary of steps that completed successfully during a DR plan execution. */ successfulSteps: outputs.DisasterRecovery.GetDrPlanExecutionStepStatusCountSuccessfulStep[]; /** * The total number of steps in a DR plan execution. */ totalSteps: number; /** * A summary of steps that encountered warnings during a DR plan execution. */ warningSteps: outputs.DisasterRecovery.GetDrPlanExecutionStepStatusCountWarningStep[]; } interface GetDrPlanExecutionStepStatusCountFailedStep { /** * The total number of failed steps in a DR plan execution. */ failed: number; /** * The total number of steps that timed out during a DR plan execution. */ timedOut: number; /** * The total number of steps that failed during a DR plan execution. */ totalFailed: number; } interface GetDrPlanExecutionStepStatusCountRemainingStep { /** * The total number of steps in progress during a DR plan execution. */ inProgress: number; /** * The total number of paused steps in a DR plan execution. */ paused: number; /** * The total number of queued steps in a DR plan execution. */ queued: number; /** * The total number of remaining steps in a DR plan execution. */ totalRemaining: number; } interface GetDrPlanExecutionStepStatusCountSkippedStep { /** * The total number of canceled steps in a DR plan execution. */ canceled: number; /** * The total number of disabled steps in a DR plan execution. */ disabled: number; /** * The total number of steps that failed but were ignored during a DR plan execution. */ failedIgnored: number; /** * The total number of steps that timed out but were ignored during a DR plan execution. */ timedOutIgnored: number; /** * The total number of steps that were skipped during a DR plan execution. */ totalSkipped: number; } interface GetDrPlanExecutionStepStatusCountSuccessfulStep { /** * The total number of steps that succeeded during a DR plan execution. */ succeeded: number; /** * The total number of successful steps in a DR plan execution. */ totalSuccessful: number; } interface GetDrPlanExecutionStepStatusCountWarningStep { /** * The total number of steps that encountered warnings in a DR plan execution. */ totalWarnings: number; /** * The total number of steps with warnings that were ignored during a DR plan execution. */ warningsIgnored: number; } interface GetDrPlanExecutionsDrPlanExecutionCollection { items: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItem[]; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItem { /** * The details of the event that started the automatic DR plan execution. */ automaticExecutionDetails: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemAutomaticExecutionDetail[]; /** * The OCID of the compartment containing this DR plan execution. Example: `ocid1.compartment.oc1..uniqueID` */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name. Example: `MyResourceDisplayName` */ displayName: string; /** * The OCID of the DR protection group. Mandatory query param. Example: `ocid1.drprotectiongroup.oc1..uniqueID` */ drProtectionGroupId: string; /** * The total duration in seconds taken to complete the step execution. Example: `35` */ executionDurationInSec: number; /** * The options for a plan execution. */ executionOptions: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemExecutionOption[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * A list of groups executed in this DR plan execution. */ groupExecutions: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemGroupExecution[]; /** * The OCID of the DR plan execution. Example: `ocid1.drplanexecution.oc1..uniqueID` */ id: string; /** * A flag indicating whether execution was submitted automatically by Automatic DR Configuration. Example: `false` */ isAutomatic: boolean; /** * A message describing the DR plan execution's current state in more detail. */ lifeCycleDetails: string; /** * The details of an object storage log location for a DR protection group. */ logLocations: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemLogLocation[]; /** * The OCID of peer DR protection group associated with this plan's DR protection group. Example: `ocid1.drprotectiongroup.oc1..uniqueID` */ peerDrProtectionGroupId: string; /** * The region of the peer DR protection group associated with this plan's DR protection group. Example: `us-ashburn-1` */ peerRegion: string; /** * The type of the DR plan executed. */ planExecutionType: string; /** * The OCID of the DR plan. Example: `ocid1.drplan.oc1..uniqueID` */ planId: string; /** * A filter to return only DR plan executions that match the given lifecycle state. */ state: string; /** * A categorized summary of step execution statuses and their corresponding counts. */ stepStatusCounts: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCount[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time at which DR plan execution was created. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeCreated: string; /** * The date and time at which DR plan execution succeeded, failed, was paused, or was canceled. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeEnded: string; /** * The date and time at which DR plan execution began. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeStarted: string; /** * The time when DR plan execution was last updated. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeUpdated: string; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemAutomaticExecutionDetail { /** * The name of the Oracle Cloud Infrastructure event that started the automatic DR plan execution. Example: `SwitchoverAutonomousDatabase` */ eventName: string; /** * The OCID of the member that emitted the event that started the automatic DR plan execution. Example: "ocid1.autonomousdatabase.oc1..uniqueID" */ memberId: string; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemExecutionOption { /** * A flag indicating whether a precheck should be executed before the plan execution. Example: `true` */ arePrechecksEnabled: boolean; /** * A flag indicating whether warnings should be ignored during the plan execution. Example: `false` */ areWarningsIgnored: boolean; /** * The type of the DR plan executed. */ planExecutionType: string; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemGroupExecution { /** * A filter to return only resources that match the given display name. Example: `MyResourceDisplayName` */ displayName: string; /** * The total duration in seconds taken to complete the step execution. Example: `35` */ executionDurationInSec: number; /** * The unique id of the group to which this step belongs. Must not be modified by user. Example: `sgid1.group..uniqueID` */ groupId: string; /** * The status of the step execution. */ status: string; /** * Additional details on the step execution status. Example: `This step failed to complete due to a timeout` */ statusDetails: string; /** * A list of step executions in the group. */ stepExecutions: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemGroupExecutionStepExecution[]; /** * The date and time at which DR plan execution succeeded, failed, was paused, or was canceled. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeEnded: string; /** * The date and time at which DR plan execution began. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeStarted: string; /** * The group type. Example: `BUILT_IN` */ type: string; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemGroupExecutionStepExecution { /** * A filter to return only resources that match the given display name. Example: `MyResourceDisplayName` */ displayName: string; /** * The total duration in seconds taken to complete the step execution. Example: `35` */ executionDurationInSec: number; /** * The unique id of the group to which this step belongs. Must not be modified by user. Example: `sgid1.group..uniqueID` */ groupId: string; /** * The details of an object storage log location for a DR protection group. */ logLocations: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemGroupExecutionStepExecutionLogLocation[]; /** * The status of the step execution. */ status: string; /** * Additional details on the step execution status. Example: `This step failed to complete due to a timeout` */ statusDetails: string; /** * The unique id of the step. Must not be modified by user. Example: `sgid1.step..uniqueID` */ stepId: string; /** * The date and time at which DR plan execution succeeded, failed, was paused, or was canceled. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeEnded: string; /** * The date and time at which DR plan execution began. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeStarted: string; /** * The group type. Example: `BUILT_IN` */ type: string; /** * The display name of the DR Plan step type. Example: `Database Switchover` */ typeDisplayName: string; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemGroupExecutionStepExecutionLogLocation { /** * The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; /** * The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemLogLocation { /** * The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; /** * The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCount { /** * A summary of steps that failed during a DR plan execution, including failed and timed out steps. */ failedSteps: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCountFailedStep[]; /** * A summary of remaining steps in a DR plan execution, including queued, paused, and in-progress steps. */ remainingSteps: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCountRemainingStep[]; /** * A summary of steps that were skipped during a DR plan execution, including disabled, failed but ignored, timed out but ignored, and canceled steps. */ skippedSteps: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCountSkippedStep[]; /** * A summary of steps that completed successfully during a DR plan execution. */ successfulSteps: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCountSuccessfulStep[]; /** * The total number of steps in a DR plan execution. */ totalSteps: number; /** * A summary of steps that encountered warnings during a DR plan execution. */ warningSteps: outputs.DisasterRecovery.GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCountWarningStep[]; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCountFailedStep { /** * The total number of failed steps in a DR plan execution. */ failed: number; /** * The total number of steps that timed out during a DR plan execution. */ timedOut: number; /** * The total number of steps that failed during a DR plan execution. */ totalFailed: number; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCountRemainingStep { /** * The total number of steps in progress during a DR plan execution. */ inProgress: number; /** * The total number of paused steps in a DR plan execution. */ paused: number; /** * The total number of queued steps in a DR plan execution. */ queued: number; /** * The total number of remaining steps in a DR plan execution. */ totalRemaining: number; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCountSkippedStep { /** * The total number of canceled steps in a DR plan execution. */ canceled: number; /** * The total number of disabled steps in a DR plan execution. */ disabled: number; /** * The total number of steps that failed but were ignored during a DR plan execution. */ failedIgnored: number; /** * The total number of steps that timed out but were ignored during a DR plan execution. */ timedOutIgnored: number; /** * The total number of steps that were skipped during a DR plan execution. */ totalSkipped: number; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCountSuccessfulStep { /** * The total number of steps that succeeded during a DR plan execution. */ succeeded: number; /** * The total number of successful steps in a DR plan execution. */ totalSuccessful: number; } interface GetDrPlanExecutionsDrPlanExecutionCollectionItemStepStatusCountWarningStep { /** * The total number of steps that encountered warnings in a DR plan execution. */ totalWarnings: number; /** * The total number of steps with warnings that were ignored during a DR plan execution. */ warningsIgnored: number; } interface GetDrPlanExecutionsFilter { name: string; regex?: boolean; values: string[]; } interface GetDrPlanPlanGroup { /** * The display name of the group. Example: `DATABASE_SWITCHOVER` */ displayName: string; /** * The unique id of the step. Must not be modified by the user. Example: `sgid1.step..uniqueID` */ id: string; /** * A flag indicating whether this group should be enabled for execution. This flag is only applicable to the `USER_DEFINED_PAUSE` group. The flag should be null for the remaining group types. Example: `true` */ isPauseEnabled: boolean; /** * The DR plan step refresh status. Example: `STEP_ADDED` */ refreshStatus: string; /** * The list of steps in the group. */ steps: outputs.DisasterRecovery.GetDrPlanPlanGroupStep[]; /** * The type of the DR plan. */ type: string; } interface GetDrPlanPlanGroupStep { /** * The display name of the group. Example: `DATABASE_SWITCHOVER` */ displayName: string; /** * The error mode for this step. */ errorMode: string; /** * The unique id of the group to which this step belongs. Must not be modified by user. Example: `sgid1.group..uniqueID` */ groupId: string; /** * The unique id of the step. Must not be modified by the user. Example: `sgid1.step..uniqueID` */ id: string; /** * A flag indicating whether this step should be enabled for execution. Example: `true` */ isEnabled: boolean; /** * The OCID of the member associated with this step. Example: `ocid1.database.oc1..uniqueID` */ memberId: string; /** * The DR plan step refresh status. Example: `STEP_ADDED` */ refreshStatus: string; /** * The timeout in seconds for executing this step. Example: `600` */ timeout: number; /** * The type of the DR plan. */ type: string; /** * The display name of the DR Plan step type. Example: `Database Switchover` */ typeDisplayName: string; /** * The details for a user-defined step in a DR plan. */ userDefinedSteps: outputs.DisasterRecovery.GetDrPlanPlanGroupStepUserDefinedStep[]; } interface GetDrPlanPlanGroupStepUserDefinedStep { /** * The OCID of function to be invoked. Example: `ocid1.fnfunc.oc1..uniqueID` */ functionId: string; /** * The region in which the function is deployed. Example: `us-ashburn-1` */ functionRegion: string; /** * The details of an object storage script location for a user-defined step in a DR plan. */ objectStorageScriptLocations: outputs.DisasterRecovery.GetDrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation[]; /** * The request body for the function. Example: `{ "FnParam1", "FnParam2" }` */ requestBody: string; /** * The user ID on the instance that will be used to execute the script specified in 'scriptCommand'. Example: `opc` */ runAsUser: string; /** * The OCID of the instance on which this script or command should be executed. */ runOnInstanceId: string; /** * The region of the instance where this script or command should be executed. Example: `us-ashburn-1` */ runOnInstanceRegion: string; /** * The entire path and arguments for the script that is stored in object store, or inside a compressed archive in object store. Example: `/usr/bin/python3.7 scripts/start_server.py --port 8080 --env "production" --max-connections 200 --log-level "INFO"` */ scriptCommand: string; /** * The type of the user-defined step. */ stepType: string; } interface GetDrPlanPlanGroupStepUserDefinedStepObjectStorageScriptLocation { /** * The bucket name inside the object storage namespace. Example: `customDrScripts` */ bucket: string; /** * The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `validate_app_start.sh` */ object: string; } interface GetDrPlansDrPlanCollection { items: outputs.DisasterRecovery.GetDrPlansDrPlanCollectionItem[]; } interface GetDrPlansDrPlanCollectionItem { /** * The OCID of the compartment containing the DR plan. Example: `ocid1.compartment.oc1..uniqueID` */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name. Example: `MyResourceDisplayName` */ displayName: string; /** * The OCID of the DR protection group. Mandatory query param. Example: `ocid1.drprotectiongroup.oc1..uniqueID` */ drProtectionGroupId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The unique id of the step. Must not be modified by the user. Example: `sgid1.step..uniqueID` */ id: string; /** * A message describing the DR plan's current state in more detail. */ lifeCycleDetails: string; /** * A filter to return only DR plans that match the given lifecycle sub-state. */ lifecycleSubState: string; /** * The OCID of the peer DR protection group associated with this plan's DR protection group. Example: `ocid1.drprotectiongroup.oc1..uniqueID` */ peerDrProtectionGroupId: string; /** * The region of the peer DR protection group associated with this plan's DR protection group. Example: `us-ashburn-1` */ peerRegion: string; /** * The list of groups in this DR plan. */ planGroups: outputs.DisasterRecovery.GetDrPlansDrPlanCollectionItemPlanGroup[]; refreshTrigger: number; /** * If this is a cloned DR plan, the OCID of the source DR plan that was used to clone this DR plan. If this DR plan was not cloned, then the value for this will be `null`. Example: `ocid1.drplan.oc1..uniqueID` */ sourcePlanId: string; /** * A filter to return only DR plans that match the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the DR plan was created. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeCreated: string; /** * The date and time the DR plan was updated. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeUpdated: string; /** * The type of the DR plan. */ type: string; verifyTrigger: number; } interface GetDrPlansDrPlanCollectionItemPlanGroup { /** * A filter to return only resources that match the given display name. Example: `MyResourceDisplayName` */ displayName: string; /** * The unique id of the step. Must not be modified by the user. Example: `sgid1.step..uniqueID` */ id: string; /** * A flag indicating whether this group should be enabled for execution. This flag is only applicable to the `USER_DEFINED_PAUSE` group. The flag should be null for the remaining group types. Example: `true` */ isPauseEnabled: boolean; /** * The DR plan step refresh status. Example: `STEP_ADDED` */ refreshStatus: string; /** * The list of steps in the group. */ steps: outputs.DisasterRecovery.GetDrPlansDrPlanCollectionItemPlanGroupStep[]; /** * The type of the DR plan. */ type: string; } interface GetDrPlansDrPlanCollectionItemPlanGroupStep { /** * A filter to return only resources that match the given display name. Example: `MyResourceDisplayName` */ displayName: string; /** * The error mode for this step. */ errorMode: string; /** * The unique id of the group to which this step belongs. Must not be modified by user. Example: `sgid1.group..uniqueID` */ groupId: string; /** * The unique id of the step. Must not be modified by the user. Example: `sgid1.step..uniqueID` */ id: string; /** * A flag indicating whether this step should be enabled for execution. Example: `true` */ isEnabled: boolean; /** * The OCID of the member associated with this step. Example: `ocid1.database.oc1..uniqueID` */ memberId: string; /** * The DR plan step refresh status. Example: `STEP_ADDED` */ refreshStatus: string; /** * The timeout in seconds for executing this step. Example: `600` */ timeout: number; /** * The type of the DR plan. */ type: string; /** * The display name of the DR Plan step type. Example: `Database Switchover` */ typeDisplayName: string; /** * The details for a user-defined step in a DR plan. */ userDefinedSteps: outputs.DisasterRecovery.GetDrPlansDrPlanCollectionItemPlanGroupStepUserDefinedStep[]; } interface GetDrPlansDrPlanCollectionItemPlanGroupStepUserDefinedStep { /** * The OCID of function to be invoked. Example: `ocid1.fnfunc.oc1..uniqueID` */ functionId: string; /** * The region in which the function is deployed. Example: `us-ashburn-1` */ functionRegion: string; /** * The details of an object storage script location for a user-defined step in a DR plan. */ objectStorageScriptLocations: outputs.DisasterRecovery.GetDrPlansDrPlanCollectionItemPlanGroupStepUserDefinedStepObjectStorageScriptLocation[]; /** * The request body for the function. Example: `{ "FnParam1", "FnParam2" }` */ requestBody: string; /** * The user ID on the instance that will be used to execute the script specified in 'scriptCommand'. Example: `opc` */ runAsUser: string; /** * The OCID of the instance on which this script or command should be executed. */ runOnInstanceId: string; /** * The region of the instance where this script or command should be executed. Example: `us-ashburn-1` */ runOnInstanceRegion: string; /** * The entire path and arguments for the script that is stored in object store, or inside a compressed archive in object store. Example: `/usr/bin/python3.7 scripts/start_server.py --port 8080 --env "production" --max-connections 200 --log-level "INFO"` */ scriptCommand: string; /** * The type of the user-defined step. */ stepType: string; } interface GetDrPlansDrPlanCollectionItemPlanGroupStepUserDefinedStepObjectStorageScriptLocation { /** * The bucket name inside the object storage namespace. Example: `customDrScripts` */ bucket: string; /** * The namespace in object storage (Note - this is usually the tenancy name). Example: `myocitenancy` */ namespace: string; /** * The object name inside the object storage bucket. Example: `validate_app_start.sh` */ object: string; } interface GetDrPlansFilter { name: string; regex?: boolean; values: string[]; } interface GetDrProtectionGroupAssociation { /** * The OCID of the peer DR protection group. Example: `ocid1.drprotectiongroup.oc1..uniqueID` */ peerId: string; /** * The region of the peer DR protection group. Example: `us-ashburn-1` */ peerRegion: string; /** * The role of the DR protection group. */ role: string; } interface GetDrProtectionGroupLogLocation { /** * The bucket name inside the object storage namespace. Example: `bucketName` */ bucket: string; /** * The OKE namespace where the config map resides. Example: `namespaceString5` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface GetDrProtectionGroupMember { /** * This specifies the mechanism used to create a temporary Autonomous Database instance for DR Drills. See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-clone-about.html for information about these clone types. See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-data-guard-snapshot-standby.html for information about snapshot standby. */ autonomousDatabaseStandbyTypeForDrDrills: string; /** * A list of backend set mappings that are used to transfer or update backends during DR. */ backendSetMappings: outputs.DisasterRecovery.GetDrProtectionGroupMemberBackendSetMapping[]; /** * The details of backup performed on OKE Cluster. */ backupConfigs: outputs.DisasterRecovery.GetDrProtectionGroupMemberBackupConfig[]; /** * The details for object storage backup location of an OKE Cluster */ backupLocations: outputs.DisasterRecovery.GetDrProtectionGroupMemberBackupLocation[]; /** * The details of the block volume operations performed on the non-movable compute instance. */ blockVolumeAttachAndMountOperations: outputs.DisasterRecovery.GetDrProtectionGroupMemberBlockVolumeAttachAndMountOperation[]; /** * Deprecated. Use the 'blockVolumeAttachAndMountOperations' attribute instead of this. Operations performed on a list of block volumes used on the non-movable compute instance. */ blockVolumeOperations: outputs.DisasterRecovery.GetDrProtectionGroupMemberBlockVolumeOperation[]; /** * The bucket name inside the object storage namespace. Example: `bucketName` */ bucket: string; /** * The OCID of a vault and customer-managed encryption key in the destination region. */ commonDestinationKeys: outputs.DisasterRecovery.GetDrProtectionGroupMemberCommonDestinationKey[]; /** * The type of connection strings used to connect to an Autonomous Container Database snapshot standby created during a DR Drill operation. See https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html for information about these service types. */ connectionStringType: string; /** * The credentials for the HeatWave MySQL DB System administrator user, containing the username and the OCID of the vault secret that stores the password. */ dbSystemAdminUserDetails: outputs.DisasterRecovery.GetDrProtectionGroupMemberDbSystemAdminUserDetail[]; /** * The credentials for the HeatWave MySQL DB System replication user, containing the username and the OCID of the vault secret that stores the password. */ dbSystemReplicationUserDetails: outputs.DisasterRecovery.GetDrProtectionGroupMemberDbSystemReplicationUserDetail[]; /** * The availability domain of the destination mount target. Example: `BBTh:region-AD` */ destinationAvailabilityDomain: string; /** * The OCID of the backup policy to use in the destination region. This policy will be used to create backups for this volume group after it moves the destination region. Example: `ocid1.volumebackuppolicy.oc1..uniqueID` */ destinationBackupPolicyId: string; /** * The OCID of a capacity reservation in the destination region which will be used to launch the compute instance. Example: `ocid1.capacityreservation.oc1..uniqueID` */ destinationCapacityReservationId: string; /** * The OCID of a compartment in the destination region in which the compute instance should be launched. Example: `ocid1.compartment.oc1..uniqueID` */ destinationCompartmentId: string; /** * The OCID of a dedicated VM host in the destination region where the compute instance should be launched. Example: `ocid1.dedicatedvmhost.oc1..uniqueID` */ destinationDedicatedVmHostId: string; /** * The OCID of a vault and customer-managed encryption key in the destination region. */ destinationEncryptionKeys: outputs.DisasterRecovery.GetDrProtectionGroupMemberDestinationEncryptionKey[]; /** * The OCID of the destination Load Balancer. Example: `ocid1.loadbalancer.oc1..uniqueID` */ destinationLoadBalancerId: string; /** * The OCID of the destination Network Load Balancer. Example: `ocid1.networkloadbalancer.oc1..uniqueID` */ destinationNetworkLoadBalancerId: string; /** * The OCID of the snapshot policy to use in the destination region. This policy will be attached to the file system after it moves to the destination region. Example: `ocid1.filesystemsnapshotpolicy.oc1..uniqueID` */ destinationSnapshotPolicyId: string; /** * A list of mappings between the primary region file system export and destination region mount target. */ exportMappings: outputs.DisasterRecovery.GetDrProtectionGroupMemberExportMapping[]; /** * Operations performed on a list of file systems used on the non-movable compute instance. */ fileSystemOperations: outputs.DisasterRecovery.GetDrProtectionGroupMemberFileSystemOperation[]; /** * The maximum time (in seconds) to wait for the Global Transaction Identifier (GTID) synchronization process to complete before timing out. Example: `600` */ gtidReconciliationTimeout: number; /** * A flag indicating whether to continue with DR operation if the Global Transaction Identifier (GTID) reconciliation operation times out. Example: `false` */ isContinueOnGtidReconciliationTimeout: boolean; /** * A flag indicating if the compute instance should be moved during DR operations. Example: `false` */ isMovable: boolean; /** * A flag indicating if the compute instance should be moved to the same fault domain in the destination region. The compute instance launch will fail if this flag is set to true and capacity is not available in the specified fault domain in the destination region. Example: `false` */ isRetainFaultDomain: boolean; /** * A flag indicating whether the non-movable compute instance needs to be started and stopped during DR operations. */ isStartStopEnabled: boolean; /** * The OCID of the compute instance member that is designated as a jump host. This compute instance will be used to perform DR operations on the cluster using Oracle Cloud Agent's Run Command feature. Example: `ocid1.instance.oc1..uniqueID` */ jumpHostId: string; /** * The list of source-to-destination load balancer mappings required for DR operations. This property applies to the OKE cluster member in primary region. */ loadBalancerMappings: outputs.DisasterRecovery.GetDrProtectionGroupMemberLoadBalancerMapping[]; /** * The list of node pools with configurations for minimum and maximum node counts. This property applies to the OKE cluster member in both the primary and standby region. */ managedNodePoolConfigs: outputs.DisasterRecovery.GetDrProtectionGroupMemberManagedNodePoolConfig[]; /** * The OCID of the member. Example: `ocid1.instance.oc1..uniqueID` */ memberId: string; /** * The type of the member. */ memberType: string; /** * The OKE namespace where the config map resides. Example: `namespaceString5` */ namespace: string; /** * The list of source-to-destination network load balancer mappings required for DR operations. This property applies to the OKE cluster member in primary region. */ networkLoadBalancerMappings: outputs.DisasterRecovery.GetDrProtectionGroupMemberNetworkLoadBalancerMapping[]; /** * The OCID of the vault secret where the database SYSDBA password is stored. This password is required and used for performing database DR Drill operations when using full clone. Example: `ocid1.vaultsecret.oc1..uniqueID` */ passwordVaultSecretId: string; /** * The OCID of the peer OKE cluster. This property applies to the OKE cluster member in both the primary and standby region. Example: `ocid1.cluster.oc1.uniqueID` */ peerClusterId: string; /** * The OCID of the peer HeatWave MySQL DB System from the peer region. Example: `ocid1.mysqldbsystem.oc1..uniqueID` */ peerDbSystemId: string; /** * The list of config maps along with their corresponding namespaces. This property applies to the OKE cluster member in primary region. */ resourceModifierMappings: outputs.DisasterRecovery.GetDrProtectionGroupMemberResourceModifierMapping[]; /** * A list of mappings between source volume IDs in the volume group and customer-managed encryption keys in the destination region which will be used to encrypt the volume after it moves to the destination region. */ sourceVolumeToDestinationEncryptionKeyMappings: outputs.DisasterRecovery.GetDrProtectionGroupMemberSourceVolumeToDestinationEncryptionKeyMapping[]; /** * The list of source-to-destination vault mappings required for DR operations. This property applies to the OKE cluster member in primary region. */ vaultMappings: outputs.DisasterRecovery.GetDrProtectionGroupMemberVaultMapping[]; /** * The list of node pools with configurations for minimum and maximum node counts. This property applies to the OKE cluster member in both the primary and standby region. */ virtualNodePoolConfigs: outputs.DisasterRecovery.GetDrProtectionGroupMemberVirtualNodePoolConfig[]; /** * A list of compute instance VNIC mappings. */ vnicMapping: outputs.DisasterRecovery.GetDrProtectionGroupMemberVnicMapping[]; /** * A list of compute instance VNIC mappings. */ vnicMappings: outputs.DisasterRecovery.GetDrProtectionGroupMemberVnicMapping[]; } interface GetDrProtectionGroupMemberBackendSetMapping { /** * The name of the destination backend set. Example: `My_Destination_Backend_Set` */ destinationBackendSetName: string; /** * This flag specifies if this backend set is used for traffic for non-movable compute instances. Backend sets that point to non-movable instances are only enabled or disabled during DR. For non-movable instances this flag should be set to 'true'. Backend sets that point to movable instances are emptied and their contents are transferred to the destination region network load balancer. For movable instances this flag should be set to 'false'. Example: `true` */ isBackendSetForNonMovable: boolean; /** * The name of the source backend set. Example: `My_Source_Backend_Set` */ sourceBackendSetName: string; } interface GetDrProtectionGroupMemberBackupConfig { /** * The schedule for backing up namespaces to the destination region. If a backup schedule is not specified, only a single backup will be created. This format of the string specifying the backup schedule must conform with RFC-5545. This schedule will use the UTC timezone. This property applies to the OKE cluster member in primary region. Example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1 */ backupSchedule: string; /** * A list of namespaces to be excluded from the backup. The default value is null. If a list of namespaces to exclude is not provided, all namespaces will be backed up. Specify either the `namespaces` or the `excludeNamespaces` parameter, but not both. This property applies to OKE cluster members in the primary region. Example: ["namespaceString3", "namespaceString4"] */ excludeNamespaces: string[]; /** * The OCID of the vault secret that stores the image credential. This property applies to the OKE cluster member in both the primary and standby region. */ imageReplicationVaultSecretId: string; /** * The maximum number of backups that should be retained. This property applies to the OKE cluster member in primary region. */ maxNumberOfBackupsRetained: number; /** * A list of namespaces to be included in the backup. The default value is null. If a list of namespaces to include is not provided, all namespaces will be backed up. Specify either the `namespaces` or the `excludeNamespaces` parameter, but not both. This property applies to the OKE cluster member in primary region. Example: ["default", "pv-nginx"] */ namespaces: string[]; /** * Controls the behaviour of image replication across regions. This property applies to the OKE cluster member in primary region. */ replicateImages: string; } interface GetDrProtectionGroupMemberBackupLocation { /** * The bucket name inside the object storage namespace. Example: `bucketName` */ bucket: string; /** * The OKE namespace where the config map resides. Example: `namespaceString5` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface GetDrProtectionGroupMemberBlockVolumeAttachAndMountOperation { /** * A list of details of attach or detach operations performed on block volumes. */ attachments: outputs.DisasterRecovery.GetDrProtectionGroupMemberBlockVolumeAttachAndMountOperationAttachment[]; /** * A list of details of mount operations performed on block volumes. */ mounts: outputs.DisasterRecovery.GetDrProtectionGroupMemberBlockVolumeAttachAndMountOperationMount[]; } interface GetDrProtectionGroupMemberBlockVolumeAttachAndMountOperationAttachment { /** * The OCID of the block volume. Example: `ocid1.volume.oc1..uniqueID` */ blockVolumeId: string; /** * The OCID of the reference compute instance needed to obtain the volume attachment details. This reference compute instance belongs to the peer DR protection group. Example: `ocid1.instance.oc1..uniqueID` */ volumeAttachmentReferenceInstanceId: string; } interface GetDrProtectionGroupMemberBlockVolumeAttachAndMountOperationMount { /** * The physical mount point of the file system on a host. Example: `/mnt/yourmountpoint` */ mountPoint: string; } interface GetDrProtectionGroupMemberBlockVolumeOperation { /** * Deprecated. Use the 'ComputeInstanceNonMovableBlockVolumeAttachOperationDetails' definition instead of this. The details for attaching or detaching a block volume. */ attachmentDetails: outputs.DisasterRecovery.GetDrProtectionGroupMemberBlockVolumeOperationAttachmentDetail[]; /** * The OCID of the block volume. Example: `ocid1.volume.oc1..uniqueID` */ blockVolumeId: string; /** * Mount details of a file system. */ mountDetails: outputs.DisasterRecovery.GetDrProtectionGroupMemberBlockVolumeOperationMountDetail[]; } interface GetDrProtectionGroupMemberBlockVolumeOperationAttachmentDetail { /** * The OCID of the reference compute instance needed to obtain the volume attachment details. This reference compute instance belongs to the peer DR protection group. Example: `ocid1.instance.oc1..uniqueID` */ volumeAttachmentReferenceInstanceId: string; } interface GetDrProtectionGroupMemberBlockVolumeOperationMountDetail { /** * The physical mount point of the file system on a host. Example: `/mnt/yourmountpoint` */ mountPoint: string; } interface GetDrProtectionGroupMemberCommonDestinationKey { /** * The OCID of the customer-managed encryption key in the destination region vault. Example: `ocid1.key.oc1..uniqueID` */ encryptionKeyId: string; /** * The OCID of the destination region vault for the customer-managed encryption key. Example: `ocid1.vault.oc1..uniqueID` */ vaultId: string; } interface GetDrProtectionGroupMemberDbSystemAdminUserDetail { /** * The OCID of the vault secret where the database SYSDBA password is stored. This password is required and used for performing database DR Drill operations when using full clone. Example: `ocid1.vaultsecret.oc1..uniqueID` */ passwordVaultSecretId: string; /** * The user name for connecting to the HeatWave MySQL DB System node. Example: `user` */ username: string; } interface GetDrProtectionGroupMemberDbSystemReplicationUserDetail { /** * The OCID of the vault secret where the database SYSDBA password is stored. This password is required and used for performing database DR Drill operations when using full clone. Example: `ocid1.vaultsecret.oc1..uniqueID` */ passwordVaultSecretId: string; /** * The user name for connecting to the HeatWave MySQL DB System node. Example: `user` */ username: string; } interface GetDrProtectionGroupMemberDestinationEncryptionKey { /** * The OCID of the customer-managed encryption key in the destination region vault. Example: `ocid1.key.oc1..uniqueID` */ encryptionKeyId: string; /** * The OCID of the destination region vault for the customer-managed encryption key. Example: `ocid1.vault.oc1..uniqueID` */ vaultId: string; } interface GetDrProtectionGroupMemberExportMapping { /** * The OCID of the destination mount target on which this file system export should be created. Example: `ocid1.mounttarget.oc1..uniqueID` */ destinationMountTargetId: string; /** * The OCID of the export path. Example: `ocid1.export.oc1..uniqueID` */ exportId: string; } interface GetDrProtectionGroupMemberFileSystemOperation { /** * The export path of the file system. Example: `/fs-export-path` */ exportPath: string; /** * Mount details of a file system. */ mountDetails: outputs.DisasterRecovery.GetDrProtectionGroupMemberFileSystemOperationMountDetail[]; /** * The physical mount point of the file system on a host. Example: `/mnt/yourmountpoint` */ mountPoint: string; /** * The OCID of the mount target for this file system. Example: `ocid1.mounttarget.oc1..uniqueID` */ mountTargetId: string; /** * Unmount details for a file system. */ unmountDetails: outputs.DisasterRecovery.GetDrProtectionGroupMemberFileSystemOperationUnmountDetail[]; } interface GetDrProtectionGroupMemberFileSystemOperationMountDetail { /** * The OCID of the mount target for this file system. Example: `ocid1.mounttarget.oc1..uniqueID` */ mountTargetId: string; } interface GetDrProtectionGroupMemberFileSystemOperationUnmountDetail { /** * The OCID of the mount target for this file system. Example: `ocid1.mounttarget.oc1..uniqueID` */ mountTargetId: string; } interface GetDrProtectionGroupMemberLoadBalancerMapping { /** * The OCID of the destination Load Balancer. Example: `ocid1.loadbalancer.oc1..uniqueID` */ destinationLoadBalancerId: string; /** * The OCID of the source Load Balancer. Example: `ocid1.loadbalancer.oc1..uniqueID` */ sourceLoadBalancerId: string; } interface GetDrProtectionGroupMemberManagedNodePoolConfig { /** * The OCID of the virtual node pool in OKE cluster. */ id: string; /** * The maximum number to which nodes in the virtual node pool could be scaled up. */ maximum: number; /** * The minimum number to which nodes in the virtual node pool could be scaled down. */ minimum: number; } interface GetDrProtectionGroupMemberNetworkLoadBalancerMapping { /** * The OCID of the destination Network Load Balancer. Example: `ocid1.networkloadbalancer.oc1..uniqueID` */ destinationNetworkLoadBalancerId: string; /** * The OCID of the source Network Load Balancer. Example: `ocid1.networkloadbalancer.oc1..uniqueID` */ sourceNetworkLoadBalancerId: string; } interface GetDrProtectionGroupMemberResourceModifierMapping { /** * The name of the config map containing resource modification details. Example: `resource-modifier` */ configMap: string; /** * The OKE namespace where the config map resides. Example: `namespaceString5` */ namespace: string; } interface GetDrProtectionGroupMemberSourceVolumeToDestinationEncryptionKeyMapping { /** * The OCID of a vault and customer-managed encryption key in the destination region. */ destinationEncryptionKeys: outputs.DisasterRecovery.GetDrProtectionGroupMemberSourceVolumeToDestinationEncryptionKeyMappingDestinationEncryptionKey[]; /** * The OCID of the source boot volume or block volume. Example: `ocid1.volume.oc1..uniqueID` */ sourceVolumeId: string; } interface GetDrProtectionGroupMemberSourceVolumeToDestinationEncryptionKeyMappingDestinationEncryptionKey { /** * The OCID of the customer-managed encryption key in the destination region vault. Example: `ocid1.key.oc1..uniqueID` */ encryptionKeyId: string; /** * The OCID of the destination region vault for the customer-managed encryption key. Example: `ocid1.vault.oc1..uniqueID` */ vaultId: string; } interface GetDrProtectionGroupMemberVaultMapping { /** * The OCID of the destination Vault. Example: `ocid1.vault.oc1..uniqueID` */ destinationVaultId: string; /** * The OCID of the source Vault. Example: `ocid1.vault.oc1..uniqueID` */ sourceVaultId: string; } interface GetDrProtectionGroupMemberVirtualNodePoolConfig { /** * The OCID of the virtual node pool in OKE cluster. */ id: string; /** * The maximum number to which nodes in the virtual node pool could be scaled up. */ maximum: number; /** * The minimum number to which nodes in the virtual node pool could be scaled down. */ minimum: number; } interface GetDrProtectionGroupMemberVnicMapping { /** * A list of OCIDs of network security groups (NSG) in the destination region which should be assigned to the source VNIC. Example: `[ ocid1.networksecuritygroup.oc1..uniqueID, ocid1.networksecuritygroup.oc1..uniqueID ]` */ destinationNsgIdLists: string[]; /** * The private IP address to be assigned as the VNIC's primary IP address in the destination subnet. This must be a valid IP address in the destination subnet and the IP address must be available. Example: `10.0.3.3` */ destinationPrimaryPrivateIpAddress: string; /** * The hostname label to be assigned in the destination subnet for the primary private IP of the source VNIC. This label is the hostname portion of the private IP's fully qualified domain name (FQDN) (for example, 'myhost1' in the FQDN 'myhost1.subnet123.vcn1.oraclevcn.com'). Example: `myhost1` */ destinationPrimaryPrivateIpHostnameLabel: string; /** * The OCID of the reserved public IP address to be assigned to the compute instance in the destination region. Example: `ocid1.publicip.oc1..uniqueID` */ destinationReservedPublicIpId: string; /** * The OCID of the destination subnet to which the source VNIC should connect. Example: `ocid1.subnet.oc1..uniqueID` */ destinationSubnetId: string; /** * The OCID of the source VNIC. Example: `ocid1.vnic.oc1..uniqueID` */ sourceVnicId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollection { items: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItem[]; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItem { associations: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemAssociation[]; /** * The ID (OCID) of the compartment in which to list resources. Example: `ocid1.compartment.oc1..uniqueID` */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; disassociateTrigger: number; /** * A filter to return only resources that match the given display name. Example: `MyResourceDisplayName` */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the virtual node pool in OKE cluster. */ id: string; /** * A message describing the DR protection group's current state in more detail. */ lifeCycleDetails: string; /** * A filter to return only DR protection groups that match the given lifecycle sub-state. */ lifecycleSubState: string; /** * The details of an object storage log location for a DR protection group. */ logLocations: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemLogLocation[]; /** * A list of DR protection group members. */ members: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMember[]; /** * The OCID of the peer DR protection group. Example: `ocid1.drprotectiongroup.oc1..uniqueID` */ peerId: string; /** * The region of the peer DR protection group. Example: `us-ashburn-1` */ peerRegion: string; /** * The DR protection group Role. */ role: string; /** * A filter to return only DR protection groups that match the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the DR protection group was created. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeCreated: string; /** * The date and time the DR protection group was updated. An RFC3339 formatted datetime string. Example: `2019-03-29T09:36:42Z` */ timeUpdated: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemAssociation { /** * The OCID of the peer DR protection group. Example: `ocid1.drprotectiongroup.oc1..uniqueID` */ peerId: string; /** * The region of the peer DR protection group. Example: `us-ashburn-1` */ peerRegion: string; /** * The DR protection group Role. */ role: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemLogLocation { /** * The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; /** * The OKE namespace where the config map resides. Example: `namespaceString5` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMember { /** * This specifies the mechanism used to create a temporary Autonomous Database instance for DR Drills. See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-clone-about.html for information about these clone types. See https://docs.oracle.com/en/cloud/paas/autonomous-database/serverless/adbsb/autonomous-data-guard-snapshot-standby.html for information about snapshot standby. */ autonomousDatabaseStandbyTypeForDrDrills: string; /** * A list of backend set mappings that are used to transfer or update backends during DR. */ backendSetMappings: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBackendSetMapping[]; /** * The details of backup performed on OKE Cluster. */ backupConfigs: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBackupConfig[]; /** * The details for object storage backup location of an OKE Cluster */ backupLocations: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBackupLocation[]; /** * The details of the block volume operations performed on the non-movable compute instance. */ blockVolumeAttachAndMountOperations: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeAttachAndMountOperation[]; /** * Deprecated. Use the 'blockVolumeAttachAndMountOperations' attribute instead of this. Operations performed on a list of block volumes used on the non-movable compute instance. */ blockVolumeOperations: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeOperation[]; /** * The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; commonDestinationKeys: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberCommonDestinationKey[]; /** * The type of connection strings used to connect to an Autonomous Container Database snapshot standby created during a DR Drill operation. See https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbcl/index.html for information about these service types. */ connectionStringType: string; /** * The credentials for the HeatWave MySQL DB System administrator user, containing the username and the OCID of the vault secret that stores the password. */ dbSystemAdminUserDetails: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberDbSystemAdminUserDetail[]; /** * The credentials for the HeatWave MySQL DB System replication user, containing the username and the OCID of the vault secret that stores the password. */ dbSystemReplicationUserDetails: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberDbSystemReplicationUserDetail[]; /** * The availability domain of the destination mount target. Example: `BBTh:region-AD` */ destinationAvailabilityDomain: string; /** * The OCID of the backup policy to use in the destination region. This policy will be used to create backups for this volume group after it moves the destination region. Example: `ocid1.volumebackuppolicy.oc1..uniqueID` */ destinationBackupPolicyId: string; /** * The OCID of a capacity reservation in the destination region which will be used to launch the compute instance. Example: `ocid1.capacityreservation.oc1..uniqueID` */ destinationCapacityReservationId: string; /** * The OCID of a compartment in the destination region in which the compute instance should be launched. Example: `ocid1.compartment.oc1..uniqueID` */ destinationCompartmentId: string; /** * The OCID of a dedicated VM host in the destination region where the compute instance should be launched. Example: `ocid1.dedicatedvmhost.oc1..uniqueID` */ destinationDedicatedVmHostId: string; /** * The OCID of a vault and customer-managed encryption key in the destination region. */ destinationEncryptionKeys: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberDestinationEncryptionKey[]; /** * The OCID of the destination Load Balancer. Example: `ocid1.loadbalancer.oc1..uniqueID` */ destinationLoadBalancerId: string; /** * The OCID of the destination Network Load Balancer. Example: `ocid1.networkloadbalancer.oc1..uniqueID` */ destinationNetworkLoadBalancerId: string; /** * The OCID of the snapshot policy to use in the destination region. This policy will be attached to the file system after it moves to the destination region. Example: `ocid1.filesystemsnapshotpolicy.oc1..uniqueID` */ destinationSnapshotPolicyId: string; /** * A list of mappings between the primary region file system export and destination region mount target. */ exportMappings: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberExportMapping[]; /** * Operations performed on a list of file systems used on the non-movable compute instance. */ fileSystemOperations: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberFileSystemOperation[]; /** * The maximum time (in seconds) to wait for the Global Transaction Identifier (GTID) synchronization process to complete before timing out. Example: `600` */ gtidReconciliationTimeout: number; /** * A flag indicating whether to continue with DR operation if the Global Transaction Identifier (GTID) reconciliation operation times out. Example: `false` */ isContinueOnGtidReconciliationTimeout: boolean; /** * A flag indicating if the compute instance should be moved during DR operations. Example: `false` */ isMovable: boolean; /** * A flag indicating if the compute instance should be moved to the same fault domain in the destination region. The compute instance launch will fail if this flag is set to true and capacity is not available in the specified fault domain in the destination region. Example: `false` */ isRetainFaultDomain: boolean; /** * A flag indicating whether the non-movable compute instance needs to be started and stopped during DR operations. */ isStartStopEnabled: boolean; /** * The OCID of the compute instance member that is designated as a jump host. This compute instance will be used to perform DR operations on the cluster using Oracle Cloud Agent's Run Command feature. Example: `ocid1.instance.oc1..uniqueID` */ jumpHostId: string; /** * The list of source-to-destination load balancer mappings required for DR operations. This property applies to the OKE cluster member in primary region. */ loadBalancerMappings: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberLoadBalancerMapping[]; /** * The list of node pools with configurations for minimum and maximum node counts. This property applies to the OKE cluster member in both the primary and standby region. */ managedNodePoolConfigs: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberManagedNodePoolConfig[]; /** * The OCID of the member. Example: `ocid1.instance.oc1..uniqueID` */ memberId: string; /** * The type of the member. */ memberType: string; /** * The OKE namespace where the config map resides. Example: `namespaceString5` */ namespace: string; /** * The list of source-to-destination network load balancer mappings required for DR operations. This property applies to the OKE cluster member in primary region. */ networkLoadBalancerMappings: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberNetworkLoadBalancerMapping[]; /** * The OCID of the vault secret where the database SYSDBA password is stored. This password is required and used for performing database DR Drill operations when using full clone. Example: `ocid1.vaultsecret.oc1..uniqueID` */ passwordVaultSecretId: string; /** * The OCID of the peer OKE cluster. This property applies to the OKE cluster member in both the primary and standby region. Example: `ocid1.cluster.oc1.uniqueID` */ peerClusterId: string; /** * The OCID of the peer HeatWave MySQL DB System from the peer region. Example: `ocid1.mysqldbsystem.oc1..uniqueID` */ peerDbSystemId: string; /** * The list of config maps along with their corresponding namespaces. This property applies to the OKE cluster member in primary region. */ resourceModifierMappings: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberResourceModifierMapping[]; /** * A list of mappings between source volume IDs in the volume group and customer-managed encryption keys in the destination region which will be used to encrypt the volume after it moves to the destination region. */ sourceVolumeToDestinationEncryptionKeyMappings: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberSourceVolumeToDestinationEncryptionKeyMapping[]; /** * The list of source-to-destination vault mappings required for DR operations. This property applies to the OKE cluster member in primary region. */ vaultMappings: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberVaultMapping[]; /** * The list of node pools with configurations for minimum and maximum node counts. This property applies to the OKE cluster member in both the primary and standby region. */ virtualNodePoolConfigs: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberVirtualNodePoolConfig[]; /** * A list of compute instance VNIC mappings. */ vnicMapping: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberVnicMapping[]; /** * A list of compute instance VNIC mappings. */ vnicMappings: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberVnicMapping[]; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBackendSetMapping { /** * The name of the destination backend set. Example: `My_Destination_Backend_Set` */ destinationBackendSetName: string; /** * This flag specifies if this backend set is used for traffic for non-movable compute instances. Backend sets that point to non-movable instances are only enabled or disabled during DR. For non-movable instances this flag should be set to 'true'. Backend sets that point to movable instances are emptied and their contents are transferred to the destination region network load balancer. For movable instances this flag should be set to 'false'. Example: `true` */ isBackendSetForNonMovable: boolean; /** * The name of the source backend set. Example: `My_Source_Backend_Set` */ sourceBackendSetName: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBackupConfig { /** * The schedule for backing up namespaces to the destination region. If a backup schedule is not specified, only a single backup will be created. This format of the string specifying the backup schedule must conform with RFC-5545. This schedule will use the UTC timezone. This property applies to the OKE cluster member in primary region. Example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1 */ backupSchedule: string; /** * A list of namespaces to be excluded from the backup. The default value is null. If a list of namespaces to exclude is not provided, all namespaces will be backed up. Specify either the `namespaces` or the `excludeNamespaces` parameter, but not both. This property applies to OKE cluster members in the primary region. Example: ["namespaceString3", "namespaceString4"] */ excludeNamespaces: string[]; /** * The OCID of the vault secret that stores the image credential. This property applies to the OKE cluster member in both the primary and standby region. */ imageReplicationVaultSecretId: string; /** * The maximum number of backups that should be retained. This property applies to the OKE cluster member in primary region. */ maxNumberOfBackupsRetained: number; /** * A list of namespaces to be included in the backup. The default value is null. If a list of namespaces to include is not provided, all namespaces will be backed up. Specify either the `namespaces` or the `excludeNamespaces` parameter, but not both. This property applies to the OKE cluster member in primary region. Example: ["default", "pv-nginx"] */ namespaces: string[]; /** * Controls the behaviour of image replication across regions. This property applies to the OKE cluster member in primary region. */ replicateImages: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBackupLocation { /** * The bucket name inside the object storage namespace. Example: `operationLogs` */ bucket: string; /** * The OKE namespace where the config map resides. Example: `namespaceString5` */ namespace: string; /** * The object name inside the object storage bucket. Example: `switchoverPlanExecutions` */ object: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeAttachAndMountOperation { /** * A list of details of attach or detach operations performed on block volumes. */ attachments: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeAttachAndMountOperationAttachment[]; /** * A list of details of mount operations performed on block volumes. */ mounts: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeAttachAndMountOperationMount[]; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeAttachAndMountOperationAttachment { /** * The OCID of the block volume. Example: `ocid1.volume.oc1..uniqueID` */ blockVolumeId: string; /** * The OCID of the reference compute instance needed to obtain the volume attachment details. This reference compute instance belongs to the peer DR protection group. Example: `ocid1.instance.oc1..uniqueID` */ volumeAttachmentReferenceInstanceId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeAttachAndMountOperationMount { /** * The physical mount point of the file system on a host. Example: `/mnt/yourmountpoint` */ mountPoint: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeOperation { /** * Deprecated. Use the 'ComputeInstanceNonMovableBlockVolumeAttachOperationDetails' definition instead of this. The details for attaching or detaching a block volume. */ attachmentDetails: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeOperationAttachmentDetail[]; /** * The OCID of the block volume. Example: `ocid1.volume.oc1..uniqueID` */ blockVolumeId: string; /** * Mount details of a file system. */ mountDetails: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeOperationMountDetail[]; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeOperationAttachmentDetail { /** * The OCID of the reference compute instance needed to obtain the volume attachment details. This reference compute instance belongs to the peer DR protection group. Example: `ocid1.instance.oc1..uniqueID` */ volumeAttachmentReferenceInstanceId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberBlockVolumeOperationMountDetail { /** * The physical mount point of the file system on a host. Example: `/mnt/yourmountpoint` */ mountPoint: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberCommonDestinationKey { /** * The OCID of the customer-managed encryption key in the destination region vault. Example: `ocid1.key.oc1..uniqueID` */ encryptionKeyId: string; /** * The OCID of the destination region vault for the customer-managed encryption key. Example: `ocid1.vault.oc1..uniqueID` */ vaultId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberDbSystemAdminUserDetail { /** * The OCID of the vault secret where the database SYSDBA password is stored. This password is required and used for performing database DR Drill operations when using full clone. Example: `ocid1.vaultsecret.oc1..uniqueID` */ passwordVaultSecretId: string; /** * The user name for connecting to the HeatWave MySQL DB System node. Example: `user` */ username: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberDbSystemReplicationUserDetail { /** * The OCID of the vault secret where the database SYSDBA password is stored. This password is required and used for performing database DR Drill operations when using full clone. Example: `ocid1.vaultsecret.oc1..uniqueID` */ passwordVaultSecretId: string; /** * The user name for connecting to the HeatWave MySQL DB System node. Example: `user` */ username: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberDestinationEncryptionKey { /** * The OCID of the customer-managed encryption key in the destination region vault. Example: `ocid1.key.oc1..uniqueID` */ encryptionKeyId: string; /** * The OCID of the destination region vault for the customer-managed encryption key. Example: `ocid1.vault.oc1..uniqueID` */ vaultId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberExportMapping { /** * The OCID of the destination mount target on which this file system export should be created. Example: `ocid1.mounttarget.oc1..uniqueID` */ destinationMountTargetId: string; /** * The OCID of the export path. Example: `ocid1.export.oc1..uniqueID` */ exportId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberFileSystemOperation { /** * The export path of the file system. Example: `/fs-export-path` */ exportPath: string; /** * Mount details of a file system. */ mountDetails: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberFileSystemOperationMountDetail[]; /** * The physical mount point of the file system on a host. Example: `/mnt/yourmountpoint` */ mountPoint: string; /** * The OCID of the mount target for this file system. Example: `ocid1.mounttarget.oc1..uniqueID` */ mountTargetId: string; /** * Unmount details for a file system. */ unmountDetails: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberFileSystemOperationUnmountDetail[]; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberFileSystemOperationMountDetail { /** * The OCID of the mount target for this file system. Example: `ocid1.mounttarget.oc1..uniqueID` */ mountTargetId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberFileSystemOperationUnmountDetail { /** * The OCID of the mount target for this file system. Example: `ocid1.mounttarget.oc1..uniqueID` */ mountTargetId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberLoadBalancerMapping { /** * The OCID of the destination Load Balancer. Example: `ocid1.loadbalancer.oc1..uniqueID` */ destinationLoadBalancerId: string; /** * The OCID of the source Load Balancer. Example: `ocid1.loadbalancer.oc1..uniqueID` */ sourceLoadBalancerId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberManagedNodePoolConfig { /** * The OCID of the virtual node pool in OKE cluster. */ id: string; /** * The maximum number to which nodes in the virtual node pool could be scaled up. */ maximum: number; /** * The minimum number to which nodes in the virtual node pool could be scaled down. */ minimum: number; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberNetworkLoadBalancerMapping { /** * The OCID of the destination Network Load Balancer. Example: `ocid1.networkloadbalancer.oc1..uniqueID` */ destinationNetworkLoadBalancerId: string; /** * The OCID of the source Network Load Balancer. Example: `ocid1.networkloadbalancer.oc1..uniqueID` */ sourceNetworkLoadBalancerId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberResourceModifierMapping { /** * The name of the config map containing resource modification details. Example: `resource-modifier` */ configMap: string; /** * The OKE namespace where the config map resides. Example: `namespaceString5` */ namespace: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberSourceVolumeToDestinationEncryptionKeyMapping { /** * The OCID of a vault and customer-managed encryption key in the destination region. */ destinationEncryptionKeys: outputs.DisasterRecovery.GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberSourceVolumeToDestinationEncryptionKeyMappingDestinationEncryptionKey[]; /** * The OCID of the source boot volume or block volume. Example: `ocid1.volume.oc1..uniqueID` */ sourceVolumeId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberSourceVolumeToDestinationEncryptionKeyMappingDestinationEncryptionKey { /** * The OCID of the customer-managed encryption key in the destination region vault. Example: `ocid1.key.oc1..uniqueID` */ encryptionKeyId: string; /** * The OCID of the destination region vault for the customer-managed encryption key. Example: `ocid1.vault.oc1..uniqueID` */ vaultId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberVaultMapping { /** * The OCID of the destination Vault. Example: `ocid1.vault.oc1..uniqueID` */ destinationVaultId: string; /** * The OCID of the source Vault. Example: `ocid1.vault.oc1..uniqueID` */ sourceVaultId: string; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberVirtualNodePoolConfig { /** * The OCID of the virtual node pool in OKE cluster. */ id: string; /** * The maximum number to which nodes in the virtual node pool could be scaled up. */ maximum: number; /** * The minimum number to which nodes in the virtual node pool could be scaled down. */ minimum: number; } interface GetDrProtectionGroupsDrProtectionGroupCollectionItemMemberVnicMapping { /** * A list of OCIDs of network security groups (NSG) in the destination region which should be assigned to the source VNIC. Example: `[ ocid1.networksecuritygroup.oc1..uniqueID, ocid1.networksecuritygroup.oc1..uniqueID ]` */ destinationNsgIdLists: string[]; /** * The private IP address to be assigned as the VNIC's primary IP address in the destination subnet. This must be a valid IP address in the destination subnet and the IP address must be available. Example: `10.0.3.3` */ destinationPrimaryPrivateIpAddress: string; /** * The hostname label to be assigned in the destination subnet for the primary private IP of the source VNIC. This label is the hostname portion of the private IP's fully qualified domain name (FQDN) (for example, 'myhost1' in the FQDN 'myhost1.subnet123.vcn1.oraclevcn.com'). Example: `myhost1` */ destinationPrimaryPrivateIpHostnameLabel: string; /** * The OCID of the reserved public IP address to be assigned to the compute instance in the destination region. Example: `ocid1.publicip.oc1..uniqueID` */ destinationReservedPublicIpId: string; /** * The OCID of the destination subnet to which the source VNIC should connect. Example: `ocid1.subnet.oc1..uniqueID` */ destinationSubnetId: string; /** * The OCID of the source VNIC. Example: `ocid1.vnic.oc1..uniqueID` */ sourceVnicId: string; } interface GetDrProtectionGroupsFilter { name: string; regex?: boolean; values: string[]; } } export declare namespace Dns { interface ActionCreateZoneFromZoneFileDnssecConfig { kskDnssecKeyVersions: outputs.Dns.ActionCreateZoneFromZoneFileDnssecConfigKskDnssecKeyVersion[]; zskDnssecKeyVersions: outputs.Dns.ActionCreateZoneFromZoneFileDnssecConfigZskDnssecKeyVersion[]; } interface ActionCreateZoneFromZoneFileDnssecConfigKskDnssecKeyVersion { algorithm: string; dsDatas: outputs.Dns.ActionCreateZoneFromZoneFileDnssecConfigKskDnssecKeyVersionDsData[]; keyTag: number; lengthInBytes: number; predecessorDnssecKeyVersionUuid: string; successorDnssecKeyVersionUuid: string; timeActivated: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; timeExpired: string; timeInactivated: string; timePromoted: string; timePublished: string; timeUnpublished: string; uuid: string; } interface ActionCreateZoneFromZoneFileDnssecConfigKskDnssecKeyVersionDsData { digestType: string; rdata: string; } interface ActionCreateZoneFromZoneFileDnssecConfigZskDnssecKeyVersion { algorithm: string; keyTag: number; lengthInBytes: number; predecessorDnssecKeyVersionUuid: string; successorDnssecKeyVersionUuid: string; timeActivated: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; timeExpired: string; timeInactivated: string; timePromoted: string; timePublished: string; timeUnpublished: string; uuid: string; } interface ActionCreateZoneFromZoneFileExternalDownstream { /** * The server's IP address (IPv4 or IPv6). */ address: string; /** * The server's port. */ port: number; /** * The OCID of the TSIG key. */ tsigKeyId: string; } interface ActionCreateZoneFromZoneFileExternalMaster { /** * The server's IP address (IPv4 or IPv6). */ address: string; /** * The server's port. */ port: number; /** * The OCID of the TSIG key. */ tsigKeyId: string; } interface ActionCreateZoneFromZoneFileNameserver { /** * The hostname of the nameserver. */ hostname: string; } interface ActionCreateZoneFromZoneFileZoneTransferServer { /** * The server's IP address (IPv4 or IPv6). */ address: string; /** * A Boolean flag indicating whether or not the server is a zone data transfer destination. */ isTransferDestination: boolean; /** * A Boolean flag indicating whether or not the server is a zone data transfer source. */ isTransferSource: boolean; /** * The server's port. */ port: number; } interface GetRecordsFilter { name: string; regex?: boolean; values: string[]; } interface GetRecordsRecord { /** * The OCID of the compartment the zone belongs to. * * This parameter is deprecated and should be omitted. */ compartmentId?: string; /** * Search by domain. Will match any record whose domain (case-insensitive) equals the provided value. * * @deprecated The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead. */ domain: string; /** * A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed. */ isProtected: boolean; /** * The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm) */ rdata?: string; /** * A unique identifier for the record within its zone. */ recordHash: string; /** * The latest version of the record's zone in which its RRSet differs from the preceding version. */ rrsetVersion: string; /** * Search by record type. Will match any record whose [type](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) (case-insensitive) equals the provided value. * * @deprecated The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead. */ rtype: string; /** * The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended. */ ttl?: number; /** * The name or OCID of the target zone. * * @deprecated The 'oci_dns_record' resource has been deprecated. Please use 'oci_dns_rrset' instead. */ zoneNameOrId: string; } interface GetResolverAttachedView { /** * The OCID of the view. */ viewId: string; } interface GetResolverEndpoint { /** * The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed. */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * The type of resolver endpoint. VNIC is currently the only supported type. */ endpointType: string; /** * An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true. */ forwardingAddress: string; /** * 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). */ freeformTags: { [key: string]: string; }; /** * The OCID of the resolver. */ id: string; /** * A Boolean flag indicating whether or not the resolver endpoint is for forwarding. */ isForwarding: boolean; /** * A Boolean flag indicating whether or not the resolver endpoint is for listening. */ isListening: boolean; /** * An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true. */ listeningAddress: string; /** * The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint resource that this resolver endpoint corresponds to. */ peId: string; /** * The OCID of the target resolver. */ resolverId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The canonical absolute URL of the resource. */ self: string; /** * The current state of the resource. */ state: string; /** * The OCID of a subnet. Must be part of the VCN that the resolver is attached to. */ subnetId: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC resource that this resolver endpoint corresponds to. */ vnicId: string; } interface GetResolverEndpointsFilter { /** * The name of a resource. */ name: string; regex?: boolean; values: string[]; } interface GetResolverEndpointsResolverEndpoint { /** * The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed. */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * The type of resolver endpoint. VNIC is currently the only supported type. */ endpointType: string; /** * An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true. */ forwardingAddress: string; /** * 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). */ freeformTags: { [key: string]: string; }; /** * The Terraform ID of the resolver endpoint. */ id: string; /** * A Boolean flag indicating whether or not the resolver endpoint is for forwarding. */ isForwarding: boolean; /** * A Boolean flag indicating whether or not the resolver endpoint is for listening. */ isListening: boolean; /** * An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true. */ listeningAddress: string; /** * The name of a resource. */ name: string; /** * An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of. */ nsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint resource that this resolver endpoint corresponds to. */ peId: string; /** * The OCID of the target resolver. */ resolverId: string; /** * Value must be `PRIVATE` when listing private name resolver endpoints. */ scope: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The canonical absolute URL of the resource. */ self: string; /** * The state of a resource. */ state: string; /** * The OCID of a subnet. Must be part of the VCN that the resolver is attached to. */ subnetId: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC resource that this resolver endpoint corresponds to. */ vnicId: string; } interface GetResolverRule { /** * The action determines the behavior of the rule. If a query matches a supplied condition, the action will apply. If there are no conditions on the rule, all queries are subject to the specified action. * * `FORWARD` - Matching requests will be forwarded from the source interface to the destination address. */ action: string; /** * A list of CIDR blocks. In order for the rule action to apply, the query must come from a client within one of the CIDR blocks. */ clientAddressConditions: string[]; /** * IP addresses to which queries should be forwarded. Currently limited to a single address. */ destinationAddresses: string[]; /** * A list of domain names. In order for the rule action to apply, the query must either match or be a subdomain of one of the listed domains. */ qnameCoverConditions: string[]; /** * Case-insensitive name of an endpoint, that is a sub-resource of the resolver, to use as the forwarding interface. The endpoint must have isForwarding set to true. */ sourceEndpointName: string; } interface GetResolversFilter { /** * The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. */ name: string; regex?: boolean; values: string[]; } interface GetResolversResolver { /** * The OCID of the attached VCN. */ attachedVcnId: string; attachedViews: outputs.Dns.GetResolversResolverAttachedView[]; /** * The OCID of the compartment the resource belongs to. */ compartmentId: string; /** * The OCID of the default view. */ defaultViewId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * The displayName of a resource. */ displayName: string; /** * Read-only array of endpoints for the resolver. */ endpoints: outputs.Dns.GetResolversResolverEndpoint[]; /** * 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). */ freeformTags: { [key: string]: string; }; /** * The OCID of a resource. */ id: string; /** * A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. */ isProtected: boolean; /** * The OCID of the resolver. */ resolverId: string; rules: outputs.Dns.GetResolversResolverRule[]; /** * Value must be `PRIVATE` when listing private resolvers. */ scope: string; /** * The canonical absolute URL of the resource. */ self: string; /** * The state of a resource. */ state: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeUpdated: string; } interface GetResolversResolverAttachedView { viewId: string; } interface GetResolversResolverEndpoint { /** * The OCID of the compartment the resource belongs to. */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * The type of resolver endpoint. VNIC is currently the only supported type. */ endpointType: string; /** * An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true. */ forwardingAddress: string; /** * 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). */ freeformTags: { [key: string]: string; }; /** * The OCID of a resource. */ id: string; /** * A Boolean flag indicating whether or not the resolver endpoint is for forwarding. */ isForwarding: boolean; /** * A Boolean flag indicating whether or not the resolver endpoint is for listening. */ isListening: boolean; /** * An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true. */ listeningAddress: string; /** * The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint resource that this resolver endpoint corresponds to. */ peId: string; /** * The OCID of the resolver. */ resolverId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The canonical absolute URL of the resource. */ self: string; /** * The state of a resource. */ state: string; /** * The OCID of a subnet. Must be part of the VCN that the resolver is attached to. */ subnetId: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC resource that this resolver endpoint corresponds to. */ vnicId: string; } interface GetResolversResolverRule { action: string; clientAddressConditions: string[]; destinationAddresses: string[]; qnameCoverConditions: string[]; sourceEndpointName: string; } interface GetRrsetItem { /** * The target fully-qualified domain name (FQDN) within the target zone. */ domain: string; /** * A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed. */ isProtected: boolean; /** * The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm) */ rdata: string; /** * A unique identifier for the record within its zone. */ recordHash: string; /** * The latest version of the record's zone in which its RRSet differs from the preceding version. */ rrsetVersion: string; /** * The type of the target RRSet within the target zone. */ rtype: string; /** * The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended. */ ttl: number; } interface GetRrsetsFilter { name: string; regex?: boolean; values: string[]; } interface GetRrsetsRrset { /** * The target fully-qualified domain name (FQDN) within the target zone. */ domain: string; items: outputs.Dns.GetRrsetsRrsetItem[]; /** * Search by record type. Will match any record whose [type](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) (case-insensitive) equals the provided value. */ rtype: string; } interface GetRrsetsRrsetItem { /** * The target fully-qualified domain name (FQDN) within the target zone. */ domain: string; /** * A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed. */ isProtected: boolean; /** * The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm) */ rdata: string; /** * A unique identifier for the record within its zone. */ recordHash: string; /** * The latest version of the record's zone in which its RRSet differs from the preceding version. */ rrsetVersion: string; /** * Search by record type. Will match any record whose [type](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4) (case-insensitive) equals the provided value. */ rtype: string; /** * The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended. */ ttl: number; } interface GetSteeringPoliciesFilter { /** * A user-friendly name for the answer, unique within the steering policy. An answer's `name` property can be referenced in `answerCondition` properties of rules using `answer.name`. */ name: string; regex?: boolean; values: string[]; } interface GetSteeringPoliciesSteeringPolicy { /** * The set of all answers that can potentially issue from the steering policy. */ answers: outputs.Dns.GetSteeringPoliciesSteeringPolicyAnswer[]; /** * The OCID of the compartment the resource belongs to. */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * The displayName of a resource. */ displayName: string; /** * 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). */ freeformTags: { [key: string]: string; }; /** * Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value. */ healthCheckMonitorId: string; /** * The OCID of a resource. */ id: string; /** * The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request. */ rules: outputs.Dns.GetSteeringPoliciesSteeringPolicyRule[]; /** * The canonical absolute URL of the resource. */ self: string; /** * The state of a resource. */ state: string; /** * Search by steering template type. Will match any resource whose template type matches the provided value. */ template: string; /** * The date and time the resource was created, expressed in RFC 3339 timestamp format. */ timeCreated: string; /** * The Time To Live (TTL) for responses from the steering policy, in seconds. If not specified during creation, a value of 30 seconds will be used. */ ttl: number; } interface GetSteeringPoliciesSteeringPolicyAnswer { /** * Set this property to `true` to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer's `isDisabled` property can be referenced in `answerCondition` properties in rules using `answer.isDisabled`. */ isDisabled: boolean; /** * A user-friendly name for the answer, unique within the steering policy. An answer's `name` property can be referenced in `answerCondition` properties of rules using `answer.name`. */ name: string; /** * The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's `pool` property can be referenced in `answerCondition` properties of rules using `answer.pool`. */ pool: string; /** * The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). */ rdata: string; /** * The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). */ rtype: string; } interface GetSteeringPoliciesSteeringPolicyRule { /** * An array of `caseConditions`. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence of `cases`, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of `cases`, it is always ignored during processing. When a rule has a non-empty sequence of `cases`, its behavior during processing is configured by the first matching `case` in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no `caseCondition` always matches. A rule case with a `caseCondition` matches only when that expression evaluates to true for the given query. */ cases: outputs.Dns.GetSteeringPoliciesSteeringPolicyRuleCase[]; /** * Defines a default set of answer conditions and values that are applied to an answer when `cases` is not defined for the rule, or a matching case does not have any matching `answerCondition`s in its `answerData`. `defaultAnswerData` is not applied if `cases` is defined and there are no matching cases. In this scenario, the next rule will be processed. */ defaultAnswerDatas: outputs.Dns.GetSteeringPoliciesSteeringPolicyRuleDefaultAnswerData[]; /** * Defines a default count if `cases` is not defined for the rule or a matching case does not define `count`. `defaultCount` is **not** applied if `cases` is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. */ defaultCount: number; /** * A user-defined description of the rule's purpose or behavior. */ description: string; /** * The type of a rule determines its sorting/filtering behavior. * * `FILTER` - Filters the list of answers based on their defined boolean data. Answers remain only if their `shouldKeep` value is `true`. * * `HEALTH` - Removes answers from the list if their `rdata` matches a target in the health check monitor referenced by the steering policy and the target is reported down. * * `WEIGHTED` - Uses a number between 0 and 255 to determine how often an answer will be served in relation to other answers. Anwers with a higher weight will be served more frequently. * * `PRIORITY` - Uses a defined rank value of answers to determine which answer to serve, moving those with the lowest values to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between `0` and `255`. * * `LIMIT` - Filters answers that are too far down the list. Parameter `defaultCount` specifies how many answers to keep. **Example:** If `defaultCount` has a value of `2` and there are five answers left, when the `LIMIT` rule is processed, only the first two answers will remain in the list. */ ruleType: string; } interface GetSteeringPoliciesSteeringPolicyRuleCase { /** * An array of `SteeringPolicyPriorityAnswerData` objects. */ answerDatas: outputs.Dns.GetSteeringPoliciesSteeringPolicyRuleCaseAnswerData[]; /** * An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. **Example:** If you have an office that uses the subnet `192.0.2.0/24` you could use a `caseCondition` expression `query.client.address in ('192.0.2.0/24')` to define a case that matches queries from that office. */ caseCondition: string; /** * The number of answers allowed to remain after the limit rule has been processed, keeping only the first of the remaining answers in the list. Example: If the `count` property is set to `2` and four answers remain before the limit rule is processed, only the first two answers in the list will remain after the limit rule has been processed. */ count: number; } interface GetSteeringPoliciesSteeringPolicyRuleCaseAnswerData { /** * An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. */ answerCondition: string; /** * Keeps the answer only if the value is `true`. */ shouldKeep: boolean; /** * The rank assigned to the set of answers that match the expression in `answerCondition`. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between `0` and `255`. */ value: number; } interface GetSteeringPoliciesSteeringPolicyRuleDefaultAnswerData { /** * An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. */ answerCondition: string; /** * Keeps the answer only if the value is `true`. */ shouldKeep: boolean; /** * The rank assigned to the set of answers that match the expression in `answerCondition`. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between `0` and `255`. */ value: number; } interface GetSteeringPolicyAnswer { /** * Set this property to `true` to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer's `isDisabled` property can be referenced in `answerCondition` properties in rules using `answer.isDisabled`. */ isDisabled: boolean; /** * A user-friendly name for the answer, unique within the steering policy. An answer's `name` property can be referenced in `answerCondition` properties of rules using `answer.name`. */ name: string; /** * The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's `pool` property can be referenced in `answerCondition` properties of rules using `answer.pool`. */ pool: string; /** * The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). */ rdata: string; /** * The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). */ rtype: string; } interface GetSteeringPolicyAttachmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetSteeringPolicyAttachmentsSteeringPolicyAttachment { /** * The OCID of the compartment the resource belongs to. */ compartmentId: string; /** * The displayName of a resource. */ displayName: string; /** * The attached domain within the attached zone. */ domainName: string; /** * The OCID of a resource. */ id: string; /** * The record types covered by the attachment at the domain. The set of record types is determined by aggregating the record types from the answers defined in the steering policy. */ rtypes: string[]; /** * The canonical absolute URL of the resource. */ self: string; /** * The state of a resource. */ state: string; /** * Search by steering policy OCID. Will match any resource whose steering policy ID matches the provided value. */ steeringPolicyId: string; /** * The date and time the resource was created, expressed in RFC 3339 timestamp format. */ timeCreated: string; /** * Search by zone OCID. Will match any resource whose zone ID matches the provided value. */ zoneId: string; } interface GetSteeringPolicyRule { /** * An array of `caseConditions`. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence of `cases`, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of `cases`, it is always ignored during processing. When a rule has a non-empty sequence of `cases`, its behavior during processing is configured by the first matching `case` in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no `caseCondition` always matches. A rule case with a `caseCondition` matches only when that expression evaluates to true for the given query. */ cases: outputs.Dns.GetSteeringPolicyRuleCase[]; /** * Defines a default set of answer conditions and values that are applied to an answer when `cases` is not defined for the rule, or a matching case does not have any matching `answerCondition`s in its `answerData`. `defaultAnswerData` is not applied if `cases` is defined and there are no matching cases. In this scenario, the next rule will be processed. */ defaultAnswerDatas: outputs.Dns.GetSteeringPolicyRuleDefaultAnswerData[]; /** * Defines a default count if `cases` is not defined for the rule or a matching case does not define `count`. `defaultCount` is **not** applied if `cases` is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. */ defaultCount: number; /** * A user-defined description of the rule's purpose or behavior. */ description: string; /** * The type of a rule determines its sorting/filtering behavior. * * `FILTER` - Filters the list of answers based on their defined boolean data. Answers remain only if their `shouldKeep` value is `true`. * * `HEALTH` - Removes answers from the list if their `rdata` matches a target in the health check monitor referenced by the steering policy and the target is reported down. * * `WEIGHTED` - Uses a number between 0 and 255 to determine how often an answer will be served in relation to other answers. Anwers with a higher weight will be served more frequently. * * `PRIORITY` - Uses a defined rank value of answers to determine which answer to serve, moving those with the lowest values to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between `0` and `255`. * * `LIMIT` - Filters answers that are too far down the list. Parameter `defaultCount` specifies how many answers to keep. **Example:** If `defaultCount` has a value of `2` and there are five answers left, when the `LIMIT` rule is processed, only the first two answers will remain in the list. */ ruleType: string; } interface GetSteeringPolicyRuleCase { /** * An array of `SteeringPolicyPriorityAnswerData` objects. */ answerDatas: outputs.Dns.GetSteeringPolicyRuleCaseAnswerData[]; /** * An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. **Example:** If you have an office that uses the subnet `192.0.2.0/24` you could use a `caseCondition` expression `query.client.address in ('192.0.2.0/24')` to define a case that matches queries from that office. */ caseCondition: string; /** * The number of answers allowed to remain after the limit rule has been processed, keeping only the first of the remaining answers in the list. Example: If the `count` property is set to `2` and four answers remain before the limit rule is processed, only the first two answers in the list will remain after the limit rule has been processed. */ count: number; } interface GetSteeringPolicyRuleCaseAnswerData { /** * An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. */ answerCondition: string; /** * Keeps the answer only if the value is `true`. */ shouldKeep: boolean; /** * The rank assigned to the set of answers that match the expression in `answerCondition`. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between `0` and `255`. */ value: number; } interface GetSteeringPolicyRuleDefaultAnswerData { /** * An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. */ answerCondition: string; /** * Keeps the answer only if the value is `true`. */ shouldKeep: boolean; /** * The rank assigned to the set of answers that match the expression in `answerCondition`. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between `0` and `255`. */ value: number; } interface GetTsigKeysFilter { /** * The name of a resource. */ name: string; regex?: boolean; values: string[]; } interface GetTsigKeysTsigKey { /** * TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see [RFC 4635](https://tools.ietf.org/html/rfc4635#section-2). */ algorithm: string; /** * The OCID of the compartment the resource belongs to. */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * 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). */ freeformTags: { [key: string]: string; }; /** * The OCID of a resource. */ id: string; /** * The name of a resource. */ name: string; /** * A base64 string encoding the binary shared secret. */ secret: string; /** * The canonical absolute URL of the resource. */ self: string; /** * The state of a resource. */ state: string; /** * The date and time the resource was created, expressed in RFC 3339 timestamp format. */ timeCreated: string; /** * The date and time the resource was last updated, expressed in RFC 3339 timestamp format. */ timeUpdated: string; } interface GetViewsFilter { name: string; regex?: boolean; values: string[]; } interface GetViewsView { /** * The OCID of the compartment the resource belongs to. */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * The displayName of a resource. */ displayName: string; /** * 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). */ freeformTags: { [key: string]: string; }; /** * The OCID of a resource. */ id: string; /** * A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. */ isProtected: boolean; /** * Value must be `PRIVATE` when listing private views. */ scope: string; /** * The canonical absolute URL of the resource. */ self: string; /** * The state of a resource. */ state: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeUpdated: string; } interface GetZoneDnssecConfig { /** * A read-only array of key signing key (KSK) versions. */ kskDnssecKeyVersions: outputs.Dns.GetZoneDnssecConfigKskDnssecKeyVersion[]; /** * A read-only array of zone signing key (ZSK) versions. */ zskDnssecKeyVersions: outputs.Dns.GetZoneDnssecConfigZskDnssecKeyVersion[]; } interface GetZoneDnssecConfigKskDnssecKeyVersion { /** * The signing algorithm used for the key. */ algorithm: string; /** * An array of data for DS records corresponding with this key version. An entry will exist for each supported DS digest algorithm. */ dsDatas: outputs.Dns.GetZoneDnssecConfigKskDnssecKeyVersionDsData[]; /** * The key tag associated with the `DnssecKeyVersion`. */ keyTag: number; /** * The length of the corresponding private key in bytes. */ lengthInBytes: number; /** * UUID of the key version this will replace or has replaced. */ predecessorDnssecKeyVersionUuid: string; /** * UUID of the key version that will replace or has replaced this key version. */ successorDnssecKeyVersionUuid: string; /** * RFC 3339 timestamp when the key version went or will go active. */ timeActivated: string; /** * The RFC 3339 timestamp when the zone was created. */ timeCreated: string; /** * RFC 3339 timestamp for end of recommended lifetime. */ timeExpired: string; /** * RFC 3339 timestamp when the key version went or will go inactive. */ timeInactivated: string; /** * RFC 3339 timestamp when the key version was promoted. */ timePromoted: string; /** * RFC 3339 timestamp when the zone contents include a DNSKEY for the key material. */ timePublished: string; /** * RFC 3339 timestamp when the DNSKEY is removed from the zone contents. */ timeUnpublished: string; /** * The UUID of the `DnssecKeyVersion`. */ uuid: string; } interface GetZoneDnssecConfigKskDnssecKeyVersionDsData { /** * The type of the digest associated with the rdata. */ digestType: string; /** * Presentation-format DS record data that must be added to the parent zone. */ rdata: string; } interface GetZoneDnssecConfigZskDnssecKeyVersion { /** * The signing algorithm used for the key. */ algorithm: string; /** * The key tag associated with the `DnssecKeyVersion`. */ keyTag: number; /** * The length of the corresponding private key in bytes. */ lengthInBytes: number; /** * UUID of the key version this will replace or has replaced. */ predecessorDnssecKeyVersionUuid: string; /** * UUID of the key version that will replace or has replaced this key version. */ successorDnssecKeyVersionUuid: string; /** * RFC 3339 timestamp when the key version went or will go active. */ timeActivated: string; /** * The RFC 3339 timestamp when the zone was created. */ timeCreated: string; /** * RFC 3339 timestamp for end of recommended lifetime. */ timeExpired: string; /** * RFC 3339 timestamp when the key version went or will go inactive. */ timeInactivated: string; /** * RFC 3339 timestamp when the key version was promoted. */ timePromoted: string; /** * RFC 3339 timestamp when the zone contents include a DNSKEY for the key material. */ timePublished: string; /** * RFC 3339 timestamp when the DNSKEY is removed from the zone contents. */ timeUnpublished: string; /** * The UUID of the `DnssecKeyVersion`. */ uuid: string; } interface GetZoneExternalDownstream { /** * The server's IP address (IPv4 or IPv6). */ address: string; /** * The server's port. */ port: number; /** * The OCID of the TSIG key. */ tsigKeyId: string; } interface GetZoneExternalMaster { /** * The server's IP address (IPv4 or IPv6). */ address: string; /** * The server's port. */ port: number; /** * The OCID of the TSIG key. */ tsigKeyId: string; } interface GetZoneNameserver { /** * Hostname of the nameserver. */ hostname: string; } interface GetZoneZoneTransferServer { /** * The server's IP address (IPv4 or IPv6). */ address: string; /** * Whether the server is a zone data transfer destination. */ isTransferDestination: boolean; /** * Whether the server is a zone data transfer source. */ isTransferSource: boolean; /** * The server's port. */ port: number; } interface GetZonesFilter { /** * A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value. */ name: string; regex?: boolean; values: string[]; } interface GetZonesZone { /** * The OCID of the compartment the resource belongs to. */ compartmentId: string; /** * 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). */ definedTags: { [key: string]: string; }; /** * DNSSEC configuration data. */ dnssecConfigs: outputs.Dns.GetZonesZoneDnssecConfig[]; /** * Search for zones that have the given `DnssecState`. */ dnssecState: string; externalDownstreams: outputs.Dns.GetZonesZoneExternalDownstream[]; externalMasters: outputs.Dns.GetZonesZoneExternalMaster[]; /** * 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). */ freeformTags: { [key: string]: string; }; /** * The OCID of the zone. */ id: string; /** * A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. */ isProtected: boolean; /** * A case-sensitive filter for zone names. Will match any zone with a name that equals the provided value. */ name: string; /** * The authoritative nameservers for the zone. */ nameservers: outputs.Dns.GetZonesZoneNameserver[]; /** * The resolution mode of a zone defines behavior related to how query responses can be handled. See [Private DNS Zone Transparency](https://docs.cloud.oracle.com/iaas/Content/DNS/Tasks/privatedns.htm#use-cases__resolution) for more information. */ resolutionMode: string; /** * Specifies to operate only on resources that have a matching DNS scope. */ scope: string; /** * The canonical absolute URL of the resource. */ self: string; /** * The current serial of the zone. As seen in the zone's SOA record. */ serial: number; /** * The state of a resource. */ state: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived. */ version: string; /** * The OCID of the view the resource is associated with. */ viewId: string; zoneTransferServers: outputs.Dns.GetZonesZoneZoneTransferServer[]; /** * Search by zone type, `PRIMARY` or `SECONDARY`. Will match any zone whose type equals the provided value. */ zoneType: string; } interface GetZonesZoneDnssecConfig { /** * A read-only array of key signing key (KSK) versions. */ kskDnssecKeyVersions: outputs.Dns.GetZonesZoneDnssecConfigKskDnssecKeyVersion[]; /** * A read-only array of zone signing key (ZSK) versions. */ zskDnssecKeyVersions: outputs.Dns.GetZonesZoneDnssecConfigZskDnssecKeyVersion[]; } interface GetZonesZoneDnssecConfigKskDnssecKeyVersion { /** * The signing algorithm used for the key. */ algorithm: string; /** * An array of data for DS records corresponding with this key version. An entry will exist for each supported DS digest algorithm. */ dsDatas: outputs.Dns.GetZonesZoneDnssecConfigKskDnssecKeyVersionDsData[]; /** * The key tag associated with the `DnssecKeyVersion`. This key tag will be present in the RRSIG and DS records associated with the key material for this `DnssecKeyVersion`. For more information about key tags, see [RFC 4034](https://tools.ietf.org/html/rfc4034). */ keyTag: number; /** * The length of the corresponding private key in bytes, expressed as an integer. */ lengthInBytes: number; /** * When populated, this is the UUID of the `DnssecKeyVersion` that this `DnssecKeyVersion` will replace or has replaced. */ predecessorDnssecKeyVersionUuid: string; /** * When populated, this is the UUID of the `DnssecKeyVersion` that will replace, or has replaced, this `DnssecKeyVersion`. */ successorDnssecKeyVersionUuid: string; /** * The date and time the key version went, or will go, active, expressed in RFC 3339 timestamp format. This is when the key material will be used to generate RRSIGs. */ timeActivated: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * The date and time at which the recommended key version publication/activation lifetime ends, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY should no longer exist in zone contents and no longer be used to generate RRSIGs. For a key sigining key (KSK), if `PromoteZoneDnssecKeyVersion` has not been called on this `DnssecKeyVersion`'s successor then it will remain active for arbitrarily long past its recommended lifetime. This prevents service disruption at the potential increased risk of key compromise. */ timeExpired: string; /** * The date and time the key version went, or will go, inactive, expressed in RFC 3339 timestamp format. This is when the key material will no longer be used to generate RRSIGs. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. */ timeInactivated: string; /** * The date and time the key version was promoted expressed in RFC 3339 timestamp format. */ timePromoted: string; /** * The date and time the key version was, or will be, published, expressed in RFC 3339 timestamp format. This is when the zone contents will include a DNSKEY record corresponding to the key material. */ timePublished: string; /** * The date and time the key version was, or will be, unpublished, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY will be removed from zone contents. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. */ timeUnpublished: string; /** * The UUID of the `DnssecKeyVersion`. */ uuid: string; } interface GetZonesZoneDnssecConfigKskDnssecKeyVersionDsData { /** * The type of the digest associated with the rdata. */ digestType: string; /** * Presentation-format DS record data that must be added to the parent zone. For more information about RDATA, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm) */ rdata: string; } interface GetZonesZoneDnssecConfigZskDnssecKeyVersion { /** * The signing algorithm used for the key. */ algorithm: string; /** * The key tag associated with the `DnssecKeyVersion`. This key tag will be present in the RRSIG and DS records associated with the key material for this `DnssecKeyVersion`. For more information about key tags, see [RFC 4034](https://tools.ietf.org/html/rfc4034). */ keyTag: number; /** * The length of the corresponding private key in bytes, expressed as an integer. */ lengthInBytes: number; /** * When populated, this is the UUID of the `DnssecKeyVersion` that this `DnssecKeyVersion` will replace or has replaced. */ predecessorDnssecKeyVersionUuid: string; /** * When populated, this is the UUID of the `DnssecKeyVersion` that will replace, or has replaced, this `DnssecKeyVersion`. */ successorDnssecKeyVersionUuid: string; /** * The date and time the key version went, or will go, active, expressed in RFC 3339 timestamp format. This is when the key material will be used to generate RRSIGs. */ timeActivated: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * The date and time at which the recommended key version publication/activation lifetime ends, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY should no longer exist in zone contents and no longer be used to generate RRSIGs. For a key sigining key (KSK), if `PromoteZoneDnssecKeyVersion` has not been called on this `DnssecKeyVersion`'s successor then it will remain active for arbitrarily long past its recommended lifetime. This prevents service disruption at the potential increased risk of key compromise. */ timeExpired: string; /** * The date and time the key version went, or will go, inactive, expressed in RFC 3339 timestamp format. This is when the key material will no longer be used to generate RRSIGs. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. */ timeInactivated: string; /** * The date and time the key version was promoted expressed in RFC 3339 timestamp format. */ timePromoted: string; /** * The date and time the key version was, or will be, published, expressed in RFC 3339 timestamp format. This is when the zone contents will include a DNSKEY record corresponding to the key material. */ timePublished: string; /** * The date and time the key version was, or will be, unpublished, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY will be removed from zone contents. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. */ timeUnpublished: string; /** * The UUID of the `DnssecKeyVersion`. */ uuid: string; } interface GetZonesZoneExternalDownstream { address: string; port: number; /** * Search for zones that are associated with a TSIG key. */ tsigKeyId: string; } interface GetZonesZoneExternalMaster { address: string; port: number; /** * Search for zones that are associated with a TSIG key. */ tsigKeyId: string; } interface GetZonesZoneNameserver { /** * The hostname of the nameserver. */ hostname: string; } interface GetZonesZoneZoneTransferServer { address: string; isTransferDestination: boolean; isTransferSource: boolean; port: number; } interface ResolverAttachedView { /** * (Updatable) The OCID of the view. */ viewId: string; } interface ResolverEndpoint { /** * (Updatable) The OCID of the owning compartment. */ compartmentId: string; /** * (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"}}` */ definedTags: { [key: string]: string; }; /** * The type of resolver endpoint. VNIC is currently the only supported type. */ endpointType: string; /** * An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true. */ forwardingAddress: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the resolver. */ id: string; /** * A Boolean flag indicating whether or not the resolver endpoint is for forwarding. */ isForwarding: boolean; /** * A Boolean flag indicating whether or not the resolver endpoint is for listening. */ isListening: boolean; /** * An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true. */ listeningAddress: string; /** * The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint resource that this resolver endpoint corresponds to. */ peId: string; /** * The OCID of the target resolver. */ resolverId: string; /** * [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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The canonical absolute URL of the resource. */ self: string; /** * The current state of the resource. */ state: string; /** * The OCID of a subnet. Must be part of the VCN that the resolver is attached to. */ subnetId: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC resource that this resolver endpoint corresponds to. */ vnicId: string; } interface ResolverRule { /** * (Updatable) The action determines the behavior of the rule. If a query matches a supplied condition, the action will apply. If there are no conditions on the rule, all queries are subject to the specified action. * * `FORWARD` - Matching requests will be forwarded from the source interface to the destination address. */ action: string; /** * (Updatable) A list of CIDR blocks. In order for the rule action to apply, the query must come from a client within one of the CIDR blocks. */ clientAddressConditions: string[]; /** * (Updatable) IP addresses to which queries should be forwarded. Currently limited to a single address. */ destinationAddresses: string[]; /** * (Updatable) A list of domain names. In order for the rule action to apply, the query must either match or be a subdomain of one of the listed domains. */ qnameCoverConditions: string[]; /** * (Updatable) Case-insensitive name of an endpoint, that is a sub-resource of the resolver, to use as the forwarding interface. The endpoint must have isForwarding set to true. */ sourceEndpointName: string; } interface RrsetItem { /** * The fully qualified domain name where the record can be located. */ domain: string; /** * A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed. */ isProtected: boolean; /** * (Updatable) The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm) */ rdata: string; /** * A unique identifier for the record within its zone. */ recordHash: string; /** * The latest version of the record's zone in which its RRSet differs from the preceding version. */ rrsetVersion: string; /** * The type of DNS record, such as A or CNAME. For more information, see [Resource Record (RR) TYPEs](https://www.iana.org/assignments/dns-parameters/dns-parameters.xhtml#dns-parameters-4). */ rtype: string; /** * (Updatable) The Time To Live for the record, in seconds. Using a TTL lower than 30 seconds is not recommended. */ ttl: number; } interface SteeringPolicyAnswer { /** * Set this property to `true` to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer's `isDisabled` property can be referenced in `answerCondition` properties in rules using `answer.isDisabled`. */ isDisabled: boolean; /** * A user-friendly name for the answer, unique within the steering policy. An answer's `name` property can be referenced in `answerCondition` properties of rules using `answer.name`. */ name: string; /** * The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's `pool` property can be referenced in `answerCondition` properties of rules using `answer.pool`. */ pool: string; /** * The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). */ rdata: string; /** * The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm). */ rtype: string; } interface SteeringPolicyRule { /** * An array of `caseConditions`. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence of `cases`, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of `cases`, it is always ignored during processing. When a rule has a non-empty sequence of `cases`, its behavior during processing is configured by the first matching `case` in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no `caseCondition` always matches. A rule case with a `caseCondition` matches only when that expression evaluates to true for the given query. */ cases: outputs.Dns.SteeringPolicyRuleCase[]; /** * Defines a default set of answer conditions and values that are applied to an answer when `cases` is not defined for the rule, or a matching case does not have any matching `answerCondition`s in its `answerData`. `defaultAnswerData` is not applied if `cases` is defined and there are no matching cases. In this scenario, the next rule will be processed. */ defaultAnswerDatas: outputs.Dns.SteeringPolicyRuleDefaultAnswerData[]; /** * Defines a default count if `cases` is not defined for the rule or a matching case does not define `count`. `defaultCount` is **not** applied if `cases` is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. */ defaultCount: number; /** * A user-defined description of the rule's purpose or behavior. */ description: string; /** * The type of a rule determines its sorting/filtering behavior. * * `FILTER` - Filters the list of answers based on their defined boolean data. Answers remain only if their `shouldKeep` value is `true`. * * `HEALTH` - Removes answers from the list if their `rdata` matches a target in the health check monitor referenced by the steering policy and the target is reported down. * * `WEIGHTED` - Uses a number between 0 and 255 to determine how often an answer will be served in relation to other answers. Anwers with a higher weight will be served more frequently. * * `PRIORITY` - Uses a defined rank value of answers to determine which answer to serve, moving those with the lowest values to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between `0` and `255`. * * `LIMIT` - Filters answers that are too far down the list. Parameter `defaultCount` specifies how many answers to keep. **Example:** If `defaultCount` has a value of `2` and there are five answers left, when the `LIMIT` rule is processed, only the first two answers will remain in the list. */ ruleType: string; } interface SteeringPolicyRuleCase { /** * An array of `SteeringPolicyPriorityAnswerData` objects. */ answerDatas: outputs.Dns.SteeringPolicyRuleCaseAnswerData[]; /** * An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. **Example:** If you have an office that uses the subnet `192.0.2.0/24` you could use a `caseCondition` expression `query.client.address in ('192.0.2.0/24')` to define a case that matches queries from that office. */ caseCondition: string; /** * The number of answers allowed to remain after the limit rule has been processed, keeping only the first of the remaining answers in the list. Example: If the `count` property is set to `2` and four answers remain before the limit rule is processed, only the first two answers in the list will remain after the limit rule has been processed. */ count: number; } interface SteeringPolicyRuleCaseAnswerData { /** * An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. */ answerCondition: string; /** * Keeps the answer only if the value is `true`. */ shouldKeep: boolean; /** * The rank assigned to the set of answers that match the expression in `answerCondition`. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between `0` and `255`. */ value: number; } interface SteeringPolicyRuleDefaultAnswerData { /** * An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties. */ answerCondition: string; /** * Keeps the answer only if the value is `true`. */ shouldKeep: boolean; /** * The rank assigned to the set of answers that match the expression in `answerCondition`. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between `0` and `255`. */ value: number; } interface ZoneDnssecConfig { /** * A read-only array of key signing key (KSK) versions. */ kskDnssecKeyVersions: outputs.Dns.ZoneDnssecConfigKskDnssecKeyVersion[]; /** * A read-only array of zone signing key (ZSK) versions. */ zskDnssecKeyVersions: outputs.Dns.ZoneDnssecConfigZskDnssecKeyVersion[]; } interface ZoneDnssecConfigKskDnssecKeyVersion { /** * The signing algorithm used for the key. */ algorithm: string; /** * An array of data for DS records corresponding with this key version. An entry will exist for each supported DS digest algorithm. */ dsDatas: outputs.Dns.ZoneDnssecConfigKskDnssecKeyVersionDsData[]; /** * The key tag associated with the `DnssecKeyVersion`. This key tag will be present in the RRSIG and DS records associated with the key material for this `DnssecKeyVersion`. For more information about key tags, see [RFC 4034](https://tools.ietf.org/html/rfc4034). */ keyTag: number; /** * The length of the corresponding private key in bytes, expressed as an integer. */ lengthInBytes: number; /** * When populated, this is the UUID of the `DnssecKeyVersion` that this `DnssecKeyVersion` will replace or has replaced. */ predecessorDnssecKeyVersionUuid: string; /** * When populated, this is the UUID of the `DnssecKeyVersion` that will replace, or has replaced, this `DnssecKeyVersion`. */ successorDnssecKeyVersionUuid: string; /** * The date and time the key version went, or will go, active, expressed in RFC 3339 timestamp format. This is when the key material will be used to generate RRSIGs. */ timeActivated: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * The date and time at which the recommended key version publication/activation lifetime ends, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY should no longer exist in zone contents and no longer be used to generate RRSIGs. For a key sigining key (KSK), if `PromoteZoneDnssecKeyVersion` has not been called on this `DnssecKeyVersion`'s successor then it will remain active for arbitrarily long past its recommended lifetime. This prevents service disruption at the potential increased risk of key compromise. */ timeExpired: string; /** * The date and time the key version went, or will go, inactive, expressed in RFC 3339 timestamp format. This is when the key material will no longer be used to generate RRSIGs. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. */ timeInactivated: string; /** * The date and time the key version was promoted expressed in RFC 3339 timestamp format. */ timePromoted: string; /** * The date and time the key version was, or will be, published, expressed in RFC 3339 timestamp format. This is when the zone contents will include a DNSKEY record corresponding to the key material. */ timePublished: string; /** * The date and time the key version was, or will be, unpublished, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY will be removed from zone contents. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. */ timeUnpublished: string; /** * The UUID of the `DnssecKeyVersion`. */ uuid: string; } interface ZoneDnssecConfigKskDnssecKeyVersionDsData { /** * The type of the digest associated with the rdata. */ digestType: string; /** * Presentation-format DS record data that must be added to the parent zone. For more information about RDATA, see [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm) */ rdata: string; } interface ZoneDnssecConfigZskDnssecKeyVersion { /** * The signing algorithm used for the key. */ algorithm: string; /** * The key tag associated with the `DnssecKeyVersion`. This key tag will be present in the RRSIG and DS records associated with the key material for this `DnssecKeyVersion`. For more information about key tags, see [RFC 4034](https://tools.ietf.org/html/rfc4034). */ keyTag: number; /** * The length of the corresponding private key in bytes, expressed as an integer. */ lengthInBytes: number; /** * When populated, this is the UUID of the `DnssecKeyVersion` that this `DnssecKeyVersion` will replace or has replaced. */ predecessorDnssecKeyVersionUuid: string; /** * When populated, this is the UUID of the `DnssecKeyVersion` that will replace, or has replaced, this `DnssecKeyVersion`. */ successorDnssecKeyVersionUuid: string; /** * The date and time the key version went, or will go, active, expressed in RFC 3339 timestamp format. This is when the key material will be used to generate RRSIGs. */ timeActivated: string; /** * The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339. */ timeCreated: string; /** * The date and time at which the recommended key version publication/activation lifetime ends, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY should no longer exist in zone contents and no longer be used to generate RRSIGs. For a key sigining key (KSK), if `PromoteZoneDnssecKeyVersion` has not been called on this `DnssecKeyVersion`'s successor then it will remain active for arbitrarily long past its recommended lifetime. This prevents service disruption at the potential increased risk of key compromise. */ timeExpired: string; /** * The date and time the key version went, or will go, inactive, expressed in RFC 3339 timestamp format. This is when the key material will no longer be used to generate RRSIGs. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. */ timeInactivated: string; /** * The date and time the key version was promoted expressed in RFC 3339 timestamp format. */ timePromoted: string; /** * The date and time the key version was, or will be, published, expressed in RFC 3339 timestamp format. This is when the zone contents will include a DNSKEY record corresponding to the key material. */ timePublished: string; /** * The date and time the key version was, or will be, unpublished, expressed in RFC 3339 timestamp format. This is when the corresponding DNSKEY will be removed from zone contents. For a key signing key (KSK) `DnssecKeyVersion`, this is populated after `PromoteZoneDnssecKeyVersion` has been called on its successor `DnssecKeyVersion`. */ timeUnpublished: string; /** * The UUID of the `DnssecKeyVersion`. */ uuid: string; } interface ZoneExternalDownstream { /** * (Updatable) The server's IP address (IPv4 or IPv6). */ address: string; /** * (Updatable) The server's port. Port value must be a value of 53, otherwise omit the port value. */ port: number; /** * (Updatable) The OCID of the TSIG key. A TSIG key is used to secure DNS messages (in this case, zone transfers) between two systems that both have the (shared) secret. */ tsigKeyId: string; } interface ZoneExternalMaster { /** * (Updatable) The server's IP address (IPv4 or IPv6). */ address: string; /** * (Updatable) The server's port. Port value must be a value of 53, otherwise omit the port value. */ port: number; /** * (Updatable) The OCID of the TSIG key. */ tsigKeyId: string; } interface ZoneNameserver { /** * The hostname of the nameserver. */ hostname: string; } interface ZoneZoneTransferServer { /** * The server's IP address (IPv4 or IPv6). */ address: string; /** * A Boolean flag indicating whether or not the server is a zone data transfer destination. */ isTransferDestination: boolean; /** * A Boolean flag indicating whether or not the server is a zone data transfer source. */ isTransferSource: boolean; /** * The server's port. */ port: number; } } export declare namespace Email { interface EmailDomainLock { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this email domain. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The time the email domain was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface EmailIpPoolLock { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this IpPool. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The time the IpPool was created. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface EmailIpPoolOutboundIpsResponse { /** * The assignment state of the public IP address. */ assignmentState: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'DRAINING' state. */ lifecycleDetails: string; /** * The public IP address assigned to the tenancy. */ outboundIp: string; /** * The current state of the IpPool. */ state: string; /** * The time IP was removed from IP Pool. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeUnassigned: string; } interface EmailReturnPathLock { /** * The lock compartment ID. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The time the email return path was created. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface GetDkimsDkimCollection { items: outputs.Email.GetDkimsDkimCollectionItem[]; } interface GetDkimsDkimCollectionItem { /** * The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred). */ cnameRecordValue: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains this DKIM. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the DKIM. Avoid entering confidential information. */ description: string; /** * The name of the DNS subdomain that must be provisioned to enable email recipients to verify DKIM signatures. It is usually created with a CNAME record set to the cnameRecordValue. */ dnsSubdomainName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the email domain to which this DKIM belongs. */ emailDomainId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to only return resources that match the given id exactly. */ id: string; /** * Indicates whether the DKIM was imported. */ isImported: boolean; /** * Length of the RSA key used in the DKIM. */ keyLength: number; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource. */ lifecycleDetails: string; /** * A filter to only return resources that match the given name exactly. */ name: string; privateKey: string; /** * Filter returned list by specified lifecycle state. This parameter is case-insensitive. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the DKIM was created. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * The time of the last change to the DKIM configuration, due to a state change or an update operation. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". */ timeUpdated: string; /** * The DNS TXT record value to provision to the DKIM DNS subdomain in place of using a CNAME record. This is used in cases where a CNAME cannot be used, such as when the cnameRecordValue would exceed the maximum length for a DNS entry. You can also use this if you have an existing procedure to directly provision TXT records for DKIM. Many DNS APIs require you to break this string into segments of fewer than 255 characters. */ txtRecordValue: string; } interface GetDkimsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetEmailDomainLock { /** * The lock compartment ID. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The time the email domain was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface GetEmailDomainsEmailDomainCollection { items: outputs.Email.GetEmailDomainsEmailDomainCollectionItem[]; } interface GetEmailDomainsEmailDomainCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DKIM key that will be used to sign mail sent from this email domain. */ activeDkimId: string; /** * The OCID for the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of an email domain. */ description: string; /** * Id for Domain in Domain Management (under governance) if DOMAINID verification method used. */ domainVerificationId: string; /** * The current domain verification status. */ domainVerificationStatus: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to only return resources that match the given id exactly. */ id: string; /** * Value of the SPF field. For more information about SPF, please see [SPF Authentication](https://docs.cloud.oracle.com/iaas/Content/Email/Concepts/overview.htm#components). */ isSpf: boolean; /** * Locks associated with this resource. */ locks: outputs.Email.GetEmailDomainsEmailDomainCollectionItemLock[]; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * Filter returned list by specified lifecycle state. This parameter is case-insensitive. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the email domain was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; } interface GetEmailDomainsEmailDomainCollectionItemLock { /** * The OCID for the compartment. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The time the email domain was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface GetEmailDomainsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetEmailIpPoolLock { /** * The lock compartment ID. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The time the IpPool was created. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface GetEmailIpPoolOutboundIpsResponse { /** * The assignment state of the public IP address. */ assignmentState: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'DRAINING' state. */ lifecycleDetails: string; /** * The public IP address assigned to the tenancy. */ outboundIp: string; /** * The current state of the IpPool. */ state: string; /** * The time IP was removed from IP Pool. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeUnassigned: string; } interface GetEmailIpPoolsEmailIpPoolCollection { items: outputs.Email.GetEmailIpPoolsEmailIpPoolCollectionItem[]; } interface GetEmailIpPoolsEmailIpPoolCollectionItem { /** * The OCID for the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the IpPool. Avoid entering confidential information. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to only return resources that match the given id exactly. */ id: string; /** * Last IP will be unassigned from the IP Pool after the period of time (in hours) specified by this parameter. Default is 24 hours. */ lastIpDrainPeriodInHours: number; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'DRAINING' state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.Email.GetEmailIpPoolsEmailIpPoolCollectionItemLock[]; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * Summary of outbound IPs assigned to the IpPool. */ outboundIps: string[]; outboundIpsResponses: outputs.Email.GetEmailIpPoolsEmailIpPoolCollectionItemOutboundIpsResponse[]; /** * Filter returned list by specified lifecycle state. This parameter is case-insensitive. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the IpPool was created. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * The time of the last change to the IpPool, due to a state change or an update operation. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". */ timeUpdated: string; } interface GetEmailIpPoolsEmailIpPoolCollectionItemLock { /** * The OCID for the compartment. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The time the IpPool was created. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface GetEmailIpPoolsEmailIpPoolCollectionItemOutboundIpsResponse { /** * The assignment state of the public IP address. */ assignmentState: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'DRAINING' state. */ lifecycleDetails: string; /** * The public IP address assigned to the tenancy. */ outboundIp: string; /** * Filter returned list by specified lifecycle state. This parameter is case-insensitive. */ state: string; /** * The time IP was removed from IP Pool. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeUnassigned: string; } interface GetEmailIpPoolsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetEmailOutboundIpsEmailOutboundIpCollection { /** * List of public IPs. */ items: outputs.Email.GetEmailOutboundIpsEmailOutboundIpCollectionItem[]; } interface GetEmailOutboundIpsEmailOutboundIpCollectionItem { /** * Filter returned list by specified assignment state. */ assignmentState: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'DRAINING' state. */ lifecycleDetails: string; /** * The outbound IP address assigned to the tenancy. */ outboundIp: string; /** * Filter returned list by specified lifecycle state. This parameter is case-insensitive. */ state: string; /** * The time IP was removed from IP Pool. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeUnassigned: string; } interface GetEmailOutboundIpsFilter { name: string; regex?: boolean; values: string[]; } interface GetEmailReturnPathLock { /** * The lock compartment ID. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The time the email return path was created. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface GetEmailReturnPathsEmailReturnPathCollection { items: outputs.Email.GetEmailReturnPathsEmailReturnPathCollectionItem[]; } interface GetEmailReturnPathsEmailReturnPathCollectionItem { /** * The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred). */ cnameRecordValue: string; /** * The OCID for the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the email return path. Avoid entering confidential information. */ description: string; /** * The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path. It is usually created with a CNAME record set to the cnameRecordValue. */ dnsSubdomainName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to only return resources that match the given id exactly. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.Email.GetEmailReturnPathsEmailReturnPathCollectionItemLock[]; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Email Domain to which this Email Return Path belongs. */ parentResourceId: string; /** * Filter returned list by specified lifecycle state. This parameter is case-insensitive. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the email return path was created. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * The time of the last change to the Email Return Path configuration, due to a state change or an update operation. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". */ timeUpdated: string; } interface GetEmailReturnPathsEmailReturnPathCollectionItemLock { /** * The OCID for the compartment. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The time the email return path was created. Times are expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, "YYYY-MM-ddThh:mmZ". Example: `2021-02-12T22:47:12.613Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface GetEmailReturnPathsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetSenderLock { /** * The lock compartment ID. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * Lock type. */ type: string; } interface GetSendersFilter { name: string; regex?: boolean; values: string[]; } interface GetSendersSender { /** * The OCID for the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The email address of the approved sender. */ emailAddress: string; /** * The email domain used to assert responsibility for emails sent from this sender. */ emailDomainId: string; /** * A filter to only return resources that match the given IpPool resource exactly. */ emailIpPoolId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The unique OCID of the sender. */ id: string; /** * Value of the SPF field. For more information about SPF, please see [SPF Authentication](https://docs.cloud.oracle.com/iaas/Content/Email/Concepts/overview.htm#components). */ isSpf: boolean; /** * Locks associated with this resource. */ locks: outputs.Email.GetSendersSenderLock[]; /** * The current state of a sender. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; } interface GetSendersSenderLock { /** * The OCID for the compartment. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * Lock type. */ type: string; } interface GetSuppressionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSuppressionsSuppression { /** * The OCID for the compartment. */ compartmentId: string; /** * The email address of the suppression. */ emailAddress: string; /** * The specific error message returned by a system that resulted in the suppression. This message is usually an SMTP error code with additional descriptive text. Not provided for all types of suppressions. */ errorDetail: string; /** * DNS name of the source of the error that caused the suppression. Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available. Not provided for all types of suppressions, and not always known. */ errorSource: string; /** * The unique OCID of the suppression. */ id: string; /** * The value of the Message-ID header from the email that triggered a suppression. This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets. Not provided for all types of suppressions. */ messageId: string; /** * The reason that the email address was suppressed. For more information on the types of bounces, see [Suppression List](https://docs.cloud.oracle.com/iaas/Content/Email/Concepts/overview.htm#components). */ reason: string; /** * The date and time a recipient's email address was added to the suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The last date and time the suppression prevented submission in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). */ timeLastSuppressed: string; } interface SenderLock { /** * (Updatable) The OCID of the compartment that contains the sender. */ compartmentId: string; /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * Lock type. */ type: string; } } export declare namespace Events { interface GetRuleAction { action: outputs.Events.GetRuleActionAction[]; /** * A list of one or more Action objects. * * @deprecated Use action instead. This field is retained for backward compatibility. */ actions: outputs.Events.GetRuleActionAction[]; } interface GetRuleActionAction { /** * The action to perform if the condition in the rule matches an event. * * **ONS:** Send to an Oracle Notification Service topic. * * **OSS:** Send to a stream from Oracle Streaming Service. * * **FAAS:** Send to an Oracle Functions Service endpoint. */ actionType: string; /** * A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Function hosted by Oracle Functions Service. */ functionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. */ id: string; /** * Whether or not this rule is currently enabled. Example: `true` */ isEnabled: boolean; /** * A message generated by the Events service about the current state of this rule. */ lifecycleMessage: string; /** * The current state of the rule. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream to which messages are delivered. */ streamId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to which messages are delivered. */ topicId: string; } interface GetRuleConditionDetail { data: string; eventTypes: string[]; } interface GetRulesFilter { name: string; regex?: boolean; values: string[]; } interface GetRulesRule { /** * A list of one or more Action objects. */ actions: outputs.Events.GetRulesRuleAction[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. */ compartmentId: string; /** * A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters: * * Fields not mentioned in the condition are ignored. You can create a valid filter that matches all events with two curly brackets: `{}` */ condition: string; conditionDetails: outputs.Events.GetRulesRuleConditionDetail[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. */ description: string; /** * A filter to return only rules with descriptions that match the displayName string in this parameter. Example: `"This rule sends a notification upon completion of DbaaS backup."` */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. */ id: string; /** * Whether or not this rule is currently enabled. Example: `true` */ isEnabled: boolean; /** * A message generated by the Events service about the current state of this rule. */ lifecycleMessage: string; /** * A filter to return only rules that match the lifecycle state in this parameter. Example: `Creating` */ state: string; /** * The time this rule was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-09-12T22:47:12.613Z` */ timeCreated: string; } interface GetRulesRuleAction { action: outputs.Events.GetRulesRuleActionAction[]; /** * A list of one or more Action objects. * * @deprecated Use action instead. This field is retained for backward compatibility. */ actions: outputs.Events.GetRulesRuleActionAction[]; } interface GetRulesRuleActionAction { /** * The action to perform if the condition in the rule matches an event. * * **ONS:** Send to an Oracle Notification Service topic. * * **OSS:** Send to a stream from Oracle Streaming Service. * * **FAAS:** Send to an Oracle Functions Service endpoint. */ actionType: string; /** * A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Function hosted by Oracle Functions Service. */ functionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. */ id: string; /** * Whether or not this rule is currently enabled. Example: `true` */ isEnabled: boolean; /** * A message generated by the Events service about the current state of this rule. */ lifecycleMessage: string; /** * A filter to return only rules that match the lifecycle state in this parameter. Example: `Creating` */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream to which messages are delivered. */ streamId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to which messages are delivered. */ topicId: string; } interface GetRulesRuleConditionDetail { data: string; eventTypes: string[]; } interface RuleActions { /** * (Updatable) A list of one or more ActionDetails objects. */ action: outputs.Events.RuleActionsAction[]; /** * (Updatable) Deprecated. Use `action` instead. This nested block is retained for backward compatibility. * * @deprecated Use action instead. This field is retained for backward compatibility. */ actions: outputs.Events.RuleActionsAction[]; } interface RuleActionsAction { /** * The action to perform if the condition in the rule matches an event. * * **ONS:** Send to an Oracle Notification Service topic. * * **OSS:** Send to a stream from Oracle Streaming Service. * * **FAAS:** Send to an Oracle Functions Service endpoint. */ actionType: string; /** * (Updatable) A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Function hosted by Oracle Functions Service. */ functionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. */ id: string; /** * (Updatable) Whether or not this rule is currently enabled. Example: `true` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ isEnabled: boolean; /** * A message generated by the Events service about the current state of this rule. */ lifecycleMessage: string; /** * The current state of the rule. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream to which messages are delivered. */ streamId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to which messages are delivered. */ topicId: string; } interface RuleConditionDetails { /** * (Updatable) A JSON string containing additional event data filters. * * The following `conditionDetails` example is equivalent to the `condition` JSON string example above. * * Example: */ data?: string; /** * (Updatable) A list of event types to match. */ eventTypes?: string[]; } } export declare namespace FileStorage { interface ExportExportOption { /** * (Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to `READ_WRITE`. */ access: string; /** * (Updatable) Array of allowed NFS authentication types. */ allowedAuths: string[]; /** * (Updatable) GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to `65534`. */ anonymousGid: string; /** * (Updatable) UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to `65534`. */ anonymousUid: string; /** * (Updatable) Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If `ALL`, all users and groups are remapped; if `ROOT`, only the root user and group (UID/GID 0) are remapped; if `NONE`, no remapping is done. If unspecified, defaults to `ROOT`. */ identitySquash: string; /** * (Updatable) Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID. */ isAnonymousAccessAllowed: boolean; /** * (Updatable) If `true`, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to `true`. */ requirePrivilegedSourcePort: boolean; /** * (Updatable) Clients these options should apply to. Must be a either single IPv4/IPv6 address or single IPv4/IPv6 CIDR block. * * **Note:** Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses. */ source: string; } interface ExportLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface FileSystemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface FileSystemSourceDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system that contains the source snapshot of a cloned file system. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ parentFileSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ sourceSnapshotId: string; } interface FilesystemSnapshotPolicyLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface FilesystemSnapshotPolicySchedule { /** * (Updatable) The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time. */ dayOfMonth: number; /** * (Updatable) The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time. */ dayOfWeek?: string; /** * (Updatable) The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time. */ hourOfDay: number; /** * (Updatable) Details for setting a retention date or legal hold. */ lockDurationDetails: outputs.FileStorage.FilesystemSnapshotPolicyScheduleLockDurationDetails; /** * (Updatable) The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time. */ month?: string; /** * (Updatable) The frequency of scheduled snapshots. */ period: string; /** * (Updatable) The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty. */ retentionDurationInSeconds: string; /** * (Updatable) A name prefix to be applied to snapshots created by this schedule. Example: `compliance1` */ schedulePrefix: string; /** * (Updatable) The starting point used to begin the scheduling of the snapshots based upon recurrence string in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. If no `timeScheduleStart` is provided, the value will be set to the time when the schedule was created. */ timeScheduleStart: string; /** * (Updatable) Time zone used for scheduling the snapshot. */ timeZone: string; } interface FilesystemSnapshotPolicyScheduleLockDurationDetails { /** * (Updatable) For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set. */ coolOffDuration: number; /** * (Updatable) The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold. */ lockDuration: number; /** * (Updatable) Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period. */ lockMode: string; } interface GetExportSetsExportSet { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource` */ displayName: string; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resouce type. */ id: string; /** * Controls the maximum `tbytes`, `fbytes`, and `abytes`, values reported by `NFS FSSTAT` calls through any associated mount targets. This is an advanced feature. For most applications, use the default value. The `tbytes` value reported by `FSSTAT` will be `maxFsStatBytes`. The value of `fbytes` and `abytes` will be `maxFsStatBytes` minus the metered size of the file system. If the metered size is larger than `maxFsStatBytes`, then `fbytes` and `abytes` will both be '0'. */ maxFsStatBytes: string; /** * Controls the maximum `tfiles`, `ffiles`, and `afiles` values reported by `NFS FSSTAT` calls through any associated mount targets. This is an advanced feature. For most applications, use the default value. The `tfiles` value reported by `FSSTAT` will be `maxFsStatFiles`. The value of `ffiles` and `afiles` will be `maxFsStatFiles` minus the metered size of the file system. If the metered size is larger than `maxFsStatFiles`, then `ffiles` and `afiles` will both be '0'. */ maxFsStatFiles: string; mountTargetId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * The date and time the export set was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual cloud network (VCN) the export set is in. */ vcnId: string; } interface GetExportSetsFilter { name: string; regex?: boolean; values: string[]; } interface GetExportsExport { /** * Policies that apply to NFS requests made through this export. `exportOptions` contains a sequential list of `ClientOptions`. Each `ClientOptions` item defines the export options that are applied to a specified set of clients. */ exportOptions: outputs.FileStorage.GetExportsExportExportOption[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export set. */ exportSetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system. */ fileSystemId: string; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resouce type. */ id: string; /** * Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read. */ isIdmapGroupsForSysAuth: boolean; isLockOverride: boolean; /** * Locks associated with this resource. */ locks: outputs.FileStorage.GetExportsExportLock[]; /** * Path used to access the associated file system. */ path: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * The date and time the export was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetExportsExportExportOption { /** * Type of access to grant clients using the file system through this export. If unspecified defaults to `READ_WRITE`. */ access: string; /** * Array of allowed NFS authentication types. */ allowedAuths: string[]; /** * GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to `65534`. */ anonymousGid: string; /** * UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to `65534`. */ anonymousUid: string; /** * Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If `ALL`, all users and groups are remapped; if `ROOT`, only the root user and group (UID/GID 0) are remapped; if `NONE`, no remapping is done. If unspecified, defaults to `ROOT`. */ identitySquash: string; /** * Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID. */ isAnonymousAccessAllowed: boolean; /** * If `true`, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to `true`. */ requirePrivilegedSourcePort: boolean; /** * Clients these options should apply to. Must be a either single IPv4/IPv6 address or single IPv4/IPv6 CIDR block. */ source: string; } interface GetExportsExportLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the export was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetExportsFilter { name: string; regex?: boolean; values: string[]; } interface GetFileSystemQuotaRulesFilter { name: string; regex?: boolean; values: string[]; } interface GetFileSystemQuotaRulesQuotaRule { /** * An option to only display the users or groups that violate their quota rules. If `areViolatorsOnly` is false, the list result will display all the quota and usage report. If `areViolatorsOnly` is true, the list result will only display the quota and usage report for the users or groups that violate their quota rules. */ areViolatorsOnly: boolean; /** * A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. Example: `UserXYZ's quota` */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system. */ fileSystemId: string; /** * The identifier of the quota rule. It is the base64 encoded string of the tuple . */ id: string; /** * The flag is an identifier to tell whether the quota rule will be enforced. If `isHardQuota` is false, the quota rule will be enforced so the usage cannot exceed the hard quota limit. If `isHardQuota` is true, usage can exceed the soft quota limit. An alarm or notification will be sent to the customer, if the specific usage exceeds. */ isHardQuota: boolean; /** * An identifier for the owner of this usage and quota rule. Unix-like operating systems use this integer value to identify a user or group to manage access control. */ principalId: number; /** * The type of the owner of this quota rule and usage. */ principalType: string; /** * The value of the quota rule. The unit is Gigabyte. */ quotaLimitInGigabytes: number; quotaRuleId: string; /** * The date and time the quota rule was started, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the quota rule was last updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetFileSystemsFileSystem { /** * Specifies the enforcement of quota rules on the file system. */ areQuotaRulesEnabled: boolean; /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * Specifies whether the file system is attached to its parent file system. */ cloneAttachStatus: string; /** * Specifies the total number of children of a file system. */ cloneCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Displays the compartment-level quota enforcement state affecting this file system. */ compartmentQuotaEnforcementState: string; /** * 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"}` */ definedTags: { [key: string]: string; }; detachCloneTrigger: number; /** * A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource` */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy that is associated with the file systems. */ filesystemSnapshotPolicyId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resouce type. */ id: string; /** * Specifies whether the file system has been cloned. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ isCloneParent: boolean; /** * Specifies whether the data has finished copying from the source to the clone. Hydration can take up to several hours to complete depending on the size of the source. The source and clone remain available during hydration, but there may be some performance impact. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm#hydration). */ isHydrated: boolean; isLockOverride: boolean; /** * Specifies whether the file system can be used as a target file system for replication. The system sets this value to `true` if the file system is unexported, hasn't yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to `false`. For more information, see [Using Replication](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/using-replication.htm). */ isTargetable: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system. */ kmsKeyId: string; /** * Additional information about the current 'lifecycleState'. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.FileStorage.GetFileSystemsFileSystemLock[]; /** * The number of bytes consumed by the file system, including any snapshots. This number reflects the metered size of the file system and is updated asynchronously with respect to updates to the file system. For more information, see [File System Usage and Metering](https://docs.cloud.oracle.com/iaas/Content/File/Concepts/FSutilization.htm). */ meteredBytes: string; /** * Displays the state of enforcement of quota rules on the file system. */ quotaEnforcementState: string; /** * Specifies the total number of replications for which this file system is a source. */ replicationSourceCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication target associated with the file system. Empty if the file system is not being used as target in a replication. */ replicationTargetId: string; /** * Source information for the file system. */ sourceDetails: outputs.FileStorage.GetFileSystemsFileSystemSourceDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ sourceSnapshotId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services. */ systemTags: { [key: string]: string; }; /** * The date and time the file system was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetFileSystemsFileSystemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the file system was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetFileSystemsFileSystemSourceDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system that contains the source snapshot of a cloned file system. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ parentFileSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ sourceSnapshotId: string; } interface GetFileSystemsFilter { name: string; regex?: boolean; values: string[]; } interface GetFilesystemSnapshotPoliciesFilesystemSnapshotPolicy { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource` */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resouce type. */ id: string; isLockOverride: boolean; /** * Locks associated with this resource. */ locks: outputs.FileStorage.GetFilesystemSnapshotPoliciesFilesystemSnapshotPolicyLock[]; /** * The prefix to apply to all snapshots created by this policy. Example: `acme` */ policyPrefix: string; /** * The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy. */ schedules: outputs.FileStorage.GetFilesystemSnapshotPoliciesFilesystemSnapshotPolicySchedule[]; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services. */ systemTags: { [key: string]: string; }; /** * The date and time the file system snapshot policy was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetFilesystemSnapshotPoliciesFilesystemSnapshotPolicyLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the file system snapshot policy was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetFilesystemSnapshotPoliciesFilesystemSnapshotPolicySchedule { /** * The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time. */ dayOfMonth: number; /** * The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time. */ dayOfWeek: string; /** * The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time. */ hourOfDay: number; /** * Details for setting a retention date or legal hold. */ lockDurationDetails: outputs.FileStorage.GetFilesystemSnapshotPoliciesFilesystemSnapshotPolicyScheduleLockDurationDetail[]; /** * The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time. */ month: string; /** * The frequency of scheduled snapshots. */ period: string; /** * The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty. */ retentionDurationInSeconds: string; /** * A name prefix to be applied to snapshots created by this schedule. Example: `compliance1` */ schedulePrefix: string; /** * The starting point used to begin the scheduling of the snapshots based upon recurrence string in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. If no `timeScheduleStart` is provided, the value will be set to the time when the schedule was created. */ timeScheduleStart: string; /** * Time zone used for scheduling the snapshot. */ timeZone: string; } interface GetFilesystemSnapshotPoliciesFilesystemSnapshotPolicyScheduleLockDurationDetail { /** * For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set. */ coolOffDuration: number; /** * The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold. */ lockDuration: number; /** * Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period. */ lockMode: string; } interface GetFilesystemSnapshotPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetFilesystemSnapshotPolicyLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the file system snapshot policy was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetFilesystemSnapshotPolicySchedule { /** * The day of the month to create a scheduled snapshot. If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time. */ dayOfMonth: number; /** * The day of the week to create a scheduled snapshot. Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time. */ dayOfWeek: string; /** * The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot. If not set, the system chooses a value at creation time. */ hourOfDay: number; /** * Details for setting a retention date or legal hold. */ lockDurationDetails: outputs.FileStorage.GetFilesystemSnapshotPolicyScheduleLockDurationDetail[]; /** * The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time. */ month: string; /** * The frequency of scheduled snapshots. */ period: string; /** * The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty. */ retentionDurationInSeconds: string; /** * A name prefix to be applied to snapshots created by this schedule. Example: `compliance1` */ schedulePrefix: string; /** * The starting point used to begin the scheduling of the snapshots based upon recurrence string in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. If no `timeScheduleStart` is provided, the value will be set to the time when the schedule was created. */ timeScheduleStart: string; /** * Time zone used for scheduling the snapshot. */ timeZone: string; } interface GetFilesystemSnapshotPolicyScheduleLockDurationDetail { /** * For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set. */ coolOffDuration: number; /** * The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold. */ lockDuration: number; /** * Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period. */ lockMode: string; } interface GetMountTargetsFilter { name: string; regex?: boolean; values: string[]; } interface GetMountTargetsMountTarget { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource` */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export set. */ exportSetId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; hostnameLabel: string; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resouce type. */ id: string; /** * The method used to map a Unix UID to secondary groups. If NONE, the mount target will not use the Unix UID for ID mapping. */ idmapType: string; ipAddress: string; isLockOverride: boolean; /** * Allows administrator to configure a mount target to interact with the administrator's Kerberos infrastructure. */ kerberos: outputs.FileStorage.GetMountTargetsMountTargetKerbero[]; /** * Mount target details about the LDAP ID mapping configuration. */ ldapIdmaps: outputs.FileStorage.GetMountTargetsMountTargetLdapIdmap[]; /** * Additional information about the current 'lifecycleState'. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.FileStorage.GetMountTargetsMountTargetLock[]; /** * The OCIDs of the IPv6 addresses associated with this mount target. */ mountTargetIpv6ids: string[]; /** * A list of Network Security Group [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this mount target. A maximum of 5 is allowed. Setting this to an empty array after the list is created removes the mount target from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * Current billed throughput for mount target in Gbps. This corresponds to shape of mount target. Available shapes and corresponding throughput are listed at [Mount Target Performance](https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance). */ observedThroughput: string; /** * The OCIDs of the private IP addresses associated with this mount target. */ privateIpIds: string[]; /** * * New throughput for mount target at the end of billing cycle in Gbps. */ requestedThroughput: string; /** * * Reserved capacity (GB) associated with this mount target. Reserved capacity depends on observedThroughput value of mount target. Value is listed at [Mount Target Performance](https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance). */ reservedStorageCapacity: string; /** * [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-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` */ securityAttributes: { [key: string]: string; }; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the mount target is in. */ subnetId: string; /** * System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services. */ systemTags: { [key: string]: string; }; /** * The date and time the mount target current billing cycle will end, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Once a cycle ends, it is updated automatically to next timestamp which is after 30 days. Example: `2016-08-25T21:10:29.600Z` */ timeBillingCycleEnd: string; /** * The date and time the mount target was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetMountTargetsMountTargetKerbero { /** * Version of the keytab secert in the Vault to use as a backup. */ backupKeyTabSecretVersion: number; /** * Version of the keytab secret in the Vault to use. */ currentKeyTabSecretVersion: number; /** * Specifies whether to enable or disable Kerberos. */ isKerberosEnabled: boolean; /** * The Kerberos realm that the mount target will join. */ kerberosRealm: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the keytab secret in the Vault. */ keyTabSecretId: string; } interface GetMountTargetsMountTargetLdapIdmap { /** * The maximum amount of time the mount target is allowed to use a cached entry. */ cacheLifetimeSeconds: number; /** * The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry. */ cacheRefreshIntervalSeconds: number; /** * All LDAP searches are recursive starting at this group. Example: `CN=Group,DC=domain,DC=com` */ groupSearchBase: string; /** * The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration. */ negativeCacheLifetimeSeconds: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first connector to use to communicate with the LDAP server. */ outboundConnector1id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second connector to use to communicate with the LDAP server. */ outboundConnector2id: string; /** * Schema type of the LDAP account. */ schemaType: string; /** * All LDAP searches are recursive starting at this user. Example: `CN=User,DC=domain,DC=com` */ userSearchBase: string; } interface GetMountTargetsMountTargetLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the mount target was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetOutboundConnectorEndpoint { /** * Name of the DNS server. */ hostname: string; /** * Port of the DNS server. */ port: string; } interface GetOutboundConnectorLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the outbound connector was created in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetOutboundConnectorsFilter { name: string; regex?: boolean; values: string[]; } interface GetOutboundConnectorsOutboundConnector { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The LDAP Distinguished Name of the account. */ bindDistinguishedName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The account type of this outbound connector. */ connectorType: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource` */ displayName: string; /** * Array of server endpoints to use when connecting with the LDAP bind account. */ endpoints: outputs.FileStorage.GetOutboundConnectorsOutboundConnectorEndpoint[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resouce type. */ id: string; isLockOverride: boolean; /** * Locks associated with this resource. */ locks: outputs.FileStorage.GetOutboundConnectorsOutboundConnectorLock[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the password for the LDAP bind account in the Vault. */ passwordSecretId: string; /** * Version of the password secret in the Vault to use. */ passwordSecretVersion: number; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services. */ systemTags: { [key: string]: string; }; /** * The date and time the outbound connector was created in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the trusted certificate for the LDAP server in the Vault . */ trustedCertificateSecretId: string; /** * Version of the trusted certificate secret in the Vault to use. */ trustedCertificateSecretVersion: number; } interface GetOutboundConnectorsOutboundConnectorEndpoint { /** * Name of the DNS server. */ hostname: string; /** * Port of the DNS server. */ port: string; } interface GetOutboundConnectorsOutboundConnectorLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the outbound connector was created in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetReplicationLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the replication was created in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2021-01-04T20:01:29.100Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetReplicationTargetsFilter { name: string; regex?: boolean; values: string[]; } interface GetReplicationTargetsReplicationTarget { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Percentage progress of the current replication cycle. */ deltaProgress: string; /** * The current state of the snapshot during replication operations. */ deltaStatus: string; /** * A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource` */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resouce type. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last snapshot snapshot which was completely applied to the target file system. Empty while the initial snapshot is being applied. */ lastSnapshotId: string; /** * Additional information about the current `lifecycleState`. */ lifecycleDetails: string; /** * The snapshotTime of the most recent recoverable replication snapshot in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2021-04-04T20:01:29.100Z` */ recoveryPointTime: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of replication. */ replicationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of source filesystem. */ sourceId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services. */ systemTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of target filesystem. */ targetId: string; /** * The date and time the replication target was created in target region. in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2021-01-04T20:01:29.100Z` */ timeCreated: string; } interface GetReplicationsFilter { name: string; regex?: boolean; values: string[]; } interface GetReplicationsReplication { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Percentage progress of the current replication cycle. */ deltaProgress: string; /** * The current state of the snapshot during replication operations. */ deltaStatus: string; /** * A user-friendly name. It does not have to be unique, and it is changeable. Example: `My resource` */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resouce type. */ id: string; isLockOverride: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete. */ lastSnapshotId: string; /** * Additional information about the current 'lifecycleState'. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.FileStorage.GetReplicationsReplicationLock[]; /** * The [`snapshotTime`](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Snapshot/snapshotTime) of the most recent recoverable replication snapshot in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2021-04-04T20:01:29.100Z` */ recoveryPointTime: string; /** * Duration in minutes between replication snapshots. */ replicationInterval: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [`ReplicationTarget`](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/ReplicationTarget). */ replicationTargetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source file system. */ sourceId: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services. */ systemTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target file system. */ targetId: string; /** * The date and time the replication was created in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2021-01-04T20:01:29.100Z` */ timeCreated: string; } interface GetReplicationsReplicationLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the replication was created in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2021-01-04T20:01:29.100Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetSnapshotLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the snapshot was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetSnapshotLockDurationDetail { /** * For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set. */ coolOffDuration: number; /** * The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold. */ lockDuration: number; /** * Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period. */ lockMode: string; } interface GetSnapshotsFilter { /** * Name of the snapshot. This value is immutable. */ name: string; regex?: boolean; values: string[]; } interface GetSnapshotsSnapshot { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Bytes referenced only by this snapshot; deducted from compartment usage immediately upon deletion. */ exclusiveBytes: string; /** * The time when this snapshot will be deleted. */ expirationTime: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system. */ fileSystemId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the file system snapshot policy that is used to create the snapshots. */ filesystemSnapshotPolicyId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter results by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resouce type. */ id: string; /** * Specifies whether the snapshot has been cloned. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ isCloneSource: boolean; isLockOverride: boolean; /** * Additional information about the current `lifecycleState`. */ lifecycleDetails: string; /** * Details for setting a retention date or legal hold. */ lockDurationDetails: outputs.FileStorage.GetSnapshotsSnapshotLockDurationDetail[]; /** * Locks associated with this resource. */ locks: outputs.FileStorage.GetSnapshotsSnapshotLock[]; /** * Name of the snapshot. This value is immutable. */ name: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) identifying the parent from which this snapshot was cloned. If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value. If this snapshot was cloned, then the `provenanceId` value is the parent's `provenanceId`. See [Cloning a File System](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm). */ provenanceId: string; /** * The date and time the snapshot was taken, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. This value might be the same or different from `timeCreated` depending on the following factors: * * If the snapshot is created in the original file system directory. * * If the snapshot is cloned from a file system. * * If the snapshot is replicated from a file system. */ snapshotTime: string; /** * Specifies the generation type of the snapshot. */ snapshotType: string; /** * Filter results by the specified lifecycle state. Must be a valid state for the resource type. */ state: string; /** * System tags for this resource. System tags are applied to resources by internal Oracle Cloud Infrastructure services. */ systemTags: { [key: string]: string; }; /** * The date and time the snapshot was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) when this snapshot was locked. It is a read-only property because the user should not be able to set it, it is set by our service. */ timeLocked: string; } interface GetSnapshotsSnapshotLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The date and time the snapshot was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetSnapshotsSnapshotLockDurationDetail { /** * For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set. */ coolOffDuration: number; /** * The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold. */ lockDuration: number; /** * Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period. */ lockMode: string; } interface MountTargetKerberos { /** * (Updatable) Version of the keytab Secret in the Vault to use as a backup. */ backupKeyTabSecretVersion: number; /** * (Updatable) Version of the keytab Secret in the Vault to use. */ currentKeyTabSecretVersion: number; /** * (Updatable) Specifies whether to enable or disable Kerberos. */ isKerberosEnabled: boolean; /** * (Updatable) The Kerberos realm that the mount target will join. */ kerberosRealm: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the keytab Secret in the Vault. */ keyTabSecretId?: string; } interface MountTargetLdapIdmap { /** * (Updatable) The maximum amount of time the mount target is allowed to use a cached entry. */ cacheLifetimeSeconds: number; /** * (Updatable) The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry. */ cacheRefreshIntervalSeconds: number; /** * (Updatable) All LDAP searches are recursive starting at this group. Example: `CN=Group,DC=domain,DC=com` */ groupSearchBase: string; /** * (Updatable) The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration. */ negativeCacheLifetimeSeconds: number; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first connector to use to communicate with the LDAP server. */ outboundConnector1id?: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second connector to use to communicate with the LDAP server. */ outboundConnector2id?: string; /** * (Updatable) Schema type of the LDAP account. */ schemaType: string; /** * (Updatable) All LDAP searches are recursive starting at this user. Example: `CN=User,DC=domain,DC=com` */ userSearchBase: string; } interface MountTargetLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface OutboundConnectorEndpoint { /** * Name of the DNS server. */ hostname: string; /** * Port of the DNS server. */ port: string; } interface OutboundConnectorLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface ReplicationLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface SnapshotLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface SnapshotLockDurationDetails { /** * (Updatable) For snapshots in compliance mode, a cooling-off period (measured in days) begins. During this time, you can still edit or remove the lock. Once this period ends, the snapshot becomes immutable until the specified retention date expires, permanently preventing any deletion or modification. The cool off duration can be set for a minimum of 0 days and a maximum of 365. It defaults to 14 days if not set. */ coolOffDuration: number; /** * (Updatable) The retention period (measured in days) defines how long a snapshot remains locked, preventing user modifications or deletions. In governance mode this period can be adjusted, but in compliance mode it becomes permanent after a cool-off period. Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days. A value of 0 days stands for an indefinite retention period and it is used for a legal hold. */ lockDuration: number; /** * (Updatable) Can be GOVERNANCE or COMPLIANCE. GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold. COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period. Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it until its set retention date passes. After the snapshot is locked, customers can only increase its retention period. */ lockMode: string; } } export declare namespace FleetAppsManagement { interface CatalogItemCatalogResultPayload { /** * branch Name */ branchName: string; /** * config result type. */ configResultType: string; /** * configuration Source Provider [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ configurationSourceProviderId: string; /** * package url */ packageUrl: string; /** * repository Url */ repositoryUrl: string; /** * template id */ templateId: string; /** * The date and time expires, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeExpires: string; /** * File path to the directory to use for running Terraform. If not specified, the root directory is used. */ workingDirectory: string; } interface CatalogItemCatalogSourcePayload { /** * access uri */ accessUri: string; /** * branch Name */ branchName: string; /** * bucket name */ bucket: string; /** * config source type. */ configSourceType: string; /** * configuration Source Provider [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ configurationSourceProviderId: string; /** * Template Description */ description: string; /** * This listing Id parameter of Payload. */ listingId: string; /** * Template Long Description */ longDescription: string; /** * nameSpace */ namespace: string; /** * object name */ object: string; /** * repository Url */ repositoryUrl: string; /** * Template Display Name */ templateDisplayName: string; /** * The date and time expires, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeExpires: string; /** * This version parameter of Payload. */ version: string; /** * File path to the directory to use for running Terraform. If not specified, the root directory is used. */ workingDirectory: string; /** * The Base64 encoded template. This payload will trigger CreateTemplate API, where the parameter will be passed. */ zipFileBase64encoded: string; } interface CompliancePolicyRulePatchSelection { /** * (Updatable) Days passed since patch release. */ daysSinceRelease: number; /** * (Updatable) Patch Name. */ patchLevel: string; /** * (Updatable) Patch Name. */ patchName: string; /** * (Updatable) Selection type for the Patch. */ selectionType: string; } interface CompliancePolicyRuleProductVersion { /** * (Updatable) Is rule applicable to all higher versions also */ isApplicableForAllHigherVersions: boolean; /** * (Updatable) Product version the rule is applicable. */ version: string; } interface FleetCredential { /** * (Updatable) Compartment OCID */ compartmentId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * Credential specific Details. */ entitySpecifics: outputs.FleetAppsManagement.FleetCredentialEntitySpecifics; /** * Credential Details. */ password: outputs.FleetAppsManagement.FleetCredentialPassword; /** * Credential Details. */ user: outputs.FleetAppsManagement.FleetCredentialUser; } interface FleetCredentialEntitySpecifics { /** * (Updatable) At what level the credential is provided? */ credentialLevel: string; /** * (Updatable) OCID of the resource associated with the target for which the credential is created. */ resourceId: string; /** * (Updatable) Target name for which the credential is provided. */ target: string; /** * (Updatable) List of fleet credential variables. */ variables: outputs.FleetAppsManagement.FleetCredentialEntitySpecificsVariable[]; } interface FleetCredentialEntitySpecificsVariable { /** * (Updatable) Name of the variable. */ name: string; /** * (Updatable) The value corresponding to the variable name. */ value: string; } interface FleetCredentialPassword { /** * (Updatable) Credential Type. */ credentialType: string; /** * (Updatable) OCID for the Vault Key that will be used to encrypt/decrypt the value given. */ keyId: string; /** * (Updatable) The Vault Key version. */ keyVersion: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. */ secretId: string; /** * (Updatable) The secret version. */ secretVersion: string; /** * (Updatable) The value corresponding to the credential. */ value: string; /** * (Updatable) OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. */ vaultId: string; } interface FleetCredentialUser { /** * (Updatable) Credential Type. */ credentialType: string; /** * (Updatable) OCID for the Vault Key that will be used to encrypt/decrypt the value given. */ keyId: string; /** * (Updatable) The Vault Key version. */ keyVersion: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. */ secretId: string; /** * (Updatable) The secret version. */ secretVersion: string; /** * (Updatable) The value corresponding to the credential. */ value: string; /** * (Updatable) OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vaultId: string; } interface FleetDetails { /** * Type of the Fleet. PRODUCT - A fleet of product-specific resources for a product type. ENVIRONMENT - A fleet of environment-specific resources for a product stack. GROUP - A fleet of a fleet of either environment or product fleets. GENERIC - A fleet of resources selected dynamically or manually for reporting purposes */ fleetType: string; } interface FleetNotificationPreference { /** * (Updatable) Compartment ID the topic belongs to. */ compartmentId: string; /** * (Updatable) Preferences to send notifications on the fleet activities. */ preferences: outputs.FleetAppsManagement.FleetNotificationPreferencePreferences; /** * (Updatable) Topic Id where the notifications will be directed. A topic is a communication channel for sending messages on chosen events to subscriptions. */ topicId: string; } interface FleetNotificationPreferencePreferences { /** * (Updatable) Enables or disables notification on job canceled. */ onJobCanceled: boolean; /** * (Updatable) Enables or disables notification on Job Failures. */ onJobFailure: boolean; /** * (Updatable) Enables or disables notification on job schedule change. */ onJobScheduleChange: boolean; /** * (Updatable) Enables or disables notification on job start. */ onJobStart: boolean; /** * (Updatable) Enables or disables notification on job success. */ onJobSuccess: boolean; /** * (Updatable) Enables or disables notification when fleet resource becomes non compliant. */ onResourceNonCompliance: boolean; /** * (Updatable) Enables or disables notification when a newer version of runbook associated with a fleet is available */ onRunbookNewerVersion: boolean; /** * (Updatable) Enables or disables notification on task failure. */ onTaskFailure: boolean; /** * (Updatable) Enables or disables notification when a task is paused. */ onTaskPause: boolean; /** * (Updatable) Enables or disables notification on task success. */ onTaskSuccess: boolean; /** * (Updatable) Enables or disables notification on Environment Fleet Topology Modification. */ onTopologyModification: boolean; /** * (Updatable) Enables notification on upcoming schedule. */ upcomingSchedule: outputs.FleetAppsManagement.FleetNotificationPreferencePreferencesUpcomingSchedule; } interface FleetNotificationPreferencePreferencesUpcomingSchedule { /** * (Updatable) Specify when the notification should be sent. */ notifyBefore: string; /** * (Updatable) Enables notification on upcoming schedule. */ onUpcomingSchedule: boolean; } interface FleetProperty { /** * (Updatable) compartment OCID */ compartmentId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * Type of the FleetProperty. */ fleetPropertyType: string; /** * Property is required or not. */ isRequired: boolean; /** * Value of the Property. */ value: string; } interface FleetResource { /** * (Updatable) Compartment Identifier[OCID]. */ compartmentId: string; /** * Type of the FleetResource. */ fleetResourceType: string; /** * OCID of the resource. */ resourceId: string; /** * Tenancy Identifier[OCID]. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ tenancyId: string; } interface FleetResourceSelection { /** * (Updatable) Type of resource selection in a Fleet. Select resources manually or select resources based on rules. */ resourceSelectionType: string; /** * (Updatable) Rule Selection Criteria for DYNAMIC resource selection for a GENERIC fleet. Rules define what resources are members of this fleet. All resources that meet the criteria are added automatically. */ ruleSelectionCriteria: outputs.FleetAppsManagement.FleetResourceSelectionRuleSelectionCriteria; } interface FleetResourceSelectionRuleSelectionCriteria { /** * (Updatable) Match condition for the rule selection. Include resources that match all rules or any of the rules. */ matchCondition: string; /** * (Updatable) Rules. */ rules: outputs.FleetAppsManagement.FleetResourceSelectionRuleSelectionCriteriaRule[]; } interface FleetResourceSelectionRuleSelectionCriteriaRule { /** * (Updatable) Based on what the rule is created. It can be based on a resourceProperty or a tag. If based on a tag, basis will be 'definedTagEquals' If based on a resource property, basis will be 'inventoryProperties' */ basis: string; /** * (Updatable) Compartment Id for which the rule is created. */ compartmentId: string; /** * (Updatable) If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it. Which resources are returned and their field contents depends on the value of accessLevel. Default value for `compartmentIdInSubtree` is false */ compartmentIdInSubtree: boolean; /** * (Updatable) Rule Conditions */ conditions: outputs.FleetAppsManagement.FleetResourceSelectionRuleSelectionCriteriaRuleCondition[]; /** * (Updatable) Match condition for the rule selection. Include resources that match all rules or any of the rules. Default value for `matchCondition` is ANY */ matchCondition: string; /** * (Updatable) The Compartment ID to dynamically search resources. Provide the compartment ID to which the rule is applicable. */ resourceCompartmentId: string; } interface FleetResourceSelectionRuleSelectionCriteriaRuleCondition { /** * (Updatable) Attribute Group. Provide a Tag namespace if the rule is based on a tag. Provide resource type if the rule is based on a resource property. */ attrGroup: string; /** * (Updatable) Attribute Key.Provide Tag key if the rule is based on a tag. Provide resource property name if the rule is based on a resource property. */ attrKey: string; /** * (Updatable) Attribute Value.Provide Tag value if the rule is based on a tag. Provide resource property value if the rule is based on a resource property. */ attrValue: string; } interface GetAnnouncementsAnnouncementCollection { /** * List of AnnouncementSummary items. */ items: outputs.FleetAppsManagement.GetAnnouncementsAnnouncementCollectionItem[]; } interface GetAnnouncementsAnnouncementCollectionItem { /** * Announcement end date. */ announcementEnd: string; /** * Announcement start date. */ announcementStart: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. */ description: string; /** * Announcement details. */ details: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the resource. */ id: string; /** * Associated region */ resourceRegion: string; /** * The lifecycle state of the announcement. */ state: string; /** * Summary of the announcement. */ summary: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Type of announcement. */ type: string; /** * URL to the announcement. */ url: string; } interface GetAnnouncementsFilter { name: string; regex?: boolean; values: string[]; } interface GetCatalogItemCatalogResultPayload { /** * branch Name */ branchName: string; /** * config result type. */ configResultType: string; /** * configuration Source Provider [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ configurationSourceProviderId: string; /** * package url */ packageUrl: string; /** * repository Url */ repositoryUrl: string; /** * template id */ templateId: string; /** * The date and time expires, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeExpires: string; /** * File path to the directory to use for running Terraform. If not specified, the root directory is used. */ workingDirectory: string; } interface GetCatalogItemCatalogSourcePayload { /** * access uri */ accessUri: string; /** * branch Name */ branchName: string; /** * bucket name */ bucket: string; /** * Config source type Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, GIT_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE. */ configSourceType: string; /** * configuration Source Provider [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ configurationSourceProviderId: string; /** * Description about the catalog item. */ description: string; /** * The catalog listing Id. */ listingId: string; /** * Template Long Description */ longDescription: string; /** * nameSpace */ namespace: string; /** * object name */ object: string; /** * repository Url */ repositoryUrl: string; /** * Template Display Name */ templateDisplayName: string; /** * The date and time expires, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeExpires: string; /** * This version parameter of Payload. */ version: string; /** * File path to the directory to use for running Terraform. If not specified, the root directory is used. */ workingDirectory: string; /** * The Base64 encoded template. This payload will trigger CreateTemplate API, where the parameter will be passed. */ zipFileBase64encoded: string; } interface GetCatalogItemVariablesDefinitionSchemaDocument { /** * Indicates if the stack allows users to view state information. */ canAllowViewState: boolean; /** * Extended help or summary for understanding output. */ description: string; /** * variable groups object. */ groupings: outputs.FleetAppsManagement.GetCatalogItemVariablesDefinitionSchemaDocumentGrouping[]; /** * Informational text or notes relevant to the stack or its use. */ informationalText: string; /** * Setup or usage instructions for this stack. */ instructions: string; /** * The locale/language for the schema user interface (default is EN). */ locale: string; /** * logo url. */ logoUrl: string; /** * Array of output group objects to group outputs for display or logical purposes. */ outputGroups: outputs.FleetAppsManagement.GetCatalogItemVariablesDefinitionSchemaDocumentOutputGroup[]; /** * A mapping of output variable names to their definitions. */ outputs: outputs.FleetAppsManagement.GetCatalogItemVariablesDefinitionSchemaDocumentOutput[]; /** * The version of the package associated with this schema. */ packageVersion: string; /** * primary output button value. */ primaryOutputButton: string; /** * The version of the schema definition format in use for this document. */ schemaVersion: string; /** * Object representing the source information for the stack, indicating origin type and a reference string. */ sources: outputs.FleetAppsManagement.GetCatalogItemVariablesDefinitionSchemaDocumentSource[]; /** * Additional details describing the stack's purpose or use-case. */ stackDescription: string; /** * Display title for the group of variables. */ title: string; /** * Troubleshooting tips, guidance, or steps for stack usage. */ troubleshooting: string; /** * An array of variable group definitions for organizing variables together. */ variableGroups: outputs.FleetAppsManagement.GetCatalogItemVariablesDefinitionSchemaDocumentVariableGroup[]; /** * Key-value map of input variables defined for use by the stack. */ variables: string; /** * The version identifier for this schema document. */ version: string; } interface GetCatalogItemVariablesDefinitionSchemaDocumentGrouping { /** * Map of group names to their respective VariableGroup objects. */ arrays: outputs.FleetAppsManagement.GetCatalogItemVariablesDefinitionSchemaDocumentGroupingArray[]; } interface GetCatalogItemVariablesDefinitionSchemaDocumentGroupingArray { /** * Display title for the group of variables. */ title: string; /** * Key-value map of input variables defined for use by the stack. */ variables: string[]; /** * Hint controlling the group's visibility. */ visible: string; } interface GetCatalogItemVariablesDefinitionSchemaDocumentOutput { /** * Extended help or summary for understanding output. */ description: string; /** * Display label abel for the URL. */ displayText: string; /** * Hint about formatting or rendering the output value. */ format: string; /** * If true, marks this output as sensitive. */ isSensitive: boolean; /** * Display title for the group of variables. */ title: string; /** * The source type of the stack (e.g. MARKETPLACE, QUICKSTART, or WEB). */ type: string; /** * Value of string that user can easily copy. */ value: boolean; /** * Hint controlling the group's visibility. */ visible: string; } interface GetCatalogItemVariablesDefinitionSchemaDocumentOutputGroup { /** * A mapping of output variable names to their definitions. */ outputs: string[]; /** * Display title for the group of variables. */ title: string; } interface GetCatalogItemVariablesDefinitionSchemaDocumentSource { /** * Reference string providing a pointer or identifier for the source. */ reference: string; /** * The source type of the stack (e.g. MARKETPLACE, QUICKSTART, or WEB). */ type: string; } interface GetCatalogItemVariablesDefinitionSchemaDocumentVariableGroup { /** * Display title for the group of variables. */ title: string; /** * Key-value map of input variables defined for use by the stack. */ variables: string[]; /** * Hint controlling the group's visibility. */ visible: string; } interface GetCatalogItemsCatalogItemCollection { items: outputs.FleetAppsManagement.GetCatalogItemsCatalogItemCollectionItem[]; } interface GetCatalogItemsCatalogItemCollectionItem { /** * Catalog result payload. */ catalogResultPayloads: outputs.FleetAppsManagement.GetCatalogItemsCatalogItemCollectionItemCatalogResultPayload[]; /** * Catalog source payload. */ catalogSourcePayloads: outputs.FleetAppsManagement.GetCatalogItemsCatalogItemCollectionItemCatalogSourcePayload[]; cloneCatalogItemTrigger: number; /** * (Updatable) The ID of the compartment in which to list resources. */ compartmentId: string; /** * The [ConfigSourceType](https://www.terraform.io/definitions/CatalogItem/configSourceType) Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, URL_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE. */ configSourceType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description about the catalog item. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the catalog. */ id: string; /** * The details of lifecycle state CatalogItem. */ lifecycleDetails: string; /** * The catalog listing Id. */ listingId: string; /** * The catalog package version. */ listingVersion: string; /** * A filter to return only resources that match the given package type. The state value is case-insensitive. */ packageType: string; /** * Short description about the catalog item. */ shortDescription: string; /** * The indicator to append Public Items from the root compartment to any query, when set to TRUE. */ shouldListPublicItems: boolean; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the CatalogItem was last checked by backfill job, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeBackfillLastChecked: string; /** * The date and time the CatalogItem was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the CatalogItem was last checked, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeLastChecked: string; /** * The date and time the CatalogItem was released, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeReleased: string; /** * The date and time the CatalogItem was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * Version description about the catalog item. */ versionDescription: string; } interface GetCatalogItemsCatalogItemCollectionItemCatalogResultPayload { /** * branch Name */ branchName: string; /** * config result type. */ configResultType: string; /** * configuration Source Provider [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ configurationSourceProviderId: string; /** * package url */ packageUrl: string; /** * repository Url */ repositoryUrl: string; /** * template id */ templateId: string; /** * The date and time expires, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeExpires: string; /** * File path to the directory to use for running Terraform. If not specified, the root directory is used. */ workingDirectory: string; } interface GetCatalogItemsCatalogItemCollectionItemCatalogSourcePayload { /** * access uri */ accessUri: string; /** * branch Name */ branchName: string; /** * bucket name */ bucket: string; /** * The [ConfigSourceType](https://www.terraform.io/definitions/CatalogItem/configSourceType) Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, URL_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE. */ configSourceType: string; /** * configuration Source Provider [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ configurationSourceProviderId: string; /** * Description about the catalog item. */ description: string; /** * The catalog listing Id. */ listingId: string; /** * Template Long Description */ longDescription: string; /** * nameSpace */ namespace: string; /** * object name */ object: string; /** * repository Url */ repositoryUrl: string; /** * Template Display Name */ templateDisplayName: string; /** * The date and time expires, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeExpires: string; /** * This version parameter of Payload. */ version: string; /** * File path to the directory to use for running Terraform. If not specified, the root directory is used. */ workingDirectory: string; /** * The Base64 encoded template. This payload will trigger CreateTemplate API, where the parameter will be passed. */ zipFileBase64encoded: string; } interface GetCatalogItemsFilter { name: string; regex?: boolean; values: string[]; } interface GetCompliancePoliciesCompliancePolicyCollection { items: outputs.FleetAppsManagement.GetCompliancePoliciesCompliancePolicyCollectionItem[]; } interface GetCompliancePoliciesCompliancePolicyCollectionItem { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single Compliance Policy by id. Either compartmentId or id must be provided. */ id: string; /** * A message that describes the current state of the CompliancePolicy in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * platformConfiguration OCID corresponding to the Product. */ productId: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the CompliancePolicy was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the CompliancePolicy was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * A filter to return Platform Configurations whose type matches the given type. */ type: string; } interface GetCompliancePoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetCompliancePolicyRulePatchSelection { /** * Days passed since patch release. */ daysSinceRelease: number; /** * Patch Name. */ patchLevel: string; /** * Patch Name. */ patchName: string; /** * Selection type for the Patch. */ selectionType: string; } interface GetCompliancePolicyRuleProductVersion { /** * Is rule applicable to all higher versions also */ isApplicableForAllHigherVersions: boolean; /** * Product version the rule is applicable. */ version: string; } interface GetCompliancePolicyRulesCompliancePolicyRuleCollection { items: outputs.FleetAppsManagement.GetCompliancePolicyRulesCompliancePolicyRuleCollectionItem[]; } interface GetCompliancePolicyRulesCompliancePolicyRuleCollectionItem { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * unique CompliancePolicy identifier. */ compliancePolicyId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Grace period in days,weeks,months or years the exemption is applicable for the rule. This enables a grace period when Fleet Application Management doesn't report the product as noncompliant when patch is not applied. */ gracePeriod: string; /** * Unique identifier or OCID for listing a single Compliance Policy Rule by id. Either compartmentId or id must be provided. */ id: string; /** * A message that describes the current state of the CompliancePolicyRule in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Patch Selection Details */ patchSelections: outputs.FleetAppsManagement.GetCompliancePolicyRulesCompliancePolicyRuleCollectionItemPatchSelection[]; /** * PlatformConfiguration OCID for the patch type to which this CompliancePolicyRule applies. */ patchTypeIds: string[]; /** * A specific product version or a specific version and succeeding. Example: 12.1 or 12.1 and above for Oracle WebLogic Application server. The policy applies to the next version only, and not to other versions such as, 12.1.x. */ productVersions: outputs.FleetAppsManagement.GetCompliancePolicyRulesCompliancePolicyRuleCollectionItemProductVersion[]; /** * Severity to which this CompliancePolicyRule applies. */ severities: string[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the CompliancePolicyRule was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the CompliancePolicyRule was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetCompliancePolicyRulesCompliancePolicyRuleCollectionItemPatchSelection { /** * Days passed since patch release. */ daysSinceRelease: number; /** * Patch Name. */ patchLevel: string; /** * A filter to return only resources that match the patch selection against the given patch name. */ patchName: string; /** * Selection type for the Patch. */ selectionType: string; } interface GetCompliancePolicyRulesCompliancePolicyRuleCollectionItemProductVersion { /** * Is rule applicable to all higher versions also */ isApplicableForAllHigherVersions: boolean; /** * Product version the rule is applicable. */ version: string; } interface GetCompliancePolicyRulesFilter { name: string; regex?: boolean; values: string[]; } interface GetComplianceRecordCountsComplianceRecordAggregationCollection { /** * List of ComplianceRecordAggregation objects. */ items: outputs.FleetAppsManagement.GetComplianceRecordCountsComplianceRecordAggregationCollectionItem[]; } interface GetComplianceRecordCountsComplianceRecordAggregationCollectionItem { /** * Count of compliance records in a compartment. */ complianceRecordCountCount: number; /** * Aggregated summary information for ComplianceRecord */ dimensions: outputs.FleetAppsManagement.GetComplianceRecordCountsComplianceRecordAggregationCollectionItemDimension[]; } interface GetComplianceRecordCountsComplianceRecordAggregationCollectionItemDimension { /** * Level at which the compliance is calculated. */ complianceLevel: string; /** * Last known compliance state. */ complianceState: string; } interface GetComplianceRecordCountsFilter { name: string; regex?: boolean; values: string[]; } interface GetComplianceRecordsComplianceRecordCollection { /** * List of compliancePolicys. */ items: outputs.FleetAppsManagement.GetComplianceRecordsComplianceRecordCollectionItem[]; } interface GetComplianceRecordsComplianceRecordCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Target Compliance State. */ complianceState: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The displayName of the entity for which the compliance is calculated.Ex.DisplayName for the Fleet */ entityDisplayName: string; /** * Entity identifier.Ex:FleetId */ entityId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the ComplianceRecord. */ id: string; /** * Details of the Patch. */ patches: outputs.FleetAppsManagement.GetComplianceRecordsComplianceRecordCollectionItemPatch[]; /** * Details of the Policy associated */ policies: outputs.FleetAppsManagement.GetComplianceRecordsComplianceRecordCollectionItemPolicy[]; /** * Details of the Resource */ resources: outputs.FleetAppsManagement.GetComplianceRecordsComplianceRecordCollectionItemResource[]; /** * The current state of the ComplianceRecord. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Details of the Target. */ targets: outputs.FleetAppsManagement.GetComplianceRecordsComplianceRecordCollectionItemTarget[]; /** * The date and time the ComplianceRecord was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the ComplianceRecord was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetComplianceRecordsComplianceRecordCollectionItemPatch { /** * Patch Description. */ patchDescription: string; /** * patch OCID. */ patchId: string; /** * Patch Name. */ patchName: string; /** * Type of patch. */ patchType: string; /** * Details of the Product. */ products: outputs.FleetAppsManagement.GetComplianceRecordsComplianceRecordCollectionItemPatchProduct[]; /** * Patch Severity. */ severity: string; /** * Date on which patch was released */ timeReleased: string; } interface GetComplianceRecordsComplianceRecordCollectionItemPatchProduct { /** * Product Name. */ productName: string; /** * ProductStack name. */ productStack: string; /** * Product Version. */ productVersion: string; } interface GetComplianceRecordsComplianceRecordCollectionItemPolicy { /** * Compliane Policy DisplayName */ compliancePolicyDisplayName: string; /** * Compliance Policy Id */ compliancePolicyId: string; /** * Product Name */ compliancePolicyRuleDisplayName: string; /** * Compliane Policy Rule Id */ compliancePolicyRuleId: string; /** * Grace period in days,weeks,months or years the exemption is applicable for the rule. */ gracePeriod: string; /** * Patch Selection Details */ patchSelections: outputs.FleetAppsManagement.GetComplianceRecordsComplianceRecordCollectionItemPolicyPatchSelection[]; } interface GetComplianceRecordsComplianceRecordCollectionItemPolicyPatchSelection { /** * Days passed since patch release. */ daysSinceRelease: number; /** * Patch Name. */ patchLevel: string; /** * Patch Name. */ patchName: string; /** * Selection type for the Patch. */ selectionType: string; } interface GetComplianceRecordsComplianceRecordCollectionItemResource { /** * Compartment the resource belongs to. */ compartment: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Resource identifier. */ resourceId: string; /** * Name of the resource. */ resourceName: string; /** * Region the resource belongs to. */ resourceRegion: string; } interface GetComplianceRecordsComplianceRecordCollectionItemTarget { /** * Target Identifier. */ targetId: string; /** * Unique target name */ targetName: string; /** * Current version. */ version: string; } interface GetComplianceRecordsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetComplianceReportResource { /** * Compartment the resource belongs to. */ compartment: string; /** * The last known compliance state of the target. */ complianceState: string; /** * Products associated with the Fleet. Only the products belonging to managed targets will be shown. */ products: outputs.FleetAppsManagement.GetFleetComplianceReportResourceProduct[]; /** * The OCID to identify the resource. */ resourceId: string; /** * Display name of the resource. */ resourceName: string; /** * The region the resource belongs to. */ resourceRegion: string; /** * Type of the resource. */ resourceType: string; /** * TenancyId of the resource. */ tenancyId: string; /** * Tenancy the resource belongs to. */ tenancyName: string; } interface GetFleetComplianceReportResourceProduct { /** * Product Name. */ productName: string; /** * Managed Targets associated with the Product. */ targets: outputs.FleetAppsManagement.GetFleetComplianceReportResourceProductTarget[]; } interface GetFleetComplianceReportResourceProductTarget { /** * The last known compliance state of the target. */ complianceState: string; /** * Installed Patches for the Target. */ installedPatches: outputs.FleetAppsManagement.GetFleetComplianceReportResourceProductTargetInstalledPatch[]; /** * Recommended Patches for the Target. */ recommendedPatches: outputs.FleetAppsManagement.GetFleetComplianceReportResourceProductTargetRecommendedPatch[]; /** * Target Identifier.Can be the target name if a separate ID is not available. */ targetId: string; /** * Target Name. */ targetName: string; /** * Current version of the target. */ version: string; } interface GetFleetComplianceReportResourceProductTargetInstalledPatch { /** * Patch description. */ patchDescription: string; /** * Patch name. */ patchName: string; /** * Type of patch. */ patchType: string; /** * Time the patch was applied. */ timeApplied: string; /** * The date on which patch was released. */ timeReleased: string; } interface GetFleetComplianceReportResourceProductTargetRecommendedPatch { /** * Patch description. */ patchDescription: string; /** * Patch name. */ patchName: string; /** * Type of patch. */ patchType: string; /** * Time the patch was applied. */ timeApplied: string; /** * The date on which patch was released. */ timeReleased: string; } interface GetFleetCredential { /** * Compartment Identifier[OCID]. */ compartmentId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * Credential specific Details. */ entitySpecifics: outputs.FleetAppsManagement.GetFleetCredentialEntitySpecific[]; /** * Credential Details. */ passwords: outputs.FleetAppsManagement.GetFleetCredentialPassword[]; /** * Credential Details. */ users: outputs.FleetAppsManagement.GetFleetCredentialUser[]; } interface GetFleetCredentialEntitySpecific { /** * At what level the credential is provided? */ credentialLevel: string; /** * OCID of the resource associated with the target for which the credential is created. */ resourceId: string; /** * Target name for which the credential is provided. */ target: string; /** * List of fleet credential variables. */ variables: outputs.FleetAppsManagement.GetFleetCredentialEntitySpecificVariable[]; } interface GetFleetCredentialEntitySpecificVariable { /** * Name of the variable. */ name: string; /** * The value corresponding to the credential. */ value: string; } interface GetFleetCredentialPassword { /** * Credential Type. */ credentialType: string; /** * OCID for the Vault Key that will be used to encrypt/decrypt the value given. */ keyId: string; /** * The Vault Key version. */ keyVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. */ secretId: string; /** * The secret version. */ secretVersion: string; /** * The value corresponding to the credential. */ value: string; /** * OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. */ vaultId: string; } interface GetFleetCredentialUser { /** * Credential Type. */ credentialType: string; /** * OCID for the Vault Key that will be used to encrypt/decrypt the value given. */ keyId: string; /** * The Vault Key version. */ keyVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. */ secretId: string; /** * The secret version. */ secretVersion: string; /** * The value corresponding to the credential. */ value: string; /** * OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. */ vaultId: string; } interface GetFleetCredentialsFilter { /** * Name of the variable. */ name: string; regex?: boolean; values: string[]; } interface GetFleetCredentialsFleetCredentialCollection { items: outputs.FleetAppsManagement.GetFleetCredentialsFleetCredentialCollectionItem[]; } interface GetFleetCredentialsFleetCredentialCollectionItem { /** * Compartment OCID */ compartmentId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Credential specific Details. */ entitySpecifics: outputs.FleetAppsManagement.GetFleetCredentialsFleetCredentialCollectionItemEntitySpecific[]; /** * Unique Fleet identifier. */ fleetId: string; /** * A filter to return only resources whose credential identifier matches the given identifier. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Credential Details. */ passwords: outputs.FleetAppsManagement.GetFleetCredentialsFleetCredentialCollectionItemPassword[]; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Credential Details. */ users: outputs.FleetAppsManagement.GetFleetCredentialsFleetCredentialCollectionItemUser[]; } interface GetFleetCredentialsFleetCredentialCollectionItemEntitySpecific { /** * A filter to return only resources whose credentialLevel matches the given credentialLevel. */ credentialLevel: string; /** * Resource Identifier */ resourceId: string; /** * A filter to return only resources whose target matches the given target name. */ target: string; /** * List of fleet credential variables. */ variables: outputs.FleetAppsManagement.GetFleetCredentialsFleetCredentialCollectionItemEntitySpecificVariable[]; } interface GetFleetCredentialsFleetCredentialCollectionItemEntitySpecificVariable { /** * Name of the variable. */ name: string; /** * The value corresponding to the credential. */ value: string; } interface GetFleetCredentialsFleetCredentialCollectionItemPassword { /** * Credential Type. */ credentialType: string; /** * OCID for the Vault Key that will be used to encrypt/decrypt the value given. */ keyId: string; /** * The Vault Key version. */ keyVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. */ secretId: string; /** * The secret version. */ secretVersion: string; /** * The value corresponding to the credential. */ value: string; /** * OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. */ vaultId: string; } interface GetFleetCredentialsFleetCredentialCollectionItemUser { /** * Credential Type. */ credentialType: string; /** * OCID for the Vault Key that will be used to encrypt/decrypt the value given. */ keyId: string; /** * The Vault Key version. */ keyVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. */ secretId: string; /** * The secret version. */ secretVersion: string; /** * The value corresponding to the credential. */ value: string; /** * OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. */ vaultId: string; } interface GetFleetDetail { /** * Type of the Fleet. PRODUCT - A fleet of product-specific resources for a product type. ENVIRONMENT - A fleet of environment-specific resources for a product stack. GROUP - A fleet of a fleet of either environment or product fleets. GENERIC - A fleet of resources selected dynamically or manually for reporting purposes */ fleetType: string; } interface GetFleetNotificationPreference { /** * Compartment Identifier[OCID]. */ compartmentId: string; /** * Preferences to send notifications on the fleet activities. */ preferences: outputs.FleetAppsManagement.GetFleetNotificationPreferencePreference[]; /** * Topic Id where the notifications will be directed. A topic is a communication channel for sending messages on chosen events to subscriptions. */ topicId: string; } interface GetFleetNotificationPreferencePreference { /** * Enables or disables notification on job canceled. */ onJobCanceled: boolean; /** * Enables or disables notification on Job Failures. */ onJobFailure: boolean; /** * Enables or disables notification on job schedule change. */ onJobScheduleChange: boolean; /** * Enables or disables notification on job start. */ onJobStart: boolean; /** * Enables or disables notification on job success. */ onJobSuccess: boolean; /** * Enables or disables notification when fleet resource becomes non compliant. */ onResourceNonCompliance: boolean; /** * Enables or disables notification when a newer version of runbook associated with a fleet is available */ onRunbookNewerVersion: boolean; /** * Enables or disables notification on task failure. */ onTaskFailure: boolean; /** * Enables or disables notification when a task is paused. */ onTaskPause: boolean; /** * Enables or disables notification on task success. */ onTaskSuccess: boolean; /** * Enables or disables notification on Environment Fleet Topology Modification. */ onTopologyModification: boolean; /** * Enables notification on upcoming schedule. */ upcomingSchedules: outputs.FleetAppsManagement.GetFleetNotificationPreferencePreferenceUpcomingSchedule[]; } interface GetFleetNotificationPreferencePreferenceUpcomingSchedule { /** * Specify when the notification should be sent. */ notifyBefore: string; /** * Enables notification on upcoming schedule. */ onUpcomingSchedule: boolean; } interface GetFleetProductsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetProductsFleetProductCollection { /** * List of fleetProducts. */ items: outputs.FleetAppsManagement.GetFleetProductsFleetProductCollectionItem[]; } interface GetFleetProductsFleetProductCollectionItem { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Resource Information for the Target. */ resources: outputs.FleetAppsManagement.GetFleetProductsFleetProductCollectionItemResource[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Count of the targets associated with the Product. */ targetCount: number; } interface GetFleetProductsFleetProductCollectionItemResource { /** * Resource Display Name. */ resourceDisplayName: string; /** * Resource Identifier */ resourceId: string; } interface GetFleetPropertiesFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetPropertiesFleetPropertyCollection { items: outputs.FleetAppsManagement.GetFleetPropertiesFleetPropertyCollectionItem[]; } interface GetFleetPropertiesFleetPropertyCollectionItem { /** * Values of the property (must be a single value if selectionType = 'SINGLE_CHOICE'). */ allowedValues: string[]; /** * Compartment OCID */ compartmentId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Unique Fleet identifier. */ fleetId: string; /** * A filter to return only resources whose fleetProperty identifier matches the given identifier. */ id: string; /** * OCID referring to global level metadata property. */ propertyId: string; /** * Text selection of the property. */ selectionType: string; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Value of the Property. */ value: string; /** * Format of the value. */ valueType: string; } interface GetFleetProperty { /** * Compartment Identifier[OCID]. */ compartmentId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * Type of the FleetProperty. */ fleetPropertyType: string; /** * Property is required or not. */ isRequired: boolean; /** * Value of the Property. */ value: string; } interface GetFleetResource { /** * Compartment Identifier[OCID]. */ compartmentId: string; /** * Type of the FleetResource. */ fleetResourceType: string; /** * OCID of the resource. */ resourceId: string; /** * Tenancy Identifier[OCID]. */ tenancyId: string; } interface GetFleetResourceSelection { /** * Type of resource selection in a Fleet. Select resources manually or select resources based on rules. */ resourceSelectionType: string; /** * Rule Selection Criteria for DYNAMIC resource selection for a GENERIC fleet. Rules define what resources are members of this fleet. All resources that meet the criteria are added automatically. */ ruleSelectionCriterias: outputs.FleetAppsManagement.GetFleetResourceSelectionRuleSelectionCriteria[]; } interface GetFleetResourceSelectionRuleSelectionCriteria { /** * Match condition for the rule selection. Include resources that match all rules or any of the rules. Default value for `matchCondition` is ANY */ matchCondition: string; /** * Rules. */ rules: outputs.FleetAppsManagement.GetFleetResourceSelectionRuleSelectionCriteriaRule[]; } interface GetFleetResourceSelectionRuleSelectionCriteriaRule { /** * Based on what the rule is created. It can be based on a resourceProperty or a tag. If based on a tag, basis will be 'definedTagEquals' If based on a resource property, basis will be 'inventoryProperties' */ basis: string; /** * Compartment Identifier[OCID]. */ compartmentId: string; /** * If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it. Which resources are returned and their field contents depends on the value of accessLevel. Default value for `compartmentIdInSubtree` is false */ compartmentIdInSubtree: boolean; /** * Rule Conditions */ conditions: outputs.FleetAppsManagement.GetFleetResourceSelectionRuleSelectionCriteriaRuleCondition[]; /** * Match condition for the rule selection. Include resources that match all rules or any of the rules. Default value for `matchCondition` is ANY */ matchCondition: string; /** * The Compartment ID to dynamically search resources. Provide the compartment ID to which the rule is applicable. */ resourceCompartmentId: string; } interface GetFleetResourceSelectionRuleSelectionCriteriaRuleCondition { /** * Attribute Group. Provide a Tag namespace if the rule is based on a tag. Provide resource type if the rule is based on a resource property. */ attrGroup: string; /** * Attribute Key.Provide Tag key if the rule is based on a tag. Provide resource property name if the rule is based on a resource property. */ attrKey: string; /** * Attribute Value.Provide Tag value if the rule is based on a tag. Provide resource property value if the rule is based on a resource property. */ attrValue: string; } interface GetFleetResourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetResourcesFleetResourceCollection { items: outputs.FleetAppsManagement.GetFleetResourcesFleetResourceCollectionItem[]; } interface GetFleetResourcesFleetResourceCollectionItem { /** * Resource Compartment name. */ compartment: string; /** * OCID of the compartment to which the resource belongs to. */ compartmentId: string; /** * Compliance State of the Resource. */ complianceState: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Environment Type associated with the Fleet when the resource type is fleet. Will only be returned for ENVIRONMENT fleets that are part of a GROUP Fleet. */ environmentType: string; /** * Unique Fleet identifier. */ fleetId: string; /** * A filter to return only resources whose identifier matches the given identifier. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * The compliance percentage. */ percentCompliant: number; /** * Product associated with the resource when the resource type is fleet. Will only be returned for PRODUCT fleets that are part of a GROUP Fleet. */ product: string; /** * Count of products within the resource. */ productCount: number; /** * The OCID of the resource. */ resourceId: string; /** * Associated region */ resourceRegion: string; /** * Type of the Resource. */ resourceType: string; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Count of targets within the resource. */ targetCount: number; /** * OCID of the tenancy to which the resource belongs to. */ tenancyId: string; /** * Resource Tenancy Name. */ tenancyName: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetFleetTargetsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetTargetsFleetTargetCollection { /** * List of fleetTargets. */ items: outputs.FleetAppsManagement.GetFleetTargetsFleetTargetCollectionItem[]; } interface GetFleetTargetsFleetTargetCollectionItem { /** * compartment OCID */ compartmentId: string; /** * The last known compliance state of the target. */ complianceState: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The OCID of the resource. */ id: string; /** * A boolean flag that represents whether the last discovery attempt was successful. */ isLastDiscoveryAttemptSuccessful: boolean; /** * Name of the parent target. */ parentTargetName: string; /** * Product Name. */ product: string; /** * Resource Information for the Target. */ resources: outputs.FleetAppsManagement.GetFleetTargetsFleetTargetCollectionItemResource[]; /** * A filter to return fleets whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when last discovery was attempted. */ timeOfLastDiscoveryAttempt: string; /** * The time when the last successful discovery was made. */ timeOfLastSuccessfulDiscovery: string; /** * Current version of target. */ version: string; } interface GetFleetTargetsFleetTargetCollectionItemResource { /** * Resource Display Name. */ resourceDisplayName: string; /** * Resource Identifier */ resourceId: string; } interface GetFleetsFilter { /** * Name of the variable. */ name: string; regex?: boolean; values: string[]; } interface GetFleetsFleetCollection { items: outputs.FleetAppsManagement.GetFleetsFleetCollectionItem[]; } interface GetFleetsFleetCollectionItem { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Credentials associated with the Fleet. */ credentials: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemCredential[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. */ description: string; /** * Fleet Type */ details: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemDetail[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * A filter to return resources that match the Environment Type given. */ environmentType: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single fleet by id. Either compartmentId or id must be provided. */ id: string; /** * A value that represents if auto-confirming of the targets can be enabled. This will allow targets to be auto-confirmed in the fleet without manual intervention. */ isTargetAutoConfirm: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Notification Preferences associated with the Fleet. */ notificationPreferences: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemNotificationPreference[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the fleet that would be the parent for this fleet. */ parentFleetId: string; /** * Products associated with the Fleet. PlatformConfiguration Ids corresponding to the Products. */ products: string[]; /** * Properties associated with the Fleet. */ properties: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemProperty[]; /** * Associated region */ resourceRegion: string; /** * Resource Selection Type */ resourceSelections: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemResourceSelection[]; /** * Resources associated with the Fleet if resourceSelectionType is MANUAL. */ resources: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemResource[]; /** * A filter to return fleets whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetFleetsFleetCollectionItemCredential { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Credential specific Details. */ entitySpecifics: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemCredentialEntitySpecific[]; /** * Credential Details. */ passwords: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemCredentialPassword[]; /** * Credential Details. */ users: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemCredentialUser[]; } interface GetFleetsFleetCollectionItemCredentialEntitySpecific { /** * At what level the credential is provided? */ credentialLevel: string; /** * OCID of the resource. */ resourceId: string; /** * Target name for which the credential is provided. */ target: string; /** * List of fleet credential variables. */ variables: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemCredentialEntitySpecificVariable[]; } interface GetFleetsFleetCollectionItemCredentialEntitySpecificVariable { /** * Name of the variable. */ name: string; /** * Value of the Property. */ value: string; } interface GetFleetsFleetCollectionItemCredentialPassword { /** * Credential Type. */ credentialType: string; /** * OCID for the Vault Key that will be used to encrypt/decrypt the value given. */ keyId: string; /** * The Vault Key version. */ keyVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. */ secretId: string; /** * The secret version. */ secretVersion: string; /** * Value of the Property. */ value: string; /** * OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. */ vaultId: string; } interface GetFleetsFleetCollectionItemCredentialUser { /** * Credential Type. */ credentialType: string; /** * OCID for the Vault Key that will be used to encrypt/decrypt the value given. */ keyId: string; /** * The Vault Key version. */ keyVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret. */ secretId: string; /** * The secret version. */ secretVersion: string; /** * Value of the Property. */ value: string; /** * OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given. */ vaultId: string; } interface GetFleetsFleetCollectionItemDetail { /** * A filter to return fleets whose fleetType matches the given fleetType. */ fleetType: string; } interface GetFleetsFleetCollectionItemNotificationPreference { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Preferences to send notifications on the fleet activities. */ preferences: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemNotificationPreferencePreference[]; /** * Topic Id where the notifications will be directed. A topic is a communication channel for sending messages on chosen events to subscriptions. */ topicId: string; } interface GetFleetsFleetCollectionItemNotificationPreferencePreference { /** * Enables or disables notification on job canceled. */ onJobCanceled: boolean; /** * Enables or disables notification on Job Failures. */ onJobFailure: boolean; /** * Enables or disables notification on job schedule change. */ onJobScheduleChange: boolean; /** * Enables or disables notification on job start. */ onJobStart: boolean; /** * Enables or disables notification on job success. */ onJobSuccess: boolean; /** * Enables or disables notification when fleet resource becomes non compliant. */ onResourceNonCompliance: boolean; /** * Enables or disables notification when a newer version of runbook associated with a fleet is available */ onRunbookNewerVersion: boolean; /** * Enables or disables notification on task failure. */ onTaskFailure: boolean; /** * Enables or disables notification when a task is paused. */ onTaskPause: boolean; /** * Enables or disables notification on task success. */ onTaskSuccess: boolean; /** * Enables or disables notification on Environment Fleet Topology Modification. */ onTopologyModification: boolean; /** * Enables notification on upcoming schedule. */ upcomingSchedules: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemNotificationPreferencePreferenceUpcomingSchedule[]; } interface GetFleetsFleetCollectionItemNotificationPreferencePreferenceUpcomingSchedule { /** * Specify when the notification should be sent. */ notifyBefore: string; /** * Enables notification on upcoming schedule. */ onUpcomingSchedule: boolean; } interface GetFleetsFleetCollectionItemProperty { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Type of the FleetProperty. */ fleetPropertyType: string; /** * Property is required or not. */ isRequired: boolean; /** * Value of the Property. */ value: string; } interface GetFleetsFleetCollectionItemResource { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Type of the FleetResource. */ fleetResourceType: string; /** * OCID of the resource. */ resourceId: string; /** * Tenancy Identifier[OCID]. */ tenancyId: string; } interface GetFleetsFleetCollectionItemResourceSelection { /** * Type of resource selection in a Fleet. Select resources manually or select resources based on rules. */ resourceSelectionType: string; /** * Rule Selection Criteria for DYNAMIC resource selection for a GENERIC fleet. Rules define what resources are members of this fleet. All resources that meet the criteria are added automatically. */ ruleSelectionCriterias: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemResourceSelectionRuleSelectionCriteria[]; } interface GetFleetsFleetCollectionItemResourceSelectionRuleSelectionCriteria { /** * Match condition for the rule selection. Include resources that match all rules or any of the rules. Default value for `matchCondition` is ANY */ matchCondition: string; /** * Rules. */ rules: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemResourceSelectionRuleSelectionCriteriaRule[]; } interface GetFleetsFleetCollectionItemResourceSelectionRuleSelectionCriteriaRule { /** * Based on what the rule is created. It can be based on a resourceProperty or a tag. If based on a tag, basis will be 'definedTagEquals' If based on a resource property, basis will be 'inventoryProperties' */ basis: string; /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it. Which resources are returned and their field contents depends on the value of accessLevel. Default value for `compartmentIdInSubtree` is false */ compartmentIdInSubtree: boolean; /** * Rule Conditions */ conditions: outputs.FleetAppsManagement.GetFleetsFleetCollectionItemResourceSelectionRuleSelectionCriteriaRuleCondition[]; /** * Match condition for the rule selection. Include resources that match all rules or any of the rules. Default value for `matchCondition` is ANY */ matchCondition: string; /** * The Compartment ID to dynamically search resources. Provide the compartment ID to which the rule is applicable. */ resourceCompartmentId: string; } interface GetFleetsFleetCollectionItemResourceSelectionRuleSelectionCriteriaRuleCondition { /** * Attribute Group. Provide a Tag namespace if the rule is based on a tag. Provide resource type if the rule is based on a resource property. */ attrGroup: string; /** * Attribute Key.Provide Tag key if the rule is based on a tag. Provide resource property name if the rule is based on a resource property. */ attrKey: string; /** * Attribute Value.Provide Tag value if the rule is based on a tag. Provide resource property value if the rule is based on a resource property. */ attrValue: string; } interface GetInstalledPatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetInstalledPatchesInstalledPatchCollection { /** * List of installed patches */ items: outputs.FleetAppsManagement.GetInstalledPatchesInstalledPatchCollectionItem[]; } interface GetInstalledPatchesInstalledPatchCollectionItem { /** * Description of the patch */ patchDescription: string; /** * The OCID of the patch. */ patchId: string; /** * Patch level with values like LATEST, LATEST_MINUS_ONE, LATEST_MINUS_TWO etc.,. */ patchLevel: string; /** * Name of the patch. */ patchName: string; /** * Patch type. */ patchType: string; /** * Patch severity with values like CRITICAL, HIGH, MEDIUM and LOW. */ severity: string; /** * Date on which the patch was applied to the target. */ timeApplied: string; /** * Date on which the patch was released. */ timeReleased: string; } interface GetInventoryRecordsFilter { /** * Name of the inventory target property. */ name: string; regex?: boolean; values: string[]; } interface GetInventoryRecordsInventoryRecordCollection { /** * List of inventory targets */ items: outputs.FleetAppsManagement.GetInventoryRecordsInventoryRecordCollectionItem[]; } interface GetInventoryRecordsInventoryRecordCollectionItem { /** * Architecture of the resource associated with the target */ architecture: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * List of target components */ components: outputs.FleetAppsManagement.GetInventoryRecordsInventoryRecordCollectionItemComponent[]; /** * List of details on the patches currently installed on the target */ installedPatches: outputs.FleetAppsManagement.GetInventoryRecordsInventoryRecordCollectionItemInstalledPatch[]; /** * OS installed on the resource associated with the target */ osType: string; /** * Name of the parent target. */ parentTargetName: string; /** * List of target properties */ properties: outputs.FleetAppsManagement.GetInventoryRecordsInventoryRecordCollectionItemProperty[]; /** * The current state of the Inventory target. */ state: string; /** * The id of the Inventory target. */ targetId: string; /** * Name of the target */ targetName: string; /** * OCID of the product installed at the target path */ targetProductId: string; /** * Name of the product installed at the target path */ targetProductName: string; /** * OCID of the resource associated with the target */ targetResourceId: string; /** * Name of the resource associated with the target */ targetResourceName: string; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Version of the product on the target */ version: string; } interface GetInventoryRecordsInventoryRecordCollectionItemComponent { /** * Name of the target component */ componentName: string; /** * Path of the component */ componentPath: string; /** * Version of the target component */ componentVersion: string; /** * List of target properties */ properties: outputs.FleetAppsManagement.GetInventoryRecordsInventoryRecordCollectionItemComponentProperty[]; } interface GetInventoryRecordsInventoryRecordCollectionItemComponentProperty { /** * Name of the inventory target property. */ name: string; /** * Value of the inventory target property. */ value: string; } interface GetInventoryRecordsInventoryRecordCollectionItemInstalledPatch { /** * Description for the installed patch */ patchDescription: string; /** * OCID of the installed patch */ patchId: string; /** * Patch Level. */ patchLevel: string; /** * Name of the installed patch */ patchName: string; /** * Type of patch applied */ patchType: string; /** * Date on which the patch was applied to the target */ timeApplied: string; /** * The date on which patch was released. */ timeReleased: string; } interface GetInventoryRecordsInventoryRecordCollectionItemProperty { /** * Name of the inventory target property. */ name: string; /** * Value of the inventory target property. */ value: string; } interface GetInventoryResourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetInventoryResourcesInventoryResourceCollection { /** * List of InventoryResources. */ items: outputs.FleetAppsManagement.GetInventoryResourcesInventoryResourceCollectionItem[]; } interface GetInventoryResourcesInventoryResourceCollectionItem { /** * Availability Domain of the resource. */ availabilityDomain: string; /** * A filter to return only resources whose base Compartment ID(TenancyId) matches the given base Compartment ID. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the resource. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter to return only resources whose resource Compartment ID matches the given resource Compartment ID. */ resourceCompartmentId: string; /** * Resource Region */ resourceRegion: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Type of the Resource. */ type: string; } interface GetMaintenanceWindowsFilter { name: string; regex?: boolean; values: string[]; } interface GetMaintenanceWindowsMaintenanceWindowCollection { items: outputs.FleetAppsManagement.GetMaintenanceWindowsMaintenanceWindowCollectionItem[]; } interface GetMaintenanceWindowsMaintenanceWindowCollectionItem { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Duration of the maintenance window. Specify how long the maintenance window remains open. */ duration: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single maintenance window by id. Either compartmentId or id must be provided. */ id: string; /** * Does the maintenenace window cause outage? An outage indicates whether a maintenance window can consider operations that require downtime. It means a period when the application is not accessible. */ isOutage: boolean; /** * Is this a recurring maintenance window? */ isRecurring: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Recurrence rule specification if maintenance window recurring. Specify the frequency of running the maintenance window. */ recurrences: string; /** * Associated region */ resourceRegion: string; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Specify the date and time of the day that the maintenance window starts. */ timeScheduleStart: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetManagedEntityCountsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedEntityCountsManagedEntityAggregationCollection { /** * List of ManagedEntityAggregation objects. */ items: outputs.FleetAppsManagement.GetManagedEntityCountsManagedEntityAggregationCollectionItem[]; } interface GetManagedEntityCountsManagedEntityAggregationCollectionItem { /** * Aggregated summary information for ComplianceRecord */ dimensions: outputs.FleetAppsManagement.GetManagedEntityCountsManagedEntityAggregationCollectionItemDimension[]; /** * Count of managed entities in a compartment. */ managedEntityCountCount: number; } interface GetManagedEntityCountsManagedEntityAggregationCollectionItemDimension { /** * Level at which the compliance is calculated. */ entity: string; } interface GetOnboardingPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetOnboardingPoliciesOnboardingPolicyCollection { /** * List of Fleet Application Management Onboard policies. */ items: outputs.FleetAppsManagement.GetOnboardingPoliciesOnboardingPolicyCollectionItem[]; } interface GetOnboardingPoliciesOnboardingPolicyCollectionItem { /** * The unique id of the resource. */ id: string; /** * Policy statements. */ statements: string[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetOnboardingsFilter { name: string; regex?: boolean; values: string[]; } interface GetOnboardingsOnboardingCollection { /** * List of Fleet Application Management Onboardings. */ items: outputs.FleetAppsManagement.GetOnboardingsOnboardingCollectionItem[]; } interface GetOnboardingsOnboardingCollectionItem { /** * Summary of the Fleet Application Management Onboard Policy. */ appliedPolicies: outputs.FleetAppsManagement.GetOnboardingsOnboardingCollectionItemAppliedPolicy[]; /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Provide discovery frequency. */ discoveryFrequency: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided. */ id: string; /** * A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag. */ isCostTrackingTagEnabled: boolean; /** * A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag. */ isFamsTagEnabled: boolean; /** * Associated region */ resourceRegion: string; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The version of Fleet Application Management that the tenant is onboarded to. */ version: string; } interface GetOnboardingsOnboardingCollectionItemAppliedPolicy { /** * Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided. */ id: string; /** * Policy statements. */ statements: string[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetPatchArtifactDetail { /** * Patch artifact metadata Details which is common for all platforms. */ artifact: outputs.FleetAppsManagement.GetPatchArtifactDetailArtifact[]; /** * Artifacts. */ artifacts: outputs.FleetAppsManagement.GetPatchArtifactDetailArtifact[]; /** * Artifact category details. */ category: string; } interface GetPatchArtifactDetailArtifact { /** * System architecture. */ architecture: string; /** * Content Source details. */ contents: outputs.FleetAppsManagement.GetPatchArtifactDetailArtifactContent[]; /** * The OS type the patch is applicable for. */ osType: string; } interface GetPatchArtifactDetailArtifactContent { /** * Bucket Name. */ bucket: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface GetPatchDependentPatch { /** * The OCID of the resource. */ id: string; } interface GetPatchPatchType { /** * PlatformConfiguration Id corresponding to the Product */ platformConfigurationId: string; } interface GetPatchProduct { /** * PlatformConfiguration Id corresponding to the Product */ platformConfigurationId: string; /** * product version. */ version: string; } interface GetPatchesFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetPatchesPatchCollection { items: outputs.FleetAppsManagement.GetPatchesPatchCollectionItem[]; } interface GetPatchesPatchCollectionItem { /** * Patch artifact description and content details. */ artifactDetails: outputs.FleetAppsManagement.GetPatchesPatchCollectionItemArtifactDetail[]; /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Dependent Patches for this patch. */ dependentPatches: outputs.FleetAppsManagement.GetPatchesPatchCollectionItemDependentPatch[]; /** * A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. */ description: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single Patch by id. Either compartmentId or id must be provided. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter to return only resources that match the entire name given. */ name: string; /** * Patch Type */ patchTypes: outputs.FleetAppsManagement.GetPatchesPatchCollectionItemPatchType[]; /** * Product */ products: outputs.FleetAppsManagement.GetPatchesPatchCollectionItemProduct[]; /** * Associated region */ resourceRegion: string; /** * Patch Severity. */ severity: string; /** * The current state of the Patch. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Date when the patch was released. */ timeReleased: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * DefinedBy type. */ type: string; } interface GetPatchesPatchCollectionItemArtifactDetail { /** * Patch artifact metadata Details which is common for all platforms. */ artifact: outputs.FleetAppsManagement.GetPatchesPatchCollectionItemArtifactDetailArtifact[]; /** * Artifacts. */ artifacts: outputs.FleetAppsManagement.GetPatchesPatchCollectionItemArtifactDetailArtifact[]; /** * Artifact category details. */ category: string; } interface GetPatchesPatchCollectionItemArtifactDetailArtifact { /** * System architecture. */ architecture: string; /** * Content Source details. */ contents: outputs.FleetAppsManagement.GetPatchesPatchCollectionItemArtifactDetailArtifactContent[]; /** * The OS type the patch is applicable for. */ osType: string; } interface GetPatchesPatchCollectionItemArtifactDetailArtifactContent { /** * Bucket Name. */ bucket: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface GetPatchesPatchCollectionItemDependentPatch { /** * Unique identifier or OCID for listing a single Patch by id. Either compartmentId or id must be provided. */ id: string; } interface GetPatchesPatchCollectionItemPatchType { /** * PlatformConfiguration Id corresponding to the Product */ platformConfigurationId: string; } interface GetPatchesPatchCollectionItemProduct { /** * PlatformConfiguration Id corresponding to the Product */ platformConfigurationId: string; /** * Product version. */ version: string; } interface GetPlatformConfigurationConfigCategoryDetail { /** * Products compatible with this Product. Provide products from the list of other products you have created that are compatible with the present one. This property is not applicable if isSoftlink is set to true. */ compatibleProducts: outputs.FleetAppsManagement.GetPlatformConfigurationConfigCategoryDetailCompatibleProduct[]; /** * Various components of the Product. For example:The administration server or node manager can be the components of the Oracle WebLogic Application server. Forms server or concurrent manager can be the components of the Oracle E-Business Suite. */ components: string[]; /** * Category of configuration */ configCategory: string; /** * OCID for the Credential name to be associated with the Product Stack. These are useful for target discovery or lifecycle management activities, for example, Oracle WebLogic admin credentials for Oracle WebLogic Application server. */ credentials: outputs.FleetAppsManagement.GetPlatformConfigurationConfigCategoryDetailCredential[]; /** * The OCID of the resource. */ instanceId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ instanceName: string; /** * If set true ,compliance policies will be created for softlink product. This property is applicable only if isSoftlink is set to true */ isCompliancePolicyRequiredForSoftlink: boolean; /** * Specify if the product is softlink product or not */ isSoftlink: boolean; /** * The OCID of the product that would be the target for the softlink. This property is applicable only if isSoftlink is set to true */ linkProductId: string; /** * Patch Types associated with this Product Stack which will be considered as Product. */ patchTypes: outputs.FleetAppsManagement.GetPlatformConfigurationConfigCategoryDetailPatchType[]; /** * Products that belong to the stack. For example, Oracle WebLogic and Java for the Oracle Fusion Middleware product stack. */ products: outputs.FleetAppsManagement.GetPlatformConfigurationConfigCategoryDetailProduct[]; /** * ProductStack Config Category Details. */ subCategoryDetails: outputs.FleetAppsManagement.GetPlatformConfigurationConfigCategoryDetailSubCategoryDetail[]; /** * Versions associated with the PRODUCT. Mandatory if product is not softlink product. */ versions: string[]; } interface GetPlatformConfigurationConfigCategoryDetailCompatibleProduct { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * The OCID of the resource. */ id: string; } interface GetPlatformConfigurationConfigCategoryDetailCredential { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * The OCID of the resource. */ id: string; } interface GetPlatformConfigurationConfigCategoryDetailPatchType { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * The OCID of the resource. */ id: string; } interface GetPlatformConfigurationConfigCategoryDetailProduct { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * The OCID of the resource. */ id: string; } interface GetPlatformConfigurationConfigCategoryDetailSubCategoryDetail { /** * Various components of the Product. For example:The administration server or node manager can be the components of the Oracle WebLogic Application server. Forms server or concurrent manager can be the components of the Oracle E-Business Suite. */ components: string[]; /** * OCID for the Credential name to be associated with the Product Stack. These are useful for target discovery or lifecycle management activities, for example, Oracle WebLogic admin credentials for Oracle WebLogic Application server. */ credentials: outputs.FleetAppsManagement.GetPlatformConfigurationConfigCategoryDetailSubCategoryDetailCredential[]; /** * Patch Types associated with this Product Stack which will be considered as Product. */ patchTypes: outputs.FleetAppsManagement.GetPlatformConfigurationConfigCategoryDetailSubCategoryDetailPatchType[]; /** * SubCategory of Product Stack. */ subCategory: string; /** * Versions associated with the PRODUCT. Mandatory if product is not softlink product. */ versions: string[]; } interface GetPlatformConfigurationConfigCategoryDetailSubCategoryDetailCredential { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * The OCID of the resource. */ id: string; } interface GetPlatformConfigurationConfigCategoryDetailSubCategoryDetailPatchType { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * The OCID of the resource. */ id: string; } interface GetPlatformConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetPlatformConfigurationsPlatformConfigurationCollection { items: outputs.FleetAppsManagement.GetPlatformConfigurationsPlatformConfigurationCollectionItem[]; } interface GetPlatformConfigurationsPlatformConfigurationCollectionItem { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Config Category Details. */ configCategoryDetails: outputs.FleetAppsManagement.GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetail[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Associated region */ resourceRegion: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return Platform Configurations whose type matches the given type. */ type: string; } interface GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetail { /** * Products compatible with this Product. Provide products from the list of other products you have created that are compatible with the present one. This property is not applicable if isSoftlink is set to true. */ compatibleProducts: outputs.FleetAppsManagement.GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailCompatibleProduct[]; /** * Various components of the Product. For example:The administration server or node manager can be the components of the Oracle WebLogic Application server. Forms server or concurrent manager can be the components of the Oracle E-Business Suite. */ components: string[]; /** * Config Category */ configCategory: string; /** * OCID for the Credential name to be associated with the Product Stack. These are useful for target discovery or lifecycle management activities, for example, Oracle WebLogic admin credentials for Oracle WebLogic Application server. */ credentials: outputs.FleetAppsManagement.GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailCredential[]; /** * The OCID of the resource. */ instanceId: string; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ instanceName: string; /** * If set true ,compliance policies will be created for softlink product. This property is applicable only if isSoftlink is set to true */ isCompliancePolicyRequiredForSoftlink: boolean; /** * Specify if the product is softlink product or not */ isSoftlink: boolean; /** * The OCID of the product that would be the target for the softlink. This property is applicable only if isSoftlink is set to true */ linkProductId: string; /** * Patch Types associated with this Product Stack which will be considered as Product. */ patchTypes: outputs.FleetAppsManagement.GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailPatchType[]; /** * Products that belong to the stack. For example, Oracle WebLogic and Java for the Oracle Fusion Middleware product stack. */ products: outputs.FleetAppsManagement.GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailProduct[]; /** * ProductStack Config Category Details. */ subCategoryDetails: outputs.FleetAppsManagement.GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailSubCategoryDetail[]; /** * Versions associated with the PRODUCT. Mandatory if product is not softlink product. */ versions: string[]; } interface GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailCompatibleProduct { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided. */ id: string; } interface GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailCredential { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided. */ id: string; } interface GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailPatchType { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided. */ id: string; } interface GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailProduct { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided. */ id: string; } interface GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailSubCategoryDetail { /** * Various components of the Product. For example:The administration server or node manager can be the components of the Oracle WebLogic Application server. Forms server or concurrent manager can be the components of the Oracle E-Business Suite. */ components: string[]; /** * OCID for the Credential name to be associated with the Product Stack. These are useful for target discovery or lifecycle management activities, for example, Oracle WebLogic admin credentials for Oracle WebLogic Application server. */ credentials: outputs.FleetAppsManagement.GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailSubCategoryDetailCredential[]; /** * Patch Types associated with this Product Stack which will be considered as Product. */ patchTypes: outputs.FleetAppsManagement.GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailSubCategoryDetailPatchType[]; /** * SubCategory of Product Stack. */ subCategory: string; /** * Versions associated with the PRODUCT. Mandatory if product is not softlink product. */ versions: string[]; } interface GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailSubCategoryDetailCredential { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided. */ id: string; } interface GetPlatformConfigurationsPlatformConfigurationCollectionItemConfigCategoryDetailSubCategoryDetailPatchType { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided. */ id: string; } interface GetPropertiesFilter { name: string; regex?: boolean; /** * Values of the property (must be a single value if selection = 'SINGLE_CHOICE'). */ values: string[]; } interface GetPropertiesPropertyCollection { items: outputs.FleetAppsManagement.GetPropertiesPropertyCollectionItem[]; } interface GetPropertiesPropertyCollectionItem { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single Property by id. Either compartmentId or id must be provided. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Associated region */ resourceRegion: string; /** * A filter to return only resources their scope matches the given scope. */ scope: string; /** * Text selection of the property. */ selection: string; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return properties whose type matches the given type. */ type: string; /** * Format of the value. */ valueType: string; /** * Values of the property (must be a single value if selection = 'SINGLE_CHOICE'). */ values: string[]; } interface GetProvisionDeployedResource { /** * The mode of the resource. Example: "managed" */ mode: string; /** * Collection of InstanceSummary */ resourceInstanceLists: outputs.FleetAppsManagement.GetProvisionDeployedResourceResourceInstanceList[]; /** * The name of the resource */ resourceName: string; /** * The name of the Provider */ resourceProvider: string; /** * The provider resource type. Must be supported by the Oracle Cloud Infrastructure provider. Example: oci.Core.Instance */ resourceType: string; } interface GetProvisionDeployedResourceResourceInstanceList { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which instance is deployed. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the FamProvision. */ id: string; /** * The current state of the FamProvision. */ state: string; } interface GetProvisionTfOutput { /** * The indicator if the data for this parameter is sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.) */ isSensitive: boolean; /** * The output description */ outputDescription: string; /** * The output name */ outputName: string; /** * The output type */ outputType: string; /** * The output value */ outputValue: string; } interface GetProvisionsFilter { name: string; regex?: boolean; values: string[]; } interface GetProvisionsProvisionCollection { items: outputs.FleetAppsManagement.GetProvisionsProvisionCollectionItem[]; } interface GetProvisionsProvisionCollectionItem { /** * (Updatable) The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * A display Name of the Catalog Item in the Catalog. */ configCatalogItemDisplayName: string; /** * A [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item to a file with key/value pairs to set up variables for createStack API. */ configCatalogItemId: string; /** * A listing ID of the Catalog Item in the Catalog. */ configCatalogItemListingId: string; /** * A listing version of the Catalog Item in the Catalog. */ configCatalogItemListingVersion: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The deployed resources and their summary */ deployedResources: outputs.FleetAppsManagement.GetProvisionsProvisionCollectionItemDeployedResource[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * unique Fleet identifier */ fleetId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single provision by id. Either compartmentId or id must be provided. */ id: string; /** * A message that describes the current state of the FamProvision in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * A display Name of the Catalog Item in the Catalog. */ packageCatalogItemDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item. */ packageCatalogItemId: string; /** * A listing ID of the Catalog Item in the Catalog. */ packageCatalogItemListingId: string; /** * A listing version of the Catalog Item in the Catalog. */ packageCatalogItemListingVersion: string; /** * A description of the provision. */ provisionDescription: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the RMS APPLY Job. */ rmsApplyJobId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the RMS Stack. */ stackId: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Outputs from the pulumi up job */ tfOutputs: outputs.FleetAppsManagement.GetProvisionsProvisionCollectionItemTfOutput[]; /** * An optional variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. */ tfVariableCompartmentId: string; /** * An optional variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. */ tfVariableCurrentUserId: string; /** * A mandatory variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. */ tfVariableRegionId: string; /** * A mandatory variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. */ tfVariableTenancyId: string; /** * The date and time the FamProvision was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the FamProvision was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetProvisionsProvisionCollectionItemDeployedResource { /** * The mode of the resource. Example: "managed" */ mode: string; /** * Collection of InstanceSummary */ resourceInstanceLists: outputs.FleetAppsManagement.GetProvisionsProvisionCollectionItemDeployedResourceResourceInstanceList[]; /** * The name of the resource */ resourceName: string; /** * The name of the Provider */ resourceProvider: string; /** * The provider resource type. Must be supported by the Oracle Cloud Infrastructure provider. Example: oci.Core.Instance */ resourceType: string; } interface GetProvisionsProvisionCollectionItemDeployedResourceResourceInstanceList { /** * (Updatable) The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Unique identifier or OCID for listing a single provision by id. Either compartmentId or id must be provided. */ id: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; } interface GetProvisionsProvisionCollectionItemTfOutput { /** * The indicator if the data for this parameter is sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.) */ isSensitive: boolean; /** * The output description */ outputDescription: string; /** * The output name */ outputName: string; /** * The output type */ outputType: string; /** * The output value */ outputValue: string; } interface GetRecommendedPatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetRecommendedPatchesRecommendedPatchCollection { /** * List of recommended patches */ items: outputs.FleetAppsManagement.GetRecommendedPatchesRecommendedPatchCollectionItem[]; } interface GetRecommendedPatchesRecommendedPatchCollectionItem { /** * Description of the patch */ patchDescription: string; /** * Patch identifier. */ patchId: string; /** * Patch level with values like LATEST, LATEST_MINUS_ONE, LATEST_MINUS_TWO etc.,. */ patchLevel: string; /** * Name of the patch. */ patchName: string; /** * Patch type. */ patchType: string; /** * Patch severity with values like CRITICAL, HIGH, MEDIUM and LOW. */ severity: string; /** * Date on which the patch was released. */ timeReleased: string; } interface GetReportMetadataFilter { /** * Name of Report. */ name: string; regex?: boolean; values: string[]; } interface GetReportMetadataReportMetadataCollection { /** * List of ReportMetadata. */ items: outputs.FleetAppsManagement.GetReportMetadataReportMetadataCollectionItem[]; } interface GetReportMetadataReportMetadataCollectionItem { /** * Column Metadata. */ columnMetadatas: outputs.FleetAppsManagement.GetReportMetadataReportMetadataCollectionItemColumnMetadata[]; /** * default order clause for reports. */ defaultOrderClauses: outputs.FleetAppsManagement.GetReportMetadataReportMetadataCollectionItemDefaultOrderClause[]; /** * Filter description. */ description: string; /** * metricMetadata. */ filters: outputs.FleetAppsManagement.GetReportMetadataReportMetadataCollectionItemFilter[]; /** * Metric Name. */ metric: string; /** * Name of Report. */ name: string; } interface GetReportMetadataReportMetadataCollectionItemColumnMetadata { /** * Filter description. */ description: string; /** * Name of Report. */ name: string; /** * Column value type. */ type: string; } interface GetReportMetadataReportMetadataCollectionItemDefaultOrderClause { /** * Column to sort by. */ sortBy: string; /** * Sort direction either ASC or DESC. */ sortOrder: string; } interface GetReportMetadataReportMetadataCollectionItemFilter { /** * Filter description. */ description: string; /** * Name of Report. */ name: string; /** * Filter value source. */ valueSource: string; } interface GetRunbookExportStatusesFilter { name: string; regex?: boolean; values: string[]; } interface GetRunbookExportStatusesRunbookExportStatusCollection { /** * List of Runbook export status. */ items: outputs.FleetAppsManagement.GetRunbookExportStatusesRunbookExportStatusCollectionItem[]; } interface GetRunbookExportStatusesRunbookExportStatusCollectionItem { /** * The OCID of the runbook. */ runbookId: string; /** * Runbook name. */ runbookName: string; /** * Runbook version. */ runbookVersion: string; /** * Runbook export status. */ status: string; /** * Tracking/Export identifier. */ trackingId: string; } interface GetRunbookImportStatusesFilter { name: string; regex?: boolean; values: string[]; } interface GetRunbookImportStatusesRunbookImportStatusCollection { /** * List of Runbook import status. */ items: outputs.FleetAppsManagement.GetRunbookImportStatusesRunbookImportStatusCollectionItem[]; } interface GetRunbookImportStatusesRunbookImportStatusCollectionItem { /** * The OCID of the runbook. */ runbookId: string; /** * Runbook name. */ runbookName: string; /** * Runbook version. */ runbookVersion: string; /** * Status. */ status: string; /** * Tracking/Import identifier. */ trackingId: string; } interface GetRunbookRunbookVersion { /** * Execution Workflow details. */ executionWorkflowDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionExecutionWorkflowDetail[]; /** * The groups of the runbook. */ groups: outputs.FleetAppsManagement.GetRunbookRunbookVersionGroup[]; /** * Is this version the latest? */ isLatest: boolean; /** * Rollback Workflow details. */ rollbackWorkflowDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionRollbackWorkflowDetail[]; /** * A set of tasks to execute in the runbook. */ tasks: outputs.FleetAppsManagement.GetRunbookRunbookVersionTask[]; /** * The version of the runbook. */ version: string; } interface GetRunbookRunbookVersionExecutionWorkflowDetail { /** * Rollback Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.GetRunbookRunbookVersionExecutionWorkflowDetailWorkflow[]; } interface GetRunbookRunbookVersionExecutionWorkflowDetailWorkflow { /** * Name of the group. */ groupName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: outputs.FleetAppsManagement.GetRunbookRunbookVersionExecutionWorkflowDetailWorkflowStep[]; /** * The type of the runbook. */ type: string; } interface GetRunbookRunbookVersionExecutionWorkflowDetailWorkflowStep { /** * Name of the group. */ groupName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * The type of the runbook. */ type: string; } interface GetRunbookRunbookVersionGroup { /** * The name of the task */ name: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.GetRunbookRunbookVersionGroupProperty[]; /** * The type of the runbook. */ type: string; } interface GetRunbookRunbookVersionGroupProperty { /** * The action to be taken in case of a failure. */ actionOnFailure: string; /** * Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.GetRunbookRunbookVersionGroupPropertyNotificationPreference[]; /** * Pause Details */ pauseDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionGroupPropertyPauseDetail[]; /** * Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * The runon conditions */ runOns: outputs.FleetAppsManagement.GetRunbookRunbookVersionGroupPropertyRunOn[]; } interface GetRunbookRunbookVersionGroupPropertyNotificationPreference { /** * Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface GetRunbookRunbookVersionGroupPropertyPauseDetail { /** * Time in minutes to apply Pause. */ durationInMinutes: number; /** * Run on based On. */ kind: string; } interface GetRunbookRunbookVersionGroupPropertyRunOn { /** * Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * OCID of the self hosted instance. */ host: string; /** * Run on based On. */ kind: string; /** * Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail[]; } interface GetRunbookRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail { /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail[]; /** * Resource Ocid. */ resourceId: string; /** * Resource Type. */ resourceType: string; } interface GetRunbookRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbookRunbookVersionRollbackWorkflowDetail { /** * The scope of the task. */ scope: string; /** * Rollback Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.GetRunbookRunbookVersionRollbackWorkflowDetailWorkflow[]; } interface GetRunbookRunbookVersionRollbackWorkflowDetailWorkflow { /** * Name of the group. */ groupName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: outputs.FleetAppsManagement.GetRunbookRunbookVersionRollbackWorkflowDetailWorkflowStep[]; /** * The type of the runbook. */ type: string; } interface GetRunbookRunbookVersionRollbackWorkflowDetailWorkflowStep { /** * Name of the group. */ groupName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * The type of the runbook. */ type: string; } interface GetRunbookRunbookVersionTask { /** * Mapping output variables of previous tasks to the input variables of the current task. */ outputVariableMappings: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskOutputVariableMapping[]; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * The properties of the component. */ stepProperties: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskStepProperty[]; /** * The details of the task. */ taskRecordDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskTaskRecordDetail[]; } interface GetRunbookRunbookVersionTaskOutputVariableMapping { /** * The name of the task */ name: string; /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskOutputVariableMappingOutputVariableDetail[]; } interface GetRunbookRunbookVersionTaskOutputVariableMappingOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbookRunbookVersionTaskStepProperty { /** * The action to be taken in case of a failure. */ actionOnFailure: string; /** * Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskStepPropertyNotificationPreference[]; /** * Pause Details */ pauseDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskStepPropertyPauseDetail[]; /** * Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * The runon conditions */ runOns: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskStepPropertyRunOn[]; } interface GetRunbookRunbookVersionTaskStepPropertyNotificationPreference { /** * Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface GetRunbookRunbookVersionTaskStepPropertyPauseDetail { /** * Time in minutes to apply Pause. */ durationInMinutes: number; /** * Run on based On. */ kind: string; } interface GetRunbookRunbookVersionTaskStepPropertyRunOn { /** * Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * OCID of the self hosted instance. */ host: string; /** * Run on based On. */ kind: string; /** * Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail[]; } interface GetRunbookRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail { /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail[]; /** * Resource Ocid. */ resourceId: string; /** * Resource Type. */ resourceType: string; } interface GetRunbookRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbookRunbookVersionTaskTaskRecordDetail { /** * The description of the argument. */ description: string; /** * Execution details. */ executionDetails: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskTaskRecordDetailExecutionDetail[]; /** * Is this an Apply Subject Task? Ex. Patch Execution Task */ isApplySubjectTask: boolean; /** * Make a copy of this task in Library */ isCopyToLibraryEnabled: boolean; /** * Is this a discovery output task? */ isDiscoveryOutputTask: boolean; /** * The name of the task */ name: string; /** * The OS for the task. */ osType: string; /** * The platform of the runbook. */ platform: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskTaskRecordDetailProperty[]; /** * The scope of the task. */ scope: string; /** * The ID of taskRecord. */ taskRecordId: string; } interface GetRunbookRunbookVersionTaskTaskRecordDetailExecutionDetail { /** * Catalog Id having terraform package. */ catalogId: string; /** * Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. */ command: string; /** * Catalog Id having config file. */ configFile: string; /** * Content Source details. */ contents: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskTaskRecordDetailExecutionDetailContent[]; /** * Credentials required for executing the task. */ credentials: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskTaskRecordDetailExecutionDetailCredential[]; /** * Endpoint to be invoked. */ endpoint: string; /** * The action type of the task */ executionType: string; /** * Is the Content an executable file? */ isExecutableContent: boolean; /** * Is the script locked to prevent changes directly in Object Storage? */ isLocked: boolean; /** * Is read output variable enabled */ isReadOutputVariableEnabled: boolean; /** * The list of system variables. */ systemVariables: string[]; /** * OCID of the compartment to which the resource belongs to. */ targetCompartmentId: string; /** * The variable of the task. At least one of the dynamicArguments or output needs to be provided. */ variables: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskTaskRecordDetailExecutionDetailVariable[]; } interface GetRunbookRunbookVersionTaskTaskRecordDetailExecutionDetailContent { /** * Bucket Name. */ bucket: string; /** * Catalog Id having terraform package. */ catalogId: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface GetRunbookRunbookVersionTaskTaskRecordDetailExecutionDetailCredential { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * The OCID of the resource. */ id: string; } interface GetRunbookRunbookVersionTaskTaskRecordDetailExecutionDetailVariable { /** * The input variables for the task. */ inputVariables: outputs.FleetAppsManagement.GetRunbookRunbookVersionTaskTaskRecordDetailExecutionDetailVariableInputVariable[]; /** * The list of output variables. */ outputVariables: string[]; } interface GetRunbookRunbookVersionTaskTaskRecordDetailExecutionDetailVariableInputVariable { /** * The description of the argument. */ description: string; /** * The name of the task */ name: string; /** * The type of the runbook. */ type: string; } interface GetRunbookRunbookVersionTaskTaskRecordDetailProperty { /** * The number of retries allowed. */ numRetries: number; /** * The timeout in seconds for the task. */ timeoutInSeconds: number; } interface GetRunbookVersionExecutionWorkflowDetail { /** * Rollback Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.GetRunbookVersionExecutionWorkflowDetailWorkflow[]; } interface GetRunbookVersionExecutionWorkflowDetailWorkflow { /** * Name of the group. */ groupName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: outputs.FleetAppsManagement.GetRunbookVersionExecutionWorkflowDetailWorkflowStep[]; /** * Input argument Type. */ type: string; } interface GetRunbookVersionExecutionWorkflowDetailWorkflowStep { /** * Name of the group. */ groupName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * Input argument Type. */ type: string; } interface GetRunbookVersionGroup { /** * The name of the task */ name: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.GetRunbookVersionGroupProperty[]; /** * Input argument Type. */ type: string; } interface GetRunbookVersionGroupProperty { /** * The action to be taken in case of a failure. */ actionOnFailure: string; /** * Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.GetRunbookVersionGroupPropertyNotificationPreference[]; /** * Pause Details */ pauseDetails: outputs.FleetAppsManagement.GetRunbookVersionGroupPropertyPauseDetail[]; /** * Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * The runon conditions */ runOns: outputs.FleetAppsManagement.GetRunbookVersionGroupPropertyRunOn[]; } interface GetRunbookVersionGroupPropertyNotificationPreference { /** * Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface GetRunbookVersionGroupPropertyPauseDetail { /** * Time in minutes to apply Pause. */ durationInMinutes: number; /** * Run on based On. */ kind: string; } interface GetRunbookVersionGroupPropertyRunOn { /** * Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * OCID of the self hosted instance. */ host: string; /** * Run on based On. */ kind: string; /** * Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.GetRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail[]; } interface GetRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail { /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail[]; /** * Resource Ocid. */ resourceId: string; /** * Resource Type. */ resourceType: string; } interface GetRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbookVersionRollbackWorkflowDetail { /** * The scope of the task. */ scope: string; /** * Rollback Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.GetRunbookVersionRollbackWorkflowDetailWorkflow[]; } interface GetRunbookVersionRollbackWorkflowDetailWorkflow { /** * Name of the group. */ groupName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: outputs.FleetAppsManagement.GetRunbookVersionRollbackWorkflowDetailWorkflowStep[]; /** * Input argument Type. */ type: string; } interface GetRunbookVersionRollbackWorkflowDetailWorkflowStep { /** * Name of the group. */ groupName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * Input argument Type. */ type: string; } interface GetRunbookVersionTask { /** * Mapping output variables of previous tasks to the input variables of the current task. */ outputVariableMappings: outputs.FleetAppsManagement.GetRunbookVersionTaskOutputVariableMapping[]; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * The properties of the component. */ stepProperties: outputs.FleetAppsManagement.GetRunbookVersionTaskStepProperty[]; /** * The details of the task. */ taskRecordDetails: outputs.FleetAppsManagement.GetRunbookVersionTaskTaskRecordDetail[]; } interface GetRunbookVersionTaskOutputVariableMapping { /** * The name of the task */ name: string; /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbookVersionTaskOutputVariableMappingOutputVariableDetail[]; } interface GetRunbookVersionTaskOutputVariableMappingOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbookVersionTaskStepProperty { /** * The action to be taken in case of a failure. */ actionOnFailure: string; /** * Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.GetRunbookVersionTaskStepPropertyNotificationPreference[]; /** * Pause Details */ pauseDetails: outputs.FleetAppsManagement.GetRunbookVersionTaskStepPropertyPauseDetail[]; /** * Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * The runon conditions */ runOns: outputs.FleetAppsManagement.GetRunbookVersionTaskStepPropertyRunOn[]; } interface GetRunbookVersionTaskStepPropertyNotificationPreference { /** * Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface GetRunbookVersionTaskStepPropertyPauseDetail { /** * Time in minutes to apply Pause. */ durationInMinutes: number; /** * Run on based On. */ kind: string; } interface GetRunbookVersionTaskStepPropertyRunOn { /** * Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * OCID of the self hosted instance. */ host: string; /** * Run on based On. */ kind: string; /** * Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.GetRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail[]; } interface GetRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail { /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail[]; /** * Resource Ocid. */ resourceId: string; /** * Resource Type. */ resourceType: string; } interface GetRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbookVersionTaskTaskRecordDetail { /** * The description of the argument. */ description: string; /** * Execution details. */ executionDetails: outputs.FleetAppsManagement.GetRunbookVersionTaskTaskRecordDetailExecutionDetail[]; /** * Is this an Apply Subject Task? Ex. Patch Execution Task */ isApplySubjectTask: boolean; /** * Make a copy of this task in Library */ isCopyToLibraryEnabled: boolean; /** * Is this a discovery output task? */ isDiscoveryOutputTask: boolean; /** * The name of the task */ name: string; /** * The OS for the task. */ osType: string; /** * The platform of the runbook. */ platform: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.GetRunbookVersionTaskTaskRecordDetailProperty[]; /** * The scope of the task. */ scope: string; /** * The ID of taskRecord. */ taskRecordId: string; } interface GetRunbookVersionTaskTaskRecordDetailExecutionDetail { /** * Catalog Id having terraform package. */ catalogId: string; /** * Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. */ command: string; /** * Catalog Id having config file. */ configFile: string; /** * Content Source details. */ contents: outputs.FleetAppsManagement.GetRunbookVersionTaskTaskRecordDetailExecutionDetailContent[]; /** * Credentials required for executing the task. */ credentials: outputs.FleetAppsManagement.GetRunbookVersionTaskTaskRecordDetailExecutionDetailCredential[]; /** * Endpoint to be invoked. */ endpoint: string; /** * The action type of the task */ executionType: string; /** * Is the Content an executable file? */ isExecutableContent: boolean; /** * Is the script locked to prevent changes directly in Object Storage? */ isLocked: boolean; /** * Is read output variable enabled */ isReadOutputVariableEnabled: boolean; /** * The list of system variables. */ systemVariables: string[]; /** * OCID of the compartment to which the resource belongs to. */ targetCompartmentId: string; /** * The variable of the task. At least one of the dynamicArguments or output needs to be provided. */ variables: outputs.FleetAppsManagement.GetRunbookVersionTaskTaskRecordDetailExecutionDetailVariable[]; } interface GetRunbookVersionTaskTaskRecordDetailExecutionDetailContent { /** * Bucket Name. */ bucket: string; /** * Catalog Id having terraform package. */ catalogId: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface GetRunbookVersionTaskTaskRecordDetailExecutionDetailCredential { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * The OCID of the resource. */ id: string; } interface GetRunbookVersionTaskTaskRecordDetailExecutionDetailVariable { /** * The input variables for the task. */ inputVariables: outputs.FleetAppsManagement.GetRunbookVersionTaskTaskRecordDetailExecutionDetailVariableInputVariable[]; /** * The list of output variables. */ outputVariables: string[]; } interface GetRunbookVersionTaskTaskRecordDetailExecutionDetailVariableInputVariable { /** * The description of the argument. */ description: string; /** * The name of the task */ name: string; /** * Input argument Type. */ type: string; } interface GetRunbookVersionTaskTaskRecordDetailProperty { /** * The number of retries allowed. */ numRetries: number; /** * The timeout in seconds for the task. */ timeoutInSeconds: number; } interface GetRunbookVersionsFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetRunbookVersionsRunbookVersionCollection { items: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItem[]; } interface GetRunbookVersionsRunbookVersionCollectionItem { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Execution Workflow details. */ executionWorkflowDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemExecutionWorkflowDetail[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The groups of the runbook. */ groups: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemGroup[]; /** * A filter to return runbook versions whose identifier matches the given identifier. */ id: string; isLatest: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter to return only resources that match the entire name given. */ name: string; /** * Rollback Workflow details. */ rollbackWorkflowDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemRollbackWorkflowDetail[]; /** * A filter to return only schedule definitions whose associated runbookId matches the given runbookId. */ runbookId: string; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A set of tasks to execute in the runbook. */ tasks: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTask[]; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetRunbookVersionsRunbookVersionCollectionItemExecutionWorkflowDetail { /** * Rollback Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemExecutionWorkflowDetailWorkflow[]; } interface GetRunbookVersionsRunbookVersionCollectionItemExecutionWorkflowDetailWorkflow { /** * Name of the group. */ groupName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemExecutionWorkflowDetailWorkflowStep[]; /** * Input argument Type. */ type: string; } interface GetRunbookVersionsRunbookVersionCollectionItemExecutionWorkflowDetailWorkflowStep { /** * Name of the group. */ groupName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * Input argument Type. */ type: string; } interface GetRunbookVersionsRunbookVersionCollectionItemGroup { /** * A filter to return only resources that match the entire name given. */ name: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemGroupProperty[]; /** * Input argument Type. */ type: string; } interface GetRunbookVersionsRunbookVersionCollectionItemGroupProperty { /** * The action to be taken in case of a failure. */ actionOnFailure: string; /** * Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemGroupPropertyNotificationPreference[]; /** * Pause Details */ pauseDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemGroupPropertyPauseDetail[]; /** * Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * The runon conditions */ runOns: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemGroupPropertyRunOn[]; } interface GetRunbookVersionsRunbookVersionCollectionItemGroupPropertyNotificationPreference { /** * Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface GetRunbookVersionsRunbookVersionCollectionItemGroupPropertyPauseDetail { /** * Time in minutes to apply Pause. */ durationInMinutes: number; /** * Run on based On. */ kind: string; } interface GetRunbookVersionsRunbookVersionCollectionItemGroupPropertyRunOn { /** * Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * OCID of the self hosted instance. */ host: string; /** * Run on based On. */ kind: string; /** * Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemGroupPropertyRunOnPreviousTaskInstanceDetail[]; } interface GetRunbookVersionsRunbookVersionCollectionItemGroupPropertyRunOnPreviousTaskInstanceDetail { /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail[]; /** * Resource Ocid. */ resourceId: string; /** * Resource Type. */ resourceType: string; } interface GetRunbookVersionsRunbookVersionCollectionItemGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbookVersionsRunbookVersionCollectionItemRollbackWorkflowDetail { /** * The scope of the task. */ scope: string; /** * Rollback Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemRollbackWorkflowDetailWorkflow[]; } interface GetRunbookVersionsRunbookVersionCollectionItemRollbackWorkflowDetailWorkflow { /** * Name of the group. */ groupName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemRollbackWorkflowDetailWorkflowStep[]; /** * Input argument Type. */ type: string; } interface GetRunbookVersionsRunbookVersionCollectionItemRollbackWorkflowDetailWorkflowStep { /** * Name of the group. */ groupName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * Input argument Type. */ type: string; } interface GetRunbookVersionsRunbookVersionCollectionItemTask { /** * Mapping output variables of previous tasks to the input variables of the current task. */ outputVariableMappings: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskOutputVariableMapping[]; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * The properties of the component. */ stepProperties: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskStepProperty[]; /** * The details of the task. */ taskRecordDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetail[]; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskOutputVariableMapping { /** * A filter to return only resources that match the entire name given. */ name: string; /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskOutputVariableMappingOutputVariableDetail[]; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskOutputVariableMappingOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskStepProperty { /** * The action to be taken in case of a failure. */ actionOnFailure: string; /** * Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskStepPropertyNotificationPreference[]; /** * Pause Details */ pauseDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskStepPropertyPauseDetail[]; /** * Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * The runon conditions */ runOns: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskStepPropertyRunOn[]; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskStepPropertyNotificationPreference { /** * Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskStepPropertyPauseDetail { /** * Time in minutes to apply Pause. */ durationInMinutes: number; /** * Run on based On. */ kind: string; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskStepPropertyRunOn { /** * Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * OCID of the self hosted instance. */ host: string; /** * Run on based On. */ kind: string; /** * Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskStepPropertyRunOnPreviousTaskInstanceDetail[]; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskStepPropertyRunOnPreviousTaskInstanceDetail { /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail[]; /** * Resource Ocid. */ resourceId: string; /** * Resource Type. */ resourceType: string; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetail { /** * The description of the argument. */ description: string; /** * Execution details. */ executionDetails: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailExecutionDetail[]; /** * Is this an Apply Subject Task? Ex. Patch Execution Task */ isApplySubjectTask: boolean; /** * Make a copy of this task in Library */ isCopyToLibraryEnabled: boolean; /** * Is this a discovery output task? */ isDiscoveryOutputTask: boolean; /** * A filter to return only resources that match the entire name given. */ name: string; /** * The OS for the task. */ osType: string; /** * The platform of the runbook. */ platform: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailProperty[]; /** * The scope of the task. */ scope: string; /** * The ID of taskRecord. */ taskRecordId: string; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailExecutionDetail { /** * Catalog Id having terraform package. */ catalogId: string; /** * Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. */ command: string; /** * Catalog Id having config file. */ configFile: string; /** * Content Source details. */ contents: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailExecutionDetailContent[]; /** * Credentials required for executing the task. */ credentials: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailExecutionDetailCredential[]; /** * Endpoint to be invoked. */ endpoint: string; /** * The action type of the task */ executionType: string; /** * Is the Content an executable file? */ isExecutableContent: boolean; /** * Is the script locked to prevent changes directly in Object Storage? */ isLocked: boolean; /** * Is read output variable enabled */ isReadOutputVariableEnabled: boolean; /** * The list of system variables. */ systemVariables: string[]; /** * OCID of the compartment to which the resource belongs to. */ targetCompartmentId: string; /** * The variable of the task. At least one of the dynamicArguments or output needs to be provided. */ variables: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailExecutionDetailVariable[]; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailExecutionDetailContent { /** * Bucket Name. */ bucket: string; /** * Catalog Id having terraform package. */ catalogId: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailExecutionDetailCredential { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * A filter to return runbook versions whose identifier matches the given identifier. */ id: string; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailExecutionDetailVariable { /** * The input variables for the task. */ inputVariables: outputs.FleetAppsManagement.GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailExecutionDetailVariableInputVariable[]; /** * The list of output variables. */ outputVariables: string[]; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailExecutionDetailVariableInputVariable { /** * The description of the argument. */ description: string; /** * A filter to return only resources that match the entire name given. */ name: string; /** * Input argument Type. */ type: string; } interface GetRunbookVersionsRunbookVersionCollectionItemTaskTaskRecordDetailProperty { /** * The number of retries allowed. */ numRetries: number; /** * The timeout in seconds for the task. */ timeoutInSeconds: number; } interface GetRunbooksFilter { /** * The name of the task */ name: string; regex?: boolean; values: string[]; } interface GetRunbooksRunbookCollection { items: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItem[]; } interface GetRunbooksRunbookCollectionItem { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The description of the argument. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Estimated time to successfully complete the runbook execution. */ estimatedTime: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Does this runbook has draft versions? */ hasDraftVersion: boolean; /** * Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided. */ id: string; /** * Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation. */ isDefault: boolean; /** * Does this runbook need SUDO access to execute? */ isSudoAccessNeeded: boolean; /** * Latest runbook version. */ latestVersion: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter to return runbooks whose operation matches the given lifecycle operation. */ operation: string; /** * The OS for the task. */ osType: string; /** * A filter to return runbooks whose platform matches the given platform. */ platform: string; /** * Associated region */ resourceRegion: string; /** * Version for the runbook. Versioning runbooks in Fleet Application Management involve assigning unique identifiers or version numbers to different iterations of the runbook to track changes, improvements, and updates over time. */ runbookVersions: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersion[]; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return runbooks whose type matches the given type. */ type: string; } interface GetRunbooksRunbookCollectionItemRunbookVersion { /** * Execution Workflow details. */ executionWorkflowDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetail[]; /** * The groups of the runbook. */ groups: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionGroup[]; /** * Is this version the latest? */ isLatest: boolean; /** * Rollback Workflow details. */ rollbackWorkflowDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetail[]; /** * A set of tasks to execute in the runbook. */ tasks: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTask[]; /** * The version of the runbook. */ version: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetail { /** * Rollback Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflow[]; } interface GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflow { /** * Name of the group. */ groupName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflowStep[]; /** * A filter to return runbooks whose type matches the given type. */ type: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionExecutionWorkflowDetailWorkflowStep { /** * Name of the group. */ groupName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * A filter to return runbooks whose type matches the given type. */ type: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionGroup { /** * The name of the task */ name: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionGroupProperty[]; /** * A filter to return runbooks whose type matches the given type. */ type: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionGroupProperty { /** * The action to be taken in case of a failure. */ actionOnFailure: string; /** * Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyNotificationPreference[]; /** * Pause Details */ pauseDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyPauseDetail[]; /** * Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * The runon conditions */ runOns: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOn[]; } interface GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyNotificationPreference { /** * Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyPauseDetail { /** * Time in minutes to apply Pause. */ durationInMinutes: number; /** * Run on based On. */ kind: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOn { /** * Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * OCID of the self hosted instance. */ host: string; /** * Run on based On. */ kind: string; /** * Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail[]; } interface GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetail { /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail[]; /** * Resource Ocid. */ resourceId: string; /** * Resource Type. */ resourceType: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionGroupPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetail { /** * The scope of the task. */ scope: string; /** * Rollback Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflow[]; } interface GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflow { /** * Name of the group. */ groupName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflowStep[]; /** * A filter to return runbooks whose type matches the given type. */ type: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionRollbackWorkflowDetailWorkflowStep { /** * Name of the group. */ groupName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * A filter to return runbooks whose type matches the given type. */ type: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionTask { /** * Mapping output variables of previous tasks to the input variables of the current task. */ outputVariableMappings: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMapping[]; /** * The name of the task step the output variable belongs to. */ stepName: string; /** * The properties of the component. */ stepProperties: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskStepProperty[]; /** * The details of the task. */ taskRecordDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetail[]; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMapping { /** * The name of the task */ name: string; /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMappingOutputVariableDetail[]; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskOutputVariableMappingOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskStepProperty { /** * The action to be taken in case of a failure. */ actionOnFailure: string; /** * Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyNotificationPreference[]; /** * Pause Details */ pauseDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyPauseDetail[]; /** * Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * The runon conditions */ runOns: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOn[]; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyNotificationPreference { /** * Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyPauseDetail { /** * Time in minutes to apply Pause. */ durationInMinutes: number; /** * Run on based On. */ kind: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOn { /** * Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * OCID of the self hosted instance. */ host: string; /** * Run on based On. */ kind: string; /** * Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail[]; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetail { /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail[]; /** * Resource Ocid. */ resourceId: string; /** * Resource Type. */ resourceType: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskStepPropertyRunOnPreviousTaskInstanceDetailOutputVariableDetail { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetail { /** * The description of the argument. */ description: string; /** * Execution details. */ executionDetails: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetail[]; /** * Is this an Apply Subject Task? Ex. Patch Execution Task */ isApplySubjectTask: boolean; /** * Make a copy of this task in Library */ isCopyToLibraryEnabled: boolean; /** * Is this a discovery output task? */ isDiscoveryOutputTask: boolean; /** * The name of the task */ name: string; /** * The OS for the task. */ osType: string; /** * A filter to return runbooks whose platform matches the given platform. */ platform: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailProperty[]; /** * The scope of the task. */ scope: string; /** * The ID of taskRecord. */ taskRecordId: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetail { /** * Catalog Id having terraform package. */ catalogId: string; /** * Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. */ command: string; /** * Catalog Id having config file. */ configFile: string; /** * Content Source details. */ contents: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailContent[]; /** * Credentials required for executing the task. */ credentials: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailCredential[]; /** * Endpoint to be invoked. */ endpoint: string; /** * The action type of the task */ executionType: string; /** * Is the Content an executable file? */ isExecutableContent: boolean; /** * Is the script locked to prevent changes directly in Object Storage? */ isLocked: boolean; /** * Is read output variable enabled */ isReadOutputVariableEnabled: boolean; /** * The list of system variables. */ systemVariables: string[]; /** * OCID of the compartment to which the resource belongs to. */ targetCompartmentId: string; /** * The variable of the task. At least one of the dynamicArguments or output needs to be provided. */ variables: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariable[]; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailContent { /** * Bucket Name. */ bucket: string; /** * Catalog Id having terraform package. */ catalogId: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailCredential { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided. */ id: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariable { /** * The input variables for the task. */ inputVariables: outputs.FleetAppsManagement.GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariableInputVariable[]; /** * The list of output variables. */ outputVariables: string[]; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailExecutionDetailVariableInputVariable { /** * The description of the argument. */ description: string; /** * The name of the task */ name: string; /** * A filter to return runbooks whose type matches the given type. */ type: string; } interface GetRunbooksRunbookCollectionItemRunbookVersionTaskTaskRecordDetailProperty { /** * The number of retries allowed. */ numRetries: number; /** * The timeout in seconds for the task. */ timeoutInSeconds: number; } interface GetSchedulerDefinitionActionGroup { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * ID of the fleet */ fleetId: string; /** * Task argument kind */ kind: string; /** * The ID of the Runbook */ runbookId: string; /** * The runbook version name */ runbookVersionName: string; /** * Sequence of the Action Group. Action groups will be executed in a seuential order. All Action Groups having the same sequence will be executed parallely. If no value is provided a default value of 1 will be given. */ sequence: number; } interface GetSchedulerDefinitionRunBook { /** * Input Parameters for the Task */ inputParameters: outputs.FleetAppsManagement.GetSchedulerDefinitionRunBookInputParameter[]; /** * The ID of the Runbook */ runbookId: string; /** * The runbook version name */ runbookVersionName: string; } interface GetSchedulerDefinitionRunBookInputParameter { /** * Arguments for the Task */ arguments: outputs.FleetAppsManagement.GetSchedulerDefinitionRunBookInputParameterArgument[]; /** * stepName for which the input parameters are provided */ stepName: string; } interface GetSchedulerDefinitionRunBookInputParameterArgument { /** * Content Source details. */ contents: outputs.FleetAppsManagement.GetSchedulerDefinitionRunBookInputParameterArgumentContent[]; /** * Task argument kind */ kind: string; /** * Name of the input variable */ name: string; /** * The task input */ value: string; } interface GetSchedulerDefinitionRunBookInputParameterArgumentContent { /** * Bucket Name. */ bucket: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface GetSchedulerDefinitionSchedule { /** * Duration of the schedule. */ duration: string; /** * Start Date for the schedule. An RFC3339 formatted datetime string */ executionStartdate: string; /** * Provide MaintenanceWindowId */ maintenanceWindowId: string; /** * Recurrence rule specification if recurring */ recurrences: string; /** * Schedule Type */ type: string; } interface GetSchedulerDefinitionScheduledFleetsFilter { name: string; regex?: boolean; values: string[]; } interface GetSchedulerDefinitionScheduledFleetsScheduledFleetCollection { /** * List of ScheduledFleets. */ items: outputs.FleetAppsManagement.GetSchedulerDefinitionScheduledFleetsScheduledFleetCollectionItem[]; } interface GetSchedulerDefinitionScheduledFleetsScheduledFleetCollectionItem { /** * The OCID of the resource. */ compartmentId: string; /** * Count of Resources affected by the Schedule */ countOfAffectedResources: number; /** * Count of Targets affected by the Schedule */ countOfAffectedTargets: number; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The OCID of the resource. */ id: string; /** * All products part of the schedule. */ products: string[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetSchedulerDefinitionsFilter { /** * Name of the input variable */ name: string; regex?: boolean; values: string[]; } interface GetSchedulerDefinitionsSchedulerDefinitionCollection { items: outputs.FleetAppsManagement.GetSchedulerDefinitionsSchedulerDefinitionCollectionItem[]; } interface GetSchedulerDefinitionsSchedulerDefinitionCollectionItem { /** * Action Groups associated with the Schedule. */ actionGroups: outputs.FleetAppsManagement.GetSchedulerDefinitionsSchedulerDefinitionCollectionItemActionGroup[]; /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Count of Action Groups affected by the Schedule. */ countOfAffectedActionGroups: number; /** * Count of Resources affected by the Schedule. */ countOfAffectedResources: number; /** * Count of Targets affected by the Schedule. */ countOfAffectedTargets: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single Schedule Definition by id. Either compartmentId or id must be provided. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * All LifeCycle Operations that are part of the schedule. */ lifecycleOperations: string[]; /** * All products that are part of the schedule for PRODUCT ActionGroup Type. */ products: string[]; /** * Associated region */ resourceRegion: string; /** * Runbooks. */ runBooks: outputs.FleetAppsManagement.GetSchedulerDefinitionsSchedulerDefinitionCollectionItemRunBook[]; /** * Schedule Information. */ schedules: outputs.FleetAppsManagement.GetSchedulerDefinitionsSchedulerDefinitionCollectionItemSchedule[]; /** * A filter to return only scheduleDefinitions whose lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The scheduled date for the next run of the Job. */ timeOfNextRun: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetSchedulerDefinitionsSchedulerDefinitionCollectionItemActionGroup { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * unique Fleet identifier */ fleetId: string; /** * Task argument kind */ kind: string; /** * A filter to return only schedule definitions whose associated runbookId matches the given runbookId. */ runbookId: string; /** * RunbookVersion Name filter */ runbookVersionName: string; /** * Sequence of the Action Group. Action groups will be executed in a seuential order. All Action Groups having the same sequence will be executed parallely. If no value is provided a default value of 1 will be given. */ sequence: number; } interface GetSchedulerDefinitionsSchedulerDefinitionCollectionItemRunBook { /** * Input Parameters for the Task */ inputParameters: outputs.FleetAppsManagement.GetSchedulerDefinitionsSchedulerDefinitionCollectionItemRunBookInputParameter[]; /** * A filter to return only schedule definitions whose associated runbookId matches the given runbookId. */ runbookId: string; /** * RunbookVersion Name filter */ runbookVersionName: string; } interface GetSchedulerDefinitionsSchedulerDefinitionCollectionItemRunBookInputParameter { /** * Arguments for the Task */ arguments: outputs.FleetAppsManagement.GetSchedulerDefinitionsSchedulerDefinitionCollectionItemRunBookInputParameterArgument[]; /** * stepName for which the input parameters are provided */ stepName: string; } interface GetSchedulerDefinitionsSchedulerDefinitionCollectionItemRunBookInputParameterArgument { /** * Content Source details. */ contents: outputs.FleetAppsManagement.GetSchedulerDefinitionsSchedulerDefinitionCollectionItemRunBookInputParameterArgumentContent[]; /** * Task argument kind */ kind: string; /** * Name of the input variable */ name: string; /** * The task input */ value: string; } interface GetSchedulerDefinitionsSchedulerDefinitionCollectionItemRunBookInputParameterArgumentContent { /** * Bucket Name. */ bucket: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface GetSchedulerDefinitionsSchedulerDefinitionCollectionItemSchedule { /** * Duration of the schedule. */ duration: string; /** * Start Date for the schedule. An RFC3339 formatted datetime string */ executionStartdate: string; /** * A filter to return only schedule definitions whose associated maintenanceWindowId matches the given maintenanceWindowId. */ maintenanceWindowId: string; /** * Recurrence rule specification if recurring */ recurrences: string; /** * Schedule Type */ type: string; } interface GetSchedulerExecutionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSchedulerExecutionsSchedulerExecutionCollection { /** * List of schedulerExecutions. */ items: outputs.FleetAppsManagement.GetSchedulerExecutionsSchedulerExecutionCollectionItem[]; } interface GetSchedulerExecutionsSchedulerExecutionCollectionItem { /** * Action Group associated with the Schedule. */ activityId: string; /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Name of the compartment in which resource exist. */ compartmentName: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the resource. */ id: string; /** * Latest Runbook version available. */ latestRunbookVersionName: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Display Name of the Fleet associated with the Schedule. */ resourceDisplayName: string; /** * ResourceId filter (Example FleetId) */ resourceId: string; /** * Display name of Runbook associated with the Schedule. */ runbookDisplayName: string; /** * A filter to return only schedule definitions whose associated runbookId matches the given runbookId. */ runbookId: string; /** * RunbookVersion Name filter */ runbookVersionName: string; /** * SchedulerDefinition associated with the job. */ schedulerDefinitions: outputs.FleetAppsManagement.GetSchedulerExecutionsSchedulerExecutionCollectionItemSchedulerDefinition[]; /** * SchedulerJob identifier filter */ schedulerJobId: string; /** * The current state of the Scheduler Execution. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Actual end date and time for the Execution. */ timeEnded: string; /** * The scheduled date and time for the Job. */ timeScheduled: string; /** * Actual start date and time for the Execution. */ timeStarted: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetSchedulerExecutionsSchedulerExecutionCollectionItemSchedulerDefinition { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The OCID of the resource. */ id: string; /** * Is this a recurring schedule? */ isRecurring: boolean; } interface GetSchedulerJobCountsFilter { name: string; regex?: boolean; values: string[]; } interface GetSchedulerJobCountsSchedulerJobAggregationCollection { /** * List of SchedulerJobAggregation objects. */ items: outputs.FleetAppsManagement.GetSchedulerJobCountsSchedulerJobAggregationCollectionItem[]; } interface GetSchedulerJobCountsSchedulerJobAggregationCollectionItem { /** * Aggregated summary information for a SchedulerJob. */ dimensions: outputs.FleetAppsManagement.GetSchedulerJobCountsSchedulerJobAggregationCollectionItemDimension[]; /** * Count of jobs in a Compartment. */ schedulerJobCountCount: number; } interface GetSchedulerJobCountsSchedulerJobAggregationCollectionItemDimension { /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; } interface GetSchedulerJobJobActivityResourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetSchedulerJobJobActivityResourcesResourceCollection { /** * List of Execution Resources. */ items: outputs.FleetAppsManagement.GetSchedulerJobJobActivityResourcesResourceCollectionItem[]; } interface GetSchedulerJobJobActivityResourcesResourceCollectionItem { /** * Description of the Execution status. If there are any errors, this can also include a short error message. */ description: string; /** * Resource Display Name. */ resourceDisplayName: string; /** * Resource Identifier associated with the Work Request. */ resourceId: string; /** * Task Order Sequence */ sequence: string; /** * Status of the Job at target Level. */ status: string; /** * Targets associated with the resource. */ targets: outputs.FleetAppsManagement.GetSchedulerJobJobActivityResourcesResourceCollectionItemTarget[]; /** * The time the task ended for the resource. An RFC3339 formatted datetime string */ timeEnded: string; /** * The time the task started for the resource. An RFC3339 formatted datetime string */ timeStarted: string; } interface GetSchedulerJobJobActivityResourcesResourceCollectionItemTarget { /** * Description of the Execution status. If there are any errors, this can also include a short error message. */ description: string; /** * Status of the Job at target Level. */ status: string; /** * Unique target name */ targetName: string; } interface GetSchedulerJobJobActivityStepsFilter { name: string; regex?: boolean; values: string[]; } interface GetSchedulerJobJobActivityStepsStepCollection { /** * List of Execution steps. */ items: outputs.FleetAppsManagement.GetSchedulerJobJobActivityStepsStepCollectionItem[]; } interface GetSchedulerJobJobActivityStepsStepCollectionItem { /** * Description of the step Execution. */ description: string; /** * Is this a rollback task? */ isRollbackTask: boolean; /** * Task Order Sequence */ sequence: string; /** * Status of the Task. */ status: string; /** * Unique step name */ stepName: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of taskRecord assocaited with the step. */ taskRecordId: string; /** * The time the task ended. An RFC3339 formatted datetime string */ timeEnded: string; /** * The time the task started. An RFC3339 formatted datetime string */ timeStarted: string; } interface GetTargetComponentsFilter { /** * Target Component Name. */ name: string; regex?: boolean; values: string[]; } interface GetTargetComponentsTargetComponentCollection { /** * List of target components. */ items: outputs.FleetAppsManagement.GetTargetComponentsTargetComponentCollectionItem[]; } interface GetTargetComponentsTargetComponentCollectionItem { /** * Target Component Name. */ name: string; /** * Path of the component. */ path: string; /** * List of properties. */ properties: outputs.FleetAppsManagement.GetTargetComponentsTargetComponentCollectionItemProperty[]; /** * Version of the component. */ version: string; } interface GetTargetComponentsTargetComponentCollectionItemProperty { /** * Target Component Name. */ name: string; /** * Value of the property. */ value: string; } interface GetTargetPropertiesFilter { /** * Name of the property. */ name: string; regex?: boolean; values: string[]; } interface GetTargetPropertiesTargetPropertyCollection { /** * List of target properties. */ items: outputs.FleetAppsManagement.GetTargetPropertiesTargetPropertyCollectionItem[]; } interface GetTargetPropertiesTargetPropertyCollectionItem { /** * Name of the property. */ name: string; /** * Value of the property. */ value: string; } interface GetTaskRecordDetail { /** * Execution details. */ executionDetails: outputs.FleetAppsManagement.GetTaskRecordDetailExecutionDetail[]; /** * Is this an Apply Subject Task? Set this to true for a Patch Execution Task which applies patches(subjects) on a target. */ isApplySubjectTask: boolean; /** * Is this a discovery output task? */ isDiscoveryOutputTask: boolean; /** * The lifecycle operation performed by the runbook. */ operation: string; /** * The OS for the task */ osType: string; /** * The platform of the runbook. */ platform: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.GetTaskRecordDetailProperty[]; /** * The scope of the task */ scope: string; } interface GetTaskRecordDetailExecutionDetail { /** * Catalog Id having terraform package. */ catalogId: string; /** * Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. */ command: string; /** * Catalog Id having config file. */ configFile: string; /** * Content Source details. */ contents: outputs.FleetAppsManagement.GetTaskRecordDetailExecutionDetailContent[]; /** * Credentials required for executing the task. */ credentials: outputs.FleetAppsManagement.GetTaskRecordDetailExecutionDetailCredential[]; /** * Endpoint to be invoked. */ endpoint: string; /** * The action type of the task */ executionType: string; /** * Is the Content an executable file? */ isExecutableContent: boolean; /** * Is the script locked to prevent changes directly in Object Storage? */ isLocked: boolean; /** * Is read output variable enabled */ isReadOutputVariableEnabled: boolean; /** * The list of system variables. */ systemVariables: string[]; /** * OCID of the compartment to which the resource belongs to. */ targetCompartmentId: string; /** * The variable of the task. At least one of the dynamicArguments or output needs to be provided. */ variables: outputs.FleetAppsManagement.GetTaskRecordDetailExecutionDetailVariable[]; } interface GetTaskRecordDetailExecutionDetailContent { /** * Bucket Name. */ bucket: string; /** * Catalog Id having terraform package. */ catalogId: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface GetTaskRecordDetailExecutionDetailCredential { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * The OCID of the resource. */ id: string; } interface GetTaskRecordDetailExecutionDetailVariable { /** * The input variables for the task. */ inputVariables: outputs.FleetAppsManagement.GetTaskRecordDetailExecutionDetailVariableInputVariable[]; /** * The list of output variables. */ outputVariables: string[]; } interface GetTaskRecordDetailExecutionDetailVariableInputVariable { /** * The description of the argument. */ description: string; /** * The name of the argument. */ name: string; /** * Task type. */ type: string; } interface GetTaskRecordDetailProperty { /** * The number of retries allowed. */ numRetries: number; /** * The timeout in seconds for the task. */ timeoutInSeconds: number; } interface GetTaskRecordsFilter { /** * The name of the argument. */ name: string; regex?: boolean; values: string[]; } interface GetTaskRecordsTaskRecordCollection { items: outputs.FleetAppsManagement.GetTaskRecordsTaskRecordCollectionItem[]; } interface GetTaskRecordsTaskRecordCollectionItem { /** * The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The description of the argument. */ description: string; /** * The details of the task. */ details: outputs.FleetAppsManagement.GetTaskRecordsTaskRecordCollectionItemDetail[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier or OCID for listing a single task record by id. Either compartmentId or id must be provided. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Associated region */ resourceRegion: string; /** * The current state of the task record. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The type of the Task. */ type: string; /** * The version of the task record. */ version: string; } interface GetTaskRecordsTaskRecordCollectionItemDetail { /** * Execution details. */ executionDetails: outputs.FleetAppsManagement.GetTaskRecordsTaskRecordCollectionItemDetailExecutionDetail[]; /** * Is this an Apply Subject Task? Set this to true for a Patch Execution Task which applies patches(subjects) on a target. */ isApplySubjectTask: boolean; /** * Is this a discovery output task? */ isDiscoveryOutputTask: boolean; /** * A filter to return task records whose operation matches the given lifecycle operation. */ operation: string; /** * The OS for the task */ osType: string; /** * The platform for the task record. */ platform: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.GetTaskRecordsTaskRecordCollectionItemDetailProperty[]; /** * The scope of the task */ scope: string; } interface GetTaskRecordsTaskRecordCollectionItemDetailExecutionDetail { /** * Catalog Id having terraform package. */ catalogId: string; /** * Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. */ command: string; /** * Catalog Id having config file. */ configFile: string; /** * Content Source details. */ contents: outputs.FleetAppsManagement.GetTaskRecordsTaskRecordCollectionItemDetailExecutionDetailContent[]; /** * Credentials required for executing the task. */ credentials: outputs.FleetAppsManagement.GetTaskRecordsTaskRecordCollectionItemDetailExecutionDetailCredential[]; /** * Endpoint to be invoked. */ endpoint: string; /** * The action type of the task */ executionType: string; /** * Is the Content an executable file? */ isExecutableContent: boolean; /** * Is the script locked to prevent changes directly in Object Storage? */ isLocked: boolean; /** * Is read output variable enabled */ isReadOutputVariableEnabled: boolean; /** * The list of system variables. */ systemVariables: string[]; /** * OCID of the compartment to which the resource belongs to. */ targetCompartmentId: string; /** * The variable of the task. At least one of the dynamicArguments or output needs to be provided. */ variables: outputs.FleetAppsManagement.GetTaskRecordsTaskRecordCollectionItemDetailExecutionDetailVariable[]; } interface GetTaskRecordsTaskRecordCollectionItemDetailExecutionDetailContent { /** * Bucket Name. */ bucket: string; /** * Catalog Id having terraform package. */ catalogId: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface GetTaskRecordsTaskRecordCollectionItemDetailExecutionDetailCredential { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Unique identifier or OCID for listing a single task record by id. Either compartmentId or id must be provided. */ id: string; } interface GetTaskRecordsTaskRecordCollectionItemDetailExecutionDetailVariable { /** * The input variables for the task. */ inputVariables: outputs.FleetAppsManagement.GetTaskRecordsTaskRecordCollectionItemDetailExecutionDetailVariableInputVariable[]; /** * The list of output variables. */ outputVariables: string[]; } interface GetTaskRecordsTaskRecordCollectionItemDetailExecutionDetailVariableInputVariable { /** * The description of the argument. */ description: string; /** * The name of the argument. */ name: string; /** * The type of the Task. */ type: string; } interface GetTaskRecordsTaskRecordCollectionItemDetailProperty { /** * The number of retries allowed. */ numRetries: number; /** * The timeout in seconds for the task. */ timeoutInSeconds: number; } interface OnboardingAppliedPolicy { /** * The unique id of the resource. */ id: string; /** * Policy statements. */ statements: string[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: * `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface PatchArtifactDetails { /** * (Updatable) Patch artifact metadata Details which is common for all platforms. */ artifact: outputs.FleetAppsManagement.PatchArtifactDetailsArtifact; /** * (Updatable) Artifacts. */ artifacts: outputs.FleetAppsManagement.PatchArtifactDetailsArtifact[]; /** * (Updatable) Artifact category details. */ category: string; } interface PatchArtifactDetailsArtifact { /** * (Updatable) System architecture. */ architecture: string; /** * (Updatable) Content Source details. */ content: outputs.FleetAppsManagement.PatchArtifactDetailsArtifactContent; /** * (Updatable) The OS type the patch is applicable for. */ osType: string; } interface PatchArtifactDetailsArtifactContent { /** * (Updatable) Bucket Name. */ bucket: string; /** * (Updatable) md5 checksum of the artifact. */ checksum: string; /** * (Updatable) Namespace. */ namespace: string; /** * (Updatable) Object Name. */ object: string; /** * (Updatable) Content Source type details. */ sourceType: string; } interface PatchDependentPatch { /** * (Updatable) The OCID of the resource. */ id: string; } interface PatchPatchType { /** * (Updatable) PlatformConfiguration Id corresponding to the Patch Type */ platformConfigurationId: string; } interface PatchProduct { /** * (Updatable) PlatformConfiguration Id corresponding to the Product */ platformConfigurationId: string; /** * (Updatable) product version. */ version: string; } interface PlatformConfigurationConfigCategoryDetails { /** * (Updatable) Products compatible with this Product. Provide products from the list of other products you have created that are compatible with the present one. This property is not applicable if isSoftlink is set to true. */ compatibleProducts: outputs.FleetAppsManagement.PlatformConfigurationConfigCategoryDetailsCompatibleProduct[]; /** * (Updatable) Various components of the Product. For example:The administration server or node manager can be the components of the Oracle WebLogic Application server. Forms server or concurrent manager can be the components of the Oracle E-Business Suite. This property is not applicable if isSoftlink is set to true. */ components: string[]; /** * (Updatable) Category of configuration */ configCategory: string; /** * (Updatable) OCID for the Credential name to be associated with the Product. These are useful for target discovery or lifecycle management activities, for example, Oracle WebLogic admin credentials for Oracle WebLogic Application server. This property is not applicable if isSoftlink is set to true. */ credentials: outputs.FleetAppsManagement.PlatformConfigurationConfigCategoryDetailsCredential[]; /** * (Updatable) The OCID of the resource. */ instanceId: string; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ instanceName: string; /** * (Updatable) If set true ,compliance policies will be created for softlink product. This property is applicable only if isSoftlink is set to true */ isCompliancePolicyRequiredForSoftlink: boolean; /** * (Updatable) Specify if the product is softlink product or not */ isSoftlink: boolean; /** * (Updatable) The OCID of the product that would be the target for the softlink. This property is applicable only if isSoftlink is set to true */ linkProductId: string; /** * (Updatable) Patch Types associated with this Product. This property is not applicable if isSoftlink is set to true. */ patchTypes: outputs.FleetAppsManagement.PlatformConfigurationConfigCategoryDetailsPatchType[]; /** * (Updatable) Products that belong to the stack. For example, Oracle WebLogic and Java for the Oracle Fusion Middleware product stack. */ products: outputs.FleetAppsManagement.PlatformConfigurationConfigCategoryDetailsProduct[]; /** * (Updatable) ProductStack Config Category Details. */ subCategoryDetails: outputs.FleetAppsManagement.PlatformConfigurationConfigCategoryDetailsSubCategoryDetails; /** * (Updatable) Versions associated with the PRODUCT. Mandatory if product is not softlink product. */ versions: string[]; } interface PlatformConfigurationConfigCategoryDetailsCompatibleProduct { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * (Updatable) The OCID of the resource. */ id: string; } interface PlatformConfigurationConfigCategoryDetailsCredential { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * (Updatable) The OCID of the resource. */ id: string; } interface PlatformConfigurationConfigCategoryDetailsPatchType { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * (Updatable) The OCID of the resource. */ id: string; } interface PlatformConfigurationConfigCategoryDetailsProduct { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * (Updatable) The OCID of the resource. */ id: string; } interface PlatformConfigurationConfigCategoryDetailsSubCategoryDetails { /** * (Updatable) Various components of the Product. For example:The administration server or node manager can be the components of the Oracle WebLogic Application server. Forms server or concurrent manager can be the components of the Oracle E-Business Suite. */ components: string[]; /** * (Updatable) OCID for the Credential name to be associated with the Product Stack. These are useful for target discovery or lifecycle management activities, for example, Oracle WebLogic admin credentials for Oracle WebLogic Application server. */ credentials: outputs.FleetAppsManagement.PlatformConfigurationConfigCategoryDetailsSubCategoryDetailsCredential[]; /** * (Updatable) Patch Types associated with this Product Stack which will be considered as Product. */ patchTypes: outputs.FleetAppsManagement.PlatformConfigurationConfigCategoryDetailsSubCategoryDetailsPatchType[]; /** * (Updatable) SubCategory of Product Stack. */ subCategory: string; /** * (Updatable) Versions associated with the PRODUCT . */ versions: string[]; } interface PlatformConfigurationConfigCategoryDetailsSubCategoryDetailsCredential { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * (Updatable) The OCID of the resource. */ id: string; } interface PlatformConfigurationConfigCategoryDetailsSubCategoryDetailsPatchType { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * (Updatable) The OCID of the resource. */ id: string; } interface ProvisionDeployedResource { /** * The mode of the resource. Example: "managed" */ mode: string; /** * Collection of InstanceSummary */ resourceInstanceLists: outputs.FleetAppsManagement.ProvisionDeployedResourceResourceInstanceList[]; /** * The name of the resource */ resourceName: string; /** * The name of the Provider */ resourceProvider: string; /** * The provider resource type. Must be supported by the Oracle Cloud Infrastructure provider. Example: oci.Core.Instance */ resourceType: string; } interface ProvisionDeployedResourceResourceInstanceList { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the FamProvision in. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the FamProvision. */ id: string; /** * The current state of the FamProvision. */ state: string; } interface ProvisionTfOutput { /** * The indicator if the data for this parameter is sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.) */ isSensitive: boolean; /** * The output description */ outputDescription: string; /** * The output name */ outputName: string; /** * The output type */ outputType: string; /** * The output value */ outputValue: string; } interface RunbookRunbookVersion { /** * Execution Workflow details. */ executionWorkflowDetails: outputs.FleetAppsManagement.RunbookRunbookVersionExecutionWorkflowDetails; /** * The groups of the runbook. */ groups: outputs.FleetAppsManagement.RunbookRunbookVersionGroup[]; /** * Is this version the latest? */ isLatest: boolean; /** * Rollback Workflow details. */ rollbackWorkflowDetails: outputs.FleetAppsManagement.RunbookRunbookVersionRollbackWorkflowDetails; /** * A set of tasks to execute in the runbook. */ tasks: outputs.FleetAppsManagement.RunbookRunbookVersionTask[]; /** * The version of the runbook. */ version: string; } interface RunbookRunbookVersionExecutionWorkflowDetails { /** * Execution Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.RunbookRunbookVersionExecutionWorkflowDetailsWorkflow[]; } interface RunbookRunbookVersionExecutionWorkflowDetailsWorkflow { /** * Name of the group. */ groupName: string; /** * Steps within the Group. */ steps: outputs.FleetAppsManagement.RunbookRunbookVersionExecutionWorkflowDetailsWorkflowStep[]; /** * Workflow Group Details. */ type: string; } interface RunbookRunbookVersionExecutionWorkflowDetailsWorkflowStep { /** * Name of the group. */ groupName: string; /** * Provide StepName for the Task. */ stepName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * Content Source Details. */ type: string; } interface RunbookRunbookVersionGroup { /** * The name of the group. */ name: string; /** * The properties of the component. */ properties: outputs.FleetAppsManagement.RunbookRunbookVersionGroupProperties; /** * The type of the group. PARALLEL_TASK_GROUP : Helps to execute tasks parallelly inside a resource. PARALLEL_RESOURCE_GROUP : Executes tasks across resources parallelly. ROLLING_RESOURCE_GROUP : Executes tasks across resources in a rolling order. */ type: string; } interface RunbookRunbookVersionGroupProperties { /** * The action to be taken in case of a failure. */ actionOnFailure: string; /** * Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.RunbookRunbookVersionGroupPropertiesNotificationPreferences; /** * Pause Details */ pauseDetails: outputs.FleetAppsManagement.RunbookRunbookVersionGroupPropertiesPauseDetails; /** * Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * The runon conditions */ runOn: outputs.FleetAppsManagement.RunbookRunbookVersionGroupPropertiesRunOn; } interface RunbookRunbookVersionGroupPropertiesNotificationPreferences { /** * Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface RunbookRunbookVersionGroupPropertiesPauseDetails { /** * Time in minutes to apply Pause. */ durationInMinutes: number; /** * Pause based On. */ kind: string; } interface RunbookRunbookVersionGroupPropertiesRunOn { /** * Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * OCID of the self hosted instance. */ host: string; /** * Run on based On. */ kind: string; /** * Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.RunbookRunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetail[]; } interface RunbookRunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetail { /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.RunbookRunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails; /** * Resource Ocid. */ resourceId: string; /** * Resource Type. */ resourceType: string; } interface RunbookRunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface RunbookRunbookVersionRollbackWorkflowDetails { /** * rollback Scope */ scope: string; /** * Rollback Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.RunbookRunbookVersionRollbackWorkflowDetailsWorkflow[]; } interface RunbookRunbookVersionRollbackWorkflowDetailsWorkflow { /** * Name of the group. */ groupName: string; /** * Steps within the Group. */ steps: outputs.FleetAppsManagement.RunbookRunbookVersionRollbackWorkflowDetailsWorkflowStep[]; /** * Workflow Group Details. */ type: string; } interface RunbookRunbookVersionRollbackWorkflowDetailsWorkflowStep { /** * Name of the group. */ groupName: string; /** * Provide StepName for the Task. */ stepName: string; /** * Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * Content Source Details. */ type: string; } interface RunbookRunbookVersionTask { /** * Mapping output variables of previous tasks to the input variables of the current task. */ outputVariableMappings: outputs.FleetAppsManagement.RunbookRunbookVersionTaskOutputVariableMapping[]; /** * The name of the task step. */ stepName: string; /** * The properties of the component. */ stepProperties: outputs.FleetAppsManagement.RunbookRunbookVersionTaskStepProperties; /** * The details of the task. */ taskRecordDetails: outputs.FleetAppsManagement.RunbookRunbookVersionTaskTaskRecordDetails; } interface RunbookRunbookVersionTaskOutputVariableMapping { /** * The name of the input variable. */ name: string; /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.RunbookRunbookVersionTaskOutputVariableMappingOutputVariableDetails; } interface RunbookRunbookVersionTaskOutputVariableMappingOutputVariableDetails { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface RunbookRunbookVersionTaskStepProperties { /** * The action to be taken in case of a failure. */ actionOnFailure: string; /** * Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.RunbookRunbookVersionTaskStepPropertiesNotificationPreferences; /** * Pause Details */ pauseDetails: outputs.FleetAppsManagement.RunbookRunbookVersionTaskStepPropertiesPauseDetails; /** * Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * The runon conditions */ runOn: outputs.FleetAppsManagement.RunbookRunbookVersionTaskStepPropertiesRunOn; } interface RunbookRunbookVersionTaskStepPropertiesNotificationPreferences { /** * Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface RunbookRunbookVersionTaskStepPropertiesPauseDetails { /** * Time in minutes to apply Pause. */ durationInMinutes: number; /** * Pause based On. */ kind: string; } interface RunbookRunbookVersionTaskStepPropertiesRunOn { /** * Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * OCID of the self hosted instance. */ host: string; /** * Run on based On. */ kind: string; /** * Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.RunbookRunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetail[]; } interface RunbookRunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetail { /** * The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.RunbookRunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails; /** * Resource Ocid. */ resourceId: string; /** * Resource Type. */ resourceType: string; } interface RunbookRunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails { /** * The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * The name of the task step the output variable belongs to. */ stepName: string; } interface RunbookRunbookVersionTaskTaskRecordDetails { /** * The description of the task. */ description: string; /** * Execution details. */ executionDetails: outputs.FleetAppsManagement.RunbookRunbookVersionTaskTaskRecordDetailsExecutionDetails; /** * Is this an Apply Subject Task? Ex. Patch Execution Task */ isApplySubjectTask: boolean; /** * Make a copy of this task in Library */ isCopyToLibraryEnabled: boolean; /** * Is this a discovery output task? */ isDiscoveryOutputTask: boolean; /** * The name of the task */ name: string; /** * The OS for the task. */ osType: string; /** * The platform of the runbook. */ platform: string; /** * The properties of the task. */ properties: outputs.FleetAppsManagement.RunbookRunbookVersionTaskTaskRecordDetailsProperties; /** * The scope of the task. */ scope: string; /** * The ID of taskRecord. */ taskRecordId: string; } interface RunbookRunbookVersionTaskTaskRecordDetailsExecutionDetails { /** * Catalog Id having terraform package. */ catalogId: string; /** * Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. */ command: string; /** * Catalog Id having config file. */ configFile: string; /** * Content Source details. */ content: outputs.FleetAppsManagement.RunbookRunbookVersionTaskTaskRecordDetailsExecutionDetailsContent; /** * Credentials required for executing the task. */ credentials: outputs.FleetAppsManagement.RunbookRunbookVersionTaskTaskRecordDetailsExecutionDetailsCredential[]; /** * Endpoint to be invoked. */ endpoint: string; /** * The action type of the task */ executionType: string; /** * Is the Content an executable file? */ isExecutableContent: boolean; /** * Is the script locked to prevent changes directly in Object Storage? */ isLocked: boolean; /** * Is read output variable enabled */ isReadOutputVariableEnabled: boolean; /** * The list of system variables. */ systemVariables: string[]; /** * OCID of the compartment to which the resource belongs to. */ targetCompartmentId: string; /** * The variable of the task. At least one of the dynamicArguments or output needs to be provided. */ variables: outputs.FleetAppsManagement.RunbookRunbookVersionTaskTaskRecordDetailsExecutionDetailsVariables; } interface RunbookRunbookVersionTaskTaskRecordDetailsExecutionDetailsContent { /** * Bucket Name. */ bucket: string; /** * Catalog Id having terraform package. */ catalogId: string; /** * md5 checksum of the artifact. */ checksum: string; /** * Namespace. */ namespace: string; /** * Object Name. */ object: string; /** * Content Source type details. */ sourceType: string; } interface RunbookRunbookVersionTaskTaskRecordDetailsExecutionDetailsCredential { /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * The OCID of the resource. */ id: string; } interface RunbookRunbookVersionTaskTaskRecordDetailsExecutionDetailsVariables { /** * The input variables for the task. */ inputVariables: outputs.FleetAppsManagement.RunbookRunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesInputVariable[]; /** * The list of output variables. */ outputVariables: string[]; } interface RunbookRunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesInputVariable { /** * The description of the argument. */ description: string; /** * The name of the argument. */ name: string; /** * Input argument Type. */ type: string; } interface RunbookRunbookVersionTaskTaskRecordDetailsProperties { /** * The number of retries allowed. */ numRetries: number; /** * The timeout in seconds for the task. */ timeoutInSeconds: number; } interface RunbookVersionExecutionWorkflowDetails { /** * (Updatable) Execution Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.RunbookVersionExecutionWorkflowDetailsWorkflow[]; } interface RunbookVersionExecutionWorkflowDetailsWorkflow { /** * (Updatable) Name of the group. */ groupName: string; /** * (Updatable) Steps within the Group. */ steps: outputs.FleetAppsManagement.RunbookVersionExecutionWorkflowDetailsWorkflowStep[]; /** * (Updatable) Workflow Group Details. */ type: string; } interface RunbookVersionExecutionWorkflowDetailsWorkflowStep { /** * (Updatable) Name of the group. */ groupName: string; /** * (Updatable) Provide StepName for the Task. */ stepName: string; /** * (Updatable) Tasks within the Group. Provide the stepName for all applicable tasks. */ steps: string[]; /** * (Updatable) Content Source Details. */ type: string; } interface RunbookVersionGroup { /** * (Updatable) The name of the group. */ name: string; /** * (Updatable) The properties of the component. */ properties: outputs.FleetAppsManagement.RunbookVersionGroupProperties; /** * (Updatable) The type of the group. PARALLEL_TASK_GROUP : Helps to execute tasks parallelly * inside a resource. PARALLEL_RESOURCE_GROUP : Executes tasks across resources parallelly. ROLLING_RESOURCE_GROUP : * Executes tasks across resources in a rolling order. * > > > > > > > theirs */ type: string; } interface RunbookVersionGroupProperties { /** * (Updatable) The action to be taken in case of a failure. */ actionOnFailure: string; /** * (Updatable) Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.RunbookVersionGroupPropertiesNotificationPreferences; /** * (Updatable) Pause Details */ pauseDetails: outputs.FleetAppsManagement.RunbookVersionGroupPropertiesPauseDetails; /** * (Updatable) Build control flow conditions that determine the relevance of the * task execution. */ preCondition: string; /** * (Updatable) The runon conditions */ runOn: outputs.FleetAppsManagement.RunbookVersionGroupPropertiesRunOn; } interface RunbookVersionGroupPropertiesNotificationPreferences { /** * (Updatable) Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * (Updatable) Enables or disables notification on Task * Failures. */ shouldNotifyOnTaskFailure: boolean; /** * (Updatable) Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface RunbookVersionGroupPropertiesPauseDetails { /** * (Updatable) Time in minutes to apply Pause. */ durationInMinutes: number; /** * (Updatable) Pause based On. */ kind: string; } interface RunbookVersionGroupPropertiesRunOn { /** * (Updatable) Build control flow conditions that * determine the relevance of the task execution. */ condition: string; /** * (Updatable) OCID of the self hosted instance. */ host: string; /** * (Updatable) Run on based On. */ kind: string; /** * (Updatable) Previous Task * Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetail[]; } interface RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetail { /** * (Updatable) The details of * the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails; /** * (Updatable) Resource Ocid. */ resourceId: string; /** * (Updatable) Resource Type. */ resourceType: string; } interface RunbookVersionGroupPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails { /** * (Updatable) The name of the * output variable whose value has to be mapped. */ outputVariableName: string; /** * (Updatable) The name of the task step * the output variable belongs to. */ stepName: string; } interface RunbookVersionRollbackWorkflowDetails { /** * (Updatable) rollback Scope */ scope: string; /** * (Updatable) Rollback Workflow for the runbook. */ workflows: outputs.FleetAppsManagement.RunbookVersionRollbackWorkflowDetailsWorkflow[]; } interface RunbookVersionRollbackWorkflowDetailsWorkflow { /** * (Updatable) Name of the group. */ groupName: string; /** * (Updatable) Steps within the Group. */ steps: outputs.FleetAppsManagement.RunbookVersionRollbackWorkflowDetailsWorkflowStep[]; /** * (Updatable) Workflow Group Details. */ type: string; } interface RunbookVersionRollbackWorkflowDetailsWorkflowStep { /** * (Updatable) Name of the group. */ groupName: string; /** * (Updatable) Provide StepName for the Task. */ stepName: string; /** * (Updatable) Tasks within the Group. Provide the * stepName for all applicable tasks. */ steps: string[]; /** * (Updatable) Content Source Details. */ type: string; } interface RunbookVersionTask { /** * (Updatable) Mapping output variables of previous tasks to the input variables of the current task. */ outputVariableMappings: outputs.FleetAppsManagement.RunbookVersionTaskOutputVariableMapping[]; /** * (Updatable) The name of the task step. */ stepName: string; /** * (Updatable) The properties of the component. */ stepProperties: outputs.FleetAppsManagement.RunbookVersionTaskStepProperties; /** * (Updatable) The details of the task. */ taskRecordDetails: outputs.FleetAppsManagement.RunbookVersionTaskTaskRecordDetails; } interface RunbookVersionTaskOutputVariableMapping { /** * (Updatable) The name of the input variable. */ name: string; /** * (Updatable) The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.RunbookVersionTaskOutputVariableMappingOutputVariableDetails; } interface RunbookVersionTaskOutputVariableMappingOutputVariableDetails { /** * (Updatable) The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * (Updatable) The name of the task step the output variable belongs to. */ stepName: string; } interface RunbookVersionTaskStepProperties { /** * (Updatable) The action to be taken in case of a failure. */ actionOnFailure: string; /** * (Updatable) Preferences to send notifications on the task activities. */ notificationPreferences: outputs.FleetAppsManagement.RunbookVersionTaskStepPropertiesNotificationPreferences; /** * (Updatable) Pause Details */ pauseDetails: outputs.FleetAppsManagement.RunbookVersionTaskStepPropertiesPauseDetails; /** * (Updatable) Build control flow conditions that determine the relevance of the task execution. */ preCondition: string; /** * (Updatable) The runon conditions */ runOn: outputs.FleetAppsManagement.RunbookVersionTaskStepPropertiesRunOn; } interface RunbookVersionTaskStepPropertiesNotificationPreferences { /** * (Updatable) Enables notification on pause. */ shouldNotifyOnPause: boolean; /** * (Updatable) Enables or disables notification on Task Failures. */ shouldNotifyOnTaskFailure: boolean; /** * (Updatable) Enables or disables notification on Task Success. */ shouldNotifyOnTaskSuccess: boolean; } interface RunbookVersionTaskStepPropertiesPauseDetails { /** * (Updatable) Time in minutes to apply Pause. */ durationInMinutes: number; /** * (Updatable) Pause based On. */ kind: string; } interface RunbookVersionTaskStepPropertiesRunOn { /** * (Updatable) Build control flow conditions that determine the relevance of the task execution against targets. */ condition: string; /** * (Updatable) OCID of the self hosted instance. */ host: string; /** * (Updatable) Run on based On. */ kind: string; /** * (Updatable) Previous Task Instance Details */ previousTaskInstanceDetails: outputs.FleetAppsManagement.RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetail[]; } interface RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetail { /** * (Updatable) The details of the output variable that will be used for mapping. */ outputVariableDetails: outputs.FleetAppsManagement.RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails; /** * (Updatable) Resource Ocid. */ resourceId: string; /** * (Updatable) Resource Type. */ resourceType: string; } interface RunbookVersionTaskStepPropertiesRunOnPreviousTaskInstanceDetailOutputVariableDetails { /** * (Updatable) The name of the output variable whose value has to be mapped. */ outputVariableName: string; /** * (Updatable) The name of the task step the output variable belongs to. */ stepName: string; } interface RunbookVersionTaskTaskRecordDetails { /** * (Updatable) The description of the task. */ description: string; /** * (Updatable) Execution details. */ executionDetails: outputs.FleetAppsManagement.RunbookVersionTaskTaskRecordDetailsExecutionDetails; /** * (Updatable) Is this an Apply Subject Task? Ex. Patch Execution Task */ isApplySubjectTask: boolean; /** * (Updatable) Make a copy of this task in Library */ isCopyToLibraryEnabled: boolean; /** * (Updatable) Is this a discovery output task? */ isDiscoveryOutputTask: boolean; /** * (Updatable) The name of the task */ name: string; /** * (Updatable) The OS for the task. */ osType: string; /** * (Updatable) The platform of the runbook. */ platform: string; /** * (Updatable) The properties of the task. */ properties: outputs.FleetAppsManagement.RunbookVersionTaskTaskRecordDetailsProperties; /** * (Updatable) The scope of the task. */ scope: string; /** * (Updatable) The ID of taskRecord. */ taskRecordId: string; } interface RunbookVersionTaskTaskRecordDetailsExecutionDetails { /** * (Updatable) Catalog Id having terraform package. */ catalogId: string; /** * (Updatable) Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. */ command: string; /** * (Updatable) Catalog Id having config file. */ configFile: string; /** * (Updatable) Content Source details. */ content: outputs.FleetAppsManagement.RunbookVersionTaskTaskRecordDetailsExecutionDetailsContent; /** * (Updatable) Credentials required for executing the task. */ credentials: outputs.FleetAppsManagement.RunbookVersionTaskTaskRecordDetailsExecutionDetailsCredential[]; /** * (Updatable) Endpoint to be invoked. */ endpoint: string; /** * (Updatable) The action type of the task */ executionType: string; /** * (Updatable) Is the Content an executable file? */ isExecutableContent: boolean; /** * (Updatable) Is the script locked to prevent changes directly in Object Storage? */ isLocked: boolean; /** * (Updatable) Is read output variable enabled */ isReadOutputVariableEnabled: boolean; /** * (Updatable) The list of system variables. */ systemVariables: string[]; /** * (Updatable) OCID of the compartment to which the resource belongs to. */ targetCompartmentId: string; /** * (Updatable) The variable of the task. At least one of the dynamicArguments or output needs to be provided. */ variables: outputs.FleetAppsManagement.RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariables; } interface RunbookVersionTaskTaskRecordDetailsExecutionDetailsContent { /** * (Updatable) Bucket Name. */ bucket: string; /** * (Updatable) Catalog Id having terraform package. */ catalogId: string; /** * (Updatable) md5 checksum of the artifact. */ checksum: string; /** * (Updatable) Namespace. */ namespace: string; /** * (Updatable) Object Name. */ object: string; /** * (Updatable) Content Source type details. */ sourceType: string; } interface RunbookVersionTaskTaskRecordDetailsExecutionDetailsCredential { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * (Updatable) The OCID of the resource. */ id: string; } interface RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariables { /** * (Updatable) The input variables for the task. */ inputVariables: outputs.FleetAppsManagement.RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesInputVariable[]; /** * (Updatable) The list of output variables. */ outputVariables: string[]; } interface RunbookVersionTaskTaskRecordDetailsExecutionDetailsVariablesInputVariable { /** * (Updatable) The description of the argument. */ description: string; /** * (Updatable) The name of the argument. */ name: string; /** * (Updatable) Input argument Type. */ type: string; } interface RunbookVersionTaskTaskRecordDetailsProperties { /** * (Updatable) The number of retries allowed. */ numRetries: number; /** * (Updatable) The timeout in seconds for the task. */ timeoutInSeconds: number; } interface SchedulerDefinitionActionGroup { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * (Updatable) ID of the fleet */ fleetId: string; /** * (Updatable) Action Group kind */ kind: string; /** * (Updatable) ID of the runbook */ runbookId: string; /** * (Updatable) Name of the runbook version */ runbookVersionName: string; /** * (Updatable) Sequence of the Action Group. Action groups will be executed in a seuential order. All Action Groups having the same sequence will be executed parallely. If no value is provided a default value of 1 will be given. */ sequence: number; } interface SchedulerDefinitionRunBook { /** * (Updatable) Input Parameters for the Task */ inputParameters: outputs.FleetAppsManagement.SchedulerDefinitionRunBookInputParameter[]; /** * (Updatable) The ID of the Runbook */ runbookId: string; /** * (Updatable) The runbook version name */ runbookVersionName: string; } interface SchedulerDefinitionRunBookInputParameter { /** * (Updatable) Arguments for the Task */ arguments: outputs.FleetAppsManagement.SchedulerDefinitionRunBookInputParameterArgument[]; /** * (Updatable) stepName for which the input parameters are provided */ stepName: string; } interface SchedulerDefinitionRunBookInputParameterArgument { /** * (Updatable) Content Source details. */ content: outputs.FleetAppsManagement.SchedulerDefinitionRunBookInputParameterArgumentContent; /** * (Updatable) Task argument kind */ kind: string; /** * (Updatable) Name of the input variable */ name: string; /** * (Updatable) The task input */ value: string; } interface SchedulerDefinitionRunBookInputParameterArgumentContent { /** * (Updatable) Bucket Name. */ bucket: string; /** * (Updatable) md5 checksum of the artifact. */ checksum: string; /** * (Updatable) Namespace. */ namespace: string; /** * (Updatable) Object Name. */ object: string; /** * (Updatable) Content Source type details. */ sourceType: string; } interface SchedulerDefinitionSchedule { /** * (Updatable) Duration of the schedule. */ duration: string; /** * (Updatable) Start Date for the schedule. An RFC3339 formatted datetime string */ executionStartdate: string; /** * (Updatable) Provide MaintenanceWindowId */ maintenanceWindowId: string; /** * (Updatable) Recurrence rule specification if recurring */ recurrences: string; /** * (Updatable) Schedule Type * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface TaskRecordDetails { /** * (Updatable) Execution details. */ executionDetails: outputs.FleetAppsManagement.TaskRecordDetailsExecutionDetails; /** * (Updatable) Is this an Apply Subject Task? Set this to true for a Patch Execution Task which applies patches(subjects) on a target. */ isApplySubjectTask: boolean; /** * (Updatable) Is this a discovery output task? */ isDiscoveryOutputTask: boolean; /** * (Updatable) The lifecycle operation performed by the runbook. */ operation: string; /** * (Updatable) The OS for the task */ osType: string; /** * (Updatable) The platform of the runbook. */ platform: string; /** * (Updatable) The properties of the task. */ properties: outputs.FleetAppsManagement.TaskRecordDetailsProperties; /** * (Updatable) The scope of the task */ scope: string; } interface TaskRecordDetailsExecutionDetails { /** * (Updatable) Catalog Id having terraform package. */ catalogId: string; /** * (Updatable) Optional command to execute the content. You can provide any commands/arguments that can't be part of the script. */ command: string; /** * (Updatable) Catalog Id having config file. */ configFile: string; /** * (Updatable) Content Source details. */ content: outputs.FleetAppsManagement.TaskRecordDetailsExecutionDetailsContent; /** * (Updatable) Credentials required for executing the task. */ credentials: outputs.FleetAppsManagement.TaskRecordDetailsExecutionDetailsCredential[]; /** * (Updatable) Endpoint to be invoked. */ endpoint: string; /** * (Updatable) The action type of the task */ executionType: string; /** * (Updatable) Is the Content an executable file? */ isExecutableContent: boolean; /** * (Updatable) Is the script locked to prevent changes directly in Object Storage? */ isLocked: boolean; /** * (Updatable) Is read output variable enabled */ isReadOutputVariableEnabled: boolean; /** * (Updatable) The list of system variables. */ systemVariables: string[]; /** * (Updatable) OCID of the compartment to which the resource belongs to. */ targetCompartmentId: string; /** * (Updatable) The variable of the task. At least one of the dynamicArguments or output needs to be provided. */ variables: outputs.FleetAppsManagement.TaskRecordDetailsExecutionDetailsVariables; } interface TaskRecordDetailsExecutionDetailsContent { /** * (Updatable) Bucket Name. */ bucket: string; /** * (Updatable) Catalog Id having terraform package. */ catalogId: string; /** * (Updatable) md5 checksum of the artifact. */ checksum: string; /** * (Updatable) Namespace. */ namespace: string; /** * (Updatable) Object Name. */ object: string; /** * (Updatable) Content Source type details. */ sourceType: string; } interface TaskRecordDetailsExecutionDetailsCredential { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName: string; /** * (Updatable) The OCID of the resource. */ id: string; } interface TaskRecordDetailsExecutionDetailsVariables { /** * (Updatable) The input variables for the task. */ inputVariables: outputs.FleetAppsManagement.TaskRecordDetailsExecutionDetailsVariablesInputVariable[]; /** * (Updatable) The list of output variables. */ outputVariables: string[]; } interface TaskRecordDetailsExecutionDetailsVariablesInputVariable { /** * (Updatable) The description of the argument. */ description: string; /** * (Updatable) The name of the argument. */ name: string; /** * (Updatable) Input argument Type. */ type: string; } interface TaskRecordDetailsProperties { /** * (Updatable) The number of retries allowed. */ numRetries: number; /** * (Updatable) The timeout in seconds for the task. */ timeoutInSeconds: number; } } export declare namespace FleetSoftwareUpdate { interface FsuCollectionActiveFsuCycle { /** * (Updatable) The user-friendly name for the Exadata Fleet Update Collection. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Collection. */ id: string; } interface FsuCollectionComponent { /** * Type of component in an Exadata software stack. */ componentType: string; /** * Fleet discovery strategies for a 'GUEST_OS' collection of Exadata VM Clusters. If specified for an UpdateCollection request, discovery for Exadata VM Clusters will be rerun. */ fleetDiscovery: outputs.FleetSoftwareUpdate.FsuCollectionComponentFleetDiscovery; /** * Major version of Exadata Image (Guest OS) release for Exadata VM Cluster targets to be included in an Exadata Fleet Update Collection. Major Versions of Exadata Software are demarcated by the underlying Oracle Linux OS version. For more details, refer to [Oracle document 2075007.1](https://support.oracle.com/knowledge/Oracle%20Database%20Products/2075007_1.html) */ sourceMajorVersion: string; } interface FsuCollectionComponentFleetDiscovery { /** * Filters to perform the target discovery. */ filters: outputs.FleetSoftwareUpdate.FsuCollectionComponentFleetDiscoveryFilter[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Discovery. */ fsuDiscoveryId: string; /** * [OCI Search Service](https://docs.cloud.oracle.com/iaas/Content/Search/Concepts/queryoverview.htm) query string. */ query: string; /** * Supported fleet discovery strategies. */ strategy: string; /** * OCIDs of target resources to include. For EXACC service type Collections only VMClusters are allowed. For EXACS service type Collections only CloudVMClusters are allowed. For EXA-DB-XS service type Collections only ExaDBVMClusters are allowed. */ targets: string[]; } interface FsuCollectionComponentFleetDiscoveryFilter { /** * Type of resource to match in the discovery. */ entityType: string; /** * List of Exadata Release versions to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ exadataReleases: string[]; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated resources to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Specified resources must match the specified 'entityType'. FsuCollection of type 'GI' or 'GUEST_OS' can be specified. */ identifiers: string[]; /** * INCLUDE or EXCLUDE the filter results when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Supported only for RESOURCE_ID filter. */ mode: string; /** * Type of join for each element in this filter. */ operator: string; /** * [Free-form tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm) to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ tags: outputs.FleetSoftwareUpdate.FsuCollectionComponentFleetDiscoveryFilterTag[]; /** * Filters supported for searching Exadata VM Cluster targets for a 'GUEST_OS' collection. */ type: string; /** * List of Exadata Image (Guest OS) version strings to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ versions: string[]; } interface FsuCollectionComponentFleetDiscoveryFilterTag { /** * Freeform tag key. */ key: string; /** * Defined tag namespace. */ namespace: string; /** * Freeform tag value. */ value: string; } interface FsuCollectionFleetDiscovery { /** * Filters to perform the target discovery. */ filters: outputs.FleetSoftwareUpdate.FsuCollectionFleetDiscoveryFilter[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Discovery. */ fsuDiscoveryId: string; /** * [OCI Search Service](https://docs.cloud.oracle.com/iaas/Content/Search/Concepts/queryoverview.htm) query string. */ query: string; /** * Supported fleet discovery strategies. */ strategy: string; /** * OCIDs of target resources to include. For EXACC service type Collections only VMClusters are allowed. For EXACS service type Collections only CloudVMClusters are allowed. For EXA-DB-XS service type Collections only ExaDBVMClusters are allowed. */ targets: string[]; } interface FsuCollectionFleetDiscoveryFilter { /** * Type of resource to match in the discovery. */ entityType: string; /** * List of Exadata Release versions to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ exadataReleases: string[]; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated resources to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Specified resources must match the specified 'entityType'. FsuCollection of type 'GI' or 'GUEST_OS' can be specified. */ identifiers: string[]; /** * INCLUDE or EXCLUDE the filter results when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Supported only for RESOURCE_ID filter. */ mode: string; /** * List of Database unique names to include in the discovery. */ names: string[]; /** * Type of join for each element in this filter. */ operator: string; /** * [Free-form tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm) to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ tags: outputs.FleetSoftwareUpdate.FsuCollectionFleetDiscoveryFilterTag[]; /** * Filters supported for searching Exadata VM Cluster targets for a 'GUEST_OS' collection. */ type: string; /** * List of Exadata Image (Guest OS) version strings to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ versions: string[]; } interface FsuCollectionFleetDiscoveryFilterTag { /** * Freeform tag key. */ key: string; /** * Defined tag namespace. */ namespace: string; /** * Freeform tag value. */ value: string; } interface FsuCycleApplyActionSchedule { /** * The date and time the Exadata Fleet Update Action is expected to start. [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeToStart: string; /** * Type of scheduling strategy to use for Fleet Patching Update Action execution. */ type: string; } interface FsuCycleBatchingStrategy { /** * (Updatable) True to force rolling patching. */ isForceRolling: boolean; /** * (Updatable) True to wait for customer to resume the Apply Action once the first half is done. False to automatically patch the second half. */ isWaitForBatchResume: boolean; /** * (Updatable) Percentage of availability in the service during the Patch operation. */ percentage: number; /** * (Updatable) Supported batching strategies. */ type: string; } interface FsuCycleDiagnosticsCollection { /** * (Updatable) Enable incident logs and trace collection. Allow Oracle to collect incident logs and traces to enable fault diagnosis and issue resolution according to the selected mode. */ logCollectionMode: string; } interface FsuCycleGoalVersionDetails { /** * (Updatable) Details of goal versions for components in an Exadata software stack. */ components: outputs.FleetSoftwareUpdate.FsuCycleGoalVersionDetailsComponent[]; /** * (Updatable) Goal home policy to use when Staging the Goal Version during patching. CREATE_NEW: Create a new DBHome (for Database Collections) for the specified image or version. USE_EXISTING: All database targets in the same VMCluster or CloudVmCluster will be moved to a shared database home. If an existing home for the selected image or version is not found in the VM Cluster for a target database, then a new home will be created. If more than one existing home for the selected image is found, then the home with the least number of databases will be used. If multiple homes have the least number of databases, then a home will be selected at random. */ homePolicy: string; /** * (Updatable) Prefix name used for new DB home resources created as part of the Stage Action. Format: _ If not specified, a default Oracle Cloud Infrastructure DB home resource will be generated for the new DB home resources created. */ newHomePrefix: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the goal database software image. */ softwareImageId: string; /** * (Updatable) Type of goal version specified */ type: string; /** * (Updatable) Goal version string for the Exadata Fleet Update Cycle. Applicable to Database, Grid Infrastructure, or Exadata Image software updates. */ version: string; } interface FsuCycleGoalVersionDetailsComponent { /** * (Updatable) Type of component in an Exadata software stack. */ componentType: string; /** * (Updatable) Details of goal 'GUEST_OS' software version. */ goalVersionDetails: outputs.FleetSoftwareUpdate.FsuCycleGoalVersionDetailsComponentGoalVersionDetails; /** * (Updatable) Goal home policy to use when Staging the Goal Version during patching. CREATE_NEW: Create a new DBHome (for Database Collections) for the specified image or version. USE_EXISTING: All database targets in the same VMCluster or CloudVmCluster will be moved to a shared database home. If an existing home for the selected image or version is not found in the VM Cluster for a target database, then a new home will be created. If more than one existing home for the selected image is found, then the home with the least number of databases will be used. If multiple homes have the least number of databases, then a home will be selected at random. */ homePolicy: string; /** * (Updatable) Prefix name used for new DB home resources created as part of the Stage Action. Format: _ If not specified, a default Oracle Cloud Infrastructure DB home resource will be generated for the new DB home resources created. */ newHomePrefix: string; } interface FsuCycleGoalVersionDetailsComponentGoalVersionDetails { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom 'GI' software image. */ goalSoftwareImageId: string; /** * (Updatable) Preference to use an Oracle released 'GI' software image or a custom 'GI' software image. */ goalType: string; /** * (Updatable) Goal version string matching an Oracle released 'GUEST_OS' software image. */ goalVersion: string; } interface FsuCycleNextActionToExecute { /** * The date and time the Exadata Fleet Update Action is expected to start. [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeToStart: string; /** * (Updatable) Type of Exadata Fleet Update Cycle. */ type: string; } interface FsuCycleStageActionSchedule { /** * The date and time the Exadata Fleet Update Action is expected to start. [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeToStart: string; /** * Type of scheduling strategy to use for Fleet Patching Update Action execution. */ type: string; } interface FsuCycleUpgradeDetails { /** * (Updatable) Type of Exadata Fleet Update collection being upgraded. */ collectionType: string; /** * (Updatable) Ignore errors during post Oracle Grid Infrastructure upgrade Cluster Verification Utility (CVU) check. */ isIgnorePostUpgradeErrors: boolean; /** * (Updatable) Ignore the Cluster Verification Utility (CVU) prerequisite checks. */ isIgnorePrerequisites: boolean; /** * (Updatable) Enables or disables the recompilation of invalid objects. */ isRecompileInvalidObjects: boolean; /** * (Updatable) Enables or disables time zone upgrade. */ isTimeZoneUpgrade: boolean; /** * (Updatable) Service drain timeout specified in seconds. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ maxDrainTimeoutInSeconds: number; } interface FsuReadinessCheckIssue { /** * Description of the patching issue. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource impacted by the patching issue. */ impactedResourceId: string; /** * Name of the patching issue. */ name: string; /** * Recommended action to perform to address or further triage the patching issue. */ recommendedAction: string; } interface FsuReadinessCheckTarget { /** * Resource identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ entityId: string; /** * Resource entity type */ entityType: string; } interface GetFsuCollectionActiveFsuCycle { /** * The user-friendly name for the Exadata Fleet Update Collection. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Collection. */ id: string; } interface GetFsuCollectionComponent { /** * Type of component in an Exadata software stack. */ componentType: string; /** * Fleet discovery strategies for a 'GUEST_OS' collection of Exadata VM Clusters. If specified for an UpdateCollection request, discovery for Exadata VM Clusters will be rerun. */ fleetDiscoveries: outputs.FleetSoftwareUpdate.GetFsuCollectionComponentFleetDiscovery[]; /** * Major version of Exadata Image (Guest OS) release for Exadata VM Cluster targets to be included in the Exadata Fleet Update Collection. Only Exadata VM Clusters whose 'systemVersion' is related to the major version will be added to the Exadata Fleet Update Collection. For more details, refer to [Oracle document 2075007.1](https://support.oracle.com/knowledge/Oracle%20Database%20Products/2075007_1.html) */ sourceMajorVersion: string; } interface GetFsuCollectionComponentFleetDiscovery { /** * Filters to perform the target discovery. */ filters: outputs.FleetSoftwareUpdate.GetFsuCollectionComponentFleetDiscoveryFilter[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Discovery. */ fsuDiscoveryId: string; /** * [OCI Search Service](https://docs.cloud.oracle.com/iaas/Content/Search/Concepts/queryoverview.htm) query string. */ query: string; /** * Supported fleet discovery strategies. */ strategy: string; /** * OCIDs of target resources to include. For EXACC service type Collections only VMClusters are allowed. For EXACS service type Collections only CloudVMClusters are allowed. For EXA-DB-XS service type Collections only ExaDBVMClusters are allowed. */ targets: string[]; } interface GetFsuCollectionComponentFleetDiscoveryFilter { /** * Type of resource to match in the discovery. */ entityType: string; /** * List of Exadata Release versions to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ exadataReleases: string[]; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated resources to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Specified resources must match the specified 'entityType'. FsuCollection of type 'GI' or 'GUEST_OS' can be specified. */ identifiers: string[]; /** * INCLUDE or EXCLUDE the filter results when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Supported only for RESOURCE_ID filter. */ mode: string; /** * Type of join for each element in this filter. */ operator: string; /** * [Free-form tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm) to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ tags: outputs.FleetSoftwareUpdate.GetFsuCollectionComponentFleetDiscoveryFilterTag[]; /** * Exadata Fleet Update Collection type. */ type: string; /** * List of Exadata Image (Guest OS) version strings to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ versions: string[]; } interface GetFsuCollectionComponentFleetDiscoveryFilterTag { /** * Freeform tag key. */ key: string; /** * Defined tag namespace. */ namespace: string; /** * Freeform tag value. */ value: string; } interface GetFsuCollectionFleetDiscovery { /** * Filters to perform the target discovery. */ filters: outputs.FleetSoftwareUpdate.GetFsuCollectionFleetDiscoveryFilter[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Discovery. */ fsuDiscoveryId: string; /** * [OCI Search Service](https://docs.cloud.oracle.com/iaas/Content/Search/Concepts/queryoverview.htm) query string. */ query: string; /** * Supported fleet discovery strategies. */ strategy: string; /** * OCIDs of target resources to include. For EXACC service type Collections only VMClusters are allowed. For EXACS service type Collections only CloudVMClusters are allowed. For EXA-DB-XS service type Collections only ExaDBVMClusters are allowed. */ targets: string[]; } interface GetFsuCollectionFleetDiscoveryFilter { /** * Type of resource to match in the discovery. */ entityType: string; /** * List of Exadata Release versions to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ exadataReleases: string[]; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated resources to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Specified resources must match the specified 'entityType'. FsuCollection of type 'GI' or 'GUEST_OS' can be specified. */ identifiers: string[]; /** * INCLUDE or EXCLUDE the filter results when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Supported only for RESOURCE_ID filter. */ mode: string; /** * List of Database unique names to include in the discovery. */ names: string[]; /** * Type of join for each element in this filter. */ operator: string; /** * [Free-form tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm) to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ tags: outputs.FleetSoftwareUpdate.GetFsuCollectionFleetDiscoveryFilterTag[]; /** * Exadata Fleet Update Collection type. */ type: string; /** * List of Exadata Image (Guest OS) version strings to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ versions: string[]; } interface GetFsuCollectionFleetDiscoveryFilterTag { /** * Freeform tag key. */ key: string; /** * Defined tag namespace. */ namespace: string; /** * Freeform tag value. */ value: string; } interface GetFsuCollectionsFilter { name: string; regex?: boolean; values: string[]; } interface GetFsuCollectionsFsuCollectionSummaryCollection { items: outputs.FleetSoftwareUpdate.GetFsuCollectionsFsuCollectionSummaryCollectionItem[]; } interface GetFsuCollectionsFsuCollectionSummaryCollectionItem { /** * Active Exadata Fleet Update Cycle resource for this Collection. Object would be null if there is no active Cycle. */ activeFsuCycles: outputs.FleetSoftwareUpdate.GetFsuCollectionsFsuCollectionSummaryCollectionItemActiveFsuCycle[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Details of components in an Exadata software stack. */ components: outputs.FleetSoftwareUpdate.GetFsuCollectionsFsuCollectionSummaryCollectionItemComponent[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Fleet discovery strategies for a 'GUEST_OS' collection of Exadata VM Clusters. If specified for an UpdateCollection request, discovery for Exadata VM Clusters will be rerun. */ fleetDiscoveries: outputs.FleetSoftwareUpdate.GetFsuCollectionsFsuCollectionSummaryCollectionItemFleetDiscovery[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Collection. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of last completed FSU Cycle. */ lastCompletedFsuCycleId: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Exadata service type for the target resource members. */ serviceType: string; /** * Major version of Exadata Image (Guest OS) release for Exadata VM Cluster targets to be included in the Exadata Fleet Update Collection. Only Exadata VM Clusters whose 'systemVersion' is related to the major version will be added to the Exadata Fleet Update Collection. For more details, refer to [Oracle document 2075007.1](https://support.oracle.com/knowledge/Oracle%20Database%20Products/2075007_1.html) */ sourceMajorVersion: string; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Number of targets that are members of this Collection. */ targetCount: number; /** * The time the Exadata Fleet Update Collection was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the Exadata Fleet Update Collection was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return only resources whose type matches the given type. */ type: string; } interface GetFsuCollectionsFsuCollectionSummaryCollectionItemActiveFsuCycle { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Collection. */ id: string; } interface GetFsuCollectionsFsuCollectionSummaryCollectionItemComponent { /** * Type of component in an Exadata software stack. */ componentType: string; /** * Fleet discovery strategies for a 'GUEST_OS' collection of Exadata VM Clusters. If specified for an UpdateCollection request, discovery for Exadata VM Clusters will be rerun. */ fleetDiscoveries: outputs.FleetSoftwareUpdate.GetFsuCollectionsFsuCollectionSummaryCollectionItemComponentFleetDiscovery[]; /** * Major version of Exadata Image (Guest OS) release for Exadata VM Cluster targets to be included in the Exadata Fleet Update Collection. Only Exadata VM Clusters whose 'systemVersion' is related to the major version will be added to the Exadata Fleet Update Collection. For more details, refer to [Oracle document 2075007.1](https://support.oracle.com/knowledge/Oracle%20Database%20Products/2075007_1.html) */ sourceMajorVersion: string; } interface GetFsuCollectionsFsuCollectionSummaryCollectionItemComponentFleetDiscovery { /** * Filters to perform the target discovery. */ filters: outputs.FleetSoftwareUpdate.GetFsuCollectionsFsuCollectionSummaryCollectionItemComponentFleetDiscoveryFilter[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Discovery. */ fsuDiscoveryId: string; /** * [OCI Search Service](https://docs.cloud.oracle.com/iaas/Content/Search/Concepts/queryoverview.htm) query string. */ query: string; /** * Supported fleet discovery strategies. */ strategy: string; /** * OCIDs of target resources to include. For EXACC service type Collections only VMClusters are allowed. For EXACS service type Collections only CloudVMClusters are allowed. For EXA-DB-XS service type Collections only ExaDBVMClusters are allowed. */ targets: string[]; } interface GetFsuCollectionsFsuCollectionSummaryCollectionItemComponentFleetDiscoveryFilter { /** * Type of resource to match in the discovery. */ entityType: string; /** * List of Exadata Release versions to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ exadataReleases: string[]; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated resources to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Specified resources must match the specified 'entityType'. FsuCollection of type 'GI' or 'GUEST_OS' can be specified. */ identifiers: string[]; /** * INCLUDE or EXCLUDE the filter results when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Supported only for RESOURCE_ID filter. */ mode: string; /** * Type of join for each element in this filter. */ operator: string; /** * [Free-form tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm) to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ tags: outputs.FleetSoftwareUpdate.GetFsuCollectionsFsuCollectionSummaryCollectionItemComponentFleetDiscoveryFilterTag[]; /** * A filter to return only resources whose type matches the given type. */ type: string; /** * List of Exadata Image (Guest OS) version strings to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ versions: string[]; } interface GetFsuCollectionsFsuCollectionSummaryCollectionItemComponentFleetDiscoveryFilterTag { /** * Freeform tag key. */ key: string; /** * Defined tag namespace. */ namespace: string; /** * Freeform tag value. */ value: string; } interface GetFsuCollectionsFsuCollectionSummaryCollectionItemFleetDiscovery { /** * Filters to perform the target discovery. */ filters: outputs.FleetSoftwareUpdate.GetFsuCollectionsFsuCollectionSummaryCollectionItemFleetDiscoveryFilter[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Discovery. */ fsuDiscoveryId: string; /** * [OCI Search Service](https://docs.cloud.oracle.com/iaas/Content/Search/Concepts/queryoverview.htm) query string. */ query: string; /** * Supported fleet discovery strategies. */ strategy: string; /** * OCIDs of target resources to include. For EXACC service type Collections only VMClusters are allowed. For EXACS service type Collections only CloudVMClusters are allowed. For EXA-DB-XS service type Collections only ExaDBVMClusters are allowed. */ targets: string[]; } interface GetFsuCollectionsFsuCollectionSummaryCollectionItemFleetDiscoveryFilter { /** * Type of resource to match in the discovery. */ entityType: string; /** * List of Exadata Release versions to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ exadataReleases: string[]; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated resources to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Specified resources must match the specified 'entityType'. FsuCollection of type 'GI' or 'GUEST_OS' can be specified. */ identifiers: string[]; /** * INCLUDE or EXCLUDE the filter results when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. Supported only for RESOURCE_ID filter. */ mode: string; /** * List of Database unique names to include in the discovery. */ names: string[]; /** * Type of join for each element in this filter. */ operator: string; /** * [Free-form tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm) to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ tags: outputs.FleetSoftwareUpdate.GetFsuCollectionsFsuCollectionSummaryCollectionItemFleetDiscoveryFilterTag[]; /** * A filter to return only resources whose type matches the given type. */ type: string; /** * List of Exadata Image (Guest OS) version strings to include when discovering Exadata VM Cluster targets for a 'GUEST_OS' collection. */ versions: string[]; } interface GetFsuCollectionsFsuCollectionSummaryCollectionItemFleetDiscoveryFilterTag { /** * Freeform tag key. */ key: string; /** * Defined tag namespace. */ namespace: string; /** * Freeform tag value. */ value: string; } interface GetFsuCycleApplyActionSchedule { /** * The date and time the Exadata Fleet Update Action is expected to start. [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeToStart: string; /** * Type of Exadata Fleet Update Cycle. */ type: string; } interface GetFsuCycleBatchingStrategy { /** * True to force rolling patching. */ isForceRolling: boolean; /** * True to wait for customer to resume the Apply Action once the first half is done. False to automatically patch the second half. */ isWaitForBatchResume: boolean; /** * Percentage of availability in the service during the Patch operation. */ percentage: number; /** * Type of Exadata Fleet Update Cycle. */ type: string; } interface GetFsuCycleDiagnosticsCollection { /** * Enable incident logs and trace collection. Allow Oracle to collect incident logs and traces to enable fault diagnosis and issue resolution according to the selected mode. */ logCollectionMode: string; } interface GetFsuCycleGoalVersionDetail { /** * Details of goal versions for components in an Exadata software stack. */ components: outputs.FleetSoftwareUpdate.GetFsuCycleGoalVersionDetailComponent[]; /** * Goal home policy to use when Staging the Goal Version during patching. CREATE_NEW: Create a new DBHome (for Database Collections) for the specified image or version. USE_EXISTING: All database targets in the same VMCluster or CloudVmCluster will be moved to a shared database home. If an existing home for the selected image or version is not found in the VM Cluster for a target database, then a new home will be created. If more than one existing home for the selected image is found, then the home with the least number of databases will be used. If multiple homes have the least number of databases, then a home will be selected at random. */ homePolicy: string; /** * Prefix name used for new DB home resources created as part of the Stage Action. Format: _ If not specified, a default Oracle Cloud Infrastructure DB home resource will be generated for the new DB home resources created. */ newHomePrefix: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the goal database software image. */ softwareImageId: string; /** * Type of Exadata Fleet Update Cycle. */ type: string; /** * Goal version string for the Exadata Fleet Update Cycle. Applicable to Database, Grid Infrastructure, or Exadata Image software updates. */ version: string; } interface GetFsuCycleGoalVersionDetailComponent { /** * Type of component in an Exadata software stack. */ componentType: string; /** * Details of goal 'GUEST_OS' software version. */ goalVersionDetails: outputs.FleetSoftwareUpdate.GetFsuCycleGoalVersionDetailComponentGoalVersionDetail[]; /** * Goal home policy to use when Staging the Goal Version during patching. CREATE_NEW: Create a new DBHome (for Database Collections) for the specified image or version. USE_EXISTING: All database targets in the same VMCluster or CloudVmCluster will be moved to a shared database home. If an existing home for the selected image or version is not found in the VM Cluster for a target database, then a new home will be created. If more than one existing home for the selected image is found, then the home with the least number of databases will be used. If multiple homes have the least number of databases, then a home will be selected at random. */ homePolicy: string; /** * Prefix name used for new DB home resources created as part of the Stage Action. Format: _ If not specified, a default Oracle Cloud Infrastructure DB home resource will be generated for the new DB home resources created. */ newHomePrefix: string; } interface GetFsuCycleGoalVersionDetailComponentGoalVersionDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom 'GI' software image. */ goalSoftwareImageId: string; /** * Preference to use an Oracle released 'GI' software image or a custom 'GI' software image. */ goalType: string; /** * Goal version string matching an Oracle released 'GUEST_OS' software image. */ goalVersion: string; } interface GetFsuCycleNextActionToExecute { /** * The date and time the Exadata Fleet Update Action is expected to start. [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeToStart: string; /** * Type of Exadata Fleet Update Cycle. */ type: string; } interface GetFsuCycleStageActionSchedule { /** * The date and time the Exadata Fleet Update Action is expected to start. [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeToStart: string; /** * Type of Exadata Fleet Update Cycle. */ type: string; } interface GetFsuCycleUpgradeDetail { /** * Type of Exadata Fleet Update collection being upgraded. */ collectionType: string; /** * Ignore errors during post Oracle Grid Infrastructure upgrade Cluster Verification Utility (CVU) check. */ isIgnorePostUpgradeErrors: boolean; /** * Ignore the Cluster Verification Utility (CVU) prerequisite checks. */ isIgnorePrerequisites: boolean; /** * Enables or disables the recompilation of invalid objects. */ isRecompileInvalidObjects: boolean; /** * Enables or disables time zone upgrade. */ isTimeZoneUpgrade: boolean; /** * Service drain timeout specified in seconds. */ maxDrainTimeoutInSeconds: number; } interface GetFsuCyclesFilter { name: string; regex?: boolean; values: string[]; } interface GetFsuCyclesFsuCycleSummaryCollection { items: outputs.FleetSoftwareUpdate.GetFsuCyclesFsuCycleSummaryCollectionItem[]; } interface GetFsuCyclesFsuCycleSummaryCollectionItem { /** * Scheduling related details for the Exadata Fleet Update Action. The specified time should not conflict with existing Exadata Infrastructure maintenance windows. Null scheduleDetails would execute the Exadata Fleet Update Action as soon as possible. */ applyActionSchedules: outputs.FleetSoftwareUpdate.GetFsuCyclesFsuCycleSummaryCollectionItemApplyActionSchedule[]; /** * Batching strategy details to use during PRECHECK and APPLY Cycle Actions. */ batchingStrategies: outputs.FleetSoftwareUpdate.GetFsuCyclesFsuCycleSummaryCollectionItemBatchingStrategy[]; /** * A filter to return only resources whose Collection type matches the given type. */ collectionType: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Details to configure diagnostics collection for targets affected by this Exadata Fleet Update Maintenance Cycle. */ diagnosticsCollections: outputs.FleetSoftwareUpdate.GetFsuCyclesFsuCycleSummaryCollectionItemDiagnosticsCollection[]; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Action that is currently in progress, if applicable. */ executingFsuActionId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only resources whose fsuCollectionId matches the given fsuCollectionId. */ fsuCollectionId: string; /** * Details of goal 'GUEST_OS' software version. */ goalVersionDetails: outputs.FleetSoftwareUpdate.GetFsuCyclesFsuCycleSummaryCollectionItemGoalVersionDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Cycle. */ id: string; /** * List of identifiers of patches to ignore. This attribute will be ignored for Exadata Image (Guest OS) maintenance update. */ isIgnoreMissingPatches: string[]; /** * Ignore patch conflicts or missing patches between the source and goal homes. This attribute will be ignored for Exadata Image (Guest OS) maintenance update. */ isIgnorePatches: boolean; /** * Ensure that database services are online on the same VMs before and after the maintenance update. */ isKeepPlacement: boolean; /** * The latest Action type that was completed in the Exadata Fleet Update Cycle. No value would indicate that the Cycle has not completed any Action yet. */ lastCompletedAction: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the latest Action in the Exadata Fleet Update Cycle. */ lastCompletedActionId: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Service drain timeout specified in seconds. */ maxDrainTimeoutInSeconds: number; /** * All possible Exadata Fleet Update Actions will be listed. The first element is the suggested Exadata Fleet Update Action. */ nextActionToExecutes: outputs.FleetSoftwareUpdate.GetFsuCyclesFsuCycleSummaryCollectionItemNextActionToExecute[]; /** * Current rollback cycle state if rollback maintenance cycle action has been attempted. No value would indicate that the Cycle has not run a rollback maintenance cycle action before. */ rollbackCycleState: string; /** * Scheduling related details for the Exadata Fleet Update Action. The specified time should not conflict with existing Exadata Infrastructure maintenance windows. Null scheduleDetails would execute the Exadata Fleet Update Action as soon as possible. */ stageActionSchedules: outputs.FleetSoftwareUpdate.GetFsuCyclesFsuCycleSummaryCollectionItemStageActionSchedule[]; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Exadata Fleet Update Cycle was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeCreated: string; /** * The date and time the Exadata Fleet Update Cycle was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeFinished: string; /** * The date and time the Exadata Fleet Update Cycle was updated, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeUpdated: string; /** * Type of Exadata Fleet Update Cycle. */ type: string; /** * Details of supported upgrade options for DB or GI collection. */ upgradeDetails: outputs.FleetSoftwareUpdate.GetFsuCyclesFsuCycleSummaryCollectionItemUpgradeDetail[]; } interface GetFsuCyclesFsuCycleSummaryCollectionItemApplyActionSchedule { /** * The date and time the Exadata Fleet Update Action is expected to start. [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeToStart: string; /** * Type of Exadata Fleet Update Cycle. */ type: string; } interface GetFsuCyclesFsuCycleSummaryCollectionItemBatchingStrategy { /** * True to force rolling patching. */ isForceRolling: boolean; /** * True to wait for customer to resume the Apply Action once the first half is done. False to automatically patch the second half. */ isWaitForBatchResume: boolean; /** * Percentage of availability in the service during the Patch operation. */ percentage: number; /** * Type of Exadata Fleet Update Cycle. */ type: string; } interface GetFsuCyclesFsuCycleSummaryCollectionItemDiagnosticsCollection { /** * Enable incident logs and trace collection. Allow Oracle to collect incident logs and traces to enable fault diagnosis and issue resolution according to the selected mode. */ logCollectionMode: string; } interface GetFsuCyclesFsuCycleSummaryCollectionItemGoalVersionDetail { /** * Details of goal versions for components in an Exadata software stack. */ components: outputs.FleetSoftwareUpdate.GetFsuCyclesFsuCycleSummaryCollectionItemGoalVersionDetailComponent[]; /** * Goal home policy to use when Staging the Goal Version during patching. CREATE_NEW: Create a new DBHome (for Database Collections) for the specified image or version. USE_EXISTING: All database targets in the same VMCluster or CloudVmCluster will be moved to a shared database home. If an existing home for the selected image or version is not found in the VM Cluster for a target database, then a new home will be created. If more than one existing home for the selected image is found, then the home with the least number of databases will be used. If multiple homes have the least number of databases, then a home will be selected at random. */ homePolicy: string; /** * Prefix name used for new DB home resources created as part of the Stage Action. Format: _ If not specified, a default Oracle Cloud Infrastructure DB home resource will be generated for the new DB home resources created. */ newHomePrefix: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the goal database software image. */ softwareImageId: string; /** * Type of Exadata Fleet Update Cycle. */ type: string; /** * Goal version string for the Exadata Fleet Update Cycle. Applicable to Database, Grid Infrastructure, or Exadata Image software updates. */ version: string; } interface GetFsuCyclesFsuCycleSummaryCollectionItemGoalVersionDetailComponent { /** * Type of component in an Exadata software stack. */ componentType: string; /** * Details of goal 'GUEST_OS' software version. */ goalVersionDetails: outputs.FleetSoftwareUpdate.GetFsuCyclesFsuCycleSummaryCollectionItemGoalVersionDetailComponentGoalVersionDetail[]; /** * Goal home policy to use when Staging the Goal Version during patching. CREATE_NEW: Create a new DBHome (for Database Collections) for the specified image or version. USE_EXISTING: All database targets in the same VMCluster or CloudVmCluster will be moved to a shared database home. If an existing home for the selected image or version is not found in the VM Cluster for a target database, then a new home will be created. If more than one existing home for the selected image is found, then the home with the least number of databases will be used. If multiple homes have the least number of databases, then a home will be selected at random. */ homePolicy: string; /** * Prefix name used for new DB home resources created as part of the Stage Action. Format: _ If not specified, a default Oracle Cloud Infrastructure DB home resource will be generated for the new DB home resources created. */ newHomePrefix: string; } interface GetFsuCyclesFsuCycleSummaryCollectionItemGoalVersionDetailComponentGoalVersionDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom 'GI' software image. */ goalSoftwareImageId: string; /** * Preference to use an Oracle released 'GI' software image or a custom 'GI' software image. */ goalType: string; /** * Goal version string matching an Oracle released 'GUEST_OS' software image. */ goalVersion: string; } interface GetFsuCyclesFsuCycleSummaryCollectionItemNextActionToExecute { /** * The date and time the Exadata Fleet Update Action is expected to start. [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeToStart: string; /** * Type of Exadata Fleet Update Cycle. */ type: string; } interface GetFsuCyclesFsuCycleSummaryCollectionItemStageActionSchedule { /** * The date and time the Exadata Fleet Update Action is expected to start. [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeToStart: string; /** * Type of Exadata Fleet Update Cycle. */ type: string; } interface GetFsuCyclesFsuCycleSummaryCollectionItemUpgradeDetail { /** * A filter to return only resources whose Collection type matches the given type. */ collectionType: string; /** * Ignore errors during post Oracle Grid Infrastructure upgrade Cluster Verification Utility (CVU) check. */ isIgnorePostUpgradeErrors: boolean; /** * Ignore the Cluster Verification Utility (CVU) prerequisite checks. */ isIgnorePrerequisites: boolean; /** * Enables or disables the recompilation of invalid objects. */ isRecompileInvalidObjects: boolean; /** * Enables or disables time zone upgrade. */ isTimeZoneUpgrade: boolean; /** * Service drain timeout specified in seconds. */ maxDrainTimeoutInSeconds: number; } interface GetFsuReadinessCheckIssue { /** * Description of the patching issue. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource impacted by the patching issue. */ impactedResourceId: string; /** * Name of the patching issue. */ name: string; /** * Recommended action to perform to address or further triage the patching issue. */ recommendedAction: string; } interface GetFsuReadinessCheckTarget { /** * Resource identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ entityId: string; /** * Resource entity type */ entityType: string; } interface GetFsuReadinessChecksFilter { /** * Name of the patching issue. */ name: string; regex?: boolean; values: string[]; } interface GetFsuReadinessChecksFsuReadinessCheckCollection { items: outputs.FleetSoftwareUpdate.GetFsuReadinessChecksFsuReadinessCheckCollectionItem[]; } interface GetFsuReadinessChecksFsuReadinessCheckCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Fleet Update Readiness Check. */ id: string; /** * Number of issues found during the Exadata Fleet Update Readiness Check run. */ issueCount: number; /** * Issues found during the Exadata Fleet Update Readiness Check run. */ issues: outputs.FleetSoftwareUpdate.GetFsuReadinessChecksFsuReadinessCheckCollectionItemIssue[]; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter to return only resources whose lifecycleState matches the specified lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * List of targets that will run the Exadata Fleet Update Readiness Check. The targets have to be of the same entity type. */ targets: outputs.FleetSoftwareUpdate.GetFsuReadinessChecksFsuReadinessCheckCollectionItemTarget[]; /** * The date and time the Exadata Fleet Update Readiness Check was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeCreated: string; /** * The date and time the Exadata Fleet Update Readiness Check was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeFinished: string; /** * The date and time the Exadata Fleet Update Readiness Check was updated, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeUpdated: string; /** * A filter to return only resources whose type matches the specified type. */ type: string; } interface GetFsuReadinessChecksFsuReadinessCheckCollectionItemIssue { /** * Description of the patching issue. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource impacted by the patching issue. */ impactedResourceId: string; /** * Name of the patching issue. */ name: string; /** * Recommended action to perform to address or further triage the patching issue. */ recommendedAction: string; } interface GetFsuReadinessChecksFsuReadinessCheckCollectionItemTarget { /** * Resource identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ entityId: string; /** * Resource entity type */ entityType: string; } } export declare namespace Functions { interface ApplicationImagePolicyConfig { /** * (Updatable) Define if image signature verification policy is enabled for the application. */ isPolicyEnabled: boolean; /** * (Updatable) A list of KMS key details. */ keyDetails: outputs.Functions.ApplicationImagePolicyConfigKeyDetail[]; } interface ApplicationImagePolicyConfigKeyDetail { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the KMS key that will be used to verify the image signature. */ kmsKeyId: string; } interface ApplicationLogging { /** * (Updatable) Specify the format of log lines emitted by functions in this application. */ lineFormat: string; } interface ApplicationTraceConfig { /** * (Updatable) The OCID of the collector (e.g. an APM Domain) trace events will be sent to. */ domainId: string; /** * (Updatable) Define if tracing is enabled for the resource. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ isEnabled: boolean; } interface FunctionFailureDestination { /** * (Updatable) The ID of the channel in the queue. */ channelId: string; /** * (Updatable) The type of destination for the response to a failed detached function invocation. */ kind: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue. */ queueId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId: string; } interface FunctionProvisionedConcurrencyConfig { /** * (Updatable) Configuration specifying a constant amount of provisioned concurrency. */ count: number; /** * (Updatable) The strategy for provisioned concurrency to be used. */ strategy: string; } interface FunctionSourceDetails { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PbfListing this function is sourced from. */ pbfListingId: string; /** * Type of the Function Source. Possible values: PBF. */ sourceType: string; } interface FunctionSuccessDestination { /** * (Updatable) The ID of the channel in the queue. */ channelId: string; /** * (Updatable) The type of destination for the response to a successful detached function invocation. */ kind: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue. */ queueId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId: string; } interface FunctionTraceConfig { /** * (Updatable) Define if tracing is enabled for the resource. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ isEnabled: boolean; } interface GetApplicationImagePolicyConfig { /** * Define if image signature verification policy is enabled for the application. */ isPolicyEnabled: boolean; /** * A list of KMS key details. */ keyDetails: outputs.Functions.GetApplicationImagePolicyConfigKeyDetail[]; } interface GetApplicationImagePolicyConfigKeyDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the KMS key that will be used to verify the image signature. */ kmsKeyId: string; } interface GetApplicationLogging { /** * Specify the format of log lines emitted by functions in this application. */ lineFormat: string; } interface GetApplicationTraceConfig { /** * The OCID of the collector (e.g. an APM Domain) trace events will be sent to. */ domainId: string; /** * Define if tracing is enabled for the resource. */ isEnabled: boolean; } interface GetApplicationsApplication { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this resource belongs. */ compartmentId: string; /** * Application configuration for functions in this application (passed as environment variables). Can be overridden by function configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}` */ config: { [key: string]: string; }; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only applications with display names that match the display name string. Matching is exact. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only applications with the specified OCID. */ id: string; /** * Define the image signature verification policy for an application. */ imagePolicyConfigs: outputs.Functions.GetApplicationsApplicationImagePolicyConfig[]; /** * Set logging configuration for an application. This is only used if Service Logs for the application are enabled in the Oracle Cloud Infrastructure Logging service. */ loggings: outputs.Functions.GetApplicationsApplicationLogging[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to. */ networkSecurityGroupIds: string[]; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * Valid values are `GENERIC_X86`, `GENERIC_ARM` and `GENERIC_X86_ARM`. Default is `GENERIC_X86`. Setting this to `GENERIC_X86`, will run the functions in the application on X86 processor architecture. Setting this to `GENERIC_ARM`, will run the functions in the application on ARM processor architecture. When set to `GENERIC_X86_ARM`, functions in the application are run on either X86 or ARM processor architecture. Accepted values are: `GENERIC_X86`, `GENERIC_ARM`, `GENERIC_X86_ARM` */ shape: string; /** * A filter to return only applications that match the lifecycle state in this parameter. Example: `Creating` */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the subnets in which to run functions in the application. */ subnetIds: string[]; /** * A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls. The syslog URL must be reachable from all of the subnets configured for the application. Note: If you enable the Oracle Cloud Infrastructure Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the Oracle Cloud Infrastructure Logging service, and not to the syslog URL. Example: `tcp://logserver.myserver:1234` */ syslogUrl: string; /** * The time the application was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-09-12T22:47:12.613Z` */ timeCreated: string; /** * The time the application was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-09-12T22:47:12.613Z` */ timeUpdated: string; /** * Define the tracing configuration for an application. */ traceConfigs: outputs.Functions.GetApplicationsApplicationTraceConfig[]; } interface GetApplicationsApplicationImagePolicyConfig { /** * Define if image signature verification policy is enabled for the application. */ isPolicyEnabled: boolean; /** * A list of KMS key details. */ keyDetails: outputs.Functions.GetApplicationsApplicationImagePolicyConfigKeyDetail[]; } interface GetApplicationsApplicationImagePolicyConfigKeyDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the KMS key that will be used to verify the image signature. */ kmsKeyId: string; } interface GetApplicationsApplicationLogging { /** * Specify the format of log lines emitted by functions in this application. */ lineFormat: string; } interface GetApplicationsApplicationTraceConfig { /** * The OCID of the collector (e.g. an APM Domain) trace events will be sent to. */ domainId: string; /** * Define if tracing is enabled for the resource. */ isEnabled: boolean; } interface GetApplicationsFilter { name: string; regex?: boolean; values: string[]; } interface GetFunctionFailureDestination { /** * The ID of the channel in the queue. */ channelId: string; /** * The type of destination for the response to a successful detached function invocation. */ kind: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue. */ queueId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId: string; } interface GetFunctionProvisionedConcurrencyConfig { /** * Configuration specifying a constant amount of provisioned concurrency. */ count: number; /** * The strategy for provisioned concurrency to be used. */ strategy: string; } interface GetFunctionSourceDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PbfListing this function is sourced from. */ pbfListingId: string; /** * Type of the Function Source. Possible values: PRE_BUILT_FUNCTIONS. */ sourceType: string; } interface GetFunctionSuccessDestination { /** * The ID of the channel in the queue. */ channelId: string; /** * The type of destination for the response to a successful detached function invocation. */ kind: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue. */ queueId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId: string; } interface GetFunctionTraceConfig { /** * Define if tracing is enabled for the resource. */ isEnabled: boolean; } interface GetFunctionsFilter { name: string; regex?: boolean; values: string[]; } interface GetFunctionsFunction { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application to which this function belongs. */ applicationId: string; /** * The OCID of the compartment that contains the function. */ compartmentId: string; /** * Function configuration. Overrides application configuration. Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters. Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}` */ config: { [key: string]: string; }; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Timeout for detached function invocations. Value in seconds. Example: `{"detachedModeTimeoutInSeconds": 900}` */ detachedModeTimeoutInSeconds: number; /** * A filter to return only functions with display names that match the display name string. Matching is exact. */ displayName: string; /** * An object that represents the destination to which Oracle Functions will send an invocation record with the details of the error of the failed detached function invocation. A notification is an example of a failure destination. Example: `{"kind": "NOTIFICATION", "topicId": "topic_OCID"}` */ failureDestinations: outputs.Functions.GetFunctionsFunctionFailureDestination[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only functions with the specified OCID. */ id: string; /** * The qualified name of the Docker image to use in the function, including the image tag. The image should be in the Oracle Cloud Infrastructure Registry that is in the same region as the function itself. Example: `phx.ocir.io/ten/functions/function:0.0.1` */ image: string; /** * The image digest for the version of the image that will be pulled when invoking this function. If no value is specified, the digest currently associated with the image in the Oracle Cloud Infrastructure Registry will be used. Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7` */ imageDigest: string; /** * The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached. */ invokeEndpoint: string; /** * Maximum usable memory for the function (MiB). */ memoryInMbs: string; /** * Define the strategy for provisioned concurrency for the function. */ provisionedConcurrencyConfigs: outputs.Functions.GetFunctionsFunctionProvisionedConcurrencyConfig[]; /** * The processor shape (`GENERIC_X86`/`GENERIC_ARM`) on which to run functions in the application, extracted from the image manifest. */ shape: string; /** * The source details for the Function. The function can be created from various sources. */ sourceDetails: outputs.Functions.GetFunctionsFunctionSourceDetail[]; /** * A filter to return only functions that match the lifecycle state in this parameter. Example: `Creating` */ state: string; /** * An object that represents the destination to which Oracle Functions will send an invocation record with the details of the successful detached function invocation. A stream is an example of a success destination. Example: `{"kind": "STREAM", "streamId": "stream_OCID"}` */ successDestinations: outputs.Functions.GetFunctionsFunctionSuccessDestination[]; /** * The time the function was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-09-12T22:47:12.613Z` */ timeCreated: string; /** * The time the function was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-09-12T22:47:12.613Z` */ timeUpdated: string; /** * Timeout for executions of the function. Value in seconds. */ timeoutInSeconds: number; /** * Define the tracing configuration for a function. */ traceConfigs: outputs.Functions.GetFunctionsFunctionTraceConfig[]; } interface GetFunctionsFunctionFailureDestination { /** * The ID of the channel in the queue. */ channelId: string; /** * The type of destination for the response to a successful detached function invocation. */ kind: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue. */ queueId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId: string; } interface GetFunctionsFunctionProvisionedConcurrencyConfig { /** * Configuration specifying a constant amount of provisioned concurrency. */ count: number; /** * The strategy for provisioned concurrency to be used. */ strategy: string; } interface GetFunctionsFunctionSourceDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PbfListing this function is sourced from. */ pbfListingId: string; /** * Type of the Function Source. Possible values: PRE_BUILT_FUNCTIONS. */ sourceType: string; } interface GetFunctionsFunctionSuccessDestination { /** * The ID of the channel in the queue. */ channelId: string; /** * The type of destination for the response to a successful detached function invocation. */ kind: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue. */ queueId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId: string; } interface GetFunctionsFunctionTraceConfig { /** * Define if tracing is enabled for the resource. */ isEnabled: boolean; } interface GetFusionEnvironmentAdditionalEgressRule { /** * A brief description of the access control rule. Avoid entering confidential information. example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.` */ description: string; /** * Specifies the destination CIDR block the port should be opened for. Must be IPv4 only, and cannot be part of any private range from [RFC 1918](https://datatracker.ietf.org/doc/html/rfc1918). */ destinationCidr: string; /** * 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. */ maxDestinationPort: number; /** * The minimum port number, which must not be greater than the maximum port number. */ minDestinationPort: number; } interface GetFusionEnvironmentAdminUserItem { /** * Admin users email address */ emailAddress: string; /** * Admin users first name */ firstName: string; /** * Admin users last name */ lastName: string; /** * Admin username */ username: string; } interface GetFusionEnvironmentAdminUsersAdminUserCollection { /** * A page of AdminUserSummary objects. */ items: outputs.Functions.GetFusionEnvironmentAdminUsersAdminUserCollectionItem[]; } interface GetFusionEnvironmentAdminUsersAdminUserCollectionItem { /** * Admin users email address */ emailAddress: string; /** * Admin users first name */ firstName: string; /** * unique FusionEnvironment identifier */ fusionEnvironmentId: string; id: string; /** * A page of AdminUserSummary objects. */ items: outputs.Functions.GetFusionEnvironmentAdminUsersAdminUserCollectionItemItem[]; /** * Admin users last name */ lastName: string; /** * Admin username */ username: string; } interface GetFusionEnvironmentAdminUsersAdminUserCollectionItemItem { /** * Admin users email address */ emailAddress: string; /** * Admin users first name */ firstName: string; /** * Admin users last name */ lastName: string; /** * Admin username */ username: string; } interface GetFusionEnvironmentAdminUsersFilter { name: string; regex?: boolean; values: string[]; } interface GetFusionEnvironmentCreateFusionEnvironmentAdminUserDetail { emailAddress: string; firstName: string; lastName: string; username: string; } interface GetFusionEnvironmentDataMaskingActivitiesDataMaskingActivityCollection { items: outputs.Functions.GetFusionEnvironmentDataMaskingActivitiesDataMaskingActivityCollectionItem[]; } interface GetFusionEnvironmentDataMaskingActivitiesDataMaskingActivityCollectionItem { /** * unique FusionEnvironment identifier */ fusionEnvironmentId: string; /** * Unique identifier that is immutable on creation. */ id: string; isResumeDataMasking: boolean; /** * A filter that returns all resources that match the specified status */ state: string; /** * The time the data masking activity ended. An RFC3339 formatted datetime string. */ timeMaskingFinish: string; /** * The time the data masking activity started. An RFC3339 formatted datetime string. */ timeMaskingStart: string; } interface GetFusionEnvironmentDataMaskingActivitiesFilter { name: string; regex?: boolean; values: string[]; } interface GetFusionEnvironmentFamiliesFilter { name: string; regex?: boolean; values: string[]; } interface GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollection { items: outputs.Functions.GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItem[]; } interface GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see [Understanding Environment Maintenance](https://docs.cloud.oracle.com/iaas/Content/fusion-applications/plan-environment-family.htm#about-env-maintenance). */ familyMaintenancePolicies: outputs.Functions.GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The unique identifier (OCID) of the environment family. Can't be changed after creation. */ id: string; /** * When set to True, a subscription update is required for the environment family. */ isSubscriptionUpdateNeeded: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter that returns all resources that match the specified lifecycle state. */ state: string; /** * The list of the IDs of the applications subscriptions that are associated with the environment family. */ subscriptionIds: string[]; /** * Environment Specific Guid/ System Name */ systemName: string; /** * The time the the FusionEnvironmentFamily was created. An RFC3339 formatted datetime string. */ timeCreated: string; timeUpdated: string; } interface GetFusionEnvironmentFamiliesFusionEnvironmentFamilyCollectionItemFamilyMaintenancePolicy { /** * Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule. */ concurrentMaintenance: string; /** * When True, monthly patching is enabled for the environment family. */ isMonthlyPatchingEnabled: boolean; /** * The quarterly maintenance month group schedule of the Fusion environment family. */ quarterlyUpgradeBeginTimes: string; } interface GetFusionEnvironmentFamilyFamilyMaintenancePolicy { /** * Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule. */ concurrentMaintenance: string; /** * When True, monthly patching is enabled for the environment family. */ isMonthlyPatchingEnabled: boolean; /** * The quarterly maintenance month group schedule of the Fusion environment family. */ quarterlyUpgradeBeginTimes: string; } interface GetFusionEnvironmentFamilyLimitsAndUsageDevelopmentLimitAndUsage { limit: number; /** * The usage of current environment. */ usage: number; } interface GetFusionEnvironmentFamilyLimitsAndUsageProductionLimitAndUsage { limit: number; /** * The usage of current environment. */ usage: number; } interface GetFusionEnvironmentFamilyLimitsAndUsageTestLimitAndUsage { limit: number; /** * The usage of current environment. */ usage: number; } interface GetFusionEnvironmentFamilySubscriptionDetailSubscription { /** * Subscription id. */ classicSubscriptionId: string; /** * OCID of the subscription details for particular root compartment or tenancy. */ id: string; /** * The type of subscription, such as 'CLOUDCM'/'SAAS'/'CRM', etc. */ serviceName: string; /** * Stock keeping unit. */ skuses: outputs.Functions.GetFusionEnvironmentFamilySubscriptionDetailSubscriptionSkus[]; } interface GetFusionEnvironmentFamilySubscriptionDetailSubscriptionSkus { /** * Description of the stock units. */ description: string; /** * Description of the covered product belonging to this Sku. */ licensePartDescription: string; /** * Base metric for billing the service. */ metricName: string; /** * Quantity of the stock units. */ quantity: number; /** * Stock keeping unit id. */ sku: string; } interface GetFusionEnvironmentKmsKeyInfo { activeKeyId: string; activeKeyVersion: string; currentKeyLifecycleState: string; scheduledKeyId: string; scheduledKeyStatus: string; scheduledKeyVersion: string; scheduledLifecycleState: string; } interface GetFusionEnvironmentMaintenancePolicy { /** * User choice to upgrade both production and non-production environments at the same time. Overrides the Fusion environment family setting. */ environmentMaintenanceOverride: string; /** * Whether the Fusion environment will be updated monthly or updated on the quarterly cycle. This setting overrides the monthly patching setting of its Fusion environment family. */ monthlyPatchingOverride: string; /** * Determines the quarterly upgrade begin times (monthly maintenance group schedule ) of the Fusion environment. */ quarterlyUpgradeBeginTimes: outputs.Functions.GetFusionEnvironmentMaintenancePolicyQuarterlyUpgradeBeginTime[]; } interface GetFusionEnvironmentMaintenancePolicyQuarterlyUpgradeBeginTime { /** * The frequency and month when maintenance occurs for the Fusion environment. */ beginTimesValue: string; /** * Determines if the maintenance schedule of the Fusion environment is inherited from the Fusion environment family. */ overrideType: string; } interface GetFusionEnvironmentRefresh { /** * The source environment id for the last refresh */ sourceFusionEnvironmentId: string; /** * The time of when the last refresh finish */ timeFinished: string; /** * The point of time of the latest DB backup for the last refresh */ timeOfRestorationPoint: string; } interface GetFusionEnvironmentRefreshActivitiesFilter { name: string; regex?: boolean; values: string[]; } interface GetFusionEnvironmentRefreshActivitiesRefreshActivityCollection { items: outputs.Functions.GetFusionEnvironmentRefreshActivitiesRefreshActivityCollectionItem[]; } interface GetFusionEnvironmentRefreshActivitiesRefreshActivityCollectionItem { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * unique FusionEnvironment identifier */ fusionEnvironmentId: string; /** * The unique identifier (OCID) of the refresh activity. Can't be changed after creation. */ id: string; /** * Represents if the customer opted for Data Masking or not during refreshActivity. */ isDataMaskingOpted: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; refreshActivityId: string; /** * Details of refresh investigation information, each item represents a different issue. */ refreshIssueDetailsLists: outputs.Functions.GetFusionEnvironmentRefreshActivitiesRefreshActivityCollectionItemRefreshIssueDetailsList[]; /** * Service availability / impact during refresh activity execution up down */ serviceAvailability: string; /** * The OCID of the Fusion environment that is the source environment for the refresh. */ sourceFusionEnvironmentId: string; /** * A filter that returns all resources that match the specified status */ state: string; /** * The time the refresh activity record was created. An RFC3339 formatted datetime string. */ timeAccepted: string; /** * The time the refresh activity is scheduled to end. An RFC3339 formatted datetime string. */ timeExpectedFinish: string; /** * The time the refresh activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. */ timeFinished: string; /** * The date and time of the most recent source environment backup used for the environment refresh. */ timeOfRestorationPoint: string; /** * The time the refresh activity record was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetFusionEnvironmentRefreshActivitiesRefreshActivityCollectionItemRefreshIssueDetailsList { /** * Detail reasons of refresh failure or validation failure that needs to be shown to customer. */ refreshIssues: string; } interface GetFusionEnvironmentRefreshActivityRefreshIssueDetailsList { /** * Detail reasons of refresh failure or validation failure that needs to be shown to customer. */ refreshIssues: string; } interface GetFusionEnvironmentRule { /** * Rule type */ action: string; conditions: outputs.Functions.GetFusionEnvironmentRuleCondition[]; /** * A brief description of the access control rule. Avoid entering confidential information. example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.` */ description: string; } interface GetFusionEnvironmentRuleCondition { /** * RuleCondition type */ attributeName: string; /** * The OCID of the originating VCN that an incoming packet must match. You can use this condition in conjunction with `SourceVcnIpAddressCondition`. **NOTE:** If you define this condition for a rule without a `SourceVcnIpAddressCondition`, this condition matches all incoming traffic in the specified VCN. */ attributeValue: string; } interface GetFusionEnvironmentScheduledActivitiesFilter { name: string; regex?: boolean; values: string[]; } interface GetFusionEnvironmentScheduledActivitiesScheduledActivityCollection { items: outputs.Functions.GetFusionEnvironmentScheduledActivitiesScheduledActivityCollectionItem[]; } interface GetFusionEnvironmentScheduledActivitiesScheduledActivityCollectionItem { /** * List of actions */ actions: outputs.Functions.GetFusionEnvironmentScheduledActivitiesScheduledActivityCollectionItemAction[]; /** * Cumulative delay hours */ delayInHours: number; /** * A filter to return only resources that match the entire display name given. */ displayName: string; freeformTags: { [key: string]: string; }; /** * unique FusionEnvironment identifier */ fusionEnvironmentId: string; /** * Unique identifier that is immutable on creation. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter that returns all resources that match the specified run cycle. */ runCycle: string; /** * Service availability / impact during scheduled activity execution up down */ serviceAvailability: string; /** * A filter that returns all resources that match the specified status */ state: string; timeAccepted: string; /** * Current time the scheduled activity is scheduled to end. An RFC3339 formatted datetime string. */ timeExpectedFinish: string; /** * The time the scheduled activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. */ timeFinished: string; /** * Current time the scheduled activity is scheduled to start. An RFC3339 formatted datetime string. */ timeScheduledStart: string; /** * The time the scheduled activity record was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetFusionEnvironmentScheduledActivitiesScheduledActivityCollectionItemAction { /** * Type of action. */ actionType: string; /** * Patch that delivered the Vertex update prerequisite. */ artifact: string; /** * Patch artifact category. */ category: string; /** * A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering confidential information. */ description: string; /** * A string that describes whether the change is applied hot or cold. */ mode: string; /** * Month qualifier. */ qualifier: string; /** * Unique identifier of the object that represents the action. */ referenceKey: string; /** * A filter that returns all resources that match the specified status */ state: string; /** * Name of the repo. */ version: string; } interface GetFusionEnvironmentScheduledActivityAction { /** * Type of action. */ actionType: string; /** * Patch that delivered the Vertex update prerequisite. */ artifact: string; /** * Patch artifact category. */ category: string; /** * A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering confidential information. */ description: string; /** * A string that describes whether the change is applied hot or cold. */ mode: string; /** * Month qualifier. */ qualifier: string; /** * Unique identifier of the object that represents the action. */ referenceKey: string; /** * The current state of the scheduledActivity. */ state: string; /** * Name of the repo. */ version: string; } interface GetFusionEnvironmentServiceAttachmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetFusionEnvironmentServiceAttachmentsServiceAttachmentCollection { items: outputs.Functions.GetFusionEnvironmentServiceAttachmentsServiceAttachmentCollectionItem[]; } interface GetFusionEnvironmentServiceAttachmentsServiceAttachmentCollectionItem { /** * Compartment Identifier */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * unique FusionEnvironment identifier */ fusionEnvironmentId: string; /** * Unique identifier that is immutable on creation */ id: string; /** * Whether this service is provisioned due to the customer being subscribed to a specific SKU */ isSkuBased: boolean; /** * The ID of the service instance created that can be used to identify this on the service control plane */ serviceInstanceId: string; /** * A filter that returns all resources that match the specified lifecycle state. */ serviceInstanceType: string; /** * Public URL */ serviceUrl: string; /** * A filter that returns all resources that match the specified lifecycle state. */ state: string; /** * The time the the ServiceInstance was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the ServiceInstance was updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetFusionEnvironmentTimeAvailableForRefreshItem { /** * refresh time. */ timeAvailableForRefresh: string; } interface GetFusionEnvironmentTimeAvailableForRefreshsFilter { name: string; regex?: boolean; values: string[]; } interface GetFusionEnvironmentTimeAvailableForRefreshsTimeAvailableForRefreshCollection { /** * A list of available refresh time objects. */ items: outputs.Functions.GetFusionEnvironmentTimeAvailableForRefreshsTimeAvailableForRefreshCollectionItem[]; } interface GetFusionEnvironmentTimeAvailableForRefreshsTimeAvailableForRefreshCollectionItem { /** * refresh time. */ timeAvailableForRefresh: string; } interface GetFusionEnvironmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetFusionEnvironmentsFusionEnvironmentCollection { items: outputs.Functions.GetFusionEnvironmentsFusionEnvironmentCollectionItem[]; } interface GetFusionEnvironmentsFusionEnvironmentCollectionItem { /** * Additional egress rules that should be applied to the environment. Some standard ports are open for general use; see [Securing Network Access to a Fusion Applications Environment][iaas/Content/fusion-applications/plan-environment.htm#internet-cache]. If access to a non-standard port is required, however, they can be listed here. */ additionalEgressRules: outputs.Functions.GetFusionEnvironmentsFusionEnvironmentCollectionItemAdditionalEgressRule[]; /** * Language packs */ additionalLanguagePacks: string[]; /** * Patch bundle names */ appliedPatchBundles: string[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; createFusionEnvironmentAdminUserDetails: outputs.Functions.GetFusionEnvironmentsFusionEnvironmentCollectionItemCreateFusionEnvironmentAdminUserDetail[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * DNS prefix */ dnsPrefix: string; /** * The IDCS domain created for the fusion instance */ domainId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The ID of the fusion environment family in which to list resources. */ fusionEnvironmentFamilyId: string; /** * Type of the FusionEnvironment. */ fusionEnvironmentType: string; /** * Unique identifier that is immutable on creation */ id: string; /** * The IDCS Domain URL */ idcsDomainUrl: string; /** * If it's true, then the Break Glass feature is enabled */ isBreakGlassEnabled: boolean; /** * Enable IPv4/IPv6 dual stack support for the environment (where available). Setting to true will assign an IPv6 address to the environment in addition to an IPv4 address. */ isIpv6dualStackEnabled: boolean; /** * BYOK key id */ kmsKeyId: string; /** * BYOK key info */ kmsKeyInfos: outputs.Functions.GetFusionEnvironmentsFusionEnvironmentCollectionItemKmsKeyInfo[]; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * The lockbox Id of this fusion environment. If there's no lockbox id, this field will be null */ lockboxId: string; /** * The policy that specifies the maintenance and upgrade preferences for an environment. For more information about the options, see [Understanding Environment Maintenance](https://docs.cloud.oracle.com/iaas/Content/fusion-applications/plan-environment-family.htm#about-env-maintenance). */ maintenancePolicies: outputs.Functions.GetFusionEnvironmentsFusionEnvironmentCollectionItemMaintenancePolicy[]; /** * Public URL */ publicUrl: string; /** * Describes a refresh of a fusion environment */ refreshes: outputs.Functions.GetFusionEnvironmentsFusionEnvironmentCollectionItemRefresh[]; /** * Network Access Control Rules */ rules: outputs.Functions.GetFusionEnvironmentsFusionEnvironmentCollectionItemRule[]; /** * A filter that returns all resources that match the specified lifecycle state. */ state: string; /** * List of subscription IDs. */ subscriptionIds: string[]; /** * Environment Specific Guid/ System Name */ systemName: string; /** * The time the the FusionEnvironment was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The next maintenance for this environment */ timeUpcomingMaintenance: string; /** * The time the FusionEnvironment was updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * Version of Fusion Apps used by this environment */ version: string; } interface GetFusionEnvironmentsFusionEnvironmentCollectionItemAdditionalEgressRule { /** * A brief description of the access control rule. Avoid entering confidential information. example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.` */ description: string; /** * Specifies the destination CIDR block the port should be opened for. Must be IPv4 only, and cannot be part of any private range from [RFC 1918](https://datatracker.ietf.org/doc/html/rfc1918). */ destinationCidr: string; /** * 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. */ maxDestinationPort: number; /** * The minimum port number, which must not be greater than the maximum port number. */ minDestinationPort: number; } interface GetFusionEnvironmentsFusionEnvironmentCollectionItemCreateFusionEnvironmentAdminUserDetail { emailAddress: string; firstName: string; lastName: string; username: string; } interface GetFusionEnvironmentsFusionEnvironmentCollectionItemKmsKeyInfo { activeKeyId: string; activeKeyVersion: string; currentKeyLifecycleState: string; scheduledKeyId: string; scheduledKeyStatus: string; scheduledKeyVersion: string; scheduledLifecycleState: string; } interface GetFusionEnvironmentsFusionEnvironmentCollectionItemMaintenancePolicy { /** * User choice to upgrade both production and non-production environments at the same time. Overrides the Fusion environment family setting. */ environmentMaintenanceOverride: string; /** * Whether the Fusion environment will be updated monthly or updated on the quarterly cycle. This setting overrides the monthly patching setting of its Fusion environment family. */ monthlyPatchingOverride: string; /** * Determines the quarterly upgrade begin times (monthly maintenance group schedule ) of the Fusion environment. */ quarterlyUpgradeBeginTimes: outputs.Functions.GetFusionEnvironmentsFusionEnvironmentCollectionItemMaintenancePolicyQuarterlyUpgradeBeginTime[]; } interface GetFusionEnvironmentsFusionEnvironmentCollectionItemMaintenancePolicyQuarterlyUpgradeBeginTime { /** * The frequency and month when maintenance occurs for the Fusion environment. */ beginTimesValue: string; /** * Determines if the maintenance schedule of the Fusion environment is inherited from the Fusion environment family. */ overrideType: string; } interface GetFusionEnvironmentsFusionEnvironmentCollectionItemRefresh { /** * The source environment id for the last refresh */ sourceFusionEnvironmentId: string; /** * The time of when the last refresh finish */ timeFinished: string; /** * The point of time of the latest DB backup for the last refresh */ timeOfRestorationPoint: string; } interface GetFusionEnvironmentsFusionEnvironmentCollectionItemRule { /** * Rule type */ action: string; conditions: outputs.Functions.GetFusionEnvironmentsFusionEnvironmentCollectionItemRuleCondition[]; /** * A brief description of the access control rule. Avoid entering confidential information. example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.` */ description: string; } interface GetFusionEnvironmentsFusionEnvironmentCollectionItemRuleCondition { /** * RuleCondition type */ attributeName: string; /** * The OCID of the originating VCN that an incoming packet must match. You can use this condition in conjunction with `SourceVcnIpAddressCondition`. **NOTE:** If you define this condition for a rule without a `SourceVcnIpAddressCondition`, this condition matches all incoming traffic in the specified VCN. */ attributeValue: string; } interface GetPbfListingPublisherDetail { /** * A brief descriptive name for the PBF trigger. */ name: string; } interface GetPbfListingTrigger { /** * A brief descriptive name for the PBF trigger. */ name: string; } interface GetPbfListingTriggersFilter { /** * A filter to return only resources that match the service trigger source of a PBF. */ name: string; regex?: boolean; values: string[]; } interface GetPbfListingTriggersTriggersCollection { /** * List of TriggerSummary. */ items: outputs.Functions.GetPbfListingTriggersTriggersCollectionItem[]; } interface GetPbfListingTriggersTriggersCollectionItem { /** * A filter to return only resources that match the service trigger source of a PBF. */ name: string; } interface GetPbfListingVersionConfig { /** * Details about why this policy is required and what it will be used for. */ description: string; /** * Is this a required config or an optional one. Requests with required config params missing will be rejected. */ isOptional: boolean; /** * The key name of the config param. */ key: string; } interface GetPbfListingVersionRequirement { /** * Minimum memory required by this PBF. The user should use memory greater than or equal to this value while configuring the Function. */ minMemoryRequiredInMbs: string; /** * List of policies required for this PBF execution. */ policies: outputs.Functions.GetPbfListingVersionRequirementPolicy[]; } interface GetPbfListingVersionRequirementPolicy { /** * Details about why this policy is required and what it will be used for. */ description: string; /** * Policy required for PBF execution */ policy: string; } interface GetPbfListingVersionTrigger { /** * A brief descriptive name for the PBF trigger. */ name: string; } interface GetPbfListingVersionsFilter { /** * Matches a PbfListingVersion based on a provided semantic version name for a PbfListingVersion. Each PbfListingVersion name is unique with respect to its associated PbfListing. */ name: string; regex?: boolean; values: string[]; } interface GetPbfListingVersionsPbfListingVersionsCollection { /** * List of PbfListingVersionSummary. */ items: outputs.Functions.GetPbfListingVersionsPbfListingVersionsCollectionItem[]; } interface GetPbfListingVersionsPbfListingVersionsCollectionItem { /** * Details changes are included in this version. */ changeSummary: string; /** * Details about the required and optional Function configurations needed for proper performance of the PBF. */ configs: outputs.Functions.GetPbfListingVersionsPbfListingVersionsCollectionItemConfig[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation */ id: string; /** * Matches a PbfListingVersion based on a provided semantic version name for a PbfListingVersion. Each PbfListingVersion name is unique with respect to its associated PbfListing. */ name: string; /** * unique PbfListing identifier */ pbfListingId: string; /** * Minimum memory required by this PBF. The user should use memory greater than or equal to this value while configuring the Function. */ requirements: outputs.Functions.GetPbfListingVersionsPbfListingVersionsCollectionItemRequirement[]; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the PbfListingVersion was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The last time the PbfListingVersion was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * An array of Trigger. A list of triggers that may activate the PBF. */ triggers: outputs.Functions.GetPbfListingVersionsPbfListingVersionsCollectionItemTrigger[]; } interface GetPbfListingVersionsPbfListingVersionsCollectionItemConfig { /** * Details about why this policy is required and what it will be used for. */ description: string; /** * Is this a required config or an optional one. Requests with required config params missing will be rejected. */ isOptional: boolean; /** * The key name of the config param. */ key: string; } interface GetPbfListingVersionsPbfListingVersionsCollectionItemRequirement { /** * Minimum memory required by this PBF. The user should use memory greater than or equal to this value while configuring the Function. */ minMemoryRequiredInMbs: string; /** * List of policies required for this PBF execution. */ policies: outputs.Functions.GetPbfListingVersionsPbfListingVersionsCollectionItemRequirementPolicy[]; } interface GetPbfListingVersionsPbfListingVersionsCollectionItemRequirementPolicy { /** * Details about why this policy is required and what it will be used for. */ description: string; /** * Policy required for PBF execution */ policy: string; } interface GetPbfListingVersionsPbfListingVersionsCollectionItemTrigger { /** * Matches a PbfListingVersion based on a provided semantic version name for a PbfListingVersion. Each PbfListingVersion name is unique with respect to its associated PbfListing. */ name: string; } interface GetPbfListingsFilter { /** * A filter to return only resources that match the entire PBF name given. */ name: string; regex?: boolean; values: string[]; } interface GetPbfListingsPbfListingsCollection { /** * List of PbfListingSummary. */ items: outputs.Functions.GetPbfListingsPbfListingsCollectionItem[]; } interface GetPbfListingsPbfListingsCollectionItem { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A short overview of the PBF Listing: the purpose of the PBF and and associated information. */ description: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation. */ id: string; /** * A filter to return only resources that match the entire PBF name given. */ name: string; /** * Contains details about the publisher of this PBF Listing. */ publisherDetails: outputs.Functions.GetPbfListingsPbfListingsCollectionItemPublisherDetail[]; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the PbfListing was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The last time the PbfListing was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * An array of Trigger. A list of triggers that may activate the PBF. */ triggers: outputs.Functions.GetPbfListingsPbfListingsCollectionItemTrigger[]; } interface GetPbfListingsPbfListingsCollectionItemPublisherDetail { /** * A filter to return only resources that match the entire PBF name given. */ name: string; } interface GetPbfListingsPbfListingsCollectionItemTrigger { /** * A filter to return only resources that match the entire PBF name given. */ name: string; } } export declare namespace FusionApps { interface FusionEnvironmentAdditionalEgressRule { /** * (Updatable) Rule description. */ description: string; /** * (Updatable) Specifies the destination CIDR block the port should be opened for. Must be IPv4 only, and cannot be part of any private range from [RFC 1918](https://datatracker.ietf.org/doc/html/rfc1918). */ destinationCidr: string; /** * (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. */ maxDestinationPort: number; /** * (Updatable) The minimum port number, which must not be greater than the maximum port number. */ minDestinationPort: number; } interface FusionEnvironmentAdminUserItem { /** * The email address for the administrator. */ emailAddress: string; /** * The administrator's first name. */ firstName: string; /** * The administrator's last name. */ lastName: string; /** * The username for the administrator. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ username: string; } interface FusionEnvironmentCreateFusionEnvironmentAdminUserDetails { /** * The email address for the administrator. */ emailAddress: string; /** * The administrator's first name. */ firstName: string; /** * The administrator's last name. */ lastName: string; /** * The username for the administrator. */ username: string; } interface FusionEnvironmentFamilyFamilyMaintenancePolicy { /** * (Updatable) Option to upgrade both production and non-production environments at the same time. When set to PROD both types of environnments are upgraded on the production schedule. When set to NON_PROD both types of environments are upgraded on the non-production schedule. */ concurrentMaintenance: string; /** * (Updatable) When True, monthly patching is enabled for the environment family. */ isMonthlyPatchingEnabled: boolean; /** * The quarterly maintenance month group schedule of the Fusion environment family. */ quarterlyUpgradeBeginTimes: string; } interface FusionEnvironmentKmsKeyInfo { activeKeyId: string; activeKeyVersion: string; currentKeyLifecycleState: string; scheduledKeyId: string; scheduledKeyStatus: string; scheduledKeyVersion: string; scheduledLifecycleState: string; } interface FusionEnvironmentMaintenancePolicy { /** * (Updatable) User choice to upgrade both test and prod pods at the same time. Overrides fusion environment families'. */ environmentMaintenanceOverride: string; /** * (Updatable) When "ENABLED", the Fusion environment is patched monthly. When "DISABLED", the Fusion environment is not patched monthly. This setting overrides the environment family setting. When not set, the environment follows the environment family policy. */ monthlyPatchingOverride: string; /** * Determines the quarterly upgrade begin times (monthly maintenance group schedule ) of the Fusion environment. */ quarterlyUpgradeBeginTimes: outputs.FusionApps.FusionEnvironmentMaintenancePolicyQuarterlyUpgradeBeginTime[]; } interface FusionEnvironmentMaintenancePolicyQuarterlyUpgradeBeginTime { /** * The frequency and month when maintenance occurs for the Fusion environment. */ beginTimesValue: string; /** * Determines if the maintenance schedule of the Fusion environment is inherited from the Fusion environment family. */ overrideType: string; } interface FusionEnvironmentRefresh { /** * The source environment id for the last refresh */ sourceFusionEnvironmentId: string; /** * The time of when the last refresh finish */ timeFinished: string; /** * The point of time of the latest DB backup for the last refresh */ timeOfRestorationPoint: string; } interface FusionEnvironmentRefreshActivityRefreshIssueDetailsList { /** * Detail reasons of refresh failure or validation failure that needs to be shown to customer. */ refreshIssues: string; } interface FusionEnvironmentRule { /** * (Updatable) Rule type */ action: string; /** * (Updatable) */ conditions: outputs.FusionApps.FusionEnvironmentRuleCondition[]; /** * (Updatable) A brief description of the access control rule. Avoid entering confidential information. example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ description: string; } interface FusionEnvironmentRuleCondition { /** * (Updatable) RuleCondition type */ attributeName: string; /** * (Updatable) The OCID of the originating VCN that an incoming packet must match. You can use this condition in conjunction with `SourceVcnIpAddressCondition`. **NOTE:** If you define this condition for a rule without a `SourceVcnIpAddressCondition`, this condition matches all incoming traffic in the specified VCN. */ attributeValue: string; } } export declare namespace GenerativeAi { interface AgentAgentEndpointContentModerationConfig { /** * (Updatable) A flag to enable or disable content moderation on input. */ shouldEnableOnInput: boolean; /** * (Updatable) A flag to enable or disable content moderation on output. */ shouldEnableOnOutput: boolean; } interface AgentAgentEndpointGuardrailConfig { /** * (Updatable) The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation. */ contentModerationConfig: outputs.GenerativeAi.AgentAgentEndpointGuardrailConfigContentModerationConfig; /** * (Updatable) The configuration details for Personally Identifiable Information. */ personallyIdentifiableInformationConfig: outputs.GenerativeAi.AgentAgentEndpointGuardrailConfigPersonallyIdentifiableInformationConfig; /** * (Updatable) The configuration details for Prompt Injection. */ promptInjectionConfig: outputs.GenerativeAi.AgentAgentEndpointGuardrailConfigPromptInjectionConfig; } interface AgentAgentEndpointGuardrailConfigContentModerationConfig { /** * (Updatable) An input guardrail mode for content moderation. */ inputGuardrailMode: string; /** * (Updatable) An output guardrail mode for content moderation. */ outputGuardrailMode: string; } interface AgentAgentEndpointGuardrailConfigPersonallyIdentifiableInformationConfig { /** * (Updatable) An input guardrail mode for personally identifiable information. */ inputGuardrailMode: string; /** * (Updatable) An output guardrail mode for personally identifiable information. */ outputGuardrailMode: string; } interface AgentAgentEndpointGuardrailConfigPromptInjectionConfig { /** * (Updatable) An input guardrail mode for prompt injection. */ inputGuardrailMode: string; } interface AgentAgentEndpointHumanInputConfig { /** * (Updatable) The Agent will request for human input for disambiguation or additional information gathering if this is enabled. */ shouldEnableHumanInput: boolean; } interface AgentAgentEndpointOutputConfig { /** * (Updatable) Location of the output. */ outputLocation: outputs.GenerativeAi.AgentAgentEndpointOutputConfigOutputLocation; /** * (Updatable) Retention duration of the output data. */ retentionPeriodInMinutes: number; } interface AgentAgentEndpointOutputConfigOutputLocation { /** * (Updatable) The name of the bucket. */ bucket: string; /** * (Updatable) The namespace of the object storage. */ namespace: string; /** * (Updatable) Type of OutputLocation. */ outputLocationType: string; /** * (Updatable) The prefix of the object storage. */ prefix: string; } interface AgentAgentEndpointProvisionedCapacityConfig { /** * (Updatable) Configuration for agent platform component. */ platformRuntimeConfig: outputs.GenerativeAi.AgentAgentEndpointProvisionedCapacityConfigPlatformRuntimeConfig; /** * (Updatable) An OCID that uniquely identifies an Provisioned Capacity. */ provisionedCapacityId: string; /** * (Updatable) RAG and SQL will be tools. */ toolRuntimeConfigs: outputs.GenerativeAi.AgentAgentEndpointProvisionedCapacityConfigToolRuntimeConfig[]; } interface AgentAgentEndpointProvisionedCapacityConfigPlatformRuntimeConfig { /** * (Updatable) The type of Platform runtime config. */ platformRuntimeConfigType: string; /** * (Updatable) The version of the Core. The latest version will be displayed as default. */ version: string; } interface AgentAgentEndpointProvisionedCapacityConfigToolRuntimeConfig { /** * (Updatable) The type of the tool. */ toolRuntimeConfigType: string; /** * (Updatable) The version of the components. */ version: string; } interface AgentAgentEndpointSessionConfig { /** * (Updatable) The session will become inactive after this timeout. */ idleTimeoutInSeconds: number; } interface AgentAgentLlmConfig { /** * (Updatable) Configuration to customize LLM. */ routingLlmCustomization: outputs.GenerativeAi.AgentAgentLlmConfigRoutingLlmCustomization; /** * (Updatable) The runtimeVersion of the system prompt. */ runtimeVersion: string; } interface AgentAgentLlmConfigRoutingLlmCustomization { /** * (Updatable) If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * (Updatable) Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * (Updatable) LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelection: outputs.GenerativeAi.AgentAgentLlmConfigRoutingLlmCustomizationLlmSelection; } interface AgentAgentLlmConfigRoutingLlmCustomizationLlmSelection { /** * (Updatable) The OCID of the GenAI endpoint */ endpointId: string; /** * (Updatable) Type of LLM selection */ llmSelectionType: string; /** * (Updatable) The OCID of the GenAI model */ modelId: string; } interface AgentDataIngestionJobDataIngestionJobStatistic { /** * The duration of this ingestion job. */ durationInSeconds: number; /** * The number of files that have failed during the ingestion. */ numberOfFailedFiles: number; /** * The number of files that have been ignored during the ingestion. */ numberOfIgnoredFiles: number; /** * The number of files that have been successfully ingested during the ingestion. */ numberOfIngestedFiles: number; } interface AgentDataIngestionJobDataIngestionJobType { /** * Type of ingestionJob. */ type: string; } interface AgentDataSourceDataSourceConfig { /** * (Updatable) The type of the tool. */ dataSourceConfigType: string; /** * (Updatable) The locations of data items in Object Storage, can either be an object (File) or a prefix (folder). */ objectStoragePrefixes: outputs.GenerativeAi.AgentDataSourceDataSourceConfigObjectStoragePrefix[]; } interface AgentDataSourceDataSourceConfigObjectStoragePrefix { /** * (Updatable) The bucket name of an object. */ bucket: string; /** * (Updatable) The namespace name of an object. */ namespace: string; /** * (Updatable) The prefix of file object(s) or folder prefix. */ prefix: string; } interface AgentKnowledgeBaseIndexConfig { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster. */ clusterId: string; /** * (Updatable) The connection type for Databases. */ databaseConnection: outputs.GenerativeAi.AgentKnowledgeBaseIndexConfigDatabaseConnection; /** * (Updatable) Array of Database functions to be used. */ databaseFunctions: outputs.GenerativeAi.AgentKnowledgeBaseIndexConfigDatabaseFunction[]; /** * (Updatable) The type of index. */ indexConfigType: string; /** * (Updatable) Index configuration for open search. */ indexes: outputs.GenerativeAi.AgentKnowledgeBaseIndexConfigIndex[]; /** * (Updatable) The details of configured security configuration on OpenSearch. */ secretDetail: outputs.GenerativeAi.AgentKnowledgeBaseIndexConfigSecretDetail; /** * (Updatable) Whether to enable Hybrid search in service managed OpenSearch. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ shouldEnableHybridSearch: boolean; } interface AgentKnowledgeBaseIndexConfigDatabaseConnection { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection. */ connectionId: string; /** * (Updatable) The type of Database connection. */ connectionType: string; } interface AgentKnowledgeBaseIndexConfigDatabaseFunction { /** * (Updatable) The name of the Database function. */ name: string; } interface AgentKnowledgeBaseIndexConfigIndex { /** * (Updatable) The index name in opensearch. */ name: string; /** * (Updatable) The index schema details. */ schema: outputs.GenerativeAi.AgentKnowledgeBaseIndexConfigIndexSchema; } interface AgentKnowledgeBaseIndexConfigIndexSchema { /** * (Updatable) Body key name. */ bodyKey: string; /** * (Updatable) Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries. */ embeddingBodyKey: string; /** * (Updatable) Title key that stores the Title of a document, if available. */ titleKey: string; /** * (Updatable) URL key that stores the URL of a document, if available. */ urlKey: string; } interface AgentKnowledgeBaseIndexConfigSecretDetail { /** * (Updatable) The IDCS Connect clientId. */ clientId: string; /** * (Updatable) The URL represent authentication url of the IDCS. */ idcsUrl: string; /** * (Updatable) Fully qualified scope url */ scopeUrl: string; /** * (Updatable) The type of OpenID. */ type: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for basic authentication. */ vaultSecretId: string; } interface AgentKnowledgeBaseKnowledgeBaseStatistic { /** * Knowledge Base size in bytes. */ sizeInBytes: string; /** * Total number of ingested files in Knowledge Base. */ totalIngestedFiles: string; } interface AgentToolToolConfig { /** * (Updatable) The AgentEndpoint OCID to be used as a tool in this agent. */ agentEndpointId: string; /** * (Updatable) The input location definition for Api schema. */ apiSchema: outputs.GenerativeAi.AgentToolToolConfigApiSchema; /** * (Updatable) The connection type for Databases. */ databaseConnection: outputs.GenerativeAi.AgentToolToolConfigDatabaseConnection; /** * (Updatable) The input location definition. */ databaseSchema: outputs.GenerativeAi.AgentToolToolConfigDatabaseSchema; /** * (Updatable) Dialect to be used for SQL generation. */ dialect: string; /** * (Updatable) Configuration to customize LLM. */ embeddingLlmCustomization: outputs.GenerativeAi.AgentToolToolConfigEmbeddingLlmCustomization; /** * (Updatable) Details of Function for Function calling tool. */ function: outputs.GenerativeAi.AgentToolToolConfigFunction; /** * (Updatable) Configuration to customize LLM. */ generationLlmCustomization: outputs.GenerativeAi.AgentToolToolConfigGenerationLlmCustomization; /** * (Updatable) Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials. */ httpEndpointAuthConfig: outputs.GenerativeAi.AgentToolToolConfigHttpEndpointAuthConfig; /** * (Updatable) The input location definition. */ iclExamples: outputs.GenerativeAi.AgentToolToolConfigIclExamples; /** * (Updatable) The KnowledgeBase configurations that this RAG Tool uses */ knowledgeBaseConfigs: outputs.GenerativeAi.AgentToolToolConfigKnowledgeBaseConfig[]; /** * (Updatable) Size of the model. */ modelSize: string; /** * (Updatable) Configuration to customize LLM. */ reasoningLlmCustomization: outputs.GenerativeAi.AgentToolToolConfigReasoningLlmCustomization; /** * (Updatable) Configuration to customize LLM. */ rerankingLlmCustomization: outputs.GenerativeAi.AgentToolToolConfigRerankingLlmCustomization; /** * (Updatable) The runtimeVersion of the system prompt. */ runtimeVersion: string; /** * (Updatable) To enable/disable self correction. */ shouldEnableSelfCorrection: boolean; /** * (Updatable) To enable/disable SQL execution. */ shouldEnableSqlExecution: boolean; /** * (Updatable) The subnet ID from agent developer tenancy through which the egress is going to be routed. */ subnetId: string; /** * (Updatable) The input location definition. */ tableAndColumnDescription: outputs.GenerativeAi.AgentToolToolConfigTableAndColumnDescription; /** * (Updatable) The type of the Tool config. The allowed values are: * * `SQL_TOOL_CONFIG`: The config for sql Tool. * * `RAG_TOOL_CONFIG`: The config for rag Tool. * * FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ toolConfigType: string; } interface AgentToolToolConfigApiSchema { /** * (Updatable) Type of Api Schema InputLocation. The allowed values are: * * `INLINE`: The Api schema input location is inline. * * `OBJECT_STORAGE_LOCATION`: The Api schema input location is object storage. */ apiSchemaInputLocationType: string; /** * (Updatable) The bucket name of an object. */ bucket: string; /** * (Updatable) Inline content as input. */ content: string; /** * (Updatable) The namespace name of an object. */ namespace: string; /** * (Updatable) The location/name of object. */ object: string; } interface AgentToolToolConfigDatabaseConnection { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection. */ connectionId: string; /** * (Updatable) The type of Database connection. The allowed values are: * * `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection. */ connectionType: string; } interface AgentToolToolConfigDatabaseSchema { /** * (Updatable) The bucket name of an object. */ bucket: string; /** * (Updatable) Inline content as input. */ content: string; /** * (Updatable) Type of InputLocation. The allowed values are: * * `INLINE`: The input location is inline. * * `OBJECT_STORAGE_PREFIX`: The input location is object storage. */ inputLocationType: string; /** * (Updatable) The namespace name of an object. */ namespace: string; /** * (Updatable) The prefix of file object(s) or folder prefix. */ prefix: string; } interface AgentToolToolConfigEmbeddingLlmCustomization { /** * (Updatable) If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * (Updatable) Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * (Updatable) LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelection: outputs.GenerativeAi.AgentToolToolConfigEmbeddingLlmCustomizationLlmSelection; } interface AgentToolToolConfigEmbeddingLlmCustomizationLlmSelection { /** * (Updatable) The OCID of the GenAI endpoint */ endpointId: string; /** * (Updatable) Type of LLM selection */ llmSelectionType: string; /** * (Updatable) The OCID of the GenAI model */ modelId: string; } interface AgentToolToolConfigFunction { /** * (Updatable) A description of the function. */ description: string; /** * (Updatable) The name of the function to invoke. */ name: string; /** * (Updatable) The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ parameters: { [key: string]: string; }; } interface AgentToolToolConfigGenerationLlmCustomization { /** * (Updatable) If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * (Updatable) Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * (Updatable) LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelection: outputs.GenerativeAi.AgentToolToolConfigGenerationLlmCustomizationLlmSelection; } interface AgentToolToolConfigGenerationLlmCustomizationLlmSelection { /** * (Updatable) The OCID of the GenAI endpoint */ endpointId: string; /** * (Updatable) Type of LLM selection */ llmSelectionType: string; /** * (Updatable) The OCID of the GenAI model */ modelId: string; } interface AgentToolToolConfigHttpEndpointAuthConfig { /** * (Updatable) A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool. */ httpEndpointAuthSources: outputs.GenerativeAi.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource[]; } interface AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource { /** * (Updatable) Specifies the level from which credentials should be resolved. */ httpEndpointAuthScope: string; /** * (Updatable) Subset of AuthScopeConfig allowed for HTTP Endpoint Tool. */ httpEndpointAuthScopeConfig: outputs.GenerativeAi.AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig; } interface AgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig { /** * (Updatable) IDCS client ID. */ clientId: string; /** * (Updatable) The type of authentication to be applied for this HTTP Endpoint. */ httpEndpointAuthScopeConfigType: string; /** * (Updatable) IDCS OpenID discovery endpoint. */ idcsUrl: string; /** * (Updatable) The location of the API key in the request. */ keyLocation: string; /** * (Updatable) The name of the key parameter in the location. */ keyName: string; /** * (Updatable) OAuth2 scopes for token generation. */ scopeUrl: string; /** * (Updatable) The OCID of the vault secret with username:password. Required when `authScope` is AGENT. */ vaultSecretId: string; } interface AgentToolToolConfigIclExamples { /** * (Updatable) The bucket name of an object. */ bucket: string; /** * (Updatable) Inline content as input. */ content: string; /** * (Updatable) Type of InputLocation. The allowed values are: * * `INLINE`: The input location is inline. * * `OBJECT_STORAGE_PREFIX`: The input location is object storage. */ inputLocationType: string; /** * (Updatable) The namespace name of an object. */ namespace: string; /** * (Updatable) The prefix of file object(s) or folder prefix. */ prefix: string; } interface AgentToolToolConfigKnowledgeBaseConfig { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBase this RAG Tool uses */ knowledgeBaseId: string; } interface AgentToolToolConfigReasoningLlmCustomization { /** * (Updatable) If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * (Updatable) Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * (Updatable) LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelection: outputs.GenerativeAi.AgentToolToolConfigReasoningLlmCustomizationLlmSelection; } interface AgentToolToolConfigReasoningLlmCustomizationLlmSelection { /** * (Updatable) The OCID of the GenAI endpoint */ endpointId: string; /** * (Updatable) Type of LLM selection */ llmSelectionType: string; /** * (Updatable) The OCID of the GenAI model */ modelId: string; } interface AgentToolToolConfigRerankingLlmCustomization { /** * (Updatable) If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * (Updatable) Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * (Updatable) LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelection: outputs.GenerativeAi.AgentToolToolConfigRerankingLlmCustomizationLlmSelection; } interface AgentToolToolConfigRerankingLlmCustomizationLlmSelection { /** * (Updatable) The OCID of the GenAI endpoint */ endpointId: string; /** * (Updatable) Type of LLM selection */ llmSelectionType: string; /** * (Updatable) The OCID of the GenAI model */ modelId: string; } interface AgentToolToolConfigTableAndColumnDescription { /** * (Updatable) The bucket name of an object. */ bucket: string; /** * (Updatable) Inline content as input. */ content: string; /** * (Updatable) Type of InputLocation. The allowed values are: * * `INLINE`: The input location is inline. * * `OBJECT_STORAGE_PREFIX`: The input location is object storage. */ inputLocationType: string; /** * (Updatable) The namespace name of an object. */ namespace: string; /** * (Updatable) The prefix of file object(s) or folder prefix. */ prefix: string; } interface DedicatedAiClusterCapacity { /** * The type of the dedicated AI cluster capacity. */ capacityType: string; /** * The total number of endpoints that can be hosted on this dedicated AI cluster. */ totalEndpointCapacity: number; /** * The number of endpoints hosted on this dedicated AI cluster. */ usedEndpointCapacity: number; } interface EndpointContentModerationConfig { /** * (Updatable) Whether to enable the content moderation feature. */ isEnabled: boolean; /** * (Updatable) Enum for the modes of operation for inference protection. */ mode: string; /** * (Updatable) The OCID of the model used for the feature. */ modelId: string; } interface GetAgentAgentEndpointContentModerationConfig { /** * A flag to enable or disable content moderation on input. */ shouldEnableOnInput: boolean; /** * A flag to enable or disable content moderation on output. */ shouldEnableOnOutput: boolean; } interface GetAgentAgentEndpointGuardrailConfig { /** * The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation. */ contentModerationConfigs: outputs.GenerativeAi.GetAgentAgentEndpointGuardrailConfigContentModerationConfig[]; /** * The configuration details for Personally Identifiable Information. */ personallyIdentifiableInformationConfigs: outputs.GenerativeAi.GetAgentAgentEndpointGuardrailConfigPersonallyIdentifiableInformationConfig[]; /** * The configuration details for Prompt Injection. */ promptInjectionConfigs: outputs.GenerativeAi.GetAgentAgentEndpointGuardrailConfigPromptInjectionConfig[]; } interface GetAgentAgentEndpointGuardrailConfigContentModerationConfig { /** * An input guardrail mode for prompt injection. */ inputGuardrailMode: string; /** * An output guardrail mode for personally identifiable information. */ outputGuardrailMode: string; } interface GetAgentAgentEndpointGuardrailConfigPersonallyIdentifiableInformationConfig { /** * An input guardrail mode for prompt injection. */ inputGuardrailMode: string; /** * An output guardrail mode for personally identifiable information. */ outputGuardrailMode: string; } interface GetAgentAgentEndpointGuardrailConfigPromptInjectionConfig { /** * An input guardrail mode for prompt injection. */ inputGuardrailMode: string; } interface GetAgentAgentEndpointHumanInputConfig { /** * The Agent will request for human input for disambiguation or additional information gathering if this is enabled. */ shouldEnableHumanInput: boolean; } interface GetAgentAgentEndpointOutputConfig { /** * Location of the output. */ outputLocations: outputs.GenerativeAi.GetAgentAgentEndpointOutputConfigOutputLocation[]; /** * Retention duration of the output data. */ retentionPeriodInMinutes: number; } interface GetAgentAgentEndpointOutputConfigOutputLocation { /** * The name of the bucket. */ bucket: string; /** * The namespace of the object storage. */ namespace: string; /** * Type of OutputLocation. */ outputLocationType: string; /** * The prefix of the object storage. */ prefix: string; } interface GetAgentAgentEndpointProvisionedCapacityConfig { /** * Configuration for agent platform component. */ platformRuntimeConfigs: outputs.GenerativeAi.GetAgentAgentEndpointProvisionedCapacityConfigPlatformRuntimeConfig[]; /** * An OCID that uniquely identifies an Provisioned Capacity. */ provisionedCapacityId: string; /** * RAG and SQL will be tools. */ toolRuntimeConfigs: outputs.GenerativeAi.GetAgentAgentEndpointProvisionedCapacityConfigToolRuntimeConfig[]; } interface GetAgentAgentEndpointProvisionedCapacityConfigPlatformRuntimeConfig { /** * The type of Platform runtime config. */ platformRuntimeConfigType: string; /** * The version of the components. */ version: string; } interface GetAgentAgentEndpointProvisionedCapacityConfigToolRuntimeConfig { /** * The type of the tool. */ toolRuntimeConfigType: string; /** * The version of the components. */ version: string; } interface GetAgentAgentEndpointSessionConfig { /** * The session will become inactive after this timeout. */ idleTimeoutInSeconds: number; } interface GetAgentAgentEndpointsAgentEndpointCollection { items: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItem[]; } interface GetAgentAgentEndpointsAgentEndpointCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent. */ agentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation. */ contentModerationConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfig[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * An optional description of the endpoint. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The configuration details about whether to apply the guardrail checks to input and output. */ guardrailConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemGuardrailConfig[]; /** * Human Input Configuration for an AgentEndpoint. */ humanInputConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemHumanInputConfig[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint. */ id: string; /** * A message that describes the current state of the endpoint in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Key-value pairs to allow additional configurations. */ metadata: { [key: string]: string; }; /** * Configuration to store results generated by agent. */ outputConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemOutputConfig[]; /** * The configuration includes the provisioned capacity id and component runtime (tool versions, and other relevant information). */ provisionedCapacityConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemProvisionedCapacityConfig[]; /** * Session Configuration on AgentEndpoint. */ sessionConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfig[]; /** * Whether to show citations in the chat result. */ shouldEnableCitation: boolean; /** * Whether to enable multi-language for chat. */ shouldEnableMultiLanguage: boolean; /** * Whether or not to enable Session-based chat. */ shouldEnableSession: boolean; /** * Whether to show traces in the chat result. */ shouldEnableTrace: boolean; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the AgentEndpoint was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the endpoint was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemContentModerationConfig { /** * A flag to enable or disable content moderation on input. */ shouldEnableOnInput: boolean; /** * A flag to enable or disable content moderation on output. */ shouldEnableOnOutput: boolean; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemGuardrailConfig { /** * The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation. */ contentModerationConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemGuardrailConfigContentModerationConfig[]; /** * The configuration details for Personally Identifiable Information. */ personallyIdentifiableInformationConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemGuardrailConfigPersonallyIdentifiableInformationConfig[]; /** * The configuration details for Prompt Injection. */ promptInjectionConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemGuardrailConfigPromptInjectionConfig[]; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemGuardrailConfigContentModerationConfig { /** * An input guardrail mode for prompt injection. */ inputGuardrailMode: string; /** * An output guardrail mode for personally identifiable information. */ outputGuardrailMode: string; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemGuardrailConfigPersonallyIdentifiableInformationConfig { /** * An input guardrail mode for prompt injection. */ inputGuardrailMode: string; /** * An output guardrail mode for personally identifiable information. */ outputGuardrailMode: string; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemGuardrailConfigPromptInjectionConfig { /** * An input guardrail mode for prompt injection. */ inputGuardrailMode: string; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemHumanInputConfig { /** * The Agent will request for human input for disambiguation or additional information gathering if this is enabled. */ shouldEnableHumanInput: boolean; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemOutputConfig { /** * Location of the output. */ outputLocations: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemOutputConfigOutputLocation[]; /** * Retention duration of the output data. */ retentionPeriodInMinutes: number; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemOutputConfigOutputLocation { /** * The name of the bucket. */ bucket: string; /** * The namespace of the object storage. */ namespace: string; /** * Type of OutputLocation. */ outputLocationType: string; /** * The prefix of the object storage. */ prefix: string; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemProvisionedCapacityConfig { /** * Configuration for agent platform component. */ platformRuntimeConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemProvisionedCapacityConfigPlatformRuntimeConfig[]; /** * An OCID that uniquely identifies an Provisioned Capacity. */ provisionedCapacityId: string; /** * RAG and SQL will be tools. */ toolRuntimeConfigs: outputs.GenerativeAi.GetAgentAgentEndpointsAgentEndpointCollectionItemProvisionedCapacityConfigToolRuntimeConfig[]; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemProvisionedCapacityConfigPlatformRuntimeConfig { /** * The type of Platform runtime config. */ platformRuntimeConfigType: string; /** * The version of the components. */ version: string; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemProvisionedCapacityConfigToolRuntimeConfig { /** * The type of the tool. */ toolRuntimeConfigType: string; /** * The version of the components. */ version: string; } interface GetAgentAgentEndpointsAgentEndpointCollectionItemSessionConfig { /** * The session will become inactive after this timeout. */ idleTimeoutInSeconds: number; } interface GetAgentAgentEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetAgentAgentLlmConfig { /** * Configuration to customize LLM. */ routingLlmCustomizations: outputs.GenerativeAi.GetAgentAgentLlmConfigRoutingLlmCustomization[]; /** * The runtimeVersion of the system prompt. */ runtimeVersion: string; } interface GetAgentAgentLlmConfigRoutingLlmCustomization { /** * If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelections: outputs.GenerativeAi.GetAgentAgentLlmConfigRoutingLlmCustomizationLlmSelection[]; } interface GetAgentAgentLlmConfigRoutingLlmCustomizationLlmSelection { /** * The OCID of the GenAI endpoint */ endpointId: string; /** * Type of LLM selection */ llmSelectionType: string; /** * The OCID of the GenAI model */ modelId: string; } interface GetAgentAgentsAgentCollection { items: outputs.GenerativeAi.GetAgentAgentsAgentCollectionItem[]; } interface GetAgentAgentsAgentCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description about the agent. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent. */ id: string; /** * List of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026. */ knowledgeBaseIds: string[]; /** * A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Configuration to Agent LLM. */ llmConfigs: outputs.GenerativeAi.GetAgentAgentsAgentCollectionItemLlmConfig[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the agent was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the agent was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * Details about purpose and responsibility of the agent */ welcomeMessage: string; } interface GetAgentAgentsAgentCollectionItemLlmConfig { /** * Configuration to customize LLM. */ routingLlmCustomizations: outputs.GenerativeAi.GetAgentAgentsAgentCollectionItemLlmConfigRoutingLlmCustomization[]; /** * The runtimeVersion of the system prompt. */ runtimeVersion: string; } interface GetAgentAgentsAgentCollectionItemLlmConfigRoutingLlmCustomization { /** * If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelections: outputs.GenerativeAi.GetAgentAgentsAgentCollectionItemLlmConfigRoutingLlmCustomizationLlmSelection[]; } interface GetAgentAgentsAgentCollectionItemLlmConfigRoutingLlmCustomizationLlmSelection { /** * The OCID of the GenAI endpoint */ endpointId: string; /** * Type of LLM selection */ llmSelectionType: string; /** * The OCID of the GenAI model */ modelId: string; } interface GetAgentAgentsFilter { name: string; regex?: boolean; values: string[]; } interface GetAgentDataIngestionJobDataIngestionJobStatistic { /** * The duration of this ingestion job. */ durationInSeconds: number; /** * The number of files that have failed during the ingestion. */ numberOfFailedFiles: number; /** * The number of files that have been ignored during the ingestion. */ numberOfIgnoredFiles: number; /** * The number of files that have been successfully ingested during the ingestion. */ numberOfIngestedFiles: number; } interface GetAgentDataIngestionJobDataIngestionJobType { /** * Type of ingestionJob. */ type: string; } interface GetAgentDataIngestionJobsDataIngestionJobCollection { items: outputs.GenerativeAi.GetAgentDataIngestionJobsDataIngestionJobCollectionItem[]; } interface GetAgentDataIngestionJobsDataIngestionJobCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * **DataIngestionJobStatistics** */ dataIngestionJobStatistics: outputs.GenerativeAi.GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatistic[]; /** * DataIngestionJob type. */ dataIngestionJobTypes: outputs.GenerativeAi.GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobType[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source. */ dataSourceId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DataIngestionJob. */ id: string; knowledgeBaseId: string; /** * A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the data ingestion job was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the data ingestion job was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobStatistic { /** * The duration of this ingestion job. */ durationInSeconds: number; /** * The number of files that have failed during the ingestion. */ numberOfFailedFiles: number; /** * The number of files that have been ignored during the ingestion. */ numberOfIgnoredFiles: number; /** * The number of files that have been successfully ingested during the ingestion. */ numberOfIngestedFiles: number; } interface GetAgentDataIngestionJobsDataIngestionJobCollectionItemDataIngestionJobType { /** * Type of ingestionJob. */ type: string; } interface GetAgentDataIngestionJobsFilter { name: string; regex?: boolean; values: string[]; } interface GetAgentDataSourceDataSourceConfig { /** * The type of the tool. */ dataSourceConfigType: string; /** * The locations of data items in Object Storage, can either be an object (File) or a prefix (folder). */ objectStoragePrefixes: outputs.GenerativeAi.GetAgentDataSourceDataSourceConfigObjectStoragePrefix[]; } interface GetAgentDataSourceDataSourceConfigObjectStoragePrefix { /** * The bucket name of an object. */ bucket: string; /** * The namespace name of an object. */ namespace: string; /** * The prefix of file object(s) or folder prefix. */ prefix: string; } interface GetAgentDataSourcesDataSourceCollection { items: outputs.GenerativeAi.GetAgentDataSourcesDataSourceCollectionItem[]; } interface GetAgentDataSourcesDataSourceCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The details of data source. */ dataSourceConfigs: outputs.GenerativeAi.GetAgentDataSourcesDataSourceCollectionItemDataSourceConfig[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A description of the data source. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data source. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base. */ knowledgeBaseId: string; /** * A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Key-value pairs to allow additional configurations. */ metadata: { [key: string]: string; }; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the data source was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the data source was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetAgentDataSourcesDataSourceCollectionItemDataSourceConfig { /** * The type of the tool. */ dataSourceConfigType: string; /** * The locations of data items in Object Storage, can either be an object (File) or a prefix (folder). */ objectStoragePrefixes: outputs.GenerativeAi.GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigObjectStoragePrefix[]; } interface GetAgentDataSourcesDataSourceCollectionItemDataSourceConfigObjectStoragePrefix { /** * The bucket name of an object. */ bucket: string; /** * The namespace name of an object. */ namespace: string; /** * The prefix of file object(s) or folder prefix. */ prefix: string; } interface GetAgentDataSourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetAgentKnowledgeBaseIndexConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster. */ clusterId: string; /** * The connection type for Databases. */ databaseConnections: outputs.GenerativeAi.GetAgentKnowledgeBaseIndexConfigDatabaseConnection[]; /** * Array of Database functions to be used. */ databaseFunctions: outputs.GenerativeAi.GetAgentKnowledgeBaseIndexConfigDatabaseFunction[]; /** * The type of index. */ indexConfigType: string; /** * Index configuration for open search. */ indexes: outputs.GenerativeAi.GetAgentKnowledgeBaseIndexConfigIndex[]; /** * The details of configured security configuration on OpenSearch. */ secretDetails: outputs.GenerativeAi.GetAgentKnowledgeBaseIndexConfigSecretDetail[]; /** * Whether to enable Hybrid search in service managed OpenSearch. */ shouldEnableHybridSearch: boolean; } interface GetAgentKnowledgeBaseIndexConfigDatabaseConnection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection. */ connectionId: string; /** * The type of Database connection. */ connectionType: string; } interface GetAgentKnowledgeBaseIndexConfigDatabaseFunction { /** * The index name in opensearch. */ name: string; } interface GetAgentKnowledgeBaseIndexConfigIndex { /** * The index name in opensearch. */ name: string; /** * The index schema details. */ schemas: outputs.GenerativeAi.GetAgentKnowledgeBaseIndexConfigIndexSchema[]; } interface GetAgentKnowledgeBaseIndexConfigIndexSchema { /** * Body key name. */ bodyKey: string; /** * Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries. */ embeddingBodyKey: string; /** * Title key that stores the Title of a document, if available. */ titleKey: string; /** * URL key that stores the URL of a document, if available. */ urlKey: string; } interface GetAgentKnowledgeBaseIndexConfigSecretDetail { /** * The IDCS Connect clientId. */ clientId: string; /** * The URL represent authentication url of the IDCS. */ idcsUrl: string; /** * Fully qualified scope url */ scopeUrl: string; /** * The type of OpenID. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for basic authentication. */ vaultSecretId: string; } interface GetAgentKnowledgeBaseKnowledgeBaseStatistic { /** * Knowledge Base size in bytes. */ sizeInBytes: string; /** * Total number of ingested files in Knowledge Base. */ totalIngestedFiles: string; } interface GetAgentKnowledgeBasesFilter { /** * The index name in opensearch. */ name: string; regex?: boolean; values: string[]; } interface GetAgentKnowledgeBasesKnowledgeBaseCollection { items: outputs.GenerativeAi.GetAgentKnowledgeBasesKnowledgeBaseCollectionItem[]; } interface GetAgentKnowledgeBasesKnowledgeBaseCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A description of the knowledge base. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledge base. */ id: string; /** * The index configuration of Knowledge bases. */ indexConfigs: outputs.GenerativeAi.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfig[]; /** * Statistics for Default Knowledge Base. */ knowledgeBaseStatistics: outputs.GenerativeAi.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemKnowledgeBaseStatistic[]; /** * A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the knowledge base was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the knowledge base was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OpenSearch Cluster. */ clusterId: string; /** * The connection type for Databases. */ databaseConnections: outputs.GenerativeAi.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnection[]; /** * Array of Database functions to be used. */ databaseFunctions: outputs.GenerativeAi.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunction[]; /** * The type of index. */ indexConfigType: string; /** * Index configuration for open search. */ indexes: outputs.GenerativeAi.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndex[]; /** * The details of configured security configuration on OpenSearch. */ secretDetails: outputs.GenerativeAi.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetail[]; /** * Whether to enable Hybrid search in service managed OpenSearch. */ shouldEnableHybridSearch: boolean; } interface GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection. */ connectionId: string; /** * The type of Database connection. */ connectionType: string; } interface GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunction { /** * The index name in opensearch. */ name: string; } interface GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndex { /** * The index name in opensearch. */ name: string; /** * The index schema details. */ schemas: outputs.GenerativeAi.GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexSchema[]; } interface GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexSchema { /** * Body key name. */ bodyKey: string; /** * Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries. */ embeddingBodyKey: string; /** * Title key that stores the Title of a document, if available. */ titleKey: string; /** * URL key that stores the URL of a document, if available. */ urlKey: string; } interface GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetail { /** * The IDCS Connect clientId. */ clientId: string; /** * The URL represent authentication url of the IDCS. */ idcsUrl: string; /** * Fully qualified scope url */ scopeUrl: string; /** * The type of OpenID. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret for basic authentication. */ vaultSecretId: string; } interface GetAgentKnowledgeBasesKnowledgeBaseCollectionItemKnowledgeBaseStatistic { /** * Knowledge Base size in bytes. */ sizeInBytes: string; /** * Total number of ingested files in Knowledge Base. */ totalIngestedFiles: string; } interface GetAgentProvisionedCapacitiesFilter { name: string; regex?: boolean; values: string[]; } interface GetAgentProvisionedCapacitiesProvisionedCapacityCollection { items: outputs.GenerativeAi.GetAgentProvisionedCapacitiesProvisionedCapacityCollectionItem[]; } interface GetAgentProvisionedCapacitiesProvisionedCapacityCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * An optional description of the provisioned capacity. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the provisioned capacity. */ id: string; /** * Provisioned Capacity Unit corresponds to the amount of characters processed per minute. */ numberOfUnits: number; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the provisioned capacity was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the provisioned capacity was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetAgentToolToolConfig { /** * The AgentEndpoint OCID to be used as a tool in this agent. */ agentEndpointId: string; /** * The input location definition for Api schema. */ apiSchemas: outputs.GenerativeAi.GetAgentToolToolConfigApiSchema[]; /** * The connection type for Databases. */ databaseConnections: outputs.GenerativeAi.GetAgentToolToolConfigDatabaseConnection[]; /** * The input location definition. */ databaseSchemas: outputs.GenerativeAi.GetAgentToolToolConfigDatabaseSchema[]; /** * Dialect to be used for SQL generation. */ dialect: string; /** * Configuration to customize LLM. */ embeddingLlmCustomizations: outputs.GenerativeAi.GetAgentToolToolConfigEmbeddingLlmCustomization[]; /** * Details of Function for Function calling tool. */ functions: outputs.GenerativeAi.GetAgentToolToolConfigFunction[]; /** * Configuration to customize LLM. */ generationLlmCustomizations: outputs.GenerativeAi.GetAgentToolToolConfigGenerationLlmCustomization[]; /** * Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials. */ httpEndpointAuthConfigs: outputs.GenerativeAi.GetAgentToolToolConfigHttpEndpointAuthConfig[]; /** * The input location definition. */ iclExamples: outputs.GenerativeAi.GetAgentToolToolConfigIclExample[]; /** * The KnowledgeBase configurations that this RAG Tool uses */ knowledgeBaseConfigs: outputs.GenerativeAi.GetAgentToolToolConfigKnowledgeBaseConfig[]; /** * Size of the model. */ modelSize: string; /** * Configuration to customize LLM. */ reasoningLlmCustomizations: outputs.GenerativeAi.GetAgentToolToolConfigReasoningLlmCustomization[]; /** * Configuration to customize LLM. */ rerankingLlmCustomizations: outputs.GenerativeAi.GetAgentToolToolConfigRerankingLlmCustomization[]; /** * The runtimeVersion of the system prompt. */ runtimeVersion: string; /** * To enable/disable self correction. */ shouldEnableSelfCorrection: boolean; /** * To enable/disable SQL execution. */ shouldEnableSqlExecution: boolean; /** * The subnet ID from agent developer tenancy through which the egress is going to be routed. */ subnetId: string; /** * The input location definition. */ tableAndColumnDescriptions: outputs.GenerativeAi.GetAgentToolToolConfigTableAndColumnDescription[]; /** * The type of the Tool config. The allowed values are: * * `SQL_TOOL_CONFIG`: The config for sql Tool. * * `RAG_TOOL_CONFIG`: The config for rag Tool. * * FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool. */ toolConfigType: string; } interface GetAgentToolToolConfigApiSchema { /** * Type of Api Schema InputLocation. The allowed values are: * * `INLINE`: The Api schema input location is inline. * * `OBJECT_STORAGE_LOCATION`: The Api schema input location is object storage. */ apiSchemaInputLocationType: string; /** * The bucket name of an object. */ bucket: string; /** * Inline content as input. */ content: string; /** * The namespace name of an object. */ namespace: string; /** * The location/name of object. */ object: string; } interface GetAgentToolToolConfigDatabaseConnection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection. */ connectionId: string; /** * The type of Database connection. The allowed values are: * * `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection. */ connectionType: string; } interface GetAgentToolToolConfigDatabaseSchema { /** * The bucket name of an object. */ bucket: string; /** * Inline content as input. */ content: string; /** * Type of InputLocation. The allowed values are: * * `INLINE`: The input location is inline. * * `OBJECT_STORAGE_PREFIX`: The input location is object storage. */ inputLocationType: string; /** * The namespace name of an object. */ namespace: string; /** * The prefix of file object(s) or folder prefix. */ prefix: string; } interface GetAgentToolToolConfigEmbeddingLlmCustomization { /** * If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelections: outputs.GenerativeAi.GetAgentToolToolConfigEmbeddingLlmCustomizationLlmSelection[]; } interface GetAgentToolToolConfigEmbeddingLlmCustomizationLlmSelection { /** * The OCID of the GenAI endpoint */ endpointId: string; /** * Type of LLM selection */ llmSelectionType: string; /** * The OCID of the GenAI model */ modelId: string; } interface GetAgentToolToolConfigFunction { /** * A description of the function. */ description: string; /** * The name of the function to invoke. */ name: string; /** * The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ parameters: { [key: string]: string; }; } interface GetAgentToolToolConfigGenerationLlmCustomization { /** * If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelections: outputs.GenerativeAi.GetAgentToolToolConfigGenerationLlmCustomizationLlmSelection[]; } interface GetAgentToolToolConfigGenerationLlmCustomizationLlmSelection { /** * The OCID of the GenAI endpoint */ endpointId: string; /** * Type of LLM selection */ llmSelectionType: string; /** * The OCID of the GenAI model */ modelId: string; } interface GetAgentToolToolConfigHttpEndpointAuthConfig { /** * A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool. */ httpEndpointAuthSources: outputs.GenerativeAi.GetAgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource[]; } interface GetAgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource { /** * Specifies the level from which credentials should be resolved. */ httpEndpointAuthScope: string; /** * Subset of AuthScopeConfig allowed for HTTP Endpoint Tool. */ httpEndpointAuthScopeConfigs: outputs.GenerativeAi.GetAgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig[]; } interface GetAgentToolToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig { /** * IDCS client ID. */ clientId: string; /** * The type of authentication to be applied for this HTTP Endpoint. */ httpEndpointAuthScopeConfigType: string; /** * IDCS OpenID discovery endpoint. */ idcsUrl: string; /** * The location of the API key in the request. */ keyLocation: string; /** * The name of the key parameter in the location. */ keyName: string; /** * OAuth2 scopes for token generation. */ scopeUrl: string; /** * The OCID of the vault secret with username:password. Required when `authScope` is AGENT. */ vaultSecretId: string; } interface GetAgentToolToolConfigIclExample { /** * The bucket name of an object. */ bucket: string; /** * Inline content as input. */ content: string; /** * Type of InputLocation. The allowed values are: * * `INLINE`: The input location is inline. * * `OBJECT_STORAGE_PREFIX`: The input location is object storage. */ inputLocationType: string; /** * The namespace name of an object. */ namespace: string; /** * The prefix of file object(s) or folder prefix. */ prefix: string; } interface GetAgentToolToolConfigKnowledgeBaseConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBase this RAG Tool uses */ knowledgeBaseId: string; } interface GetAgentToolToolConfigReasoningLlmCustomization { /** * If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelections: outputs.GenerativeAi.GetAgentToolToolConfigReasoningLlmCustomizationLlmSelection[]; } interface GetAgentToolToolConfigReasoningLlmCustomizationLlmSelection { /** * The OCID of the GenAI endpoint */ endpointId: string; /** * Type of LLM selection */ llmSelectionType: string; /** * The OCID of the GenAI model */ modelId: string; } interface GetAgentToolToolConfigRerankingLlmCustomization { /** * If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelections: outputs.GenerativeAi.GetAgentToolToolConfigRerankingLlmCustomizationLlmSelection[]; } interface GetAgentToolToolConfigRerankingLlmCustomizationLlmSelection { /** * The OCID of the GenAI endpoint */ endpointId: string; /** * Type of LLM selection */ llmSelectionType: string; /** * The OCID of the GenAI model */ modelId: string; } interface GetAgentToolToolConfigTableAndColumnDescription { /** * The bucket name of an object. */ bucket: string; /** * Inline content as input. */ content: string; /** * Type of InputLocation. The allowed values are: * * `INLINE`: The input location is inline. * * `OBJECT_STORAGE_PREFIX`: The input location is object storage. */ inputLocationType: string; /** * The namespace name of an object. */ namespace: string; /** * The prefix of file object(s) or folder prefix. */ prefix: string; } interface GetAgentToolsFilter { /** * The name of the function to invoke. */ name: string; regex?: boolean; values: string[]; } interface GetAgentToolsToolCollection { items: outputs.GenerativeAi.GetAgentToolsToolCollectionItem[]; } interface GetAgentToolsToolCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the agent. */ agentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A description of the function. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Tool. */ id: string; /** * Key-value pairs to allow additional configurations. */ metadata: { [key: string]: string; }; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Tool was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Tool was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * The configuration and type of Tool. */ toolConfigs: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfig[]; } interface GetAgentToolsToolCollectionItemToolConfig { /** * The AgentEndpoint OCID to be used as a tool in this agent. */ agentEndpointId: string; /** * The input location definition for Api schema. */ apiSchemas: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigApiSchema[]; /** * The connection type for Databases. */ databaseConnections: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigDatabaseConnection[]; /** * The input location definition. */ databaseSchemas: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigDatabaseSchema[]; /** * Dialect to be used for SQL generation. */ dialect: string; /** * Configuration to customize LLM. */ embeddingLlmCustomizations: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigEmbeddingLlmCustomization[]; /** * Details of Function for Function calling tool. */ functions: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigFunction[]; /** * Configuration to customize LLM. */ generationLlmCustomizations: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomization[]; /** * Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials. */ httpEndpointAuthConfigs: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfig[]; /** * The input location definition. */ iclExamples: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigIclExample[]; /** * The KnowledgeBase configurations that this RAG Tool uses */ knowledgeBaseConfigs: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigKnowledgeBaseConfig[]; /** * Size of the model. */ modelSize: string; /** * Configuration to customize LLM. */ reasoningLlmCustomizations: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigReasoningLlmCustomization[]; /** * Configuration to customize LLM. */ rerankingLlmCustomizations: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigRerankingLlmCustomization[]; /** * The runtimeVersion of the system prompt. */ runtimeVersion: string; /** * To enable/disable self correction. */ shouldEnableSelfCorrection: boolean; /** * To enable/disable SQL execution. */ shouldEnableSqlExecution: boolean; /** * The subnet ID from agent developer tenancy through which the egress is going to be routed. */ subnetId: string; /** * The input location definition. */ tableAndColumnDescriptions: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigTableAndColumnDescription[]; /** * The type of the Tool config. The allowed values are: * * `SQL_TOOL_CONFIG`: The config for sql Tool. * * `RAG_TOOL_CONFIG`: The config for rag Tool. * * FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool. */ toolConfigType: string; } interface GetAgentToolsToolCollectionItemToolConfigApiSchema { /** * Type of Api Schema InputLocation. The allowed values are: * * `INLINE`: The Api schema input location is inline. * * `OBJECT_STORAGE_LOCATION`: The Api schema input location is object storage. */ apiSchemaInputLocationType: string; /** * The bucket name of an object. */ bucket: string; /** * Inline content as input. */ content: string; /** * The namespace name of an object. */ namespace: string; /** * The location/name of object. */ object: string; } interface GetAgentToolsToolCollectionItemToolConfigDatabaseConnection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Tools Connection. */ connectionId: string; /** * The type of Database connection. The allowed values are: * * `DATABASE_TOOL_CONNECTION`: This allows the service to connect to a vector store via a Database Tools Connection. */ connectionType: string; } interface GetAgentToolsToolCollectionItemToolConfigDatabaseSchema { /** * The bucket name of an object. */ bucket: string; /** * Inline content as input. */ content: string; /** * Type of InputLocation. The allowed values are: * * `INLINE`: The input location is inline. * * `OBJECT_STORAGE_PREFIX`: The input location is object storage. */ inputLocationType: string; /** * The namespace name of an object. */ namespace: string; /** * The prefix of file object(s) or folder prefix. */ prefix: string; } interface GetAgentToolsToolCollectionItemToolConfigEmbeddingLlmCustomization { /** * If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelections: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigEmbeddingLlmCustomizationLlmSelection[]; } interface GetAgentToolsToolCollectionItemToolConfigEmbeddingLlmCustomizationLlmSelection { /** * The OCID of the GenAI endpoint */ endpointId: string; /** * Type of LLM selection */ llmSelectionType: string; /** * The OCID of the GenAI model */ modelId: string; } interface GetAgentToolsToolCollectionItemToolConfigFunction { /** * A description of the function. */ description: string; /** * The name of the function to invoke. */ name: string; /** * The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ parameters: { [key: string]: string; }; } interface GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomization { /** * If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelections: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomizationLlmSelection[]; } interface GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomizationLlmSelection { /** * The OCID of the GenAI endpoint */ endpointId: string; /** * Type of LLM selection */ llmSelectionType: string; /** * The OCID of the GenAI model */ modelId: string; } interface GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfig { /** * A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool. */ httpEndpointAuthSources: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource[]; } interface GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource { /** * Specifies the level from which credentials should be resolved. */ httpEndpointAuthScope: string; /** * Subset of AuthScopeConfig allowed for HTTP Endpoint Tool. */ httpEndpointAuthScopeConfigs: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig[]; } interface GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig { /** * IDCS client ID. */ clientId: string; /** * The type of authentication to be applied for this HTTP Endpoint. */ httpEndpointAuthScopeConfigType: string; /** * IDCS OpenID discovery endpoint. */ idcsUrl: string; /** * The location of the API key in the request. */ keyLocation: string; /** * The name of the key parameter in the location. */ keyName: string; /** * OAuth2 scopes for token generation. */ scopeUrl: string; /** * The OCID of the vault secret with username:password. Required when `authScope` is AGENT. */ vaultSecretId: string; } interface GetAgentToolsToolCollectionItemToolConfigIclExample { /** * The bucket name of an object. */ bucket: string; /** * Inline content as input. */ content: string; /** * Type of InputLocation. The allowed values are: * * `INLINE`: The input location is inline. * * `OBJECT_STORAGE_PREFIX`: The input location is object storage. */ inputLocationType: string; /** * The namespace name of an object. */ namespace: string; /** * The prefix of file object(s) or folder prefix. */ prefix: string; } interface GetAgentToolsToolCollectionItemToolConfigKnowledgeBaseConfig { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the knowledgeBase this RAG Tool uses */ knowledgeBaseId: string; } interface GetAgentToolsToolCollectionItemToolConfigReasoningLlmCustomization { /** * If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelections: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigReasoningLlmCustomizationLlmSelection[]; } interface GetAgentToolsToolCollectionItemToolConfigReasoningLlmCustomizationLlmSelection { /** * The OCID of the GenAI endpoint */ endpointId: string; /** * Type of LLM selection */ llmSelectionType: string; /** * The OCID of the GenAI model */ modelId: string; } interface GetAgentToolsToolCollectionItemToolConfigRerankingLlmCustomization { /** * If specified, the default instruction is replaced with provided instruction. */ instruction: string; /** * Hyper parameters for LLM configuration. Accepts Key-value pairs to configure various hyper parameters. Refer to the guide for examples and the JSON Schema documentation for details on the format. */ llmHyperParameters: { [key: string]: string; }; /** * LLM selection configuration - either DEFAULT or CUSTOM. */ llmSelections: outputs.GenerativeAi.GetAgentToolsToolCollectionItemToolConfigRerankingLlmCustomizationLlmSelection[]; } interface GetAgentToolsToolCollectionItemToolConfigRerankingLlmCustomizationLlmSelection { /** * The OCID of the GenAI endpoint */ endpointId: string; /** * Type of LLM selection */ llmSelectionType: string; /** * The OCID of the GenAI model */ modelId: string; } interface GetAgentToolsToolCollectionItemToolConfigTableAndColumnDescription { /** * The bucket name of an object. */ bucket: string; /** * Inline content as input. */ content: string; /** * Type of InputLocation. The allowed values are: * * `INLINE`: The input location is inline. * * `OBJECT_STORAGE_PREFIX`: The input location is object storage. */ inputLocationType: string; /** * The namespace name of an object. */ namespace: string; /** * The prefix of file object(s) or folder prefix. */ prefix: string; } interface GetDedicatedAiClusterCapacity { capacityType: string; totalEndpointCapacity: number; usedEndpointCapacity: number; } interface GetDedicatedAiClustersDedicatedAiClusterCollection { items: outputs.GenerativeAi.GetDedicatedAiClustersDedicatedAiClusterCollectionItem[]; } interface GetDedicatedAiClustersDedicatedAiClusterCollectionItem { capacities: outputs.GenerativeAi.GetDedicatedAiClustersDedicatedAiClusterCollectionItemCapacity[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * An optional description of the dedicated AI cluster. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster. */ id: string; /** * A message describing the current state with detail that can provide actionable information. */ lifecycleDetails: string; /** * A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the dedicated AI cluster was created, in the format defined by RFC 3339 */ timeCreated: string; /** * The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339 */ timeUpdated: string; /** * The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor. */ type: string; /** * The number of dedicated units in this AI cluster. */ unitCount: number; /** * The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers. */ unitShape: string; } interface GetDedicatedAiClustersDedicatedAiClusterCollectionItemCapacity { capacityType: string; totalEndpointCapacity: number; usedEndpointCapacity: number; } interface GetDedicatedAiClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetEndpointContentModerationConfig { /** * Whether to enable the content moderation feature. */ isEnabled: boolean; /** * Enum for the modes of operation for inference protection. */ mode: string; /** * The OCID of the model that's used to create this endpoint. */ modelId: string; } interface GetEndpointsEndpointCollection { items: outputs.GenerativeAi.GetEndpointsEndpointCollectionItem[]; } interface GetEndpointsEndpointCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses. */ contentModerationConfigs: outputs.GenerativeAi.GetEndpointsEndpointCollectionItemContentModerationConfig[]; /** * The OCID of the dedicated AI cluster on which the model will be deployed to. */ dedicatedAiClusterId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * An optional description of the endpoint. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ generativeAiPrivateEndpointId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the endpoint. */ id: string; /** * A message describing the current state of the endpoint in more detail that can provide actionable information. */ lifecycleDetails: string; /** * The OCID of the model that's used to create this endpoint. */ modelId: string; /** * A filter to return only resources that their lifecycle state matches the given lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time that the endpoint was created in the format of an RFC3339 datetime string. */ timeCreated: string; /** * The date and time that the endpoint was updated in the format of an RFC3339 datetime string. */ timeUpdated: string; } interface GetEndpointsEndpointCollectionItemContentModerationConfig { /** * Whether to enable the content moderation feature. */ isEnabled: boolean; /** * Enum for the modes of operation for inference protection. */ mode: string; /** * The OCID of the model that's used to create this endpoint. */ modelId: string; } interface GetEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetGenerativeAiPrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetGenerativeAiPrivateEndpointsGenerativeAiPrivateEndpointCollection { items: outputs.GenerativeAi.GetGenerativeAiPrivateEndpointsGenerativeAiPrivateEndpointCollectionItem[]; } interface GetGenerativeAiPrivateEndpointsGenerativeAiPrivateEndpointCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; definedTags: { [key: string]: string; }; /** * A description of this private endpoint. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; dnsPrefix: string; /** * Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com) */ fqdn: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ id: string; lifecycleDetails: string; /** * A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to. */ nsgIds: string[]; previousState: string; /** * The private IP address (in the customer's VCN) that represents the access point for the associated endpoint service. */ privateEndpointIp: string; /** * Query by the resource type of Generative AI private endpoints. */ resourceType: string; /** * The lifecycle state of Generative AI private endpoints. */ state: string; /** * The OCID of the subnet that the private endpoint belongs to. */ subnetId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time that the Generative AI private endpoint was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeCreated: string; /** * The date and time that the Generative AI private endpoint was updated expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeUpdated: string; } interface GetHostedApplicationEnvironmentVariable { /** * Name of the environment variable. */ name: string; /** * Type of the environment variable (PLAINTEXT or VAULT, no default value). */ type: string; /** * Value of the environment variable. */ value: string; } interface GetHostedApplicationIamEnvironmentVariable { /** * Name of the environment variable. */ name: string; /** * Type of the environment variable (PLAINTEXT or VAULT, no default value). */ type: string; /** * Value of the environment variable. */ value: string; } interface GetHostedApplicationIamNetworkingConfig { /** * Inbound Networking configuration. */ inboundNetworkingConfigs: outputs.GenerativeAi.GetHostedApplicationIamNetworkingConfigInboundNetworkingConfig[]; /** * Outbound Networking configuration. */ outboundNetworkingConfigs: outputs.GenerativeAi.GetHostedApplicationIamNetworkingConfigOutboundNetworkingConfig[]; } interface GetHostedApplicationIamNetworkingConfigInboundNetworkingConfig { /** * inbounding from public or private endpoint. */ endpointMode: string; /** * The [OCID] of Private Endpoint when endpointMode=Private */ privateEndpointId: string; } interface GetHostedApplicationIamNetworkingConfigOutboundNetworkingConfig { /** * ocid of customer subnet when networkMode=Custom */ customSubnetId: string; /** * outbounding to managed internet or customer network. */ networkMode: string; /** * A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to. */ nsgIds: string[]; } interface GetHostedApplicationIamScalingConfig { /** * Maximum number of replicas allowed. */ maxReplica: number; /** * Minimum number of replicas to keep running. */ minReplica: number; /** * scaling type for application. */ scalingType: string; /** * number of simultaneous requests that can be processed by each replica. */ targetConcurrencyThreshold: number; /** * Scale up if average CPU utilization exceeds this threshold. */ targetCpuThreshold: number; /** * Scale up if average memory utilization exceeds this threshold. */ targetMemoryThreshold: number; /** * requests-per-second per replica of an application. */ targetRpsThreshold: number; } interface GetHostedApplicationIamStorageConfig { /** * The key of environment variable to store the database connection. */ environmentVariableKey: string; /** * The [OCID] of ApplicationStorage. */ storageId: string; } interface GetHostedApplicationIamsFilter { /** * Name of the environment variable. */ name: string; regex?: boolean; values: string[]; } interface GetHostedApplicationIamsHostedApplicationCollection { items: outputs.GenerativeAi.GetHostedApplicationIamsHostedApplicationCollectionItem[]; } interface GetHostedApplicationIamsHostedApplicationCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * An optional description of the hosted application. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime. */ environmentVariables: outputs.GenerativeAi.GetHostedApplicationIamsHostedApplicationCollectionItemEnvironmentVariable[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application. */ id: string; /** * A message describing the current state of the endpoint in more detail that can provide actionable information. */ lifecycleDetails: string; /** * Networking configuration. */ networkingConfigs: outputs.GenerativeAi.GetHostedApplicationIamsHostedApplicationCollectionItemNetworkingConfig[]; /** * The auto scaling configuration for the Hosted Application. Defines the minimum and maximum number of replicas. When unspecified, the service applies service-defined default scaling values. */ scalingConfigs: outputs.GenerativeAi.GetHostedApplicationIamsHostedApplicationCollectionItemScalingConfig[]; /** * A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state. */ state: string; /** * A list of storageConfigs managed by the Oracle Cloud Infrastructure GenAI Platform and attached to the application. */ storageConfigs: outputs.GenerativeAi.GetHostedApplicationIamsHostedApplicationCollectionItemStorageConfig[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the hosted application was created, in the format defined by RFC 3339 */ timeCreated: string; /** * The date and time the hosted application was updated, in the format defined by RFC 3339 */ timeUpdated: string; } interface GetHostedApplicationIamsHostedApplicationCollectionItemEnvironmentVariable { /** * Name of the environment variable. */ name: string; /** * Type of the environment variable (PLAINTEXT or VAULT, no default value). */ type: string; /** * Value of the environment variable. */ value: string; } interface GetHostedApplicationIamsHostedApplicationCollectionItemNetworkingConfig { /** * Inbound Networking configuration. */ inboundNetworkingConfigs: outputs.GenerativeAi.GetHostedApplicationIamsHostedApplicationCollectionItemNetworkingConfigInboundNetworkingConfig[]; /** * Outbound Networking configuration. */ outboundNetworkingConfigs: outputs.GenerativeAi.GetHostedApplicationIamsHostedApplicationCollectionItemNetworkingConfigOutboundNetworkingConfig[]; } interface GetHostedApplicationIamsHostedApplicationCollectionItemNetworkingConfigInboundNetworkingConfig { /** * inbounding from public or private endpoint. */ endpointMode: string; /** * The [OCID] of Private Endpoint when endpointMode=Private */ privateEndpointId: string; } interface GetHostedApplicationIamsHostedApplicationCollectionItemNetworkingConfigOutboundNetworkingConfig { /** * ocid of customer subnet when networkMode=Custom */ customSubnetId: string; /** * outbounding to managed internet or customer network. */ networkMode: string; /** * A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to. */ nsgIds: string[]; } interface GetHostedApplicationIamsHostedApplicationCollectionItemScalingConfig { /** * Maximum number of replicas allowed. */ maxReplica: number; /** * Minimum number of replicas to keep running. */ minReplica: number; /** * scaling type for application. */ scalingType: string; /** * number of simultaneous requests that can be processed by each replica. */ targetConcurrencyThreshold: number; /** * Scale up if average CPU utilization exceeds this threshold. */ targetCpuThreshold: number; /** * Scale up if average memory utilization exceeds this threshold. */ targetMemoryThreshold: number; /** * requests-per-second per replica of an application. */ targetRpsThreshold: number; } interface GetHostedApplicationIamsHostedApplicationCollectionItemStorageConfig { /** * The key of environment variable to store the database connection. */ environmentVariableKey: string; /** * The [OCID] of ApplicationStorage. */ storageId: string; } interface GetHostedApplicationInboundAuthConfig { /** * Oracle Identity Cloud Service (IDCS) configuration used when inboundAuthConfigType is set to IDCS_AUTH_CONFIG. This object must be specified when inboundAuthConfigType is IDCS_AUTH_CONFIG. */ idcsConfigs: outputs.GenerativeAi.GetHostedApplicationInboundAuthConfigIdcsConfig[]; /** * Inbound authentication configuration type of network access (IDCS_AUTH_CONFIG). */ inboundAuthConfigType: string; } interface GetHostedApplicationInboundAuthConfigIdcsConfig { /** * Audience for IDCS. */ audience: string; /** * Domain URL for IDCS. */ domainUrl: string; /** * Scope for IDCS. */ scope: string; } interface GetHostedApplicationNetworkingConfig { /** * Inbound Networking configuration. */ inboundNetworkingConfigs: outputs.GenerativeAi.GetHostedApplicationNetworkingConfigInboundNetworkingConfig[]; /** * Outbound Networking configuration. */ outboundNetworkingConfigs: outputs.GenerativeAi.GetHostedApplicationNetworkingConfigOutboundNetworkingConfig[]; } interface GetHostedApplicationNetworkingConfigInboundNetworkingConfig { /** * inbounding from public or private endpoint. */ endpointMode: string; /** * The [OCID] of Private Endpoint when endpointMode=Private */ privateEndpointId: string; } interface GetHostedApplicationNetworkingConfigOutboundNetworkingConfig { /** * ocid of customer subnet when networkMode=Custom */ customSubnetId: string; /** * outbounding to managed internet or customer network. */ networkMode: string; /** * A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to. */ nsgIds: string[]; } interface GetHostedApplicationScalingConfig { /** * Maximum number of replicas allowed. */ maxReplica: number; /** * Minimum number of replicas to keep running. */ minReplica: number; /** * scaling type for application. */ scalingType: string; /** * number of simultaneous requests that can be processed by each replica. */ targetConcurrencyThreshold: number; /** * Scale up if average CPU utilization exceeds this threshold. */ targetCpuThreshold: number; /** * Scale up if average memory utilization exceeds this threshold. */ targetMemoryThreshold: number; /** * requests-per-second per replica of an application. */ targetRpsThreshold: number; } interface GetHostedApplicationStorageConfig { /** * The key of environment variable to store the database connection. */ environmentVariableKey: string; /** * The [OCID] of ApplicationStorage. */ storageId: string; } interface GetHostedApplicationStoragesFilter { name: string; regex?: boolean; values: string[]; } interface GetHostedApplicationStoragesHostedApplicationStorageCollection { items: outputs.GenerativeAi.GetHostedApplicationStoragesHostedApplicationStorageCollectionItem[]; } interface GetHostedApplicationStoragesHostedApplicationStorageCollectionItem { /** * A list of application OCID. */ applicationIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * An optional description of the hosted application storage. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application storage. */ id: string; /** * A message describing the current state of the hosted application storage in more detail that can provide actionable information. */ lifecycleDetails: string; /** * A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state. */ state: string; /** * type like Cache, Postgresql and ADB. */ storageType: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the hosted application was created, in the format defined by RFC 3339 */ timeCreated: string; /** * The date and time the hosted application was updated, in the format defined by RFC 3339 */ timeUpdated: string; } interface GetHostedApplicationsFilter { /** * Name of the environment variable. */ name: string; regex?: boolean; values: string[]; } interface GetHostedApplicationsHostedApplicationCollection { items: outputs.GenerativeAi.GetHostedApplicationsHostedApplicationCollectionItem[]; } interface GetHostedApplicationsHostedApplicationCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * An optional description of the hosted application. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The list of environment variables for the Hosted Application. Defines a list of environment variables injected at runtime. */ environmentVariables: outputs.GenerativeAi.GetHostedApplicationsHostedApplicationCollectionItemEnvironmentVariable[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted application. */ id: string; /** * The client-side inbound authentication configuration for the Hosted Application. Defines the network access rules. When unspecified, the service applies the default inbound authentication configuration type. */ inboundAuthConfigs: outputs.GenerativeAi.GetHostedApplicationsHostedApplicationCollectionItemInboundAuthConfig[]; /** * A message describing the current state of the endpoint in more detail that can provide actionable information. */ lifecycleDetails: string; /** * Networking configuration. */ networkingConfigs: outputs.GenerativeAi.GetHostedApplicationsHostedApplicationCollectionItemNetworkingConfig[]; /** * The auto scaling configuration for the Hosted Application. Defines the minimum and maximum number of replicas. When unspecified, the service applies service-defined default scaling values. */ scalingConfigs: outputs.GenerativeAi.GetHostedApplicationsHostedApplicationCollectionItemScalingConfig[]; /** * A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state. */ state: string; /** * A list of storageConfigs managed by the Oracle Cloud Infrastructure GenAI Platform and attached to the application. */ storageConfigs: outputs.GenerativeAi.GetHostedApplicationsHostedApplicationCollectionItemStorageConfig[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the hosted application was created, in the format defined by RFC 3339 */ timeCreated: string; /** * The date and time the hosted application was updated, in the format defined by RFC 3339 */ timeUpdated: string; } interface GetHostedApplicationsHostedApplicationCollectionItemEnvironmentVariable { /** * Name of the environment variable. */ name: string; /** * Type of the environment variable (PLAINTEXT or VAULT, no default value). */ type: string; /** * Value of the environment variable. */ value: string; } interface GetHostedApplicationsHostedApplicationCollectionItemInboundAuthConfig { /** * Oracle Identity Cloud Service (IDCS) configuration used when inboundAuthConfigType is set to IDCS_AUTH_CONFIG. This object must be specified when inboundAuthConfigType is IDCS_AUTH_CONFIG. */ idcsConfigs: outputs.GenerativeAi.GetHostedApplicationsHostedApplicationCollectionItemInboundAuthConfigIdcsConfig[]; /** * Inbound authentication configuration type of network access (IDCS_AUTH_CONFIG). */ inboundAuthConfigType: string; } interface GetHostedApplicationsHostedApplicationCollectionItemInboundAuthConfigIdcsConfig { /** * Audience for IDCS. */ audience: string; /** * Domain URL for IDCS. */ domainUrl: string; /** * Scope for IDCS. */ scope: string; } interface GetHostedApplicationsHostedApplicationCollectionItemNetworkingConfig { /** * Inbound Networking configuration. */ inboundNetworkingConfigs: outputs.GenerativeAi.GetHostedApplicationsHostedApplicationCollectionItemNetworkingConfigInboundNetworkingConfig[]; /** * Outbound Networking configuration. */ outboundNetworkingConfigs: outputs.GenerativeAi.GetHostedApplicationsHostedApplicationCollectionItemNetworkingConfigOutboundNetworkingConfig[]; } interface GetHostedApplicationsHostedApplicationCollectionItemNetworkingConfigInboundNetworkingConfig { /** * inbounding from public or private endpoint. */ endpointMode: string; /** * The [OCID] of Private Endpoint when endpointMode=Private */ privateEndpointId: string; } interface GetHostedApplicationsHostedApplicationCollectionItemNetworkingConfigOutboundNetworkingConfig { /** * ocid of customer subnet when networkMode=Custom */ customSubnetId: string; /** * outbounding to managed internet or customer network. */ networkMode: string; /** * A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to. */ nsgIds: string[]; } interface GetHostedApplicationsHostedApplicationCollectionItemScalingConfig { /** * Maximum number of replicas allowed. */ maxReplica: number; /** * Minimum number of replicas to keep running. */ minReplica: number; /** * scaling type for application. */ scalingType: string; /** * number of simultaneous requests that can be processed by each replica. */ targetConcurrencyThreshold: number; /** * Scale up if average CPU utilization exceeds this threshold. */ targetCpuThreshold: number; /** * Scale up if average memory utilization exceeds this threshold. */ targetMemoryThreshold: number; /** * requests-per-second per replica of an application. */ targetRpsThreshold: number; } interface GetHostedApplicationsHostedApplicationCollectionItemStorageConfig { /** * The key of environment variable to store the database connection. */ environmentVariableKey: string; /** * The [OCID] of ApplicationStorage. */ storageId: string; } interface GetHostedDeploymentActiveArtifact { /** * The type of the artifact. */ artifactType: string; /** * image url. */ containerUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. */ hostedDeploymentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. */ id: string; /** * Optional flag that requires an Oracle Cloud Infrastructure Vulnerability Scanning Service compliance report for this artifact before it can become active. When not provided, the value defaults to false and the artifact is not blocked on a scan result. */ isVulnerabilityScanRequired: boolean; /** * The current status of the artifact. */ status: string; /** * image tag. */ tag: string; /** * The date and time the hosted deployment was created, in the format defined by RFC 3339 */ timeCreated: string; } interface GetHostedDeploymentArtifact { /** * The type of the artifact. */ artifactType: string; /** * image url. */ containerUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. */ hostedDeploymentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. */ id: string; /** * Optional flag that requires an Oracle Cloud Infrastructure Vulnerability Scanning Service compliance report for this artifact before it can become active. When not provided, the value defaults to false and the artifact is not blocked on a scan result. */ isVulnerabilityScanRequired: boolean; /** * The current status of the artifact. */ status: string; /** * image tag. */ tag: string; /** * The date and time the hosted deployment was created, in the format defined by RFC 3339 */ timeCreated: string; } interface GetHostedDeploymentsFilter { name: string; regex?: boolean; values: string[]; } interface GetHostedDeploymentsHostedDeploymentCollection { items: outputs.GenerativeAi.GetHostedDeploymentsHostedDeploymentCollectionItem[]; } interface GetHostedDeploymentsHostedDeploymentCollectionItem { /** * Container/artifact configuration for the deployment. */ activeArtifacts: outputs.GenerativeAi.GetHostedDeploymentsHostedDeploymentCollectionItemActiveArtifact[]; /** * array of Artifacts. */ artifacts: outputs.GenerativeAi.GetHostedDeploymentsHostedDeploymentCollectionItemArtifact[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent Hosted Application. The ID may refer to either an IAM-authenticated or non-IAM Hosted Application. */ hostedApplicationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. */ id: string; /** * A filter to return only the hosted deployments that their lifecycle state matches the given lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the hosted deployment was created, in the format defined by RFC 3339 */ timeCreated: string; /** * The date and time the hosted deployment was updated, in the format defined by RFC 3339 */ timeUpdated: string; } interface GetHostedDeploymentsHostedDeploymentCollectionItemActiveArtifact { /** * The type of the artifact. */ artifactType: string; /** * image url. */ containerUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application. */ hostedDeploymentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. */ id: string; /** * Optional flag that requires an Oracle Cloud Infrastructure Vulnerability Scanning Service compliance report for this artifact before it can become active. When not provided, the value defaults to false and the artifact is not blocked on a scan result. */ isVulnerabilityScanRequired: boolean; /** * The current status of the artifact. */ status: string; /** * image tag. */ tag: string; /** * The date and time the hosted deployment was created, in the format defined by RFC 3339 */ timeCreated: string; } interface GetHostedDeploymentsHostedDeploymentCollectionItemArtifact { /** * The type of the artifact. */ artifactType: string; /** * image url. */ containerUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application. */ hostedDeploymentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. */ id: string; /** * Optional flag that requires an Oracle Cloud Infrastructure Vulnerability Scanning Service compliance report for this artifact before it can become active. When not provided, the value defaults to false and the artifact is not blocked on a scan result. */ isVulnerabilityScanRequired: boolean; /** * The current status of the artifact. */ status: string; /** * image tag. */ tag: string; /** * The date and time the hosted deployment was created, in the format defined by RFC 3339 */ timeCreated: string; } interface GetImportedModelDataSource { accessToken: string; branch: string; bucket: string; commit: string; modelId: string; namespace: string; prefixName: string; region: string; sourceType: string; } interface GetImportedModelsFilter { name: string; regex?: boolean; values: string[]; } interface GetImportedModelsImportedModelCollection { items: outputs.GenerativeAi.GetImportedModelsImportedModelCollectionItem[]; } interface GetImportedModelsImportedModelCollectionItem { capabilities: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; dataSources: outputs.GenerativeAi.GetImportedModelsImportedModelCollectionItemDataSource[]; definedTags: { [key: string]: string; }; description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The ID of the importedModel. */ id: string; /** * Additional information about the current state of the imported model, providing more detailed and actionable context. */ lifecycleDetails: string; previousState: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; systemTags: { [key: string]: string; }; /** * The date and time that the imported model was created in the format of an RFC3339 datetime string. */ timeCreated: string; timeUpdated: string; /** * A filter to return only resources that match the entire vendor given. */ vendor: string; version: string; } interface GetImportedModelsImportedModelCollectionItemDataSource { accessToken: string; branch: string; bucket: string; commit: string; modelId: string; namespace: string; prefixName: string; region: string; sourceType: string; } interface GetModelFineTuneDetail { dedicatedAiClusterId: string; trainingConfigs: outputs.GenerativeAi.GetModelFineTuneDetailTrainingConfig[]; trainingDatasets: outputs.GenerativeAi.GetModelFineTuneDetailTrainingDataset[]; } interface GetModelFineTuneDetailTrainingConfig { earlyStoppingPatience: number; earlyStoppingThreshold: number; learningRate: number; logModelMetricsIntervalInSteps: number; loraAlpha: number; loraDropout: number; loraR: number; numOfLastLayers: number; totalTrainingEpochs: number; trainingBatchSize: number; trainingConfigType: string; } interface GetModelFineTuneDetailTrainingDataset { bucket: string; datasetType: string; namespace: string; object: string; } interface GetModelModelMetric { finalAccuracy: number; finalLoss: number; modelMetricsType: string; } interface GetModelsFilter { name: string; regex?: boolean; values: string[]; } interface GetModelsModelCollection { items: outputs.GenerativeAi.GetModelsModelCollectionItem[]; } interface GetModelsModelCollectionItem { baseModelId: string; /** * Describes what this model can be used for. */ capabilities: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; definedTags: { [key: string]: string; }; /** * An optional description of the model. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; fineTuneDetails: outputs.GenerativeAi.GetModelsModelCollectionItemFineTuneDetail[]; freeformTags: { [key: string]: string; }; /** * The ID of the model. */ id: string; isLongTermSupported: boolean; lifecycleDetails: string; modelMetrics: outputs.GenerativeAi.GetModelsModelCollectionItemModelMetric[]; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; timeCreated: string; timeDeprecated: string; timeUpdated: string; type: string; /** * A filter to return only resources that match the entire vendor given. */ vendor: string; /** * The version of the model. */ version: string; } interface GetModelsModelCollectionItemFineTuneDetail { dedicatedAiClusterId: string; trainingConfigs: outputs.GenerativeAi.GetModelsModelCollectionItemFineTuneDetailTrainingConfig[]; trainingDatasets: outputs.GenerativeAi.GetModelsModelCollectionItemFineTuneDetailTrainingDataset[]; } interface GetModelsModelCollectionItemFineTuneDetailTrainingConfig { earlyStoppingPatience: number; earlyStoppingThreshold: number; learningRate: number; logModelMetricsIntervalInSteps: number; loraAlpha: number; loraDropout: number; loraR: number; numOfLastLayers: number; totalTrainingEpochs: number; trainingBatchSize: number; trainingConfigType: string; } interface GetModelsModelCollectionItemFineTuneDetailTrainingDataset { bucket: string; datasetType: string; namespace: string; object: string; } interface GetModelsModelCollectionItemModelMetric { finalAccuracy: number; finalLoss: number; modelMetricsType: string; } interface GetProjectConversationConfig { /** * Retention period (in hours) for conversations. The TTL starts from the time the conversation was last updated. */ conversationsRetentionInHours: number; /** * Retention period (in hours) for responses. The TTL starts from the time the response was created. */ responsesRetentionInHours: number; } interface GetProjectLongTermMemoryConfig { /** * Standard strategy settings for long-term memory. */ standardLongTermMemoryStrategies: outputs.GenerativeAi.GetProjectLongTermMemoryConfigStandardLongTermMemoryStrategy[]; } interface GetProjectLongTermMemoryConfigStandardLongTermMemoryStrategy { /** * Configuration for generating embeddings from extracted information. */ embeddingConfigs: outputs.GenerativeAi.GetProjectLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfig[]; /** * Configuration for information extraction from conversation content. */ extractionConfigs: outputs.GenerativeAi.GetProjectLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfig[]; /** * Indicates whether short-term memory optimization is enabled. */ isEnabled: boolean; } interface GetProjectLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfig { /** * LLM selection configuration. */ llmSelections: outputs.GenerativeAi.GetProjectLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfigLlmSelection[]; } interface GetProjectLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfigLlmSelection { /** * The type of LLM selection. */ llmSelectionType: string; /** * The id of the GenAI model */ modelId: string; } interface GetProjectLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfig { /** * LLM selection configuration. */ llmSelections: outputs.GenerativeAi.GetProjectLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfigLlmSelection[]; } interface GetProjectLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfigLlmSelection { /** * The type of LLM selection. */ llmSelectionType: string; /** * The id of the GenAI model */ modelId: string; } interface GetProjectShortTermMemoryOptimizationConfig { /** * Configuration for condensing conversation content. */ condenserConfigs: outputs.GenerativeAi.GetProjectShortTermMemoryOptimizationConfigCondenserConfig[]; /** * Indicates whether short-term memory optimization is enabled. */ isEnabled: boolean; } interface GetProjectShortTermMemoryOptimizationConfigCondenserConfig { /** * LLM selection configuration. */ llmSelections: outputs.GenerativeAi.GetProjectShortTermMemoryOptimizationConfigCondenserConfigLlmSelection[]; } interface GetProjectShortTermMemoryOptimizationConfigCondenserConfigLlmSelection { /** * The type of LLM selection. */ llmSelectionType: string; /** * The id of the GenAI model */ modelId: string; } interface GetProjectsFilter { name: string; regex?: boolean; values: string[]; } interface GetProjectsGenerativeAiProjectCollection { items: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItem[]; } interface GetProjectsGenerativeAiProjectCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Holds configuration related to conversation retention */ conversationConfigs: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItemConversationConfig[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * An optional description of the GenerativeAiProject. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the generativeAiProject. */ id: string; /** * A message describing the current state in more detail that can provide actionable information. */ lifecycleDetails: string; /** * Configuration settings for long-term memory behavior. */ longTermMemoryConfigs: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfig[]; /** * Configuration settings for short-term memory optimization. */ shortTermMemoryOptimizationConfigs: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItemShortTermMemoryOptimizationConfig[]; /** * A filter to return only resources whose lifecycle state matches the given value. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time that the generativeAiProject was created in the format of an RFC3339 datetime string. */ timeCreated: string; /** * The date and time that the generativeAiProject was updated in the format of an RFC3339 datetime string. */ timeUpdated: string; } interface GetProjectsGenerativeAiProjectCollectionItemConversationConfig { /** * Retention period (in hours) for conversations. The TTL starts from the time the conversation was last updated. */ conversationsRetentionInHours: number; /** * Retention period (in hours) for responses. The TTL starts from the time the response was created. */ responsesRetentionInHours: number; } interface GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfig { /** * Standard strategy settings for long-term memory. */ standardLongTermMemoryStrategies: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfigStandardLongTermMemoryStrategy[]; } interface GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfigStandardLongTermMemoryStrategy { /** * Configuration for generating embeddings from extracted information. */ embeddingConfigs: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfig[]; /** * Configuration for information extraction from conversation content. */ extractionConfigs: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfig[]; /** * Indicates whether short-term memory optimization is enabled. */ isEnabled: boolean; } interface GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfig { /** * LLM selection configuration. */ llmSelections: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfigLlmSelection[]; } interface GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfigLlmSelection { /** * The type of LLM selection. */ llmSelectionType: string; /** * The id of the GenAI model */ modelId: string; } interface GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfig { /** * LLM selection configuration. */ llmSelections: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfigLlmSelection[]; } interface GetProjectsGenerativeAiProjectCollectionItemLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfigLlmSelection { /** * The type of LLM selection. */ llmSelectionType: string; /** * The id of the GenAI model */ modelId: string; } interface GetProjectsGenerativeAiProjectCollectionItemShortTermMemoryOptimizationConfig { /** * Configuration for condensing conversation content. */ condenserConfigs: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItemShortTermMemoryOptimizationConfigCondenserConfig[]; /** * Indicates whether short-term memory optimization is enabled. */ isEnabled: boolean; } interface GetProjectsGenerativeAiProjectCollectionItemShortTermMemoryOptimizationConfigCondenserConfig { /** * LLM selection configuration. */ llmSelections: outputs.GenerativeAi.GetProjectsGenerativeAiProjectCollectionItemShortTermMemoryOptimizationConfigCondenserConfigLlmSelection[]; } interface GetProjectsGenerativeAiProjectCollectionItemShortTermMemoryOptimizationConfigCondenserConfigLlmSelection { /** * The type of LLM selection. */ llmSelectionType: string; /** * The id of the GenAI model */ modelId: string; } interface GetSemanticStoreDataSource { /** * Specifies the type of underlying connection. */ connectionType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure Database Tools Connection for enrichment. */ enrichmentConnectionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure Database Tools Connection for querying. */ queryingConnectionId: string; } interface GetSemanticStoreRefreshSchedule { /** * Specifies the type of refresh schedule. */ type: string; /** * Specifies the refresh interval value. The interval must be provided using the ISO 8601 extended format, either as PnW or PnYnMnDTnHnMnS, where 'P' is always required, 'T' precedes any time components less than one day, and each included component is properly suffixed. For example, "P1DT6H" represents a duration of 1 day and 6 hours. */ value: string; } interface GetSemanticStoreSchema { /** * Specifies the type of underlying connection. */ connectionType: string; /** * Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later. */ schemas: outputs.GenerativeAi.GetSemanticStoreSchemaSchema[]; } interface GetSemanticStoreSchemaSchema { name: string; } interface GetSemanticStoresFilter { name: string; regex?: boolean; values: string[]; } interface GetSemanticStoresSemanticStoreCollection { items: outputs.GenerativeAi.GetSemanticStoresSemanticStoreCollectionItem[]; } interface GetSemanticStoresSemanticStoreCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defines the data source that the semantic model connects to. */ dataSources: outputs.GenerativeAi.GetSemanticStoresSemanticStoreCollectionItemDataSource[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * An optional description of the SemanticStore. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SemanticStore. */ id: string; /** * A message describing the current state in more detail that can provide actionable information. */ lifecycleDetails: string; /** * Specifies a refresh schedule. Null represents no automated synchronization schedule. */ refreshSchedules: outputs.GenerativeAi.GetSemanticStoresSemanticStoreCollectionItemRefreshSchedule[]; /** * Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later. */ schemas: outputs.GenerativeAi.GetSemanticStoresSemanticStoreCollectionItemSchema[]; /** * A filter to return only resources whose lifecycle state matches the given array. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time that the SemanticStore was created in the format of an RFC3339 datetime string. */ timeCreated: string; /** * The date and time that the SemanticStore was updated in the format of an RFC3339 datetime string. */ timeUpdated: string; } interface GetSemanticStoresSemanticStoreCollectionItemDataSource { /** * Specifies the type of underlying connection. */ connectionType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure Database Tools Connection for enrichment. */ enrichmentConnectionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure Database Tools Connection for querying. */ queryingConnectionId: string; } interface GetSemanticStoresSemanticStoreCollectionItemRefreshSchedule { /** * Specifies the type of refresh schedule. */ type: string; /** * Specifies the refresh interval value. The interval must be provided using the ISO 8601 extended format, either as PnW or PnYnMnDTnHnMnS, where 'P' is always required, 'T' precedes any time components less than one day, and each included component is properly suffixed. For example, "P1DT6H" represents a duration of 1 day and 6 hours. */ value: string; } interface GetSemanticStoresSemanticStoreCollectionItemSchema { /** * Specifies the type of underlying connection. */ connectionType: string; /** * Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later. */ schemas: outputs.GenerativeAi.GetSemanticStoresSemanticStoreCollectionItemSchemaSchema[]; } interface GetSemanticStoresSemanticStoreCollectionItemSchemaSchema { name: string; } interface HostedApplicationEnvironmentVariable { /** * (Updatable) Name of the environment variable. */ name: string; /** * (Updatable) Type of the environment variable (PLAINTEXT or VAULT, no default value). */ type: string; /** * (Updatable) Value of the environment variable. */ value: string; } interface HostedApplicationIamEnvironmentVariable { /** * (Updatable) Name of the environment variable. */ name: string; /** * (Updatable) Type of the environment variable (PLAINTEXT or VAULT, no default value). */ type: string; /** * (Updatable) Value of the environment variable. */ value: string; } interface HostedApplicationIamNetworkingConfig { /** * Inbound Networking configuration. */ inboundNetworkingConfig: outputs.GenerativeAi.HostedApplicationIamNetworkingConfigInboundNetworkingConfig; /** * Outbound Networking configuration. */ outboundNetworkingConfig: outputs.GenerativeAi.HostedApplicationIamNetworkingConfigOutboundNetworkingConfig; } interface HostedApplicationIamNetworkingConfigInboundNetworkingConfig { /** * inbounding from public or private endpoint. */ endpointMode: string; /** * The [OCID] of Private Endpoint when endpointMode=Private */ privateEndpointId: string; } interface HostedApplicationIamNetworkingConfigOutboundNetworkingConfig { /** * ocid of customer subnet when networkMode=Custom */ customSubnetId: string; /** * outbounding to managed internet or customer network. */ networkMode: string; /** * A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to. */ nsgIds: string[]; } interface HostedApplicationIamScalingConfig { /** * (Updatable) Maximum number of replicas allowed. */ maxReplica: number; /** * (Updatable) Minimum number of replicas to keep running. */ minReplica: number; /** * (Updatable) scaling type for application. */ scalingType: string; /** * (Updatable) number of simultaneous requests that can be processed by each replica. */ targetConcurrencyThreshold: number; /** * (Updatable) Scale up if average CPU utilization exceeds this threshold. */ targetCpuThreshold: number; /** * (Updatable) Scale up if average memory utilization exceeds this threshold. */ targetMemoryThreshold: number; /** * (Updatable) requests-per-second per replica of an application. */ targetRpsThreshold: number; } interface HostedApplicationIamStorageConfig { /** * The key of environment variable to store the database connection. */ environmentVariableKey: string; /** * The [OCID] of ApplicationStorage. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ storageId: string; } interface HostedApplicationInboundAuthConfig { /** * (Updatable) Oracle Identity Cloud Service (IDCS) configuration used when inboundAuthConfigType is set to IDCS_AUTH_CONFIG. This object must be specified when inboundAuthConfigType is IDCS_AUTH_CONFIG. */ idcsConfig: outputs.GenerativeAi.HostedApplicationInboundAuthConfigIdcsConfig; /** * (Updatable) Inbound authentication configuration type of network access (IDCS_AUTH_CONFIG). */ inboundAuthConfigType: string; } interface HostedApplicationInboundAuthConfigIdcsConfig { /** * (Updatable) Audience for IDCS. */ audience: string; /** * (Updatable) Domain URL for IDCS. */ domainUrl: string; /** * (Updatable) Scope for IDCS. */ scope: string; } interface HostedApplicationNetworkingConfig { /** * Inbound Networking configuration. */ inboundNetworkingConfig: outputs.GenerativeAi.HostedApplicationNetworkingConfigInboundNetworkingConfig; /** * Outbound Networking configuration. */ outboundNetworkingConfig: outputs.GenerativeAi.HostedApplicationNetworkingConfigOutboundNetworkingConfig; } interface HostedApplicationNetworkingConfigInboundNetworkingConfig { /** * inbounding from public or private endpoint. */ endpointMode: string; /** * The [OCID] of Private Endpoint when endpointMode=Private */ privateEndpointId: string; } interface HostedApplicationNetworkingConfigOutboundNetworkingConfig { /** * ocid of customer subnet when networkMode=Custom */ customSubnetId: string; /** * outbounding to managed internet or customer network. */ networkMode: string; /** * A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to. */ nsgIds: string[]; } interface HostedApplicationScalingConfig { /** * (Updatable) Maximum number of replicas allowed. */ maxReplica: number; /** * (Updatable) Minimum number of replicas to keep running. */ minReplica: number; /** * (Updatable) scaling type for application. */ scalingType: string; /** * (Updatable) number of simultaneous requests that can be processed by each replica. */ targetConcurrencyThreshold: number; /** * (Updatable) Scale up if average CPU utilization exceeds this threshold. */ targetCpuThreshold: number; /** * (Updatable) Scale up if average memory utilization exceeds this threshold. */ targetMemoryThreshold: number; /** * (Updatable) requests-per-second per replica of an application. */ targetRpsThreshold: number; } interface HostedApplicationStorageConfig { /** * The key of environment variable to store the database connection. */ environmentVariableKey: string; /** * The [OCID] of ApplicationStorage. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ storageId: string; } interface HostedDeploymentActiveArtifact { /** * (Updatable) The type of the artifact. */ artifactType: string; /** * (Updatable) image url. */ containerUri: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application. */ hostedDeploymentId: string; /** * (Updatable) if put artifact to a table, the id is needed */ id: string; /** * (Updatable) Optional flag that requires an Oracle Cloud Infrastructure Vulnerability Scanning Service compliance report for this artifact before it can become active. When not provided, the value defaults to false and the artifact is not blocked on a scan result. */ isVulnerabilityScanRequired: boolean; /** * (Updatable) The current status of the artifact. */ status: string; /** * (Updatable) image tag. */ tag: string; /** * (Updatable) The date and time the artifact was created. */ timeCreated: string; } interface HostedDeploymentArtifact { /** * The type of the artifact. */ artifactType: string; /** * image url. */ containerUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application. */ hostedDeploymentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the hosted deployment. */ id: string; /** * Optional flag that requires an Oracle Cloud Infrastructure Vulnerability Scanning Service compliance report for this artifact before it can become active. When not provided, the value defaults to false and the artifact is not blocked on a scan result. */ isVulnerabilityScanRequired: boolean; /** * The current status of the artifact. */ status: string; /** * image tag. */ tag: string; /** * The date and time the hosted deployment was created, in the format defined by RFC 3339 */ timeCreated: string; } interface ImportedModelDataSource { /** * Hugging Face access token to authenticate requests for restricted models. This token will be securely stored in Oracle Cloud Infrastructure Vault. */ accessToken: string; /** * The name of the branch in the Hugging Face repository to import the model from. If not specified, "main" will be used by default. If you provide both a branch and a commit hash, the model will be imported from the specified commit. */ branch: string; /** * The name of the Object Storage bucket. */ bucket: string; /** * The commit hash in the Hugging Face repository to import the model from. If both a branch and a commit are provided, the commit hash will be used. */ commit: string; /** * The full model OCID from Hugging Face, typically in the format "org/model-name" (e.g., "meta-llama/Llama-2-7b"). */ modelId: string; /** * The namespace of the Object Storage where the files are stored. */ namespace: string; /** * The prefix path (or folder) within the bucket where files are located. */ prefixName: string; /** * The full canonical Oracle Cloud region identifier (e.g., "us-ashburn-1") where the object storage bucket containing the files resides. */ region: string; /** * Specifies the source type for model import. */ sourceType: string; } interface ModelFineTuneDetails { /** * The OCID of the dedicated AI cluster this fine-tuning runs on. */ dedicatedAiClusterId: string; /** * The fine-tuning method and hyperparameters used for fine-tuning a custom model. */ trainingConfig: outputs.GenerativeAi.ModelFineTuneDetailsTrainingConfig; /** * The dataset used to fine-tune the model. * * Only one dataset is allowed per custom model, which is split 80-20 for training and validating. You must provide the dataset in a JSON Lines (JSONL) file. Each line in the JSONL file must have the format: `{"prompt": "", "completion": ""}` */ trainingDataset: outputs.GenerativeAi.ModelFineTuneDetailsTrainingDataset; } interface ModelFineTuneDetailsTrainingConfig { /** * Stop training if the loss metric does not improve beyond 'early_stopping_threshold' for this many times of evaluation. */ earlyStoppingPatience: number; /** * How much the loss must improve to prevent early stopping. */ earlyStoppingThreshold: number; /** * The initial learning rate to be used during training */ learningRate: number; /** * Determines how frequently to log model metrics. * * Every step is logged for the first 20 steps and then follows this parameter for log frequency. Set to 0 to disable logging the model metrics. */ logModelMetricsIntervalInSteps: number; /** * This parameter represents the scaling factor for the weight matrices in LoRA. */ loraAlpha: number; /** * This parameter indicates the dropout probability for LoRA layers. */ loraDropout: number; /** * This parameter represents the LoRA rank of the update matrices. */ loraR: number; /** * The number of last layers to be fine-tuned. */ numOfLastLayers: number; /** * The maximum number of training epochs to run for. */ totalTrainingEpochs: number; /** * The batch size used during training. */ trainingBatchSize: number; /** * The fine-tuning method for training a custom model. */ trainingConfigType: string; } interface ModelFineTuneDetailsTrainingDataset { /** * The Object Storage bucket name. */ bucket: string; /** * The type of the data asset. */ datasetType: string; /** * The Object Storage namespace. */ namespace: string; /** * The Object Storage object name. */ object: string; } interface ModelModelMetric { /** * Fine-tuned model accuracy. */ finalAccuracy: number; /** * Fine-tuned model loss. */ finalLoss: number; /** * The type of the model metrics. Each type of model can expect a different set of model metrics. */ modelMetricsType: string; } interface ProjectConversationConfig { /** * (Updatable) Retention period (in hours) for conversations. The TTL starts from the time the conversation was last updated. */ conversationsRetentionInHours: number; /** * (Updatable) Retention period (in hours) for responses. The TTL starts from the time the response was created. */ responsesRetentionInHours: number; } interface ProjectLongTermMemoryConfig { /** * (Updatable) Standard strategy settings for long-term memory. */ standardLongTermMemoryStrategy: outputs.GenerativeAi.ProjectLongTermMemoryConfigStandardLongTermMemoryStrategy; } interface ProjectLongTermMemoryConfigStandardLongTermMemoryStrategy { /** * (Updatable) Configuration for generating embeddings from extracted information. */ embeddingConfig: outputs.GenerativeAi.ProjectLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfig; /** * (Updatable) Configuration for information extraction from conversation content. */ extractionConfig: outputs.GenerativeAi.ProjectLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfig; /** * (Updatable) Indicates whether long-term memory is enabled. */ isEnabled: boolean; } interface ProjectLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfig { /** * (Updatable) LLM selection configuration. */ llmSelection: outputs.GenerativeAi.ProjectLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfigLlmSelection; } interface ProjectLongTermMemoryConfigStandardLongTermMemoryStrategyEmbeddingConfigLlmSelection { /** * (Updatable) The type of LLM selection. */ llmSelectionType: string; /** * (Updatable) The id of the GenAI model */ modelId: string; } interface ProjectLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfig { /** * (Updatable) LLM selection configuration. */ llmSelection: outputs.GenerativeAi.ProjectLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfigLlmSelection; } interface ProjectLongTermMemoryConfigStandardLongTermMemoryStrategyExtractionConfigLlmSelection { /** * (Updatable) The type of LLM selection. */ llmSelectionType: string; /** * (Updatable) The id of the GenAI model */ modelId: string; } interface ProjectShortTermMemoryOptimizationConfig { /** * (Updatable) Configuration for condensing conversation content. */ condenserConfig: outputs.GenerativeAi.ProjectShortTermMemoryOptimizationConfigCondenserConfig; /** * (Updatable) Indicates whether short-term memory optimization is enabled. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ isEnabled: boolean; } interface ProjectShortTermMemoryOptimizationConfigCondenserConfig { /** * (Updatable) LLM selection configuration. */ llmSelection: outputs.GenerativeAi.ProjectShortTermMemoryOptimizationConfigCondenserConfigLlmSelection; } interface ProjectShortTermMemoryOptimizationConfigCondenserConfigLlmSelection { /** * (Updatable) The type of LLM selection. */ llmSelectionType: string; /** * (Updatable) The id of the GenAI model */ modelId: string; } interface SemanticStoreDataSource { /** * Specifies the type of underlying connection. */ connectionType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure Database Tools Connection for enrichment. */ enrichmentConnectionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure Database Tools Connection for querying. */ queryingConnectionId: string; } interface SemanticStoreRefreshSchedule { /** * (Updatable) Specifies the type of refresh schedule. */ type: string; /** * (Updatable) Specifies the refresh interval value. The interval must be provided using the ISO 8601 extended format, either as PnW or PnYnMnDTnHnMnS, where 'P' is always required, 'T' precedes any time components less than one day, and each included component is properly suffixed. For example, "P1DT6H" represents a duration of 1 day and 6 hours. */ value: string; } interface SemanticStoreSchemas { /** * (Updatable) Specifies the type of underlying connection. */ connectionType: string; /** * (Updatable) Array of database schemas to be included in the connection. Each schema must define a name. A simple schema definition includes only the name, for example: { "schemas": [ { "name": "HR" } ] } Only one schema name is allowed now. Additional configuration options may be supported in extended forms later. */ schemas: outputs.GenerativeAi.SemanticStoreSchemasSchema[]; } interface SemanticStoreSchemasSchema { /** * (Updatable) * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ name: string; } } export declare namespace GoldenGate { interface ConnectionAdditionalAttribute { /** * (Updatable) The name of the property entry. */ name: string; /** * (Updatable) The value of the property entry. */ value: string; } interface ConnectionAuthDetails { /** * (Updatable) API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate */ apiKey: string; /** * (Updatable) API key secret OCID for the AI model connection. */ apiKeySecretId: string; /** * (Updatable) Authentication type used by the AI model connection. */ authType: string; /** * (Updatable) Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used. */ baseUrl: string; /** * (Updatable) Oracle Cloud Infrastructure Generative AI key fingerprint. */ keyFingerprint: string; /** * (Updatable) The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region. */ region: string; /** * (Updatable) Oracle Cloud Infrastructure Generative AI tenancy OCID. If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation. */ tenancyId: string; /** * (Updatable) Oracle Cloud Infrastructure Generative AI user OCID. If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation. */ userId: string; } interface ConnectionBootstrapServer { /** * (Updatable) The name or address of a host. */ host: string; /** * (Updatable) The port of an endpoint usually specified for a connection. */ port: number; /** * This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty. */ privateIp: string; } interface ConnectionCatalog { /** * (Updatable) The active branch of the Nessie catalog from which Iceberg reads and writes table metadata. */ branch: string; /** * (Updatable) The catalog type. */ catalogType: string; /** * (Updatable) The OAuth client ID used for authentication. */ clientId: string; /** * (Updatable) Client secret required to connect to Polaris. * * @deprecated The 'client_secret' field has been deprecated. Please use 'client_secret_secret_id' instead. */ clientSecret: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris. */ clientSecretSecretId: string; /** * (Updatable) The AWS Glue Catalog ID where Iceberg tables are registered. */ glueId: string; /** * (Updatable) The catalog name within Polaris where Iceberg tables are registered. */ name: string; /** * (Updatable) The Snowflake role used to access Polaris. */ principalRole: string; /** * (Updatable) The base64 encoded content of the configuration file containing additional properties for the REST catalog. * * @deprecated The 'properties' field has been deprecated. Please use 'properties_secret_id' instead. */ properties: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm */ propertiesSecretId: string; /** * (Updatable) * * NESSIE: Nessie URI. e.g.: 'http://.com:10001/api/v2' * * POLARIS: The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog' * * REST: The base URL for the REST Catalog API. e.g.: 'https://my-rest-catalog.example.com/api/v1' */ uri: string; } interface ConnectionIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface ConnectionLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface ConnectionStorage { /** * (Updatable) * * AMAZON_S3: Access key ID to access the Amazon S3 bucket. * * OCI_OBJECT_STORAGE_S3_API: Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. * Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID. */ accessKeyId: string; /** * (Updatable) Azure storage account key. This property is required when 'authenticationType' is set to 'SHARED_KEY'. e.g.: pa3WbhVATzj56xD4DH1VjOUhApRGEGHvOo58eQJVWIzX+j8j4CUVFcTjpIqDSRaSa1Wo2LbWY5at+AStEgLOIQ== Deprecated: This field is deprecated and replaced by "accountKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate * * @deprecated The 'account_key' field has been deprecated. Please use 'account_key_secret_id' instead. */ accountKey: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored. */ accountKeySecretId: string; /** * (Updatable) Sets the Azure storage account name. */ accountName: string; /** * (Updatable) * * AMAZON_S3: S3 bucket where Iceberg stores metadata and data files. * * GOOGLE_CLOUD_STORAGE: Google Cloud Storage bucket where Iceberg stores metadata and data files. * * OCI_OBJECT_STORAGE_S3_API: Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files. */ bucket: string; /** * (Updatable) The Azure Blob Storage container where Iceberg tables are stored. */ container: string; /** * (Updatable) * * AMAZON_S3: The endpoint URL of the Amazon S3 storage service. e.g.: 'https://s3.amazonaws.com' * * AZURE_DATA_LAKE_STORAGE: The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net' * * GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com * * OCI_OBJECT_STORAGE_S3_API: Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com" */ endpoint: string; /** * (Updatable) The Google Cloud Project where the bucket exists. */ projectId: string; /** * (Updatable) The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2' */ region: string; /** * (Updatable) The scheme of the storage. */ schemeType: string; /** * (Updatable) * * AMAZON_S3: Secret access key to access the Amazon S3 bucket. * * OCI_OBJECT_STORAGE_S3_API: Secret Access Key from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. * Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate * * @deprecated The 'secret_access_key' field has been deprecated. Please use 'secret_access_key_secret_id' instead. */ secretAccessKey: string; /** * (Updatable) * * AMAZON_S3: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored. * * OCI_OBJECT_STORAGE_S3_API: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication is stored. */ secretAccessKeySecretId: string; /** * (Updatable) The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage. Deprecated: This field is deprecated and replaced by "serviceAccountKeyFileSecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate * * @deprecated The 'service_account_key_file' field has been deprecated. Please use 'service_account_key_file_secret_id' instead. */ serviceAccountKeyFile: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. */ serviceAccountKeyFileSecretId: string; /** * (Updatable) The storage type used in the Iceberg connection. */ storageType: string; } interface DeploymentBackupLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DeploymentBackupSchedule { /** * (Updatable) Name of the bucket where the object is to be uploaded in the object storage */ bucket: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced. */ compartmentId: string; /** * (Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY. */ frequencyBackupScheduled: string; /** * (Updatable) Parameter to allow users to create backup without trails */ isMetadataOnly: boolean; /** * (Updatable) Name of namespace that serves as a container for all of your buckets */ namespace: string; /** * (Updatable) The start timestamp for the deployment backup schedule. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`. */ timeBackupScheduled: string; } interface DeploymentDeploymentDiagnosticData { /** * Name of the bucket where the object is to be uploaded in the object storage */ bucket: string; /** * The state of the deployment diagnostic collection. */ diagnosticState: string; /** * Name of namespace that serves as a container for all of your buckets */ namespace: string; /** * Name of the diagnostic collected and uploaded to object storage */ object: string; /** * The time until which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeDiagnosticEnd: string; /** * The time from which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeDiagnosticStart: string; } interface DeploymentIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface DeploymentLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface DeploymentMaintenanceConfiguration { /** * (Updatable) Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default. */ bundleReleaseUpgradePeriodInDays: number; /** * (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period. */ interimReleaseUpgradePeriodInDays: number; /** * (Updatable) By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too. */ isInterimReleaseAutoUpgradeEnabled: boolean; /** * (Updatable) Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default. */ majorReleaseUpgradePeriodInDays: number; /** * (Updatable) Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default. */ securityPatchUpgradePeriodInDays: number; } interface DeploymentMaintenanceWindow { /** * (Updatable) Days of the week. */ day: string; /** * (Updatable) Start hour for maintenance period. Hour is in UTC. */ startHour: number; } interface DeploymentOggData { /** * (Updatable) The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as '$', '^', or '?' are not allowed. This field will be deprecated and replaced by "passwordSecretId". * * @deprecated The 'admin_password' field has been deprecated. Please use 'password_secret_id' instead. */ adminPassword: string; /** * (Updatable) The GoldenGate deployment console username. */ adminUsername: string; /** * (Updatable) The base64 encoded content of the PEM file containing the SSL certificate. */ certificate: string; /** * (Updatable) The type of credential store for OGG. */ credentialStore: string; /** * The name given to the GoldenGate service deployment. The name must contain only alphanumeric characters and must start with a letter. For standby deployment the deployment name is inherited from primary. */ deploymentName: string; /** * (Updatable) Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to. */ groupToRolesMapping: outputs.GoldenGate.DeploymentOggDataGroupToRolesMapping; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used. */ identityDomainId: string; /** * (Updatable) The base64 encoded content of the PEM file containing the private key. */ key: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment ssl private key is stored in PEM format. */ keySecretId: string; /** * Version of OGG */ oggVersion: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored. */ passwordSecretId: string; } interface DeploymentOggDataGroupToRolesMapping { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server. */ administratorGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server. */ operatorGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges. */ securityGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information */ userGroupId: string; } interface DeploymentPlacement { /** * (Updatable) The availability domain of a placement. */ availabilityDomain: string; /** * (Updatable) The fault domain of a placement. */ faultDomain: string; } interface GetAiModelsAiModelCollection { /** * An array of AI models. */ items: outputs.GoldenGate.GetAiModelsAiModelCollectionItem[]; } interface GetAiModelsAiModelCollectionItem { /** * Metadata about this specific object. */ description: string; /** * An object's Display Name. */ displayName: string; /** * The identifier of the AI model offered by a provider. */ key: string; /** * The AI provider type for which model information is requested. */ providerType: string; } interface GetAiModelsFilter { name: string; regex?: boolean; values: string[]; } interface GetAiProvidersAiProviderCollection { /** * An array of AI providers. */ items: outputs.GoldenGate.GetAiProvidersAiProviderCollectionItem[]; } interface GetAiProvidersAiProviderCollectionItem { /** * Authentication types supported by the AI provider. */ authTypes: string[]; /** * Default base URL for the AI provider. */ defaultBaseUrl: string; /** * Metadata about this specific object. */ description: string; /** * An object's Display Name. */ displayName: string; /** * List of AI models supported by this provider, when available. This field is null when the provider's models can be retrieved only after supplying additional context. For example, OCI_GENERATIVE_AI model availability may vary by region. */ models: outputs.GoldenGate.GetAiProvidersAiProviderCollectionItemModel[]; /** * AI Provider type used by the AI Model Connection. */ providerType: string; } interface GetAiProvidersAiProviderCollectionItemModel { /** * Metadata about this specific object. */ description: string; /** * An object's Display Name. */ displayName: string; /** * The identifier of the AI model offered by a provider. */ key: string; /** * AI Provider type used by the AI Model Connection. */ providerType: string; } interface GetAiProvidersFilter { name: string; regex?: boolean; values: string[]; } interface GetConnectionAdditionalAttribute { /** * The catalog name within Polaris where Iceberg tables are registered. */ name: string; /** * The value of the property entry. */ value: string; } interface GetConnectionAssignmentsConnectionAssignmentCollection { items: outputs.GoldenGate.GetConnectionAssignmentsConnectionAssignmentCollectionItem[]; } interface GetConnectionAssignmentsConnectionAssignmentCollectionItem { /** * Credential store alias. */ aliasName: string; /** * The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection. */ connectionId: string; /** * The array of connection types. */ connectionType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources. */ deploymentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection assignment being referenced. */ id: string; isLockOverride: boolean; /** * A filter to return only connection assignments having the 'lifecycleState' given. */ state: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeUpdated: string; } interface GetConnectionAssignmentsFilter { /** * The name of the connection in the assignment (aliasName). */ name: string; regex?: boolean; values: string[]; } interface GetConnectionAuthDetail { /** * API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate */ apiKey: string; /** * API key secret OCID for the AI model connection. */ apiKeySecretId: string; /** * Authentication type used by the AI model connection. */ authType: string; /** * Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used. */ baseUrl: string; /** * Oracle Cloud Infrastructure Generative AI key fingerprint. */ keyFingerprint: string; /** * The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2' */ region: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related Oracle Cloud Infrastructure tenancy. */ tenancyId: string; /** * * OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure user who will access Object Storage. The user must have write access to the bucket they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint. * * ORACLE_NOSQL: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint. */ userId: string; } interface GetConnectionBootstrapServer { /** * The name or address of a host. * In case of Generic connection type it represents the Host and port separated by colon. Example: `"server.example.com:1234"` * For multiple hosts, provide a comma separated list. Example: `"server1.example.com:1000,server1.example.com:2000"` */ host: string; /** * The port of an endpoint usually specified for a connection. */ port: number; /** * This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty. */ privateIp: string; } interface GetConnectionCatalog { /** * The active branch of the Nessie catalog from which Iceberg reads and writes table metadata. */ branch: string; /** * The catalog type. */ catalogType: string; /** * * AZURE_DATA_LAKE_STORAGE: Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d * * DATABRICKS: OAuth client id, only applicable for authenticationType == OAUTH_M2M. * * MICROSOFT_FABRIC: Azure client ID of the application. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d */ clientId: string; /** * @deprecated The 'client_secret' field has been deprecated. Please use 'client_secret_secret_id' instead. */ clientSecret: string; /** * * AZURE_DATA_LAKE_STORAGE: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. * * DATABRICKS: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. * * MICROSOFT_FABRIC: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. * Note: When provided, 'clientSecret' field must not be provided. */ clientSecretSecretId: string; /** * The AWS Glue Catalog ID where Iceberg tables are registered. */ glueId: string; /** * The catalog name within Polaris where Iceberg tables are registered. */ name: string; /** * The Snowflake role used to access Polaris. */ principalRole: string; /** * @deprecated The 'properties' field has been deprecated. Please use 'properties_secret_id' instead. */ properties: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm */ propertiesSecretId: string; /** * * NESSIE: Nessie URI. e.g.: 'http://.com:10001/api/v2' * * POLARIS: The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog' * * REST: The base URL for the REST Catalog API. e.g.: 'https://my-rest-catalog.example.com/api/v1' */ uri: string; } interface GetConnectionIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface GetConnectionLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetConnectionStorage { /** * * AMAZON_S3: Access key ID to access the Amazon S3 bucket. * * OCI_OBJECT_STORAGE_S3_API: Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. * Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID. */ accessKeyId: string; /** * @deprecated The 'account_key' field has been deprecated. Please use 'account_key_secret_id' instead. */ accountKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored. */ accountKeySecretId: string; /** * Sets the Azure storage account name. */ accountName: string; /** * * AMAZON_S3: S3 bucket where Iceberg stores metadata and data files. * * GOOGLE_CLOUD_STORAGE: Google Cloud Storage bucket where Iceberg stores metadata and data files. * * OCI_OBJECT_STORAGE_S3_API: Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files. */ bucket: string; /** * The Azure Blob Storage container where Iceberg tables are stored. */ container: string; /** * * AMAZON_S3: The endpoint URL of the Amazon S3 storage service. e.g.: 'https://s3.amazonaws.com' * * AZURE_DATA_LAKE_STORAGE: The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net' * * GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com * * OCI_OBJECT_STORAGE_S3_API: Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com" */ endpoint: string; /** * The Google Cloud Project where the bucket exists. */ projectId: string; /** * The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2' */ region: string; /** * The scheme of the storage. */ schemeType: string; /** * @deprecated The 'secret_access_key' field has been deprecated. Please use 'secret_access_key_secret_id' instead. */ secretAccessKey: string; /** * * AMAZON_S3: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored. * * OCI_OBJECT_STORAGE_S3_API: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication is stored. */ secretAccessKeySecretId: string; /** * @deprecated The 'service_account_key_file' field has been deprecated. Please use 'service_account_key_file_secret_id' instead. */ serviceAccountKeyFile: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. */ serviceAccountKeyFileSecretId: string; /** * The storage type used in the Iceberg connection. */ storageType: string; } interface GetConnectionsConnectionCollection { items: outputs.GoldenGate.GetConnectionsConnectionCollectionItem[]; } interface GetConnectionsConnectionCollectionItem { /** * * AMAZON_S3: Access key ID to access the Amazon S3 bucket. * * OCI_OBJECT_STORAGE_S3_API: Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. * Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID. */ accessKeyId: string; /** * @deprecated The 'account_key' field has been deprecated. Please use 'account_key_secret_id' instead. */ accountKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored. */ accountKeySecretId: string; /** * Sets the Azure storage account name. */ accountName: string; /** * An array of name-value pair attribute entries. Used as additional parameters in connection string. */ additionalAttributes: outputs.GoldenGate.GetConnectionsConnectionCollectionItemAdditionalAttribute[]; /** * Represents authentication details for an AI Model connection. */ authDetails: outputs.GoldenGate.GetConnectionsConnectionCollectionItemAuthDetail[]; /** * Authentication mode. It can be provided at creation of Oracle Autonomous Database Serverless connections, when a databaseId is provided. The default value is MTLS. */ authenticationMode: string; /** * Used authentication mechanism to be provided for the following connection types: * * SNOWFLAKE, AZURE_DATA_LAKE_STORAGE, ELASTICSEARCH, KAFKA_SCHEMA_REGISTRY, REDIS * * JAVA_MESSAGE_SERVICE - If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required. * * DATABRICKS - Required fields by authentication types: * * PERSONAL_ACCESS_TOKEN: username is always 'token', user must enter password * * OAUTH_M2M: user must enter clientId and clientSecret */ authenticationType: string; /** * The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com When connecting to a non-public Azure Cloud, the endpoint must be provided, eg: * * Azure China: https://login.chinacloudapi.cn/ * * Azure US Government: https://login.microsoftonline.us/ */ azureAuthorityHost: string; /** * Azure tenant ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 14593954-d337-4a61-a364-9f758c64f97f */ azureTenantId: string; /** * Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: `"server1.example.com:9092,server2.example.com:9092"` */ bootstrapServers: outputs.GoldenGate.GetConnectionsConnectionCollectionItemBootstrapServer[]; /** * Represents the catalog of given type used in an Iceberg connection. */ catalogs: outputs.GoldenGate.GetConnectionsConnectionCollectionItemCatalog[]; /** * * AZURE_DATA_LAKE_STORAGE: Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d * * DATABRICKS: OAuth client id, only applicable for authenticationType == OAUTH_M2M. * * MICROSOFT_FABRIC: Azure client ID of the application. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d */ clientId: string; /** * @deprecated The 'client_secret' field has been deprecated. Please use 'client_secret_secret_id' instead. */ clientSecret: string; /** * * AZURE_DATA_LAKE_STORAGE: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. * * DATABRICKS: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. * * MICROSOFT_FABRIC: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. * Note: When provided, 'clientSecret' field must not be provided. */ clientSecretSecretId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Kafka cluster being referenced from Oracle Cloud Infrastructure Streaming with Apache Kafka. */ clusterId: string; /** * The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud must not be provided. */ clusterPlacementGroupId: string; /** * The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. */ compartmentId: string; /** * The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA' */ connectionFactory: string; /** * * ORACLE: Connect descriptor or Easy Connect Naming method used to connect to a database. * * MONGODB: MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords' * * AZURE_SYNAPSE_ANALYTICS: JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;' */ connectionString: string; /** * The array of connection types. */ connectionType: string; /** * * JAVA_MESSAGE_SERVICE: Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676' * * SNOWFLAKE: JDBC connection URL. e.g.: 'jdbc:snowflake://.snowflakecomputing.com/?warehouse=&db=' * * AMAZON_REDSHIFT: Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb' * * DATABRICKS: Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb' * * ORACLE_AI_DATA_PLATFORM: Connection URL. It must start with 'jdbc:spark://' */ connectionUrl: string; /** * The base64 encoded content of the consumer.properties file. */ consumerProperties: string; /** * The base64 encoded content of the Hadoop Distributed File System configuration file (core-site.xml). It is not included in GET responses if the `view=COMPACT` query parameter is specified. */ coreSiteXml: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Autonomous Json Database. */ databaseId: string; /** * The name of the database. */ databaseName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system being referenced. */ dbSystemId: string; /** * Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced. */ deploymentId: string; /** * Metadata about this specific object. */ description: string; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * Indicates that sensitive attributes are provided via Secrets. */ doesUseSecretIds: boolean; /** * * AMAZON_S3: The endpoint URL of the Amazon S3 storage service. e.g.: 'https://s3.amazonaws.com' * * AZURE_DATA_LAKE_STORAGE: The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net' * * GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com * * OCI_OBJECT_STORAGE_S3_API: Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com" */ endpoint: string; /** * Fingerprint required by TLS security protocol. E.g.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c' */ fingerprint: string; /** * A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The name or address of a host. * In case of Generic connection type it represents the Host and port separated by colon. Example: `"server.example.com:1234"` * For multiple hosts, provide a comma separated list. Example: `"server1.example.com:1000,server1.example.com:2000"` */ host: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced. */ id: string; /** * List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses. */ ingressIps: outputs.GoldenGate.GetConnectionsConnectionCollectionItemIngressIp[]; isLockOverride: boolean; /** * The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory' */ jndiConnectionFactory: string; /** * The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory' */ jndiInitialContextFactory: string; /** * The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000' */ jndiProviderUrl: string; /** * @deprecated The 'jndi_security_credentials' field has been deprecated. Please use 'jndi_security_credentials_secret_id' instead. */ jndiSecurityCredentials: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided. */ jndiSecurityCredentialsSecretId: string; /** * Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2' */ jndiSecurityPrincipal: string; /** * References the Oracle Cloud Infrastructure Vault key in the Oracle Cloud Infrastructure Vault identified by `vaultId`. */ keyId: string; /** * @deprecated The 'key_store' field has been deprecated. Please use 'key_store_secret_id' instead. */ keyStore: string; /** * @deprecated The 'key_store_password' field has been deprecated. Please use 'key_store_password_secret_id' instead. */ keyStorePassword: string; /** * * JAVA_MESSAGE_SERVICE: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the KeyStore password is stored. * * KAFKA: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka KeyStore password is stored. * * KAFKA_SCHEMA_REGISTRY: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl KeyStore password is stored. * * REDIS: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Redis KeyStore password is stored. * Note: When provided, 'keyStorePassword' field must not be provided. */ keyStorePasswordSecretId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided. */ keyStoreSecretId: string; /** * Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.GoldenGate.GetConnectionsConnectionCollectionItemLock[]; /** * Maximum number of input characters supported by this AI model connection. */ maxInputChars: number; /** * AI model identifier. */ modelKey: string; /** * An array of Network Security Group OCIDs used to define network access for either Deployments or Connections. */ nsgIds: string[]; /** * @deprecated The 'password' field has been deprecated. Please use 'password_secret_id' instead. */ password: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Note: When provided, 'password' field must not be provided. */ passwordSecretId: string; /** * The port of an endpoint usually specified for a connection. */ port: number; /** * This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty. */ privateIp: string; /** * @deprecated The 'private_key_file' field has been deprecated. Please use 'private_key_file_secret_id' instead. */ privateKeyFile: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided. */ privateKeyFileSecretId: string; /** * @deprecated The 'private_key_passphrase' field has been deprecated. Please use 'private_key_passphrase_secret_id' instead. */ privateKeyPassphrase: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password for the private key file. Note: When provided, 'privateKeyPassphrase' field must not be provided. */ privateKeyPassphraseSecretId: string; /** * The base64 encoded content of the producer.properties file. */ producerProperties: string; /** * AI Provider type used by the AI Model Connection. */ providerType: string; /** * The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm */ publicKeyFingerprint: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Redis cluster. */ redisClusterId: string; /** * The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2' */ region: string; /** * Controls the network traffic direction to the target: SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. */ routingMethod: string; /** * @deprecated The 'sas_token' field has been deprecated. Please use 'sas_token_secret_id' instead. */ sasToken: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the sas token is stored. Note: When provided, 'sasToken' field must not be provided. */ sasTokenSecretId: string; /** * @deprecated The 'secret_access_key' field has been deprecated. Please use 'secret_access_key_secret_id' instead. */ secretAccessKey: string; /** * * AMAZON_S3: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored. * * OCI_OBJECT_STORAGE_S3_API: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication is stored. */ secretAccessKeySecretId: string; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * * DB2: Security protocol for the DB2 database. * * ELASTICSEARCH: Security protocol for Elasticsearch. * * JAVA_MESSAGE_SERVICE: Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required. * * KAFKA: Security Type for Kafka. * * MICROSOFT_SQLSERVER: Security Type for Microsoft SQL Server. * * MONGODB: Security Type for MongoDB. * * MYSQL: Security Type for MySQL. * * POSTGRESQL: Security protocol for PostgreSQL. * * REDIS: Security protocol for Redis. */ securityProtocol: string; /** * * ELASTICSEARCH: Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Used for establishing the initial connection to the Elasticsearch cluster. Example: `"server1.example.com:4000,server2.example.com:4000"` * * REDIS: Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 6379. Used for establishing the initial connection to the Redis cluster. Example: `"server1.example.com:6379,server2.example.com:6379"` */ servers: string; /** * @deprecated The 'service_account_key_file' field has been deprecated. Please use 'service_account_key_file_secret_id' instead. */ serviceAccountKeyFile: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. */ serviceAccountKeyFileSecretId: string; /** * Specifies the session mode for the database connection. Use REDIRECT only for RAC databases with SCAN listeners that return IP addresses. For RAC databases with SCAN listeners that return FQDNs, and for all other Oracle database technologies, use DIRECT. In RAC deployments, SCAN listeners redirects a connection to a specific database node, identified by either IP address or FQDN. It is recommended to configure RAC with FQDN-based SCAN listeners. */ sessionMode: string; /** * If set to true, Java Naming and Directory Interface (JNDI) properties should be provided. */ shouldUseJndi: boolean; /** * * KAFKA: Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for Oracle Cloud Infrastructure Streaming connections. Only available from 23.9.0.0.0 GoldenGate versions. Note: When specified, 'username'/'password'/'passwordSecretId' fields must not be provided. Default: false * * OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM, ORACLE_NOSQL: Specifies that the user intends to authenticate to the instance using a resource principal. Default: false */ shouldUseResourcePrincipal: boolean; /** * If set to true, the driver validates the certificate that is sent by the database server. */ shouldValidateServerCertificate: boolean; /** * * MICROSOFT_SQLSERVER: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL). * * MYSQL: Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the `view=COMPACT` query parameter is specified. * * POSTGRESQL: The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL. The supported file formats are .pem and .crt. It is not included in GET responses if the `view=COMPACT` query parameter is specified. */ sslCa: string; /** * * MYSQL: Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the `view=COMPACT` query parameter is specified. * * POSTGRESQL: The base64 encoded certificate of the PostgreSQL server. The supported file formats are .pem and .crt. It is not included in GET responses if the `view=COMPACT` query parameter is specified. */ sslCert: string; /** * @deprecated The 'ssl_client_keystash' field has been deprecated. Please use 'ssl_client_keystash_secret_id' instead. */ sslClientKeystash: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. Note: When provided, 'sslClientKeystash' field must not be provided. */ sslClientKeystashSecretId: string; /** * @deprecated The 'ssl_client_keystoredb' field has been deprecated. Please use 'ssl_client_keystoredb_secret_id' instead. */ sslClientKeystoredb: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. Note: When provided, 'sslClientKeystoredb' field must not be provided. */ sslClientKeystoredbSecretId: string; /** * * MYSQL: The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected. It is not included in GET responses if the `view=COMPACT` query parameter is specified. * * POSTGRESQL: The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). It is not included in GET responses if the `view=COMPACT` query parameter is specified. */ sslCrl: string; /** * @deprecated The 'ssl_key' field has been deprecated. Please use 'ssl_key_secret_id' instead. */ sslKey: string; /** * @deprecated The 'ssl_key_password' field has been deprecated. Please use 'ssl_key_password_secret_id' instead. */ sslKeyPassword: string; /** * * JAVA_MESSAGE_SERVICE, KAFKA_SCHEMA_REGISTRY: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. * * KAFKA: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl Key password is stored. * Note: When provided, 'sslKeyPassword' field must not be provided. */ sslKeyPasswordSecretId: string; /** * * MYSQL: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL). * * POSTGRESQL: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the private key of the PostgreSQL server. The supported file formats are .pem and .crt. * Note: When provided, 'sslKey' field must not be provided. */ sslKeySecretId: string; /** * * MYSQL: SSL modes for MySQL. * * POSTGRESQL: SSL modes for PostgreSQL. */ sslMode: string; /** * The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate. It is not included in GET responses if the `view=COMPACT` query parameter is specified. */ sslServerCertificate: string; /** * A filter to return only connections having the 'lifecycleState' given. */ state: string; /** * Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS. */ storageCredentialName: string; /** * Represents the storage of given type used in an Iceberg connection. */ storages: outputs.GoldenGate.GetConnectionsConnectionCollectionItemStorage[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream pool being referenced. */ streamPoolId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The array of technology types. */ technologyType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related Oracle Cloud Infrastructure tenancy. */ tenancyId: string; /** * Azure tenant ID of the application. e.g.: 14593954-d337-4a61-a364-9f758c64f97f */ tenantId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeUpdated: string; /** * Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the `view=COMPACT` query parameter is specified. */ tlsCaFile: string; /** * @deprecated The 'tls_certificate_key_file' field has been deprecated. Please use 'tls_certificate_key_file_secret_id' instead. */ tlsCertificateKeyFile: string; /** * @deprecated The 'tls_certificate_key_file_password' field has been deprecated. Please use 'tls_certificate_key_file_password_secret_id' instead. */ tlsCertificateKeyFilePassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided. */ tlsCertificateKeyFilePasswordSecretId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the certificate key file of the mtls connection. * * The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided. */ tlsCertificateKeyFileSecretId: string; triggerRefresh: boolean; /** * @deprecated The 'trust_store' field has been deprecated. Please use 'trust_store_secret_id' instead. */ trustStore: string; /** * @deprecated The 'trust_store_password' field has been deprecated. Please use 'trust_store_password_secret_id' instead. */ trustStorePassword: string; /** * * JAVA_MESSAGE_SERVICE: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the TrustStore password is stored. * * KAFKA: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka TrustStore password is stored. * * KAFKA_SCHEMA_REGISTRY: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the kafka Ssl TrustStore password is stored. * * REDIS: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Redis TrustStore password is stored. * Note: When provided, 'trustStorePassword' field must not be provided. */ trustStorePasswordSecretId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided. */ trustStoreSecretId: string; /** * Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081' */ url: string; /** * * OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure user who will access Object Storage. The user must have write access to the bucket they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint. * * ORACLE_NOSQL: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint. */ userId: string; /** * The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it. */ username: string; /** * References the Oracle Cloud Infrastructure Vault that contains the customer-managed encryption key identified by `keyId`. */ vaultId: string; /** * @deprecated The 'wallet' field has been deprecated. Please use 'wallet_secret_id' instead. */ wallet: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the wallet file is stored. The wallet contents Oracle GoldenGate uses to make connections to a database. Note: When provided, 'wallet' field must not be provided. */ walletSecretId: string; } interface GetConnectionsConnectionCollectionItemAdditionalAttribute { /** * The catalog name within Polaris where Iceberg tables are registered. */ name: string; /** * The value of the property entry. */ value: string; } interface GetConnectionsConnectionCollectionItemAuthDetail { /** * API key for the AI model connection. Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate */ apiKey: string; /** * API key secret OCID for the AI model connection. */ apiKeySecretId: string; /** * Authentication type used by the AI model connection. */ authType: string; /** * Base URL of the AI model endpoint. If not specified, the default base URL for the selected AI provider will be used. */ baseUrl: string; /** * Oracle Cloud Infrastructure Generative AI key fingerprint. */ keyFingerprint: string; /** * The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2' */ region: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related Oracle Cloud Infrastructure tenancy. */ tenancyId: string; /** * * OCI_OBJECT_STORAGE, ORACLE_AI_DATA_PLATFORM: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure user who will access Object Storage. The user must have write access to the bucket they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint. * * ORACLE_NOSQL: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint. */ userId: string; } interface GetConnectionsConnectionCollectionItemBootstrapServer { /** * The name or address of a host. * In case of Generic connection type it represents the Host and port separated by colon. Example: `"server.example.com:1234"` * For multiple hosts, provide a comma separated list. Example: `"server1.example.com:1000,server1.example.com:2000"` */ host: string; /** * The port of an endpoint usually specified for a connection. */ port: number; /** * This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty. */ privateIp: string; } interface GetConnectionsConnectionCollectionItemCatalog { /** * The active branch of the Nessie catalog from which Iceberg reads and writes table metadata. */ branch: string; /** * The catalog type. */ catalogType: string; /** * * AZURE_DATA_LAKE_STORAGE: Azure client ID of the application. This property is required when 'authenticationType' is set to 'AZURE_ACTIVE_DIRECTORY'. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d * * DATABRICKS: OAuth client id, only applicable for authenticationType == OAUTH_M2M. * * MICROSOFT_FABRIC: Azure client ID of the application. e.g.: 06ecaabf-8b80-4ec8-a0ec-20cbf463703d */ clientId: string; /** * @deprecated The 'client_secret' field has been deprecated. Please use 'client_secret_secret_id' instead. */ clientSecret: string; /** * * AZURE_DATA_LAKE_STORAGE: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. * * DATABRICKS: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. Only applicable for authenticationType == OAUTH_M2M. * * MICROSOFT_FABRIC: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the client secret is stored. * Note: When provided, 'clientSecret' field must not be provided. */ clientSecretSecretId: string; /** * The AWS Glue Catalog ID where Iceberg tables are registered. */ glueId: string; /** * The catalog name within Polaris where Iceberg tables are registered. */ name: string; /** * The Snowflake role used to access Polaris. */ principalRole: string; /** * @deprecated The 'properties' field has been deprecated. Please use 'properties_secret_id' instead. */ properties: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret that stores the content of the configuration file containing additional properties for the REST catalog. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm */ propertiesSecretId: string; /** * * NESSIE: Nessie URI. e.g.: 'http://.com:10001/api/v2' * * POLARIS: The URL endpoint for the Polaris API. e.g.: 'https://.snowflakecomputing.com/polaris/api/catalog' * * REST: The base URL for the REST Catalog API. e.g.: 'https://my-rest-catalog.example.com/api/v1' */ uri: string; } interface GetConnectionsConnectionCollectionItemIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface GetConnectionsConnectionCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetConnectionsConnectionCollectionItemStorage { /** * * AMAZON_S3: Access key ID to access the Amazon S3 bucket. * * OCI_OBJECT_STORAGE_S3_API: Access Key ID from the Oracle Cloud Infrastructure IAM user's Customer Secret Key pair used to authenticate to Oracle Cloud Infrastructure Object Storage via the S3 Compatibility API. * Note: Despite the "Id" suffix, this value is not an Oracle Cloud Infrastructure OCID. */ accessKeyId: string; /** * @deprecated The 'account_key' field has been deprecated. Please use 'account_key_secret_id' instead. */ accountKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the account key is stored. */ accountKeySecretId: string; /** * Sets the Azure storage account name. */ accountName: string; /** * * AMAZON_S3: S3 bucket where Iceberg stores metadata and data files. * * GOOGLE_CLOUD_STORAGE: Google Cloud Storage bucket where Iceberg stores metadata and data files. * * OCI_OBJECT_STORAGE_S3_API: Target Oracle Cloud Infrastructure Object Storage bucket name where Iceberg stores table metadata and data files. */ bucket: string; /** * The Azure Blob Storage container where Iceberg tables are stored. */ container: string; /** * * AMAZON_S3: The endpoint URL of the Amazon S3 storage service. e.g.: 'https://s3.amazonaws.com' * * AZURE_DATA_LAKE_STORAGE: The Azure Blob Storage endpoint where Iceberg data is stored. e.g.: 'https://my-azure-storage-account.blob.core.windows.net' * * GOOGLE_CLOUD_STORAGE: A legal URL to connect to Google Cloud Storage including scheme, server name and port, if not the default port. Default: https://storage.googleapis.com * * OCI_OBJECT_STORAGE_S3_API: Oracle Cloud Infrastructure Object Storage S3 Compatibility API endpoint URL. Format: "https://.compat.objectstorage.." Example: "https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com" */ endpoint: string; /** * The Google Cloud Project where the bucket exists. */ projectId: string; /** * The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2' */ region: string; /** * The scheme of the storage. */ schemeType: string; /** * @deprecated The 'secret_access_key' field has been deprecated. Please use 'secret_access_key_secret_id' instead. */ secretAccessKey: string; /** * * AMAZON_S3: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key is stored. * * OCI_OBJECT_STORAGE_S3_API: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the Secret Access Key used for Oracle Cloud Infrastructure Object Storage S3 Compatibility authentication is stored. */ secretAccessKeySecretId: string; /** * @deprecated The 'service_account_key_file' field has been deprecated. Please use 'service_account_key_file_secret_id' instead. */ serviceAccountKeyFile: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the content of the service account key file is stored, which contains the credentials required to use Google Cloud Storage. */ serviceAccountKeyFileSecretId: string; /** * The storage type used in the Iceberg connection. */ storageType: string; } interface GetConnectionsFilter { /** * The catalog name within Polaris where Iceberg tables are registered. */ name: string; regex?: boolean; values: string[]; } interface GetDatabaseRegistrationsDatabaseRegistrationCollection { items: outputs.GoldenGate.GetDatabaseRegistrationsDatabaseRegistrationCollectionItem[]; } interface GetDatabaseRegistrationsDatabaseRegistrationCollectionItem { /** * Credential store alias. */ aliasName: string; /** * The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced as the successor resource of the deprecated database registration. */ connectionId: string; /** * Connect descriptor or Easy Connect Naming method used to connect to a database. */ connectionString: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database being referenced. */ databaseId: string; /** * Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Metadata about this specific object. */ description: string; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * A three-label Fully Qualified Domain Name (FQDN) for a resource. */ fqdn: string; /** * A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the databaseRegistration being referenced. */ id: string; /** * The private IP address in the customer's VCN of the customer's endpoint, typically a database. */ ipAddress: string; /** * Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key. */ keyId: string; /** * Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state. */ lifecycleDetails: string; password: string; /** * A Private Endpoint IP address created in the customer's subnet. A customer database can expect network traffic initiated by GoldenGate Service from this IP address. It can also send network traffic to this IP address, typically in response to requests from GoldenGate Service. The customer may use this IP address in Security Lists or Network Security Groups (NSG) as needed. */ rcePrivateIp: string; /** * The OCID of the compartment where the GoldenGate Secret will be created. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key. */ secretCompartmentId: string; /** * The OCID of the customer's GoldenGate Service Secret. If provided, it references a key that customers will be required to ensure the policies are established to permit GoldenGate to use this Secret. */ secretId: string; /** * The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT. */ sessionMode: string; /** * A filter to return only the resources that match the 'lifecycleState' given. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target subnet of the dedicated connection. */ subnetId: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeUpdated: string; /** * The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it. */ username: string; /** * Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault. */ vaultId: string; wallet: string; } interface GetDatabaseRegistrationsFilter { name: string; regex?: boolean; values: string[]; } interface GetDeploymentBackupLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetDeploymentBackupSchedule { /** * Name of the bucket where the object is to be uploaded in the object storage */ bucket: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced. */ compartmentId: string; /** * The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY. */ frequencyBackupScheduled: string; /** * Parameter to allow users to create backup without trails */ isMetadataOnly: boolean; /** * Name of namespace that serves as a container for all of your buckets */ namespace: string; /** * The start timestamp for the deployment backup schedule. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`. */ timeBackupScheduled: string; } interface GetDeploymentBackupsDeploymentBackupCollection { items: outputs.GoldenGate.GetDeploymentBackupsDeploymentBackupCollectionItem[]; } interface GetDeploymentBackupsDeploymentBackupCollectionItem { /** * Possible deployment backup source types. */ backupSourceType: string; /** * Possible Deployment backup types. */ backupType: string; /** * Name of the bucket where the object is to be uploaded in the object storage */ bucket: string; /** * The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. */ compartmentId: string; /** * Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources. */ deploymentId: string; /** * The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'. */ deploymentType: string; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced. */ id: string; /** * True if this object is automatically created */ isAutomatic: boolean; isLockOverride: boolean; /** * Parameter to allow users to create backup without trails */ isMetadataOnly: boolean; /** * Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.GoldenGate.GetDeploymentBackupsDeploymentBackupCollectionItemLock[]; /** * Name of namespace that serves as a container for all of your buckets */ namespace: string; /** * Name of the object to be uploaded to object storage */ object: string; /** * Version of OGG */ oggVersion: string; /** * The size of the backup stored in object storage (in bytes) */ sizeInBytes: number; /** * A filter to return only the deployment backups having the 'lifecycleState' given. */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time of the resource backup finish. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeBackupFinished: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * The time of the resource backup. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeOfBackup: string; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeUpdated: string; } interface GetDeploymentBackupsDeploymentBackupCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetDeploymentBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetDeploymentCertificatesCertificateCollection { items: outputs.GoldenGate.GetDeploymentCertificatesCertificateCollectionItem[]; } interface GetDeploymentCertificatesCertificateCollectionItem { /** * The Certificate authority key id. */ authorityKeyId: string; /** * The base64 encoded content of the PEM file containing the SSL certificate. */ certificateContent: string; /** * A unique Deployment identifier. */ deploymentId: string; /** * Indicates if the certificate is ca. */ isCa: boolean; isLockOverride: boolean; /** * Indicates if the certificate is self signed. */ isSelfSigned: boolean; /** * The Certificate issuer. */ issuer: string; /** * The identifier key (unique name in the scope of the deployment) of the certificate being referenced. It must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter. */ key: string; /** * The Certificate md5Hash. */ md5hash: string; /** * The Certificate public key. */ publicKey: string; /** * The Certificate public key algorithm. */ publicKeyAlgorithm: string; /** * The Certificate public key size. */ publicKeySize: string; /** * The Certificate serial. */ serial: string; /** * The Certificate sha1 hash. */ sha1hash: string; /** * A filter to return only connections having the 'lifecycleState' given. */ state: string; /** * The Certificate subject. */ subject: string; /** * The Certificate subject key id. */ subjectKeyId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * The time the certificate is valid from. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeValidFrom: string; /** * The time the certificate is valid to. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeValidTo: string; /** * The Certificate version. */ version: string; } interface GetDeploymentCertificatesFilter { name: string; regex?: boolean; values: string[]; } interface GetDeploymentDeploymentDiagnosticData { /** * Name of the bucket where the object is to be uploaded in the object storage */ bucket: string; /** * The state of the deployment diagnostic collection. */ diagnosticState: string; /** * Name of namespace that serves as a container for all of your buckets */ namespace: string; /** * Name of the diagnostic collected and uploaded to object storage */ object: string; /** * The time until which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeDiagnosticEnd: string; /** * The time from which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeDiagnosticStart: string; } interface GetDeploymentDisasterRecoveryPrecheckReportCheck { /** * The code returned when GoldenGate reports an error while running a step during pipeline initialization. https://docs.oracle.com/en/middleware/goldengate/core/23/error-messages/ogg-00001-ogg-40000.html#GUID-97FF7AA7-7A5C-4AA7-B29F-3CC8D26761F2 */ code: string; /** * The corrective action for non-passing checks. Null for passed checks. */ correctiveAction: string; /** * Metadata about this specific object. */ description: string; /** * An object's Display Name. */ displayName: string; /** * UUID to uniquely identify the each check result. */ key: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource related to the corresponding check. */ relatedResourceId: string; /** * Type of resource related to corresponding check. */ relatedResourceType: string; /** * Status of the DR precheck result. */ status: string; } interface GetDeploymentEnvironmentsDeploymentEnvironmentCollection { /** * Array of DeploymentEnvironmentSummary objects. */ items: outputs.GoldenGate.GetDeploymentEnvironmentsDeploymentEnvironmentCollectionItem[]; } interface GetDeploymentEnvironmentsDeploymentEnvironmentCollectionItem { /** * The deployment category defines the broad separation of the deployment type into four categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS', 'DATA_TRANSFORMS' and 'DATA_VERIFICATION'. */ category: string; /** * The default CPU core count. */ defaultCpuCoreCount: number; /** * An object's Display Name. */ displayName: string; /** * Specifies whether the deployment is used in a production or development/testing environment. */ environmentType: string; /** * Specifies whether the "Auto scaling" option should be enabled by default or not. */ isAutoScalingEnabledByDefault: boolean; /** * The maximum CPU core count. */ maxCpuCoreCount: number; /** * The multiplier value between CPU core count and memory size. */ memoryPerOcpuInGbs: number; /** * The minimum CPU core count. */ minCpuCoreCount: number; /** * The multiplier value between CPU core count and network bandwidth. */ networkBandwidthPerOcpuInGbps: number; /** * The multiplier value between CPU core count and storage usage limit size. */ storageUsageLimitPerOcpuInGbs: number; } interface GetDeploymentEnvironmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetDeploymentIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface GetDeploymentLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetDeploymentMaintenanceConfiguration { /** * Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default. */ bundleReleaseUpgradePeriodInDays: number; /** * Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period. */ interimReleaseUpgradePeriodInDays: number; /** * By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too. */ isInterimReleaseAutoUpgradeEnabled: boolean; /** * Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default. */ majorReleaseUpgradePeriodInDays: number; /** * Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default. */ securityPatchUpgradePeriodInDays: number; } interface GetDeploymentMaintenanceWindow { /** * Days of the week. */ day: string; /** * Start hour for maintenance period. Hour is in UTC. */ startHour: number; } interface GetDeploymentOggData { /** * @deprecated The 'admin_password' field has been deprecated. Please use 'password_secret_id' instead. */ adminPassword: string; /** * The GoldenGate deployment console username. */ adminUsername: string; /** * The base64 encoded content of the PEM file containing the SSL certificate. */ certificate: string; /** * The type of credential store for OGG. */ credentialStore: string; /** * The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter. */ deploymentName: string; /** * Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to. */ groupToRolesMappings: outputs.GoldenGate.GetDeploymentOggDataGroupToRolesMapping[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used. */ identityDomainId: string; key: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment ssl private key is stored in PEM format. */ keySecretId: string; /** * Version of OGG */ oggVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored. */ passwordSecretId: string; } interface GetDeploymentOggDataGroupToRolesMapping { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server. */ administratorGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server. */ operatorGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges. */ securityGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information */ userGroupId: string; } interface GetDeploymentPeersDeploymentPeerCollection { /** * An array of DeploymentPeers. */ items: outputs.GoldenGate.GetDeploymentPeersDeploymentPeerCollectionItem[]; } interface GetDeploymentPeersDeploymentPeerCollectionItem { /** * The availability domain of a placement. */ availabilityDomain: string; /** * The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided. */ clusterPlacementGroupId: string; /** * A unique Deployment identifier. */ deploymentId: string; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * The fault domain of a placement. */ faultDomain: string; /** * The type of the deployment role. */ peerRole: string; /** * The type of the deployment peer. */ peerType: string; /** * Status of the DR precheck result. */ precheckStatus: string; /** * The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region. */ region: string; /** * A filter to return only the deployment peers having the 'lifecycleState' given. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * The timestamp when pre-check started. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`. */ timeLastPrecheckPerformed: string; /** * The time of the last data synchronization from the primary to the standby peer. [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeLastSynced: string; /** * The time of the last role change. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeRoleChanged: string; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeUpdated: string; } interface GetDeploymentPeersFilter { name: string; regex?: boolean; values: string[]; } interface GetDeploymentPlacement { /** * The availability domain of a placement. */ availabilityDomain: string; /** * The fault domain of a placement. */ faultDomain: string; } interface GetDeploymentTypeItem { /** * The deployment category defines the broad separation of the deployment type into categories. Currently the separation is 'DATA_REPLICATION' and 'STREAM_ANALYTICS'. */ category: string; /** * An array of connectionTypes. */ connectionTypes: string[]; /** * The type of deployment, the value determines the exact 'type' of service executed in the Deployment. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of the equivalent 'DATABASE_ORACLE' value. */ deploymentType: string; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * List of the supported technologies generally. The value is a freeform text string generally consisting of a description of the technology and optionally the speific version(s) support. For example, [ "Oracle Database 19c", "Oracle Exadata", "OCI Streaming" ] */ sourceTechnologies: string[]; /** * List of the supported technologies generally. The value is a freeform text string generally consisting of a description of the technology and optionally the speific version(s) support. For example, [ "Oracle Database 19c", "Oracle Exadata", "OCI Streaming" ] */ targetTechnologies: string[]; } interface GetDeploymentTypesDeploymentTypeCollection { /** * Array of DeploymentTypeSummary */ items: outputs.GoldenGate.GetDeploymentTypesDeploymentTypeCollectionItem[]; } interface GetDeploymentTypesDeploymentTypeCollectionItem { /** * The deployment category defines the broad separation of the deployment type into four categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS', 'DATA_TRANSFORMS' and 'DATA_VERIFICATION'. */ category: string; /** * An array of connectionTypes. */ connectionTypes: string[]; /** * The default admin username used by deployment. */ defaultUsername: string; /** * The type of deployment, the value determines the exact 'type' of the service executed in the deployment. Default value is DATABASE_ORACLE. */ deploymentType: string; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * Allows to query by a specific GoldenGate version. */ oggVersion: string; /** * List of the supported technologies generally. The value is a freeform text string generally consisting of a description of the technology and optionally the speific version(s) support. For example, [ "Oracle Database 19c", "Oracle Exadata", "OCI Streaming" ] */ sourceTechnologies: string[]; /** * Specifies supported capabilities or features by a deployment type . */ supportedCapabilities: string[]; /** * The list of Oracle license models supported by the deployment type. */ supportedLicenseTypes: string[]; /** * The URL to the webpage listing the supported technologies. */ supportedTechnologiesUrl: string; /** * List of the supported technologies generally. The value is a freeform text string generally consisting of a description of the technology and optionally the speific version(s) support. For example, [ "Oracle Database 19c", "Oracle Exadata", "OCI Streaming" ] */ targetTechnologies: string[]; } interface GetDeploymentTypesFilter { name: string; regex?: boolean; values: string[]; } interface GetDeploymentUpgradesDeploymentUpgradeCollection { items: outputs.GoldenGate.GetDeploymentUpgradesDeploymentUpgradeCollectionItem[]; } interface GetDeploymentUpgradesDeploymentUpgradeCollectionItem { /** * The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. */ compartmentId: string; /** * Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment in which to list resources. */ deploymentId: string; /** * The type of the deployment upgrade: MANUAL or AUTOMATIC */ deploymentUpgradeType: string; /** * Metadata about this specific object. */ description: string; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment upgrade being referenced. */ id: string; /** * Indicates if cancel is allowed. Scheduled upgrade can be cancelled only if target version is not forced by service, otherwise only reschedule allowed. */ isCancelAllowed: boolean; /** * Indicates if reschedule is allowed. Upgrade can be rescheduled postponed until the end of the service defined auto-upgrade period. */ isRescheduleAllowed: boolean; /** * Indicates if rollback is allowed. In practice only the last upgrade can be rolled back. * * Manual upgrade is allowed to rollback only until the old version isn't deprecated yet. * * Automatic upgrade by default is not allowed, unless a serious issue does not justify. */ isRollbackAllowed: boolean; /** * Indicates if OGG release contains security fix. */ isSecurityFix: boolean; /** * Indicates if upgrade notifications are snoozed or not. */ isSnoozed: boolean; /** * Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state. */ lifecycleDetails: string; /** * Possible GGS lifecycle sub-states. */ lifecycleSubState: string; /** * Version of OGG */ oggVersion: string; /** * Version of OGG */ previousOggVersion: string; /** * The type of release. */ releaseType: string; /** * A filter to return only the deployment upgrades having the 'lifecycleState' given. */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * The date and time the request was finished. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeFinished: string; /** * The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeOggVersionSupportedUntil: string; /** * The time the resource was released. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeReleased: string; /** * The time of upgrade schedule. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeSchedule: string; /** * Indicates the latest time until the deployment upgrade could be rescheduled. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeScheduleMax: string; /** * The time the upgrade notifications are snoozed until. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeSnoozedUntil: string; /** * The date and time the request was started. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeStarted: string; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeUpdated: string; } interface GetDeploymentUpgradesFilter { name: string; regex?: boolean; values: string[]; } interface GetDeploymentVersionsDeploymentVersionCollection { /** * Array of DeploymentVersionSummary. */ items: outputs.GoldenGate.GetDeploymentVersionsDeploymentVersionCollectionItem[]; } interface GetDeploymentVersionsDeploymentVersionCollectionItem { /** * The type of deployment, the value determines the exact 'type' of the service executed in the deployment. Default value is DATABASE_ORACLE. */ deploymentType: string; /** * Indicates if OGG release contains security fix. */ isSecurityFix: boolean; /** * Version of OGG */ oggVersion: string; /** * The type of release. */ releaseType: string; /** * The time the resource was released. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeReleased: string; /** * The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeSupportedUntil: string; } interface GetDeploymentVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetDeploymentsDeploymentCollection { items: outputs.GoldenGate.GetDeploymentsDeploymentCollectionItem[]; } interface GetDeploymentsDeploymentCollectionItem { /** * The availability domain of a placement. */ availabilityDomain: string; /** * Defines the schedule of the deployment backup. */ backupSchedules: outputs.GoldenGate.GetDeploymentsDeploymentCollectionItemBackupSchedule[]; /** * The maximum number of CPUs allowed with a 'Bring Your Own License' (BYOL) license type. Any CPU usage above this limit is considered as License Included and billed. */ byolCpuCoreCountLimit: number; /** * The deployment category defines the broad separation of the deployment type into four categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS', 'DATA_TRANSFORMS' and 'DATA_VERIFICATION'. */ category: string; /** * The OCID(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided. */ clusterPlacementGroupId: string; /** * The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. */ compartmentId: string; /** * The Minimum number of OCPUs to be made available for this Deployment. */ cpuCoreCount: number; /** * Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced. */ deploymentBackupId: string; /** * Information regarding the deployment diagnostic collection */ deploymentDiagnosticDatas: outputs.GoldenGate.GetDeploymentsDeploymentCollectionItemDeploymentDiagnosticData[]; /** * The type of the deployment role. */ deploymentRole: string; /** * A filter that returns only the resources matching the specified 'deploymentType'. */ deploymentType: string; /** * The URL of a resource. */ deploymentUrl: string; /** * Metadata about this specific object. */ description: string; /** * Indicates if disaster recovery is enabled for a deployment. If not specified, disaster recovery is ENABLED when no clusterPlacementGroupId is provided, and DISABLED when a clusterPlacementGroupId is provided. */ disasterRecoveryStatus: string; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * Specifies whether the deployment is used in a production or development/testing environment. */ environmentType: string; /** * The fault domain of a placement. */ faultDomain: string; /** * A filter to return only the resources that match the 'fqdn' given. */ fqdn: string; /** * A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced. */ id: string; /** * List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses. */ ingressIps: outputs.GoldenGate.GetDeploymentsDeploymentCollectionItemIngressIp[]; /** * Indicates if auto scaling is enabled for the Deployment's CPU core count. */ isAutoScalingEnabled: boolean; /** * Flag to allow to configure the 'Bring Your Own License' (BYOL) license type CPU limit. If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit. */ isByolCpuCoreCountLimitEnabled: boolean; /** * True if all of the aggregate resources are working correctly. */ isHealthy: boolean; /** * Indicates if the resource is the the latest available version. */ isLatestVersion: boolean; isLockOverride: boolean; /** * True if this object is publicly available. */ isPublic: boolean; /** * Deprecated: This field is not updated and will be removed in future versions. If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=. Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit. Exceeding the limit may be an indication of a misconfiguration of the deployment's GoldenGate service. * * @deprecated The 'is_storage_utilization_limit_exceeded' field has been deprecated. It is no longer supported. */ isStorageUtilizationLimitExceeded: boolean; /** * The Oracle license model that applies to a Deployment. */ licenseModel: string; /** * Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state. */ lifecycleDetails: string; /** * A filter to return only the resources that match the 'lifecycleSubState' given. */ lifecycleSubState: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet. */ loadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy used to host the public load balancer of the deployment. */ loadBalancerSubnetId: string; /** * Locks associated with this resource. */ locks: outputs.GoldenGate.GetDeploymentsDeploymentCollectionItemLock[]; /** * Attributes for configuring automatic deployment maintenance. */ maintenanceConfigurations: outputs.GoldenGate.GetDeploymentsDeploymentCollectionItemMaintenanceConfiguration[]; /** * Defines the maintenance window, when automatic actions can be performed. */ maintenanceWindows: outputs.GoldenGate.GetDeploymentsDeploymentCollectionItemMaintenanceWindow[]; /** * Type of the next maintenance. */ nextMaintenanceActionType: string; /** * Description of the next maintenance. */ nextMaintenanceDescription: string; /** * An array of Network Security Group OCIDs used to define network access for either Deployments or Connections. */ nsgIds: string[]; /** * Deployment Data for an OggDeployment */ oggDatas: outputs.GoldenGate.GetDeploymentsDeploymentCollectionItemOggData[]; /** * An array of local peers of deployment */ placements: outputs.GoldenGate.GetDeploymentsDeploymentCollectionItemPlacement[]; /** * The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN. */ privateIpAddress: string; /** * The public IP address representing the access point for the Deployment. */ publicIpAddress: string; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced. */ sourceDeploymentId: string; /** * A filter to return only the deployments having the 'lifecycleState' given. */ state: string; /** * The amount of storage being utilized (in bytes) */ storageUtilizationInBytes: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced. */ subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ subscriptionId: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * The timestamp of last deployment backup scheduled. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`. */ timeLastBackupScheduled: string; /** * The timestamp of next deployment backup scheduled. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`. */ timeNextBackupScheduled: string; /** * The time of next maintenance schedule. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeOfNextMaintenance: string; /** * The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeOggVersionSupportedUntil: string; /** * The time of the last role change. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeRoleChanged: string; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeUpdated: string; } interface GetDeploymentsDeploymentCollectionItemBackupSchedule { /** * Name of the bucket where the object is to be uploaded in the object storage */ bucket: string; /** * The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. */ compartmentId: string; /** * The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY. */ frequencyBackupScheduled: string; /** * Parameter to allow users to create backup without trails */ isMetadataOnly: boolean; /** * Name of namespace that serves as a container for all of your buckets */ namespace: string; /** * The start timestamp for the deployment backup schedule. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`. */ timeBackupScheduled: string; } interface GetDeploymentsDeploymentCollectionItemDeploymentDiagnosticData { /** * Name of the bucket where the object is to be uploaded in the object storage */ bucket: string; /** * The state of the deployment diagnostic collection. */ diagnosticState: string; /** * Name of namespace that serves as a container for all of your buckets */ namespace: string; /** * Name of the diagnostic collected and uploaded to object storage */ object: string; /** * The time until which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeDiagnosticEnd: string; /** * The time from which the diagnostic collection should collect the logs. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeDiagnosticStart: string; } interface GetDeploymentsDeploymentCollectionItemIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface GetDeploymentsDeploymentCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetDeploymentsDeploymentCollectionItemMaintenanceConfiguration { /** * Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default. */ bundleReleaseUpgradePeriodInDays: number; /** * Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period. */ interimReleaseUpgradePeriodInDays: number; /** * By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too. */ isInterimReleaseAutoUpgradeEnabled: boolean; /** * Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default. */ majorReleaseUpgradePeriodInDays: number; /** * Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default. */ securityPatchUpgradePeriodInDays: number; } interface GetDeploymentsDeploymentCollectionItemMaintenanceWindow { /** * Days of the week. */ day: string; /** * Start hour for maintenance period. Hour is in UTC. */ startHour: number; } interface GetDeploymentsDeploymentCollectionItemOggData { /** * @deprecated The 'admin_password' field has been deprecated. Please use 'password_secret_id' instead. */ adminPassword: string; /** * The GoldenGate deployment console username. */ adminUsername: string; /** * The base64 encoded content of the PEM file containing the SSL certificate. */ certificate: string; /** * The type of credential store for OGG. */ credentialStore: string; /** * The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter. */ deploymentName: string; /** * Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to. */ groupToRolesMappings: outputs.GoldenGate.GetDeploymentsDeploymentCollectionItemOggDataGroupToRolesMapping[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Identity Domain when IAM credential store is used. */ identityDomainId: string; key: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment ssl private key is stored in PEM format. */ keySecretId: string; /** * Version of OGG */ oggVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the deployment password is stored. */ passwordSecretId: string; } interface GetDeploymentsDeploymentCollectionItemOggDataGroupToRolesMapping { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server. */ administratorGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server. */ operatorGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges. */ securityGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information */ userGroupId: string; } interface GetDeploymentsDeploymentCollectionItemPlacement { /** * The availability domain of a placement. */ availabilityDomain: string; /** * The fault domain of a placement. */ faultDomain: string; } interface GetDeploymentsFilter { name: string; regex?: boolean; values: string[]; } interface GetMessageItem { /** * The deployment Message in plain text with optional HTML anchor tags. */ deploymentMessage: string; /** * The deployment Message Status. */ deploymentMessageStatus: string; /** * The deployment Message Id. */ id: string; } interface GetMessagesDeploymentMessagesCollection { /** * An array of DeploymentMessages. */ items: outputs.GoldenGate.GetMessagesDeploymentMessagesCollectionItem[]; } interface GetMessagesDeploymentMessagesCollectionItem { /** * The deployment Message in plain text with optional HTML anchor tags. */ deploymentMessage: string; /** * The deployment Message Status. */ deploymentMessageStatus: string; /** * The deployment Message Id. */ id: string; } interface GetMessagesFilter { name: string; regex?: boolean; values: string[]; } interface GetPipelineIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface GetPipelineLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetPipelineMappingRule { /** * Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline. */ mappingType: string; /** * The source schema/table combination for replication to target. */ source: string; /** * The target schema/table combination for replication from the source. */ target: string; } interface GetPipelinePipelineDiagnosticData { /** * Name of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ bucket: string; /** * The state of the pipeline diagnostics collection. */ diagnosticState: string; /** * Namespace that serves as a container of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ namespace: string; /** * Name of the diagnostic collected and uploaded to object storage */ object: string; /** * The date and time the diagnostic data was last collected for the pipeline. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`. */ timeLastCollected: string; } interface GetPipelineProcessOption { /** * Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication. */ initialDataLoads: outputs.GoldenGate.GetPipelineProcessOptionInitialDataLoad[]; /** * Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication. */ replicateSchemaChanges: outputs.GoldenGate.GetPipelineProcessOptionReplicateSchemaChange[]; /** * If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline. */ shouldRestartOnFailure: string; /** * If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option only applies when creating a pipeline and is not applicable while updating a pipeline. */ startUsingDefaultMapping: string; } interface GetPipelineProcessOptionInitialDataLoad { /** * Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true. */ actionOnExistingTable: string; /** * Directory path of ADB wallet locally available in Non-ADB target DB. Required for ADB to non-ADB DBLink type initial load only. If not provided the default wallet path "/u01/targetwallet" will be used. */ adbWalletPath: string; /** * Name of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ bucket: string; /** * Type of Initial load, which can be objectStorage or dbLink. */ initialLoadType: string; /** * If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline. */ isInitialLoad: string; /** * Namespace that serves as a container of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ namespace: string; /** * Directory path of ObjectStorage wallet locally available in Non-ADB source DB. Required for Object Storage type initial load only if source DB is Non-ADB type. */ sourceWalletPath: string; /** * Directory path of ObjectStorage wallet locally available in Non-ADB target DB. Required for Object Storage type initial load only if target DB is Non-ADB type. */ targetWalletPath: string; } interface GetPipelineProcessOptionReplicateSchemaChange { /** * Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true */ actionOnDdlError: string; /** * Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true */ actionOnDmlError: string; /** * If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline. */ canReplicateSchemaChange: string; } interface GetPipelineRunningProcessesFilter { /** * An object's Display Name. */ name: string; regex?: boolean; values: string[]; } interface GetPipelineRunningProcessesPipelineRunningProcessCollection { /** * The list of replication processes and their details. */ items: outputs.GoldenGate.GetPipelineRunningProcessesPipelineRunningProcessCollectionItem[]; } interface GetPipelineRunningProcessesPipelineRunningProcessCollectionItem { /** * The latency, in seconds, of a process running in a replication. This option applies when retrieving running processes. */ lastRecordLagInSeconds: number; /** * An object's Display Name. */ name: string; /** * The type of process running in a replication. For example, Extract or Replicat. This option applies when retrieving running processes. */ processType: string; /** * The status of the Extract or Replicat process. This option applies when retrieving running processes. */ status: string; /** * The date and time the last record was processed by an Extract or Replicat. This option applies when retrieving running processes. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`. */ timeLastProcessed: string; } interface GetPipelineSchemaTablesFilter { name: string; regex?: boolean; values: string[]; } interface GetPipelineSchemaTablesPipelineSchemaTableCollection { /** * Array of source or target schema tables of a pipeline's assigned connection. */ items: outputs.GoldenGate.GetPipelineSchemaTablesPipelineSchemaTableCollectionItem[]; /** * Name of the source schema obtained from get schema endpoint of the created pipeline. */ sourceSchemaName: string; /** * Name of the target schema obtained from get schema endpoint of the created pipeline. */ targetSchemaName: string; } interface GetPipelineSchemaTablesPipelineSchemaTableCollectionItem { /** * The table name from the schema of database connection. */ sourceTableName: string; /** * The table name from the schema of database connection. */ targetTableName: string; } interface GetPipelineSchemasFilter { name: string; regex?: boolean; values: string[]; } interface GetPipelineSchemasPipelineSchemaCollection { /** * Array of pipeline schemas */ items: outputs.GoldenGate.GetPipelineSchemasPipelineSchemaCollectionItem[]; } interface GetPipelineSchemasPipelineSchemaCollectionItem { /** * The schema name from the database connection. */ sourceSchemaName: string; /** * The schema name from the database connection. */ targetSchemaName: string; } interface GetPipelineSourceConnectionDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced. */ connectionId: string; } interface GetPipelineTargetConnectionDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced. */ connectionId: string; } interface GetPipelinesFilter { name: string; regex?: boolean; values: string[]; } interface GetPipelinesPipelineCollection { items: outputs.GoldenGate.GetPipelinesPipelineCollectionItem[]; } interface GetPipelinesPipelineCollectionItem { /** * The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. */ compartmentId: string; /** * The Minimum number of OCPUs to be made available for this Deployment. */ cpuCoreCount: number; /** * Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Metadata about this specific object. */ description: string; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pipeline. This option applies when retrieving a pipeline. */ id: string; /** * List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses. */ ingressIps: outputs.GoldenGate.GetPipelinesPipelineCollectionItemIngressIp[]; /** * Indicates if auto scaling is enabled for the Deployment's CPU core count. */ isAutoScalingEnabled: boolean; /** * The Oracle license model that applies to a Deployment. */ licenseModel: string; /** * Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state. */ lifecycleDetails: string; /** * A filtered list of pipelines to return for a given lifecycleSubState. */ lifecycleSubState: string; /** * Locks associated with this resource. */ locks: outputs.GoldenGate.GetPipelinesPipelineCollectionItemLock[]; /** * Mapping for source/target schema/tables for the pipeline data replication. */ mappingRules: outputs.GoldenGate.GetPipelinesPipelineCollectionItemMappingRule[]; /** * Information regarding the pipeline diagnostic collection */ pipelineDiagnosticDatas: outputs.GoldenGate.GetPipelinesPipelineCollectionItemPipelineDiagnosticData[]; /** * Required pipeline options to configure the replication process (Extract or Replicat). */ processOptions: outputs.GoldenGate.GetPipelinesPipelineCollectionItemProcessOption[]; /** * The type of the recipe */ recipeType: string; /** * The source connection details for creating a pipeline. */ sourceConnectionDetails: outputs.GoldenGate.GetPipelinesPipelineCollectionItemSourceConnectionDetail[]; /** * A filtered list of pipelines to return for a given lifecycleState. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet of the pipeline's private endpoint. The subnet must be a private subnet. */ subnetId: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The target connection details for creating a pipeline. */ targetConnectionDetails: outputs.GoldenGate.GetPipelinesPipelineCollectionItemTargetConnectionDetail[]; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * When the resource was last updated. This option applies when retrieving a pipeline. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`. */ timeLastRecorded: string; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeUpdated: string; } interface GetPipelinesPipelineCollectionItemIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface GetPipelinesPipelineCollectionItemLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetPipelinesPipelineCollectionItemMappingRule { /** * Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline. */ mappingType: string; /** * The source schema/table combination for replication to target. */ source: string; /** * The target schema/table combination for replication from the source. */ target: string; } interface GetPipelinesPipelineCollectionItemPipelineDiagnosticData { /** * Name of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ bucket: string; /** * The state of the pipeline diagnostics collection. */ diagnosticState: string; /** * Namespace that serves as a container of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ namespace: string; /** * Name of the diagnostic collected and uploaded to object storage */ object: string; /** * The date and time the diagnostic data was last collected for the pipeline. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`. */ timeLastCollected: string; } interface GetPipelinesPipelineCollectionItemProcessOption { /** * Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication. */ initialDataLoads: outputs.GoldenGate.GetPipelinesPipelineCollectionItemProcessOptionInitialDataLoad[]; /** * Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication. */ replicateSchemaChanges: outputs.GoldenGate.GetPipelinesPipelineCollectionItemProcessOptionReplicateSchemaChange[]; /** * If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline. */ shouldRestartOnFailure: string; /** * If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option only applies when creating a pipeline and is not applicable while updating a pipeline. */ startUsingDefaultMapping: string; } interface GetPipelinesPipelineCollectionItemProcessOptionInitialDataLoad { /** * Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true. */ actionOnExistingTable: string; /** * Directory path of ADB wallet locally available in Non-ADB target DB. Required for ADB to non-ADB DBLink type initial load only. If not provided the default wallet path "/u01/targetwallet" will be used. */ adbWalletPath: string; /** * Name of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ bucket: string; /** * Type of Initial load, which can be objectStorage or dbLink. */ initialLoadType: string; /** * If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline. */ isInitialLoad: string; /** * Namespace that serves as a container of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ namespace: string; /** * Directory path of ObjectStorage wallet locally available in Non-ADB source DB. Required for Object Storage type initial load only if source DB is Non-ADB type. */ sourceWalletPath: string; /** * Directory path of ObjectStorage wallet locally available in Non-ADB target DB. Required for Object Storage type initial load only if target DB is Non-ADB type. */ targetWalletPath: string; } interface GetPipelinesPipelineCollectionItemProcessOptionReplicateSchemaChange { /** * Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true */ actionOnDdlError: string; /** * Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true */ actionOnDmlError: string; /** * If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline. */ canReplicateSchemaChange: string; } interface GetPipelinesPipelineCollectionItemSourceConnectionDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced. */ connectionId: string; } interface GetPipelinesPipelineCollectionItemTargetConnectionDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced. */ connectionId: string; } interface GetRecipesFilter { /** * An object's Display Name. */ name: string; regex?: boolean; values: string[]; } interface GetRecipesRecipeSummaryCollection { /** * Array of Recipe Summary */ items: outputs.GoldenGate.GetRecipesRecipeSummaryCollectionItem[]; } interface GetRecipesRecipeSummaryCollectionItem { /** * Metadata about this specific object. */ description: string; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * An object's Display Name. */ name: string; /** * The pipeline's recipe type. The default value is ZERO_ETL. */ recipeType: string; /** * Array of supported technology types for this recipe. */ supportedSourceTechnologyTypes: string[]; /** * Array of supported technology types for this recipe. */ supportedTargetTechnologyTypes: string[]; } interface GetTrailFileItem { /** * array of consumer process names */ consumers: string[]; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * Maximum sequence number */ maxSequenceNumber: string; /** * Minimum sequence number */ minSequenceNumber: string; /** * Number of sequences for a specific trail file */ numberOfSequences: number; /** * Producer Process Name if any. */ producer: string; /** * The size of the backup stored in object storage (in bytes) */ sizeInBytes: number; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeLastUpdated: string; /** * A Trail File identifier */ trailFileId: string; } interface GetTrailFilesFilter { name: string; regex?: boolean; values: string[]; } interface GetTrailFilesTrailFileCollection { /** * An array of TrailFiles. */ items: outputs.GoldenGate.GetTrailFilesTrailFileCollectionItem[]; /** * The time the data was last fetched from the deployment. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeLastFetched: string; } interface GetTrailFilesTrailFileCollectionItem { /** * array of consumer process names */ consumers: string[]; /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * Maximum sequence number */ maxSequenceNumber: string; /** * Minimum sequence number */ minSequenceNumber: string; /** * Number of sequences for a specific trail file */ numberOfSequences: number; /** * Producer Process Name if any. */ producer: string; /** * The size of the backup stored in object storage (in bytes) */ sizeInBytes: number; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeLastUpdated: string; /** * A Trail File identifier */ trailFileId: string; } interface GetTrailSequenceItem { /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * Sequence Id */ sequenceId: string; /** * The size of the backup stored in object storage (in bytes) */ sizeInBytes: number; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeLastUpdated: string; } interface GetTrailSequencesFilter { name: string; regex?: boolean; values: string[]; } interface GetTrailSequencesTrailSequenceCollection { /** * An array of TrailSequences. */ items: outputs.GoldenGate.GetTrailSequencesTrailSequenceCollectionItem[]; /** * The time the data was last fetched from the deployment. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeLastFetched: string; } interface GetTrailSequencesTrailSequenceCollectionItem { /** * A filter to return only the resources that match the entire 'displayName' given. */ displayName: string; /** * Sequence Id */ sequenceId: string; /** * The size of the backup stored in object storage (in bytes) */ sizeInBytes: number; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ timeLastUpdated: string; } interface PipelineIngressIp { /** * A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. */ ingressIp: string; } interface PipelineLock { /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface PipelineMappingRule { /** * Defines the exclude/include rules of source and target schemas and tables when replicating from source to target. This option applies when creating and updating a pipeline. */ mappingType: string; /** * The source schema/table combination for replication to target. */ source: string; /** * The target schema/table combination for replication from the source. */ target: string; } interface PipelinePipelineDiagnosticData { /** * Name of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ bucket: string; /** * The state of the pipeline diagnostics collection. */ diagnosticState: string; /** * Namespace that serves as a container of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ namespace: string; /** * Name of the diagnostic collected and uploaded to object storage */ object: string; /** * The date and time the diagnostic data was last collected for the pipeline. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-07-25T21:10:29.600Z`. */ timeLastCollected: string; } interface PipelineProcessOptions { /** * (Updatable) Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication. */ initialDataLoad: outputs.GoldenGate.PipelineProcessOptionsInitialDataLoad; /** * (Updatable) Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication. */ replicateSchemaChange: outputs.GoldenGate.PipelineProcessOptionsReplicateSchemaChange; /** * (Updatable) If ENABLED, then the replication process restarts itself upon failure. This option applies when creating or updating a pipeline. */ shouldRestartOnFailure: string; /** * (Updatable) If ENABLED, then the pipeline is started as part of pipeline creation. It uses default mapping. This option only applies when creating a pipeline and is not applicable while updating a pipeline. */ startUsingDefaultMapping: string; } interface PipelineProcessOptionsInitialDataLoad { /** * (Updatable) Action upon existing tables in target when initial Data Load is set i.e., isInitialLoad=true. */ actionOnExistingTable: string; /** * (Updatable) Directory path of ADB wallet locally available in Non-ADB target DB. Required for ADB to non-ADB DBLink type initial load only. If not provided the default wallet path "/u01/targetwallet" will be used. */ adbWalletPath: string; /** * (Updatable) Name of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ bucket: string; /** * (Updatable) Type of Initial load, which can be objectStorage or dbLink. */ initialLoadType: string; /** * (Updatable) If ENABLED, then existing source data is also synchronized to the target when creating or updating the pipeline. */ isInitialLoad: string; /** * (Updatable) Namespace that serves as a container of the ObjectStorage bucket. Required only for Objectstorage Initial load. */ namespace: string; /** * (Updatable) Directory path of ObjectStorage wallet locally available in Non-ADB source DB. Required for Object Storage type initial load only if source DB is Non-ADB type. */ sourceWalletPath: string; /** * (Updatable) Directory path of ObjectStorage wallet locally available in Non-ADB target DB. Required for Object Storage type initial load only if target DB is Non-ADB type. */ targetWalletPath: string; } interface PipelineProcessOptionsReplicateSchemaChange { /** * (Updatable) Action upon DDL Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true */ actionOnDdlError: string; /** * (Updatable) Action upon DML Error (active only if 'Replicate schema changes (DDL)' is selected) i.e canReplicateSchemaChange=true */ actionOnDmlError: string; /** * (Updatable) If ENABLED, then addition or removal of schema is also replicated, apart from individual tables and records when creating or updating the pipeline. */ canReplicateSchemaChange: string; } interface PipelineSourceConnectionDetails { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced. */ connectionId: string; } interface PipelineTargetConnectionDetails { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connection being referenced. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ connectionId: string; } } export declare namespace HealthChecks { interface GetHttpMonitorsFilter { name: string; regex?: boolean; values: string[]; } interface GetHttpMonitorsHttpMonitor { /** * Filters results by compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Filters results that exactly match the `displayName` field. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A dictionary of HTTP request headers. */ headers: { [key: string]: string; }; /** * Filters results that match the `homeRegion`. */ homeRegion: string; /** * The OCID of the resource. */ id: string; /** * The monitor interval in seconds. Valid values: 10, 30, and 60. */ intervalInSeconds: number; /** * Enables or disables the monitor. Set to 'true' to launch monitoring. */ isEnabled: boolean; /** * The supported HTTP methods available for probes. */ method: string; /** * The optional URL path to probe, including query parameters. */ path: string; /** * The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. */ port: number; /** * The supported protocols available for HTTP probes. */ protocol: string; /** * A URL for fetching the probe results. */ resultsUrl: string; /** * A list of targets (hostnames or IP addresses) of the probe. */ targets: string[]; /** * The RFC 3339-formatted creation date and time of the probe. */ timeCreated: string; /** * The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. */ timeoutInSeconds: number; /** * A list of names of vantage points from which to execute the probe. */ vantagePointNames: string[]; } interface GetHttpProbeResultsFilter { name: string; regex?: boolean; values: string[]; } interface GetHttpProbeResultsHttpProbeResult { /** * The time immediately after the vantage point finishes establishing the connection to the server to retrieve the resource. */ connectEnd: number; /** * The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource. */ connectStart: number; /** * TCP connection results. All durations are in milliseconds. */ connections: outputs.HealthChecks.GetHttpProbeResultsHttpProbeResultConnection[]; /** * The DNS resolution results. */ dns: outputs.HealthChecks.GetHttpProbeResultsHttpProbeResultDn[]; /** * The time immediately before the vantage point finishes the domain name lookup for the resource. */ domainLookupEnd: number; /** * The time immediately before the vantage point starts the domain name lookup for the resource. */ domainLookupStart: number; /** * The total duration from start of request until response is fully consumed or the connection is closed. */ duration: number; /** * The size, in octets, of the payload body prior to removing any applied content-codings. */ encodedBodySize: number; /** * The category of error if an error occurs executing the probe. The `errorMessage` field provides a message with the error details. * * NONE - No error * * DNS - DNS errors * * TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error. * * NETWORK - Network-related errors, for example a "network unreachable" error. * * SYSTEM - Internal system errors. */ errorCategory: string; /** * The error information indicating why a probe execution failed. */ errorMessage: string; /** * The time immediately before the vantage point starts to fetch the resource. */ fetchStart: number; /** * True if the probe result is determined to be healthy based on probe type-specific criteria. For HTTP probes, a probe result is considered healthy if the HTTP response code is greater than or equal to 200 and less than 300. */ isHealthy: boolean; /** * True if the probe did not complete before the configured `timeoutInSeconds` value. */ isTimedOut: boolean; /** * A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days. */ key: string; /** * The OCID of a monitor or on-demand probe. */ probeConfigurationId: string; /** * The supported protocols available for HTTP probes. */ protocol: string; /** * The time immediately before the vantage point starts requesting the resource from the server. */ requestStart: number; /** * The time immediately after the vantage point receives the last byte of the response or immediately before the transport connection is closed, whichever comes first. */ responseEnd: number; /** * The time immediately after the vantage point's HTTP parser receives the first byte of the response. */ responseStart: number; /** * The time immediately before the vantage point starts the handshake process to secure the current connection. */ secureConnectionStart: number; /** * The date and time the probe was executed, expressed in milliseconds since the POSIX epoch. This field is defined by the PerformanceResourceTiming interface of the W3C Resource Timing specification. For more information, see [Resource Timing](https://w3c.github.io/resource-timing/#sec-resource-timing). */ startTime: number; /** * The HTTP response status code. */ statusCode: number; /** * Filters results that match the `target`. */ target: string; /** * The name of the vantage point that executed the probe. */ vantagePointName: string; } interface GetHttpProbeResultsHttpProbeResultConnection { /** * The connection IP address. */ address: string; /** * Total connect duration, calculated using `connectEnd` minus `connectStart`. */ connectDuration: number; /** * The port. */ port: number; /** * The duration to secure the connection. This value will be zero for insecure connections. Calculated using `connectEnd` minus `secureConnectionStart`. */ secureConnectDuration: number; } interface GetHttpProbeResultsHttpProbeResultDn { /** * The addresses returned by DNS resolution. */ addresses: string[]; /** * Total DNS resolution duration, in milliseconds. Calculated using `domainLookupEnd` minus `domainLookupStart`. */ domainLookupDuration: number; } interface GetPingMonitorsFilter { name: string; regex?: boolean; values: string[]; } interface GetPingMonitorsPingMonitor { /** * Filters results by compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Filters results that exactly match the `displayName` field. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filters results that match the `homeRegion`. */ homeRegion: string; /** * The OCID of the resource. */ id: string; /** * The monitor interval in seconds. Valid values: 10, 30, and 60. */ intervalInSeconds: number; /** * Enables or disables the monitor. Set to 'true' to launch monitoring. */ isEnabled: boolean; /** * The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. */ port: number; /** * The protocols for ping probes. */ protocol: string; /** * A URL for fetching the probe results. */ resultsUrl: string; /** * A list of targets (hostnames or IP addresses) of the probe. */ targets: string[]; /** * The RFC 3339-formatted creation date and time of the probe. */ timeCreated: string; /** * The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. */ timeoutInSeconds: number; /** * A list of names of vantage points from which to execute the probe. */ vantagePointNames: string[]; } interface GetPingProbeResultsFilter { name: string; regex?: boolean; values: string[]; } interface GetPingProbeResultsPingProbeResult { /** * The network connection results. */ connections: outputs.HealthChecks.GetPingProbeResultsPingProbeResultConnection[]; /** * The DNS resolution results. */ dns: outputs.HealthChecks.GetPingProbeResultsPingProbeResultDn[]; /** * The time immediately before the vantage point finishes the domain name lookup for the resource. */ domainLookupEnd: number; /** * The time immediately before the vantage point starts the domain name lookup for the resource. */ domainLookupStart: number; /** * The category of error if an error occurs executing the probe. The `errorMessage` field provides a message with the error details. * * NONE - No error * * DNS - DNS errors * * TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error. * * NETWORK - Network-related errors, for example a "network unreachable" error. * * SYSTEM - Internal system errors. */ errorCategory: string; /** * The error information indicating why a probe execution failed. */ errorMessage: string; /** * The ICMP code of the response message. This field is not used when the protocol is set to TCP. For more information on ICMP codes, see [Internet Control Message Protocol (ICMP) Parameters](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml). */ icmpCode: number; /** * True if the probe result is determined to be healthy based on probe type-specific criteria. For HTTP probes, a probe result is considered healthy if the HTTP response code is greater than or equal to 200 and less than 300. */ isHealthy: boolean; /** * True if the probe did not complete before the configured `timeoutInSeconds` value. */ isTimedOut: boolean; /** * A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days. */ key: string; /** * The latency of the probe execution, in milliseconds. */ latencyInMs: number; /** * The OCID of a monitor or on-demand probe. */ probeConfigurationId: string; /** * The protocols for ping probes. */ protocol: string; /** * The date and time the probe was executed, expressed in milliseconds since the POSIX epoch. This field is defined by the PerformanceResourceTiming interface of the W3C Resource Timing specification. For more information, see [Resource Timing](https://w3c.github.io/resource-timing/#sec-resource-timing). */ startTime: number; /** * Filters results that match the `target`. */ target: string; /** * The name of the vantage point that executed the probe. */ vantagePointName: string; } interface GetPingProbeResultsPingProbeResultConnection { /** * The connection IP address. */ address: string; /** * The port. */ port: number; } interface GetPingProbeResultsPingProbeResultDn { /** * The addresses returned by DNS resolution. */ addresses: string[]; /** * Total DNS resolution duration, in milliseconds. Calculated using `domainLookupEnd` minus `domainLookupStart`. */ domainLookupDuration: number; } interface GetVantagePointsFilter { /** * Filters results that exactly match the `name` field. */ name: string; regex?: boolean; values: string[]; } interface GetVantagePointsHealthChecksVantagePoint { /** * Filters results that exactly match the `displayName` field. */ displayName: string; /** * Geographic information about a vantage point. */ geos: outputs.HealthChecks.GetVantagePointsHealthChecksVantagePointGeo[]; /** * Filters results that exactly match the `name` field. */ name: string; /** * The organization on whose infrastructure this vantage point resides. Provider names are not unique, as Oracle Cloud Infrastructure maintains many vantage points in each major provider. */ providerName: string; /** * An array of objects that describe how traffic to this vantage point is routed, including which prefixes and ASNs connect it to the internet. */ routings: outputs.HealthChecks.GetVantagePointsHealthChecksVantagePointRouting[]; } interface GetVantagePointsHealthChecksVantagePointGeo { /** * 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](https://www.iso.org/obp/ui/#search). */ adminDivCode: string; /** * Common English-language name for the city. */ cityName: string; /** * The ISO 3166-1 alpha-2 country code. For a list of codes, see [Country Codes](https://www.iso.org/obp/ui/#search). */ countryCode: string; /** * The common English-language name for the country. */ countryName: string; /** * An opaque identifier for the geographic location of the vantage point. */ geoKey: string; /** * Degrees north of the Equator. */ latitude: number; /** * Degrees east of the prime meridian. */ longitude: number; } interface GetVantagePointsHealthChecksVantagePointRouting { /** * The registry label for `asn`, usually the name of the organization that owns the ASN. May be omitted or null. */ asLabel: string; /** * The Autonomous System Number (ASN) identifying the organization responsible for routing packets to `prefix`. */ asn: number; /** * An IP prefix (CIDR syntax) that is less specific than `address`, through which `address` is routed. */ prefix: string; /** * An integer between 0 and 100 used to select between multiple origin ASNs when routing to `prefix`. Most prefixes have exactly one origin ASN, in which case `weight` will be 100. */ weight: number; } } export declare namespace Identity { interface AuthenticationPolicyNetworkPolicy { /** * (Updatable) Network Source ids */ networkSourceIds: string[]; } interface AuthenticationPolicyPasswordPolicy { /** * (Updatable) At least one lower case character required. */ isLowercaseCharactersRequired: boolean; /** * (Updatable) At least one numeric character required. */ isNumericCharactersRequired: boolean; /** * (Updatable) At least one special character required. */ isSpecialCharactersRequired: boolean; /** * (Updatable) At least one uppercase character required. */ isUppercaseCharactersRequired: boolean; /** * (Updatable) User name is allowed to be part of the password. */ isUsernameContainmentAllowed: boolean; /** * (Updatable) Minimum password length required. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ minimumPasswordLength: number; } interface DomainReplicaRegion { /** * A REPLICATION_ENABLED region, e.g. us-ashburn-1. See [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) for the full list of supported region names. */ region: string; /** * The current state. */ state: string; /** * Region agnostic domain URL. */ url: string; } interface DomainsAccountRecoverySettingIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAccountRecoverySettingIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAccountRecoverySettingMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsAccountRecoverySettingTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApiKeyIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApiKeyIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApiKeyMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsApiKeyTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). * * **Added In:** 2205182039 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: writeOnly * * required: false * * returned: never * * type: boolean * * uniqueness: none */ allowSelfChange: boolean; } interface DomainsApiKeyUser { /** * (Updatable) The user's display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The username. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * The user's OCID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The user's ID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsAppAccount { /** * (Updatable) Status of the account * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ active: boolean; /** * (Updatable) Name of the account * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) Owner identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ ownerId: string; /** * (Updatable) AccountMgmtInfo URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Account identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsAppAdminRole { /** * (Updatable) The description of the AppRole. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ description: string; /** * (Updatable) Display-name of the AppRole. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) URI of the AppRole. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) ID of the AppRole. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppAliasApp { /** * (Updatable) Description of the alias App. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ description: string; /** * (Updatable) Display name of the alias App. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) URI of the alias App. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) ID of the alias App. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppAllowedScope { /** * (Updatable) A fully qualified scope that this App is allowed to access when it acts as an OAuthClient. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ fqs: string; /** * (Updatable) The ID of the App that defines this scope. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ idOfDefiningApp: string; /** * (Updatable) If true, indicates that this value must be protected. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ readOnly: boolean; } interface DomainsAppAllowedTag { /** * (Updatable) Key or name of the allowed tag. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) If true, indicates that this value must be protected. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ readOnly: boolean; /** * (Updatable) Value of the allowed tag. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppAppSignonPolicy { /** * (Updatable) URI of the policy. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Identifier of the Policy. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppAppsNetworkPerimeter { /** * (Updatable) URI of the Network Perimeter. * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) List of identifier of Network Perimeters for App * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsAppAsOpcService { /** * (Updatable) URI of the OPCService facet. * * **Deprecated Since: 17.3.4** * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Identifier of the OPCService facet. * * **Deprecated Since: 17.3.4** * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppAttrRenderingMetadata { /** * (Updatable) Data type of the attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ datatype: string; /** * (Updatable) Help text for the attribute. It can contain HTML tags. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ helptext: string; /** * (Updatable) Label for the attribute to be shown in the UI. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ label: string; /** * (Updatable) Maximum length of the attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ maxLength: number; /** * (Updatable) Maximum size of the attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ maxSize: number; /** * (Updatable) Minimum length of the attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ minLength: number; /** * (Updatable) Minimum size of the attribute.. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ minSize: number; /** * (Updatable) Name of the attribute. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) Data type of the attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ order: number; /** * (Updatable) Is the attribute readOnly. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ readOnly: boolean; /** * (Updatable) Regular expression of the attribute for validation. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ regexp: string; /** * (Updatable) Attribute is required or optional. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ required: boolean; /** * (Updatable) UI widget to use for the attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ section: string; /** * (Updatable) Indicates whether the attribute is to be shown on the application creation UI. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ visible: boolean; /** * (Updatable) UI widget to use for the attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ widget: string; } interface DomainsAppBasedOnTemplate { /** * (Updatable) The most recent DateTime that the appTemplate on which the application based upon is updated. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) URI of the application template. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * Identifier of the application template. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; /** * (Updatable) Unique Well-known identifier used to reference app template. * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: string * * uniqueness: none */ wellKnownId: string; } interface DomainsAppCertificate { /** * (Updatable) Certificate alias * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ certAlias: string; /** * (Updatable) Certificate kid * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ kid: string; /** * (Updatable) sha1Thumbprint * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ sha1thumbprint: string; /** * (Updatable) Base-64-encoded certificate. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: binary * * uniqueness: none */ x509base64certificate: string; /** * (Updatable) Certificate x5t * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ x5t: string; } interface DomainsAppCloudControlProperty { /** * (Updatable) The name of the property. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) The value(s) of the property. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: true * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ values: string[]; } interface DomainsAppEditableAttribute { /** * (Updatable) Name of the attribute. The attribute name will be qualified by schema name if any extension schema defines the attribute. The attribute name will not be qualified by schema name if the base schema defines the attribute. * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; } interface DomainsAppGrant { /** * (Updatable) Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ grantMechanism: string; /** * (Updatable) Grantee identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ granteeId: string; /** * (Updatable) Grantee resource type. Allowed values are User and Group. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ granteeType: string; /** * (Updatable) Grant URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Grant identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppGrantedAppRole { /** * (Updatable) If true, then this granted AppRole confers administrative privileges within the App that defines it. Otherwise, the granted AppRole confers only functional privileges. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ adminRole: boolean; /** * (Updatable) The id of the App that defines this AppRole, which is granted to this App. The App that defines the AppRole acts as the producer; the App to which the AppRole is granted acts as a consumer. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ appId: string; /** * (Updatable) The name of the App that defines this AppRole, which is granted to this App. The App that defines the AppRole acts as the producer; the App to which the AppRole is granted acts as a consumer. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ appName: string; /** * (Updatable) The display-name of an AppRole that is granted to this App. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The name of the legacy group associated with this AppRole. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ legacyGroupName: string; /** * (Updatable) If true, indicates that this value must be protected. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ readOnly: boolean; /** * (Updatable) The URI of an AppRole that is granted to this App. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) A label that indicates whether this AppRole was granted directly to the App (or indirectly through a Group). For an App, the value of this attribute will always be 'direct' (because an App cannot be a member of a Group). * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The id of an AppRole that is granted to this App. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppIdentityProvider { /** * (Updatable) Display-name of the IdentityProvider. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) URI of the IdentityProvider. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) ID of the IdentityProvider. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppIdpPolicy { /** * (Updatable) URI of the policy. * * **Added In:** 18.1.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Identifier of the Policy. * * **Added In:** 18.1.2 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsAppProtectableSecondaryAudience { /** * (Updatable) If true, indicates that this value must be protected. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ readOnly: boolean; /** * (Updatable) The value of an secondary audience--additional URI to be added automatically to any OAuth token that allows access to this App. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppRadiusPolicy { _ref: string; /** * (Updatable) Identifier of the Policy. * * **Added In:** 2209070044 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppRoleApp { /** * (Updatable) App display name * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ display: string; /** * (Updatable) Application name * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) App URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The serviceInstanceIdentifier of the App that defines this AppRole. This value will match the opcServiceInstanceGUID of any service-instance that the App represents. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ serviceInstanceIdentifier: string; /** * App identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsAppRoleIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppRoleIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppRoleMember { /** * Member display name * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The URI corresponding to the member Resource of this Group * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * Indicates the type of Resource--for example, User, Group or DynamicResourceGroup * * **SCIM++ Properties:** * * caseExact: true * * idcsCsvAttributeName: Member Type * * idcsDefaultValue: User * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * ID of the member of this AppRole * * **SCIM++ Properties:** * * caseExact: true * * idcsCsvAttributeName: Member * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsAppRoleMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsAppRoleTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppSamlServiceProvider { /** * (Updatable) The URI of the App that acts as a Service Provider. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The id of the App that acts as a Service Provider. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsAppScope { /** * (Updatable) OAuth scope description * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ description: string; /** * (Updatable) OAuth scope display name * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ displayName: string; /** * (Updatable) The fully qualified value of this scope within this App. A fully qualified scope combines the 'value' of each scope with the value of 'audience'. Each value of 'fqs' must be unique across the system. Used only when this App acts as an OAuth Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: server */ fqs: string; /** * (Updatable) If true, indicates that this value must be protected. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ readOnly: boolean; /** * (Updatable) If true, indicates that a user must provide consent to access this scope. Note: Used only when this App acts as an OAuth Resource. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ requiresConsent: boolean; /** * (Updatable) OAuth scope. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppServiceParam { /** * (Updatable) The name of the attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) The value of the attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppSignonPolicy { /** * (Updatable) URI of the policy. * * **Deprecated Since: 17.3.4** * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Identifier of the Policy. * * **Deprecated Since: 17.3.4** * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppTermsOfUse { /** * (Updatable) Terms Of Use name * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ name: string; /** * (Updatable) URI of the TermsOfUse. * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Identifier of the TermsOfUse * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppTrustPolicy { /** * (Updatable) URI of the policy. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Identifier of the Policy. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionOciTags { /** * (Updatable) Oracle Cloud Infrastructure Defined Tags * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsCompositeKey: [namespace, key, value] * * type: complex * * idcsSearchable: true * * required: false * * mutability: readWrite * * multiValued: true * * returned: default */ definedTags: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionOciTagsDefinedTag[]; /** * (Updatable) Oracle Cloud Infrastructure Freeform Tags * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsCompositeKey: [key, value] * * idcsSearchable: true * * type: complex * * required: false * * mutability: readWrite * * returned: default * * multiValued: true */ freeformTags: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionOciTagsFreeformTag[]; /** * (Updatable) Oracle Cloud Infrastructure Tag slug * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * type: binary * * mutability: readOnly * * returned: request */ tagSlug: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionOciTagsDefinedTag { /** * (Updatable) Oracle Cloud Infrastructure Tag key * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ key: string; /** * (Updatable) Oracle Cloud Infrastructure Tag namespace * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ namespace: string; /** * (Updatable) Oracle Cloud Infrastructure Tag value * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * required: true * * idcsReturnEmptyWhenNull: true * * mutability: readWrite * * returned: default * * type: string * * idcsSearchable: true * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionOciTagsFreeformTag { /** * (Updatable) Oracle Cloud Infrastructure Tag key * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ key: string; /** * (Updatable) Oracle Cloud Infrastructure Tag value * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * required: true * * idcsReturnEmptyWhenNull: true * * mutability: readWrite * * returned: default * * type: string * * idcsSearchable: true * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensiondbcsApp { /** * (Updatable) Description: * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ domainApp: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensiondbcsAppDomainApp; /** * (Updatable) The name of the Enterprise Domain that contains any number of DBInstances. If specified, the value must be unique. A non-null value indicates that App represents a DBDomain. A value of null indicates that the App represents an DB-instance. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: string * * uniqueness: server */ domainName: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensiondbcsAppDomainApp { /** * (Updatable) DB Domain App display name * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; /** * (Updatable) DB Domain App URI * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) DB Domain App identifier * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppApp { /** * (Updatable) Allow Authz policy decision expiry time in seconds. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsMaxValue: 3600 * * idcsMinValue: 0 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ allowAuthzDecisionTtl: number; /** * (Updatable) Allow Authz Policy. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex */ allowAuthzPolicy: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAllowAuthzPolicy; /** * (Updatable) A list of AppResources of this App. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: true * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: complex */ appResources: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAppResource[]; /** * (Updatable) Deny Authz policy decision expiry time in seconds. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsMaxValue: 3600 * * idcsMinValue: 0 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ denyAuthzDecisionTtl: number; /** * (Updatable) Deny Authz Policy. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex */ denyAuthzPolicy: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppDenyAuthzPolicy; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAllowAuthzPolicy { /** * (Updatable) URI of the policy. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Identifier of the Policy. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAppResource { /** * (Updatable) The URI of an AppResource of this App. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The id of an AppResource of this App. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppDenyAuthzPolicy { /** * (Updatable) URI of the policy. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Identifier of the Policy. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppApp { /** * (Updatable) FormFill Application Configuration CLOB which has to be maintained in Form-Fill APP for legacy code to do Form-Fill injection * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ configuration: string; /** * (Updatable) Indicates how FormFill obtains the username and password of the account that FormFill will use to sign into the target App. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ formCredMethod: string; /** * (Updatable) Credential Sharing Group to which this form-fill application belongs. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ formCredentialSharingGroupId: string; /** * (Updatable) A list of application-formURLs that FormFill should match against any formUrl that the user-specifies when signing in to the target service. Each item in the list also indicates how FormFill should interpret that formUrl. * * **SCIM++ Properties:** * * idcsCompositeKey: [formUrl] * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ formFillUrlMatches: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppAppFormFillUrlMatch[]; /** * (Updatable) Type of the FormFill application like WebApplication, MainFrameApplication, WindowsApplication. Initially, we will support only WebApplication. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ formType: string; /** * (Updatable) If true, indicates that system is allowed to show the password in plain-text for this account after re-authentication. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ revealPasswordOnForm: boolean; /** * (Updatable) If true, indicates that each of the Form-Fill-related attributes that can be inherited from the template actually will be inherited from the template. If false, indicates that the AppTemplate on which this App is based has disabled inheritance for these Form-Fill-related attributes. * * **Added In:** 17.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ syncFromTemplate: boolean; /** * (Updatable) Indicates the custom expression, which can combine concat and substring operations with literals and with any attribute of the Oracle Identity Cloud Service User * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ userNameFormExpression: string; /** * (Updatable) Format for generating a username. This value can be Username or Email Address; any other value will be treated as a custom expression. A custom expression may combine 'concat' and 'substring' operations with literals and with any attribute of the Oracle Identity Cloud Service user. * * **SCIM++ Properties:** * * caseExact: false * * idcsPii: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ userNameFormTemplate: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppAppFormFillUrlMatch { /** * (Updatable) An application formUrl that FormFill will match against any formUrl that a User enters in trying to access the target-service which this App represents. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ formUrl: string; /** * (Updatable) Indicates how to interpret the value of 'formUrl' when matching against a user-specified formUrl. The system currently supports only 'Exact', which indicates that the value of 'formUrl' should be treated as a literal value. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ formUrlMatchType: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplate { /** * (Updatable) FormFill Application Configuration CLOB which has to be maintained in Form-Fill APP for legacy code to do Form-Fill injection * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ configuration: string; /** * (Updatable) Indicates how FormFill obtains the username and password of the account that FormFill will use to sign into the target App. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ formCredMethod: string; /** * (Updatable) Credential Sharing Group to which this form-fill application belongs. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ formCredentialSharingGroupId: string; /** * (Updatable) A list of application-formURLs that FormFill should match against any formUrl that the user-specifies when signing in to the target service. Each item in the list also indicates how FormFill should interpret that formUrl. * * **SCIM++ Properties:** * * idcsCompositeKey: [formUrl] * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ formFillUrlMatches: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplateFormFillUrlMatch[]; /** * (Updatable) Type of the FormFill application like WebApplication, MainFrameApplication, WindowsApplication. Initially, we will support only WebApplication. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ formType: string; /** * (Updatable) If true, indicates that system is allowed to show the password in plain-text for this account after re-authentication. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ revealPasswordOnForm: boolean; /** * (Updatable) If true, indicates that each of the Form-Fill-related attributes that can be inherited from the template actually will be inherited from the template. If false, indicates that the AppTemplate disabled inheritance for these Form-Fill-related attributes. * * **Added In:** 17.4.2 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ syncFromTemplate: boolean; /** * (Updatable) Indicates the custom expression, which can combine concat and substring operations with literals and with any attribute of the Oracle Identity Cloud Service User * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ userNameFormExpression: string; /** * (Updatable) Format for generating a username. This value can be Username or Email Address; any other value will be treated as a custom expression. A custom expression may combine 'concat' and 'substring' operations with literals and with any attribute of the Oracle Identity Cloud Service user. * * **SCIM++ Properties:** * * caseExact: false * * idcsPii: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ userNameFormTemplate: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplateFormFillUrlMatch { /** * (Updatable) An application formUrl that FormFill will match against any formUrl that a User enters in trying to access the target-service which this App represents. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ formUrl: string; /** * (Updatable) Indicates how to interpret the value of 'formUrl' when matching against a user-specified formUrl. The system currently supports only 'Exact', which indicates that the value of 'formUrl' should be treated as a literal value. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ formUrlMatchType: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionkerberosRealmApp { /** * (Updatable) The type of salt that the system will use to encrypt Kerberos-specific artifacts of this App unless another type of salt is specified. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ defaultEncryptionSaltType: string; /** * (Updatable) The primary key that the system should use to encrypt artifacts that are specific to this Kerberos realm -- for example, to encrypt the Principal Key in each KerberosRealmUser. * * **SCIM++ Properties:** * * idcsSearchable: false * * idcsSensitive: none * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ masterKey: string; /** * (Updatable) Max Renewable Age in seconds * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: integer * * uniqueness: none */ maxRenewableAge: number; /** * (Updatable) Max Ticket Life in seconds * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: integer * * uniqueness: none */ maxTicketLife: number; /** * (Updatable) The name of the Kerberos Realm that this App uses for authentication. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ realmName: string; /** * (Updatable) The types of salt that are available for the system to use when encrypting Kerberos-specific artifacts for this App. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ supportedEncryptionSaltTypes: string[]; /** * (Updatable) Ticket Flags * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: integer * * uniqueness: none */ ticketFlags: number; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappApp { /** * (Updatable) If true, then the account form will be displayed in the Oracle Identity Cloud Service UI to interactively create or update an account for this App. If a value is not specified for this attribute, a default value of \"false\" will be assumed as the value for this attribute. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ accountFormVisible: boolean; /** * (Updatable) If true, admin has granted consent to perform managed app run-time operations. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ adminConsentGranted: boolean; /** * (Updatable) ConnectorBundle configuration properties * * **SCIM++ Properties:** * * idcsCompositeKey: [name] * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ bundleConfigurationProperties: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundleConfigurationProperty[]; /** * (Updatable) Configurable options maintaining a pool of ICF connector instances. Values for sub attributes can be set only if the ConnectorBundle referenced in the App has connectorPoolingSupported set to true * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ bundlePoolConfiguration: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundlePoolConfiguration; /** * (Updatable) If true, the managed app can be authoritative. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ canBeAuthoritative: boolean; /** * (Updatable) If true, the accounts of the application are managed through an ICF connector bundle * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ connected: boolean; /** * (Updatable) ConnectorBundle * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: complex * * uniqueness: none */ connectorBundles: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppConnectorBundle[]; /** * (Updatable) If true, send activation email to new users created from authoritative sync. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ enableAuthSyncNewUserNotification: boolean; /** * (Updatable) If true, sync run-time operations are enabled for this App. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ enableSync: boolean; /** * (Updatable) If true, send sync summary as notification upon job completion. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ enableSyncSummaryReportNotification: boolean; /** * (Updatable) Flat file connector bundle configuration properties * * **SCIM++ Properties:** * * idcsCompositeKey: [name] * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ flatFileBundleConfigurationProperties: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileBundleConfigurationProperty[]; /** * (Updatable) Flat file connector bundle to sync from a flat file. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ flatFileConnectorBundle: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileConnectorBundle; /** * (Updatable) IdentityBridges associated with this App * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ identityBridges: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppIdentityBridge[]; /** * (Updatable) If true, sync from the managed app will be performed as authoritative sync. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ isAuthoritative: boolean; /** * (Updatable) If true, the managed app is a directory. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ isDirectory: boolean; /** * (Updatable) If true, the managed app is an On-Premise app. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ isOnPremiseApp: boolean; /** * (Updatable) If true, the managed app supports schema customization. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ isSchemaCustomizationSupported: boolean; /** * (Updatable) If true, the managed app supports schema discovery. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ isSchemaDiscoverySupported: boolean; /** * (Updatable) If true, the managed app requires 3-legged OAuth for authorization. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ isThreeLeggedOauthEnabled: boolean; /** * (Updatable) If true, indicates that Oracle Identity Cloud Service can use two-legged OAuth to connect to this ManagedApp. * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ isTwoLeggedOauthEnabled: boolean; /** * (Updatable) Object classes * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: default * * type: complex * * uniqueness: none */ objectClasses: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppObjectClass[]; /** * (Updatable) The most recent DateTime that the configuration of this App was updated. AppServices updates this timestamp whenever AppServices updates an App's configuration with respect to synchronization. * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: dateTime * * uniqueness: none */ syncConfigLastModified: string; /** * (Updatable) The value of this attribute persists any OAuth access token that the system uses to connect to this ManagedApp. The system obtains this access token using an OAuth protocol flow that could be two-legged or three-legged. A two-legged flow involves only the requester and the server. A three-legged flow also requires the consent of a user -- in this case the consent of an administrator. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex */ threeLeggedOauthCredential: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppThreeLeggedOauthCredential; /** * (Updatable) Three legged OAuth provider name in Oracle Identity Cloud Service. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string */ threeLeggedOauthProviderName: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundleConfigurationProperty { /** * (Updatable) If true, this bundle configuration property value is confidential and will be encrypted in Oracle Identity Cloud Service. This attribute maps to \"isConfidential\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: boolean * * uniqueness: none */ confidential: boolean; /** * (Updatable) Display name of the bundle configuration property. This attribute maps to \"displayName\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ displayName: string; /** * (Updatable) Help message of the bundle configuration property. This attribute maps to \"helpMessage\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ helpMessage: string; /** * (Updatable) ICF data type of the bundle configuration property. This attribute maps to \"type\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ icfType: string; /** * (Updatable) Name of the bundle configuration property. This attribute maps to \"name\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) Display sequence of the bundle configuration property. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ order: number; /** * (Updatable) If true, this bundle configuration property is required to connect to the target connected managed app. This attribute maps to \"isRequired\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: boolean * * uniqueness: none */ required: boolean; /** * (Updatable) Value of the bundle configuration property. This attribute maps to \"value\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * idcsSensitive: encrypt * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ values: string[]; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundlePoolConfiguration { /** * (Updatable) Maximum number of connector instances in the pool that are idle and active. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ maxIdle: number; /** * (Updatable) Maximum number of connector instances in the pool that are idle and active. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ maxObjects: number; /** * (Updatable) Maximum time (in milliseconds) to wait for a free connector instance to become available before failing. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ maxWait: number; /** * (Updatable) Minimum time (in milliseconds) to wait before evicting an idle conenctor instance from the pool. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ minEvictableIdleTimeMillis: number; /** * (Updatable) Minimum number of idle connector instances in the pool. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ minIdle: number; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppConnectorBundle { /** * (Updatable) ConnectorBundle display name * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) ConnectorBundle URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Connector Bundle type. Allowed values are ConnectorBundle, LocalConnectorBundle. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsDefaultValue: ConnectorBundle * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) ConnectorBundle identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; /** * (Updatable) Unique Well-known identifier used to reference connector bundle. * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: string * * uniqueness: none */ wellKnownId: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileBundleConfigurationProperty { /** * (Updatable) If true, this flatfile bundle configuration property value is confidential and will be encrypted in Oracle Identity Cloud Service. This attribute maps to \"isConfidential\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: boolean * * uniqueness: none */ confidential: boolean; /** * (Updatable) Display name of the flatfile bundle configuration property. This attribute maps to \"displayName\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ displayName: string; /** * (Updatable) Help message of the flatfile bundle configuration property. This attribute maps to \"helpMessage\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ helpMessage: string; /** * (Updatable) ICF data type of flatfile the bundle configuration property. This attribute maps to \"type\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ icfType: string; /** * (Updatable) Name of the flatfile bundle configuration property. This attribute maps to \"name\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) Display sequence of the bundle configuration property. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ order: number; /** * (Updatable) If true, this flatfile bundle configuration property is required to connect to the target connected managed app. This attribute maps to \"isRequired\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: boolean * * uniqueness: none */ required: boolean; /** * (Updatable) Value of the flatfile bundle configuration property. This attribute maps to \"value\" attribute in \"ConfigurationProperty\" in ICF. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * idcsSensitive: encrypt * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ values: string[]; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileConnectorBundle { /** * (Updatable) ConnectorBundle display name * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) ConnectorBundle URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) ConnectorBundle identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; /** * (Updatable) Unique well-known identifier used to reference connector bundle. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: string * * uniqueness: none */ wellKnownId: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppIdentityBridge { /** * (Updatable) Name of the IdentityBridge associated with the App. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) The URI of the IdentityBridge associated with the App. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The Id of the IdentityBridge associated with the App. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppObjectClass { /** * (Updatable) Object class display name * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) If true, the object class represents an account. The isAccountObjectClass attribute value 'true' MUST appear no more than once. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: boolean * * uniqueness: none */ isAccountObjectClass: boolean; /** * (Updatable) Object class URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Object class resource type * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsDefaultValue: AccountObjectClass * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) Object class template identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppThreeLeggedOauthCredential { /** * (Updatable) Access Token * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * idcsSensitive: encrypt * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ accessToken: string; /** * (Updatable) Access token expiry * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ accessTokenExpiry: string; /** * (Updatable) Refresh Token * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * idcsSensitive: encrypt * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ refreshToken: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionmulticloudServiceAppApp { /** * (Updatable) The multicloud platform service URL which the application will invoke for runtime operations such as AWSCredentials api invocation * * **Added In:** 2301202328 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: request * * type: string * * uniqueness: none */ multicloudPlatformUrl: string; /** * (Updatable) Specifies the service type for which the application is configured for multicloud integration. For applicable external service types, app will invoke multicloud service for runtime operations * * **Added In:** 2301202328 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: true * * returned: request * * type: string * * uniqueness: none */ multicloudServiceType: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionopcServiceApp { /** * (Updatable) Current Federation Mode * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string */ currentFederationMode: string; /** * (Updatable) Current Synchronization Mode * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string */ currentSynchronizationMode: string; /** * (Updatable) If true, indicates that enablement is in progress started but not completed * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean */ enablingNextFedSyncModes: boolean; /** * (Updatable) Next Federation Mode * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string */ nextFederationMode: string; /** * (Updatable) Next Synchronization Mode * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string */ nextSynchronizationMode: string; /** * (Updatable) This value identifies the OPC region in which the service is running. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ region: string; /** * (Updatable) This value specifies the unique identifier assigned to an instance of an Oracle Public Cloud service app. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: string * * uniqueness: server */ serviceInstanceIdentifier: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionradiusAppApp { /** * (Updatable) If true, capture the client IP address from the RADIUS request packet. IP Address is used for auditing, policy-evaluation and country-code calculation. * * **Added In:** 2205120021 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean */ captureClientIp: boolean; /** * (Updatable) This is the IP address of the RADIUS Client like Oracle Database server. It can be only IP address and not hostname. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ clientIp: string; /** * (Updatable) Vendor-specific identifier of the attribute in the RADIUS response that will contain the end-user's country code. This is an integer-value in the range 1 to 255 * * **Added In:** 2205120021 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string */ countryCodeResponseAttributeId: string; /** * (Updatable) The name of the attribute that contains the Internet Protocol address of the end-user. * * **Added In:** 2205120021 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string */ endUserIpAttribute: string; /** * (Updatable) RADIUS attribute that RADIUS-enabled system uses to pass the group membership * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string */ groupMembershipRadiusAttribute: string; /** * (Updatable) In a successful authentication response, Oracle Identity Cloud Service will pass user's group information restricted to groups persisted in this attribute, in the specified RADIUS attribute. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: complex * * uniqueness: none */ groupMembershipToReturns: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionradiusAppAppGroupMembershipToReturn[]; /** * (Updatable) Configure the groupNameFormat based on vendor in order to pass it to RADIUS infra * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string */ groupNameFormat: string; /** * (Updatable) Indicates to include groups in RADIUS response * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean */ includeGroupInResponse: boolean; /** * (Updatable) Indicates if password and OTP are passed in the same sign-in request or not. * * **Added In:** 2205120021 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean */ passwordAndOtpTogether: boolean; /** * (Updatable) This is the port of RADIUS Proxy which RADIUS client will connect to. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ port: string; /** * (Updatable) ID used to identify a particular vendor. * * **Added In:** 2205120021 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string */ radiusVendorSpecificId: string; /** * (Updatable) Configure the responseFormat based on vendor in order to pass it to RADIUS infra * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string */ responseFormat: string; /** * (Updatable) The delimiter used if group membership responseFormat is a delimited list instead of repeating attributes * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string */ responseFormatDelimiter: string; /** * (Updatable) Secret key used to secure communication between RADIUS Proxy and RADIUS client * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ secretKey: string; /** * (Updatable) Value consists of type of RADIUS App. Type can be Oracle Database, VPN etc * * **Added In:** 2205120021 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string */ typeOfRadiusApp: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionradiusAppAppGroupMembershipToReturn { /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The URI of the corresponding Group resource to which the user belongs * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The identifier of the User's group. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionrequestableApp { /** * (Updatable) Flag controlling whether resource can be request by user through self service console. * * **Added In:** 17.3.4 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: boolean * * uniqueness: none */ requestable: boolean; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderApp { /** * (Updatable) The attribute represents the URL to which the SAML Assertions will be sent by the SAML IdP. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ assertionConsumerUrl: string; /** * (Updatable) If true, indicates that the system must encrypt the Security Assertion Markup Language (SAML) assertion. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ encryptAssertion: boolean; /** * (Updatable) This attribute indicates the encryption algorithm used to encrypt the SAML assertion. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ encryptionAlgorithm: string; /** * (Updatable) This attribute represents the encryption certificate that an App uses to encrypt the Security Assertion Markup Language (SAML) assertion. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ encryptionCertificate: string; /** * (Updatable) Specifies the preferred federation protocol (SAML2.0 or WS-Fed1.1). * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsDefaultValue: SAML2.0 * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ federationProtocol: string; /** * (Updatable) Each value of this attribute describes an attribute of Group that will be sent in a Security Assertion Markup Language (SAML) assertion. * * **Deprecated Since: 18.2.2** * * **SCIM++ Properties:** * * caseExact: false * * idcsCompositeKey: [name] * * idcsSearchable: false * * idcsValuePersistedInOtherAttribute: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ groupAssertionAttributes: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppGroupAssertionAttribute[]; /** * (Updatable) Hok Assertion Consumer Service Url * * **Added In:** 2101262133 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ hokAcsUrl: string; /** * (Updatable) If enabled, then the SAML Service supports Hok for this App. * * **Added In:** 2101262133 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ hokRequired: boolean; /** * (Updatable) If true, then the signing certificate is included in the signature. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ includeSigningCertInSignature: boolean; /** * (Updatable) This attribute indicates the key encryption algorithm. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ keyEncryptionAlgorithm: string; /** * (Updatable) Records the notification timestamp for the SP whose signing certificate is about to expire. * * **Added In:** 2302092332 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastNotificationSentTime: string; /** * (Updatable) This attribute represents the HTTP binding that would be used while logout. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ logoutBinding: string; /** * (Updatable) If true, then the SAML Service supports logout for this App. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ logoutEnabled: boolean; /** * (Updatable) The URL to which the partner sends the logout request. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ logoutRequestUrl: string; /** * (Updatable) The URL to which the partner sends the logout response. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ logoutResponseUrl: string; /** * (Updatable) This attribute represents the metadata of a Security Provider in the Security Assertion Markup Language protocol. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ metadata: string; /** * (Updatable) This can be any string, but there are a set of standard nameIdFormats. If a nameIdFormat other than the standard list is chosen, it will be considered a custom nameidformat. The standard nameidformats include: saml-x509, saml-emailaddress, saml-windowsnamequalifier, saml-kerberos, saml-persistent, saml-transient, saml-unspecified, saml-none, and saml-persistent-opaque. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ nameIdFormat: string; /** * (Updatable) **Deprecated Since: 18.2.2** * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * idcsValuePersistedInOtherAttribute: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none This property specifies which user attribute is used as the NameID value in the SAML assertion. This attribute can be constructed by using attributes from the Oracle Identity Cloud Service Core Users schema. */ nameIdUserstoreAttribute: string; /** * (Updatable) Use to construct the outgoing SAML attributes * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: complex * * uniqueness: none */ outboundAssertionAttributes: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppOutboundAssertionAttribute[]; /** * (Updatable) The ID of the Provider. This value corresponds to the entityID from the Service Provider metadata. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ partnerProviderId: string; /** * (Updatable) The pattern of the Provider. This value corresponds to the entityID from the Service Provider metadata. * * **Added In:** 2202230830 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ partnerProviderPattern: string; /** * (Updatable) Indicates which part of the response should be signed. A value of \"Assertion\" indicates that the Assertion should be signed. A value of \"Response\" indicates that the SSO Response should be signed. A value of \"AssertionAndResponse\" indicates that both the Assertion and the SSO Response should be signed. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ signResponseOrAssertion: string; /** * (Updatable) This attribute represents the algorithm used to hash the signature. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ signatureHashAlgorithm: string; /** * (Updatable) This attribute represents the signing certificate that an App uses to verify the signed authentication request. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ signingCertificate: string; /** * (Updatable) This attribute represents the Succinct ID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: server */ succinctId: string; /** * (Updatable) The alternate Provider ID to be used as the Oracle Identity Cloud Service providerID (instead of the one in SamlSettings) when interacting with this SP. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ tenantProviderId: string; /** * (Updatable) Each value of this attribute describes an attribute of User that will be sent in a Security Assertion Markup Language (SAML) assertion. * * **Deprecated Since: 18.2.2** * * **SCIM++ Properties:** * * caseExact: false * * idcsCompositeKey: [name] * * idcsSearchable: false * * idcsValuePersistedInOtherAttribute: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ userAssertionAttributes: outputs.Identity.DomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppUserAssertionAttribute[]; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppGroupAssertionAttribute { /** * (Updatable) Indicates the filter types that are supported for the Group assertion attributes. * * **Deprecated Since: 18.2.2** * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * idcsValuePersistedInOtherAttribute: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ condition: string; /** * (Updatable) Indicates the format of the assertion attribute. * * **Deprecated Since: 18.2.2** * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * idcsValuePersistedInOtherAttribute: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ format: string; /** * (Updatable) Indicates the group name that are supported for the group assertion attributes. * * **Deprecated Since: 18.2.2** * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * idcsValuePersistedInOtherAttribute: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ groupName: string; /** * (Updatable) The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion * * **Deprecated Since: 18.2.2** * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * idcsValuePersistedInOtherAttribute: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppOutboundAssertionAttribute { /** * (Updatable) Mapped Attribute Direction * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ direction: string; /** * (Updatable) Mapped Attribute URI * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Mapped Attribute identifier * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppUserAssertionAttribute { /** * (Updatable) Indicates the format of the assertion attribute. * * **Deprecated Since: 18.2.2** * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * idcsValuePersistedInOtherAttribute: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ format: string; /** * (Updatable) The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion * * **Deprecated Since: 18.2.2** * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * idcsValuePersistedInOtherAttribute: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) This attribute specifies which user attribute should be used to create the value of the SAML assertion attribute. The userstore attribute can be constructed by using attributes from the Oracle Identity Cloud Service Core Users schema.
Note: Attributes from extensions to the Core User schema are not supported in v1.0. * * **Deprecated Since: 18.2.2** * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * idcsValuePersistedInOtherAttribute: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ userStoreAttributeName: string; } interface DomainsAppUrnietfparamsscimschemasoracleidcsextensionwebTierPolicyApp { /** * (Updatable) If this Attribute is true, resource ref id and resource ref name attributes will we included in wtp json response. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ resourceRef: boolean; /** * (Updatable) Webtier policy AZ Control * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ webTierPolicyAzControl: string; /** * (Updatable) Store the web tier policy for an application as a string in Javascript Object Notification (JSON) format. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ webTierPolicyJson: string; } interface DomainsAppUserRole { /** * (Updatable) The description of the AppRole. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ description: string; /** * (Updatable) Display-name of the AppRole. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) URI of the AppRole. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) ID of the AppRole. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsApprovalWorkflowApprovalWorkflowStep { /** * (Updatable) The unique Oracle Cloud Infrastructure identifier of the ApprovalWorkflowStep. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The order of the ApprovalWorkflowSteps. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: integer * * uniqueness: none */ order: number; /** * (Updatable) ApprovalWorkflowSteps URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of the ApprovalWorkflowSteps. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The unique identifier of the ApprovalWorkflowStep. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowAssignmentApprovalWorkflow { /** * (Updatable) Display name of the approval workflow * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; /** * Unique Oracle Cloud Infrastructure Identifier of the approval workflow * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) URI of the approval workflow * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: reference * * uniqueness: none */ ref: string; /** * Indicates type of the entity that is associated with this assignment (for ARM validation) * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * idcsDefaultValue: ApprovalWorkflow * * multiValued: false * * mutability: readWrite * * required: true * * returned: request * * type: string * * uniqueness: none */ type: string; /** * Identifier of the approval workflow * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowAssignmentAssignedTo { /** * (Updatable) Description * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ description: string; /** * (Updatable) Display name of the resource for which Approval Workflow is assigned * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; /** * Ocid of the resource for which Approval Workflow is assigned * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * Type of the resource (stripe and non-stripe) for which Approval Workflow is assigned * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ type: string; /** * Identifier of the resource for which Approval Workflow is assigned * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowAssignmentIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowAssignmentIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowAssignmentMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsApprovalWorkflowAssignmentTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowMaxDuration { /** * (Updatable) The unit of the max duration. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * idcsDefaultValue: DAY * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ unit: string; /** * (Updatable) The value of the max duration. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * idcsMaxValue: 1488 * * idcsMinValue: 1 * * idcsDefaultValue: 14 * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ value: number; } interface DomainsApprovalWorkflowMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsApprovalWorkflowStepApprover { /** * (Updatable) The display of the approver. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The unique Oracle Cloud Infrastructure identifier of the approver. * * **SCIM++ Properties:** * * idcsSearchable: true * * caseExact: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) Approver URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of the approver. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: reference * * uniqueness: none */ type: string; /** * The unique identifier of the approver. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowStepIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowStepIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowStepMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsApprovalWorkflowStepTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsApprovalWorkflowTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAuthTokenIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAuthTokenIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAuthTokenMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsAuthTokenTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAuthTokenUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). * * **Added In:** 2205182039 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: writeOnly * * required: false * * returned: never * * type: boolean * * uniqueness: none */ allowSelfChange: boolean; } interface DomainsAuthTokenUser { /** * (Updatable) The user's display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The username. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * The user's OCID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The user's ID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsAuthenticationFactorSettingBypassCodeSettings { /** * (Updatable) Expiry (in minutes) of any bypass code that is generated by the help desk * * **SCIM++ Properties:** * * idcsMaxValue: 9999999 * * idcsMinValue: 1 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ helpDeskCodeExpiryInMins: number; /** * (Updatable) If true, indicates that help desk bypass code generation is enabled * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ helpDeskGenerationEnabled: boolean; /** * (Updatable) The maximum number of times that any bypass code that is generated by the help desk can be used * * **SCIM++ Properties:** * * idcsMaxValue: 999 * * idcsMinValue: 1 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ helpDeskMaxUsage: number; /** * (Updatable) Exact length of the bypass code to be generated * * **SCIM++ Properties:** * * idcsMaxValue: 20 * * idcsMinValue: 8 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ length: number; /** * (Updatable) The maximum number of bypass codes that can be issued to any user * * **SCIM++ Properties:** * * idcsMaxValue: 6 * * idcsMinValue: 1 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ maxActive: number; /** * (Updatable) If true, indicates that self-service bypass code generation is enabled * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ selfServiceGenerationEnabled: boolean; } interface DomainsAuthenticationFactorSettingClientAppSettings { /** * (Updatable) Indicates what protection policy that the system applies on a device. By default, the value is NONE, which indicates that the system applies no protection policy. A value of APP_PIN indicates that the system requires a Personal Identification Number (PIN). A value of DEVICE_BIOMETRIC_OR_APP_PIN indicates that either a PIN or a biometric authentication factor is required. * * **SCIM++ Properties:** * * idcsCanonicalValueSourceFilter: attrName eq "deviceProtectionPolicy" and attrValues.value eq "$(deviceProtectionPolicy)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ deviceProtectionPolicy: string; /** * (Updatable) The period of time in seconds that the system will lock a user out of the service after that user exceeds the maximum number of login failures * * **SCIM++ Properties:** * * idcsMaxValue: 86400 * * idcsMinValue: 30 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ initialLockoutPeriodInSecs: number; /** * (Updatable) The size of the key that the system uses to generate the public-private key pair * * **SCIM++ Properties:** * * idcsMaxValue: 4000 * * idcsMinValue: 32 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ keyPairLength: number; /** * (Updatable) The pattern of escalation that the system follows, in locking a particular user out of the service. * * **SCIM++ Properties:** * * idcsCanonicalValueSourceFilter: attrName eq "lockoutEscalationPattern" and attrValues.value eq "$(lockoutEscalationPattern)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ lockoutEscalationPattern: string; /** * (Updatable) The maximum number of times that a particular user can fail to login before the system locks that user out of the service * * **SCIM++ Properties:** * * idcsMaxValue: 10 * * idcsMinValue: 5 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ maxFailuresBeforeLockout: number; /** * (Updatable) The maximum number of login failures that the system will allow before raising a warning and sending an alert via email * * **SCIM++ Properties:** * * idcsMaxValue: 10 * * idcsMinValue: 0 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ maxFailuresBeforeWarning: number; /** * (Updatable) The maximum period of time that the system will lock a particular user out of the service regardless of what the configured pattern of escalation would otherwise dictate * * **SCIM++ Properties:** * * idcsMaxValue: 86400 * * idcsMinValue: 30 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ maxLockoutIntervalInSecs: number; /** * (Updatable) Minimum length of the Personal Identification Number (PIN) * * **SCIM++ Properties:** * * idcsMaxValue: 10 * * idcsMinValue: 6 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ minPinLength: number; /** * (Updatable) The period of time in days after which a client should refresh its policy by re-reading that policy from the server * * **SCIM++ Properties:** * * idcsMaxValue: 999 * * idcsMinValue: 1 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ policyUpdateFreqInDays: number; /** * (Updatable) Indicates which algorithm the system will use to sign requests * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ requestSigningAlgo: string; /** * (Updatable) Indicates the type of encoding that the system should use to generate a shared secret * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ sharedSecretEncoding: string; /** * (Updatable) If true, indicates that the system should require the user to unlock the client app for each request. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ unlockAppForEachRequestEnabled: boolean; /** * (Updatable) Specifies the period of time in seconds after which the client App should require the user to unlock the App. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. A value of zero means that it is disabled. * * **SCIM++ Properties:** * * idcsMaxValue: 9999999 * * idcsMinValue: 0 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ unlockAppIntervalInSecs: number; /** * (Updatable) If true, indicates that the system should require the user to unlock the client App, when the client App comes to the foreground in the display of the device. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ unlockOnAppForegroundEnabled: boolean; /** * (Updatable) If true, indicates that the system should require the user to unlock the client App whenever the App is started. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ unlockOnAppStartEnabled: boolean; } interface DomainsAuthenticationFactorSettingCompliancePolicy { /** * (Updatable) The action to be taken if the value of the attribute is not as expected * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ action: string; /** * (Updatable) The name of the attribute being evaluated * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) The value of the attribute to be evaluated * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAuthenticationFactorSettingEmailSettings { /** * (Updatable) Custom redirect Url which will be used in email link * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ emailLinkCustomUrl: string; /** * (Updatable) Specifies whether Email link is enabled or not. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ emailLinkEnabled: boolean; } interface DomainsAuthenticationFactorSettingEndpointRestrictions { /** * (Updatable) Maximum number of days until an endpoint can be trusted * * **SCIM++ Properties:** * * idcsMaxValue: 180 * * idcsMinValue: 1 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ maxEndpointTrustDurationInDays: number; /** * (Updatable) Maximum number of enrolled devices per user * * **SCIM++ Properties:** * * idcsMaxValue: 20 * * idcsMinValue: 1 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ maxEnrolledDevices: number; /** * (Updatable) An integer that represents the maximum number of failed MFA logins before an account is locked * * **SCIM++ Properties:** * * idcsMaxValue: 20 * * idcsMinValue: 5 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ maxIncorrectAttempts: number; /** * (Updatable) Max number of trusted endpoints per user * * **SCIM++ Properties:** * * idcsMaxValue: 20 * * idcsMinValue: 1 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ maxTrustedEndpoints: number; /** * (Updatable) Specify if trusted endpoints are enabled * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ trustedEndpointsEnabled: boolean; } interface DomainsAuthenticationFactorSettingIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAuthenticationFactorSettingIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAuthenticationFactorSettingIdentityStoreSettings { /** * (Updatable) If true, indicates that Multi-Factor Authentication should use the mobile number in the identity store * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ mobileNumberEnabled: boolean; /** * (Updatable) If true, indicates that the user can update the mobile number in the user's Multi-Factor Authentication profile * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ mobileNumberUpdateEnabled: boolean; } interface DomainsAuthenticationFactorSettingMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsAuthenticationFactorSettingNotificationSettings { /** * (Updatable) If true, indicates that the Mobile App Pull Notification channel is enabled for authentication * * **Added In:** 17.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ pullEnabled: boolean; } interface DomainsAuthenticationFactorSettingTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsAuthenticationFactorSettingThirdPartyFactor { /** * (Updatable) To enable Duo Security factor * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ duoSecurity: boolean; } interface DomainsAuthenticationFactorSettingTotpSettings { /** * (Updatable) The period of time (in minutes) that a one-time passcode remains valid that the system sends by email. * * **Added In:** 18.1.2 * * **SCIM++ Properties:** * * idcsMaxValue: 60 * * idcsMinValue: 2 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ emailOtpValidityDurationInMins: number; /** * (Updatable) Exact length of the email one-time passcode. * * **Added In:** 18.1.2 * * **SCIM++ Properties:** * * idcsMaxValue: 10 * * idcsMinValue: 4 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ emailPasscodeLength: number; /** * (Updatable) The hashing algorithm to be used to calculate a One-Time Passcode. By default, the system uses SHA1. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ hashingAlgorithm: string; /** * (Updatable) The period of time (in seconds) that a JSON Web Token (JWT) is valid * * **SCIM++ Properties:** * * idcsMaxValue: 99999 * * idcsMinValue: 30 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ jwtValidityDurationInSecs: number; /** * (Updatable) The duration of time (in days) after which the shared secret has to be refreshed * * **SCIM++ Properties:** * * idcsMaxValue: 999 * * idcsMinValue: 30 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ keyRefreshIntervalInDays: number; /** * (Updatable) Exact length of the One-Time Passcode that the system should generate * * **SCIM++ Properties:** * * idcsMaxValue: 10 * * idcsMinValue: 4 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ passcodeLength: number; /** * (Updatable) The period of time (in minutes) for which a One-Time Passcode that the system sends by Short Message Service (SMS) or by voice remains valid * * **SCIM++ Properties:** * * idcsMaxValue: 60 * * idcsMinValue: 2 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ smsOtpValidityDurationInMins: number; /** * (Updatable) Exact length of the Short Message Service (SMS) One-Time Passcode * * **SCIM++ Properties:** * * idcsMaxValue: 10 * * idcsMinValue: 4 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ smsPasscodeLength: number; /** * (Updatable) Time (in secs) to be used as the time step * * **SCIM++ Properties:** * * idcsMaxValue: 300 * * idcsMinValue: 30 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ timeStepInSecs: number; /** * (Updatable) The tolerance/step-size that the system should use when validating a One-Time Passcode * * **SCIM++ Properties:** * * idcsMaxValue: 3 * * idcsMinValue: 2 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ timeStepTolerance: number; } interface DomainsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionfidoAuthenticationFactorSettings { /** * (Updatable) Attribute used to define the type of attestation required. * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ attestation: string; /** * (Updatable) Attribute used to define authenticator selection attachment. * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ authenticatorSelectionAttachment: string; /** * (Updatable) Flag used to indicate authenticator selection is required or not * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ authenticatorSelectionRequireResidentKey: boolean; /** * (Updatable) Attribute used to define authenticator selection resident key requirement. * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ authenticatorSelectionResidentKey: string; /** * (Updatable) Attribute used to define authenticator selection verification. * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ authenticatorSelectionUserVerification: string; /** * (Updatable) Number of domain levels Oracle Identity Cloud Service should use for origin comparision * * **Added In:** 2109020413 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * idcsMaxValue: 2 * * idcsMinValue: 0 * * required: false * * returned: default * * type: integer * * uniqueness: none */ domainValidationLevel: number; /** * (Updatable) Flag used to indicate whether we need to restrict creation of multiple credentials in same authenticator * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ excludeCredentials: boolean; /** * (Updatable) List of server supported public key algorithms * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ publicKeyTypes: string[]; /** * (Updatable) Timeout for the fido authentication to complete * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * idcsMaxValue: 600000 * * idcsMinValue: 10000 * * required: true * * returned: default * * type: integer * * uniqueness: none */ timeout: number; } interface DomainsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSettings { /** * (Updatable) Settings related to Duo Security * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ duoSecuritySettings: outputs.Identity.DomainsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSettingsDuoSecuritySettings; } interface DomainsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSettingsDuoSecuritySettings { /** * (Updatable) Hostname to access the Duo security account * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ apiHostname: string; /** * (Updatable) Attestation key to attest the request and response between Duo Security * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: never * * type: string * * uniqueness: none */ attestationKey: string; /** * (Updatable) Integration key from Duo Security authenticator * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ integrationKey: string; /** * (Updatable) Secret key from Duo Security authenticator * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ secretKey: string; /** * (Updatable) User attribute mapping value * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ userMappingAttribute: string; } interface DomainsCloudGateIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateMapping { /** * (Updatable) The ID of the App being mapped to * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ appId: string; /** * (Updatable) The id of the Cloud Gate Mapping * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ mappingId: string; /** * (Updatable) The name (Client ID) of the App being mapped to * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) More NGINX Settings. JSON encoded key value pairs similar to WTP encoding * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ nginxSettings: string; /** * (Updatable) The Web Tier policy name used for the App that is mapped to this Cloud Gate * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ policyName: string; /** * (Updatable) NGINX ProxyPass entry for this Mapping * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ proxyPass: string; /** * (Updatable) URI of the App being mapped to * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Resource prefix for this mapping. This will be used to define the location block * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ resourcePrefix: string; /** * (Updatable) Server Instance for the Mapping. This is one of the server IDs(server blocks) from the associated Cloud Gate list * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ serverId: string; /** * (Updatable) Upstream server group instance for the Mapping. This is one of the upstream server group IDs(upstream blocks) from the associated Cloud Gate list * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ upstreamServerGroupId: string; /** * (Updatable) The id of the App being mapped to * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateMappingCloudGate { /** * (Updatable) The URI of the OAuth app for this Cloud Gate. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The id of the owning Cloud Gate. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateMappingGatewayApp { /** * (Updatable) The name (Client ID) of the gateway application protected by this Cloud Gate. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) The URI to the gateway application protected by this Cloud Gate * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The id of the gateway application protected by this Cloud Gate. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateMappingIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateMappingIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateMappingMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsCloudGateMappingServer { /** * (Updatable) The URI to the server block entry * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The id of the server block entry. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateMappingTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateMappingUpstreamServerGroup { /** * (Updatable) The URI to the upstream block entry * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) SSL flag for the Upstream Block * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ ssl: boolean; /** * (Updatable) The id of the upstream block entry. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsCloudGateMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsCloudGateOauthClient { /** * (Updatable) The Client ID of the OAuth app for this CloudGate. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ clientId: string; /** * (Updatable) The URI of the OAuth app for this CloudGate. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The id of the OAuth app for this CloudGate. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateServer { /** * (Updatable) Hostname for the Server block * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ hostName: string; /** * (Updatable) More nginx Settings. JSON encoded text block * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ nginxSettings: string; /** * (Updatable) Port for the Server Block * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: integer * * uniqueness: none */ port: number; /** * (Updatable) Server Name for the Server Block * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ serverId: string; /** * (Updatable) SSL flag for the Server Block * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: boolean * * uniqueness: none */ ssl: boolean; } interface DomainsCloudGateServerCloudGate { /** * (Updatable) The URI of the owning Cloud Gate for this server block. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The id of the owning Cloud Gate. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateServerIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateServerIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateServerMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsCloudGateServerTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCloudGateUpstreamServer { /** * (Updatable) Display name of upstream server * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ displayName: string; /** * (Updatable) Upstream Server Group instance for the upstream server. This is one of the upstreamServerGroup IDs(upstream blocks) from the associated Cloud Gate list * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ groupId: string; /** * (Updatable) Any incoming request to cloud gate is finally sent to this host, if selected during load balancing * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ hostName: string; /** * (Updatable) Any additional settings for this upstream server in nginx configuration form * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ nginxSettings: string; /** * (Updatable) Port for the Upstream Server * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: integer * * uniqueness: none */ port: number; /** * (Updatable) URI of the upstream server * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) ID of the upstream server * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsCloudGateUpstreamServerGroup { /** * (Updatable) Display name of upstream * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ displayName: string; /** * (Updatable) Any additional settings in nginx configuration form * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ nginxSettings: string; /** * (Updatable) URI of the upstream server groups * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) SSL flag for the Upstream Block * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ ssl: boolean; /** * (Updatable) Name for the Upstream Block * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsConditionIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsConditionIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsConditionMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsConditionTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCustomerSecretKeyIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCustomerSecretKeyIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCustomerSecretKeyMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsCustomerSecretKeyTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsCustomerSecretKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). * * **Added In:** 2205182039 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: writeOnly * * required: false * * returned: never * * type: boolean * * uniqueness: none */ allowSelfChange: boolean; } interface DomainsCustomerSecretKeyUser { /** * (Updatable) The user's display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The user's name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * The user's OCID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The user's ID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsDynamicResourceGroupDynamicGroupAppRole { /** * (Updatable) If true, then the role provides administrative access privileges. READ-ONLY. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ adminRole: boolean; /** * (Updatable) ID of parent App. READ-ONLY. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ appId: string; /** * (Updatable) Name of parent App. READ-ONLY. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ appName: string; /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The name of the legacy group associated with this AppRole. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ legacyGroupName: string; /** * (Updatable) The URI of the corresponding appRole resource to which the user belongs * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The identifier of the appRole * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsDynamicResourceGroupGrant { /** * (Updatable) App identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsAddedSinceVersion: 3 * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ appId: string; /** * (Updatable) Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. * * **SCIM++ Properties:** * * caseExact: true * * idcsAddedSinceVersion: 3 * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ grantMechanism: string; /** * (Updatable) Grant URI * * **SCIM++ Properties:** * * idcsAddedSinceVersion: 3 * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Grant identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsAddedSinceVersion: 3 * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsDynamicResourceGroupIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsDynamicResourceGroupIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsDynamicResourceGroupMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsDynamicResourceGroupTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTags { /** * (Updatable) Oracle Cloud Infrastructure Defined Tags * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsCompositeKey: [namespace, key, value] * * type: complex * * idcsSearchable: true * * required: false * * mutability: readWrite * * multiValued: true * * returned: default */ definedTags: outputs.Identity.DomainsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagsDefinedTag[]; /** * (Updatable) Oracle Cloud Infrastructure Freeform Tags * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsCompositeKey: [key, value] * * idcsSearchable: true * * type: complex * * required: false * * mutability: readWrite * * returned: default * * multiValued: true */ freeformTags: outputs.Identity.DomainsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagsFreeformTag[]; /** * (Updatable) Oracle Cloud Infrastructure Tag slug * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * type: binary * * mutability: readOnly * * returned: request * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ tagSlug: string; } interface DomainsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagsDefinedTag { /** * (Updatable) Oracle Cloud Infrastructure Tag key * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ key: string; /** * (Updatable) Oracle Cloud Infrastructure Tag namespace * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ namespace: string; /** * (Updatable) Oracle Cloud Infrastructure Tag value * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * required: true * * idcsReturnEmptyWhenNull: true * * mutability: readWrite * * returned: default * * type: string * * idcsSearchable: true * * uniqueness: none */ value: string; } interface DomainsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagsFreeformTag { /** * (Updatable) Oracle Cloud Infrastructure Tag key * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ key: string; /** * (Updatable) Oracle Cloud Infrastructure Tag value * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * required: true * * idcsReturnEmptyWhenNull: true * * mutability: readWrite * * returned: default * * type: string * * idcsSearchable: true * * uniqueness: none */ value: string; } interface DomainsGrantApp { /** * (Updatable) Application display name * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; /** * (Updatable) Application URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * Application identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGrantAppEntitlementCollection { /** * (Updatable) Application Entitlement Collection URI * * **Added In:** 18.2.4 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * Application Entitlement Collection identifier * * **Added In:** 18.2.4 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGrantEntitlement { /** * The name of the attribute whose value (specified by attributeValue) confers privilege within the service-instance (specified by app). * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ attributeName: string; /** * The value of the attribute (specified by attributeName) that confers privilege within the service-instance (specified by app). If attributeName is 'appRoles', then attributeValue is the ID of the AppRole. * * **SCIM++ Properties:** * * caseExact: true * * idcsCsvAttributeName: Display Name * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ attributeValue: string; } interface DomainsGrantGrantee { /** * (Updatable) Grantee display name * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; /** * (Updatable) Grantee URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * Grantee resource type. Allowed values are User, Group, App and DynamicResourceGroup. * * **SCIM++ Properties:** * * caseExact: true * * idcsCsvAttributeName: Member Type * * idcsDefaultValue: User * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * Grantee identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsCsvAttributeName: Member * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGrantGrantor { /** * (Updatable) Grantor display name * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; /** * (Updatable) Grantor URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Resource type of the grantor. Allowed values are User and App. * * **SCIM++ Properties:** * * caseExact: true * * idcsDefaultValue: User * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) Grantor user identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGrantIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGrantIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGrantMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsGrantTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGroupIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGroupIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGroupMember { /** * (Updatable) The date and time that the member was added to the group. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readOnly * * returned: default * * type: dateTime * * uniqueness: none */ dateAdded: string; /** * (Updatable) The member's display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The membership OCID. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ membershipOcid: string; /** * (Updatable) The member's name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) The OCID of the member of this group. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the member Resource of this group. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Indicates the type of resource, for example, User or Group. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * idcsDefaultValue: User * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the member of this Group * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsGroupMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsGroupTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensionOciTags { /** * (Updatable) Oracle Cloud Infrastructure Defined Tags * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsCompositeKey: [namespace, key, value] * * type: complex * * idcsSearchable: true * * required: false * * mutability: readWrite * * multiValued: true * * returned: default */ definedTags: outputs.Identity.DomainsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagsDefinedTag[]; /** * (Updatable) Oracle Cloud Infrastructure Freeform Tags * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsCompositeKey: [key, value] * * idcsSearchable: true * * type: complex * * required: false * * mutability: readWrite * * returned: default * * multiValued: true */ freeformTags: outputs.Identity.DomainsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagsFreeformTag[]; /** * (Updatable) Oracle Cloud Infrastructure Tag slug * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * type: binary * * mutability: readOnly * * returned: request */ tagSlug: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagsDefinedTag { /** * (Updatable) Oracle Cloud Infrastructure Tag key * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ key: string; /** * (Updatable) Oracle Cloud Infrastructure Tag namespace * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ namespace: string; /** * (Updatable) Oracle Cloud Infrastructure Tag value * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * required: true * * idcsReturnEmptyWhenNull: true * * mutability: readWrite * * returned: default * * type: string * * idcsSearchable: true * * uniqueness: none */ value: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagsFreeformTag { /** * (Updatable) Oracle Cloud Infrastructure Tag key * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ key: string; /** * (Updatable) Oracle Cloud Infrastructure Tag value * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * required: true * * idcsReturnEmptyWhenNull: true * * mutability: readWrite * * returned: default * * type: string * * idcsSearchable: true * * uniqueness: none */ value: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroup { /** * (Updatable) DBCS Domain-level schema-name. This attribute refers implicitly to a value of 'domainLevelSchemaNames' for a particular DB Domain. * * **Added In:** 18.2.4 * * **SCIM++ Properties:** * * idcsSearchable: false * * idcsSensitive: none * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ domainLevelSchema: string; /** * (Updatable) DBCS Domain-level schema-names. Each value is specific to a DB Domain. * * **Added In:** 18.2.4 * * **SCIM++ Properties:** * * idcsCompositeKey: [domainName, schemaName] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex */ domainLevelSchemaNames: outputs.Identity.DomainsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupDomainLevelSchemaName[]; /** * (Updatable) DBCS instance-level schema-name. This attribute refers implicitly to a value of 'instanceLevelSchemaNames' for a particular DB Instance. * * **Added In:** 18.2.4 * * **SCIM++ Properties:** * * idcsSearchable: false * * idcsSensitive: none * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ instanceLevelSchema: string; /** * (Updatable) DBCS instance-level schema-names. Each schema-name is specific to a DB Instance. * * **Added In:** 18.2.4 * * **SCIM++ Properties:** * * idcsCompositeKey: [dbInstanceId, schemaName] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex */ instanceLevelSchemaNames: outputs.Identity.DomainsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupInstanceLevelSchemaName[]; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupDomainLevelSchemaName { /** * (Updatable) DBCS Domain Name * * **Added In:** 18.2.4 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ domainName: string; /** * (Updatable) The DBCS schema-name granted to this group in the DB domain that 'domainName' specifies. * * **Added In:** 18.2.4 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ schemaName: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupInstanceLevelSchemaName { /** * (Updatable) App Id of DBCS App instance * * **Added In:** 18.2.4 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ dbInstanceId: string; /** * (Updatable) The DBCS schema-name granted to this Group for the DB instance that 'dbInstanceId' specifies. * * **Added In:** 18.2.4 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ schemaName: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensiondynamicGroup { /** * (Updatable) Membership rule * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ membershipRule: string; /** * (Updatable) Membership type * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: always * * type: string * * uniqueness: none */ membershipType: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroup { /** * (Updatable) A list of appRoles that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated * * **SCIM++ Properties:** * * caseExact: false * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ appRoles: outputs.Identity.DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupAppRole[]; /** * (Updatable) Source from which this group got created. * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeNameMappings: [[defaultValue:import]] * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: request * * type: string * * uniqueness: none */ creationMechanism: string; /** * (Updatable) Group description * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: Description * * idcsCsvAttributeNameMappings: [[columnHeaderName:Description]] * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ description: string; /** * (Updatable) Grants assigned to group * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ grants: outputs.Identity.DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupGrant[]; /** * (Updatable) Group owners * * **SCIM++ Properties:** * * caseExact: false * * idcsCompositeKey: [value, type] * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: complex * * uniqueness: none */ owners: outputs.Identity.DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupOwner[]; /** * (Updatable) Password Policy associated with this Group. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ passwordPolicies: outputs.Identity.DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupPasswordPolicy[]; /** * (Updatable) The entity that created this Group. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ syncedFromApps: outputs.Identity.DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupSyncedFromApp[]; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupAppRole { /** * (Updatable) If true, then the role provides administrative access privileges. READ-ONLY. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ adminRole: boolean; /** * (Updatable) ID of parent App. READ-ONLY. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ appId: string; /** * (Updatable) Name of parent App. READ-ONLY. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ appName: string; /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The name of the legacy group associated with this AppRole. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ legacyGroupName: string; /** * (Updatable) The URI of the corresponding appRole resource to which the user belongs * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) A label indicating the attribute's function; e.g., 'direct' or 'indirect'. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The identifier of the appRole * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupGrant { /** * (Updatable) App identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ appId: string; /** * (Updatable) Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ grantMechanism: string; /** * (Updatable) Grant URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Grant identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupOwner { /** * (Updatable) Owner display name * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The URI that corresponds to the owning Resource of this Group * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Indicates the type of resource--for example, User or Group * * **SCIM++ Properties:** * * caseExact: true * * idcsDefaultValue: User * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) ID of the owner of this Group * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupPasswordPolicy { /** * (Updatable) PasswordPolicy Name * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) PasswordPolicy priority * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: integer * * uniqueness: none */ priority: number; /** * (Updatable) PasswordPolicy URI * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The ID of the PasswordPolicy. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupSyncedFromApp { /** * (Updatable) App Display Name * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * caseExact: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) App URI * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of the entity that created this Group. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * idcsDefaultValue: App * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the App. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensionposixGroup { /** * (Updatable) Integer uniquely identifying a group in a POSIX administrative domain * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: integer * * uniqueness: server */ gidNumber: number; } interface DomainsGroupUrnietfparamsscimschemasoracleidcsextensionrequestableGroup { /** * (Updatable) Flag controlling whether group membership can be request by user through self service console. * * **Added In:** 17.3.4 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * idcsCsvAttributeNameMappings: [[columnHeaderName:Requestable, mapsTo:requestable]] * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: boolean * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ requestable: boolean; } interface DomainsIdentityProofingProviderClaimMapping { /** * (Updatable) Matching attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ attrMatch: string; /** * (Updatable) Verifiable Claims. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ verifiableClaim: string; } interface DomainsIdentityProofingProviderConfiguration { /** * (Updatable) Name of the configuration supported. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) Value of the configuration supported. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * idcsSensitive: encrypt * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProofingProviderIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProofingProviderIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProofingProviderIdcsLockedBy { /** * (Updatable) The URI of the SCIM resource that represents the User or App who Locked this Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ _ref: string; /** * (Updatable) The displayName of the User or App who locked this Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who LOCKED this Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The type of resource, User or App, that locked this Resource. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who LOCKED this Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProofingProviderMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsIdentityProofingProviderRuntimeData { /** * (Updatable) Name of the attribute. * * **Added In:** 2505161800 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ attrName: string; /** * (Updatable) Value of the attribute. * * **Added In:** 2505161800 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ attrValue: string; } interface DomainsIdentityProofingProviderTemplateConfiguration { /** * (Updatable) Name of the Identity Proofing Provider configuration. * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ name: string; /** * (Updatable) Sensitivity of the Identity Proofing configuration. * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean */ sensitivity: boolean; /** * (Updatable) Type of the Identity Proofing configuration. * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ type: string; } interface DomainsIdentityProofingProviderTemplateIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProofingProviderTemplateIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProofingProviderTemplateIdcsLockedBy { /** * (Updatable) The URI of the SCIM resource that represents the User or App who Locked this Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ _ref: string; /** * (Updatable) The displayName of the User or App who locked this Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who LOCKED this Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The type of resource, User or App, that locked this Resource. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who LOCKED this Resource. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProofingProviderTemplateMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsIdentityPropagationTrustCaCertChain { /** * (Updatable) A list of PEM-encoded intermediate CA certificates. * * **Added In:** 2508041610 * * **SCIM++ Properties:** * * caseExact: true * * type: string * * multiValued: true * * required: false * * mutability: readWrite * * returned: default * * uniqueness: none */ intermediateCas: string[]; /** * (Updatable) A list of PEM-encoded root CA certificates. * * **Added In:** 2508041610 * * **SCIM++ Properties:** * * caseExact: true * * type: string * * multiValued: true * * required: true * * mutability: readWrite * * returned: default * * uniqueness: none */ rootCas: string[]; } interface DomainsIdentityPropagationTrustClaimValidation { /** * Claim Name * * **Added In:** 2509172316 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) Claim Value * * **Added In:** 2509172316 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityPropagationTrustIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityPropagationTrustIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityPropagationTrustImpersonationServiceUser { /** * (Updatable) The OCID of the Service User. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The rule expression to be used for matching the inbound token for impersonation. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ rule: string; /** * (Updatable) The ID of the Service User. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityPropagationTrustKeytab { /** * (Updatable) The OCID of the secret. The secret content corresponding to the OCID is expected to be in Base64 encoded content type. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ secretOcid: string; /** * (Updatable) The version of the secret. When the version is not specified, then the latest secret version is used during runtime. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ secretVersion: number; } interface DomainsIdentityPropagationTrustMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsIdentityPropagationTrustTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProviderCorrelationPolicy { /** * (Updatable) Policy display name * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) Policy URI * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) A label that indicates the type that this references. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsDefaultValue: Policy * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) Policy identifier * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProviderIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProviderIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProviderJitUserProvAssignedGroup { /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) Group URI * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Group identifier * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProviderJitUserProvAttributes { /** * (Updatable) Mapped Attribute URI * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * mutability: immutable * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Mapped Attribute identifier * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProviderJitUserProvGroupMapping { /** * (Updatable) IDP Group Name * * **Added In:** 2205120021 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * type: string */ idpGroup: string; /** * (Updatable) Group URI * * **Added In:** 2205120021 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: reference */ ref: string; /** * (Updatable) Domain Group * * **Added In:** 2205120021 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * idcsSearchable: true * * type: string */ value: string; } interface DomainsIdentityProviderMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsIdentityProviderTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProviderUrnietfparamsscimschemasoracleidcsextensionsocialIdentityProvider { /** * (Updatable) Social IDP Access token URL * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ accessTokenUrl: string; /** * (Updatable) Whether account linking is enabled * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ accountLinkingEnabled: boolean; /** * (Updatable) Admin scope to request * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ adminScopes: string[]; /** * (Updatable) Apple Developer ID * * **Added In:** 2311180004 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ appleDevId: string; /** * (Updatable) Apple Private Key ID * * **Added In:** 2311180004 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ appleKeyId: string; /** * (Updatable) Social IDP Authorization URL * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ authzUrl: string; /** * (Updatable) Whether social auto redirect is enabled. The IDP policy should be configured with only one Social IDP, and without username/password selected. * * **Added In:** 2310202314 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ autoRedirectEnabled: boolean; /** * (Updatable) Whether the client credential is contained in payload * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ clientCredentialInPayload: boolean; /** * (Updatable) Social IDP allowed clock skew time * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ clockSkewInSeconds: number; /** * (Updatable) Social IDP Client Application Client ID * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ consumerKey: string; /** * (Updatable) Social IDP Client Application Client Secret * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * idcsSensitive: encrypt * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ consumerSecret: string; /** * (Updatable) Discovery URL * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ discoveryUrl: string; /** * (Updatable) Id attribute used for account linking * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: string * * uniqueness: none */ idAttribute: string; /** * (Updatable) Lists the groups each social JIT-provisioned user is a member. Just-in-Time user-provisioning applies this static list when jitProvGroupStaticListEnabled:true. * * **Added In:** 2310202314 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ jitProvAssignedGroups: outputs.Identity.DomainsIdentityProviderUrnietfparamsscimschemasoracleidcsextensionsocialIdentityProviderJitProvAssignedGroup[]; /** * (Updatable) Set to true to indicate Social JIT User Provisioning Groups should be assigned from a static list * * **Added In:** 2310202314 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ jitProvGroupStaticListEnabled: boolean; /** * (Updatable) Social IDP User profile URL * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ profileUrl: string; /** * (Updatable) redirect URL for social idp * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ redirectUrl: string; /** * (Updatable) Whether registration is enabled * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ registrationEnabled: boolean; /** * (Updatable) Scope to request * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ scopes: string[]; /** * (Updatable) Service Provider Name * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ serviceProviderName: string; /** * (Updatable) Whether Social JIT Provisioning is enabled * * **Added In:** 2307282043 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ socialJitProvisioningEnabled: boolean; /** * (Updatable) Status * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ status: string; } interface DomainsIdentityProviderUrnietfparamsscimschemasoracleidcsextensionsocialIdentityProviderJitProvAssignedGroup { /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **Added In:** 2310202314 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; /** * Group URI */ ref: string; /** * (Updatable) Group identifier * * **Added In:** 2310202314 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentityProviderUrnietfparamsscimschemasoracleidcsextensionx509identityProvider { /** * (Updatable) X509 Certificate Matching Attribute * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ certMatchAttribute: string; /** * (Updatable) Fallback on CRL Validation if OCSP fails. * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ crlCheckOnOcspFailureEnabled: boolean; /** * (Updatable) Set to true to enable CRL Validation * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ crlEnabled: boolean; /** * (Updatable) CRL Location URL * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ crlLocation: string; /** * (Updatable) Fetch the CRL contents every X minutes * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ crlReloadDuration: number; /** * (Updatable) Set to true to enable EKU Validation * * **Added In:** 2304270343 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ ekuValidationEnabled: boolean; /** * (Updatable) List of EKU which needs to be validated * * **Added In:** 2304270343 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ekuValues: string[]; /** * (Updatable) Allow access if OCSP response is UNKNOWN or OCSP Responder does not respond within the timeout duration * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ ocspAllowUnknownResponseStatus: boolean; /** * (Updatable) Describes if the OCSP response is signed * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ ocspEnableSignedResponse: boolean; /** * (Updatable) Set to true to enable OCSP Validation * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ ocspEnabled: boolean; /** * (Updatable) This property specifies OCSP Responder URL. * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ocspResponderUrl: string; /** * (Updatable) Revalidate OCSP status for user after X hours * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * idcsMaxValue: 24 * * idcsMinValue: 0 * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ ocspRevalidateTime: number; /** * (Updatable) This property specifies the OCSP Server alias name * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ocspServerName: string; /** * (Updatable) OCSP Trusted Certificate Chain * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ocspTrustCertChains: string[]; /** * (Updatable) Check for specific conditions of other certificate attributes * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ otherCertMatchAttribute: string; /** * (Updatable) Certificate alias list to create a chain for the incoming client certificate * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ signingCertificateChains: string[]; /** * (Updatable) This property specifies the userstore attribute value that must match the incoming certificate attribute. * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ userMatchAttribute: string; } interface DomainsIdentitySettingIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentitySettingIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentitySettingMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsIdentitySettingMyProfile { /** * (Updatable) Whether to allow users to change their own password. * * **Added In:** 2207040824 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ allowEndUsersToChangeTheirPassword: boolean; /** * (Updatable) Whether to allow users to link or unlink their support accounts. * * **Added In:** 2207040824 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ allowEndUsersToLinkTheirSupportAccount: boolean; /** * (Updatable) Whether to allow users to update their capabilities. * * **Added In:** 2207040824 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ allowEndUsersToManageTheirCapabilities: boolean; /** * (Updatable) Whether to allow users to update their security settings. * * **Added In:** 2207040824 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ allowEndUsersToUpdateTheirSecuritySettings: boolean; } interface DomainsIdentitySettingPosixGid { /** * (Updatable) The number at which the Posix Gid Manual assignment ends. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ manualAssignmentEndsAt: number; /** * (Updatable) The number from which the Posix Gid Manual assignment starts. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ manualAssignmentStartsFrom: number; } interface DomainsIdentitySettingPosixUid { /** * (Updatable) The number at which the Posix Uid Manual assignment ends. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ manualAssignmentEndsAt: number; /** * (Updatable) The number from which the Posix Uid Manual assignment starts. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ manualAssignmentStartsFrom: number; } interface DomainsIdentitySettingTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsIdentitySettingToken { /** * (Updatable) Indicates the number of minutes after which the token expires automatically. * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ expiresAfter: number; /** * (Updatable) The token type. * * **SCIM++ Properties:** * * caseExact: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; } interface DomainsKmsiSettingIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsKmsiSettingIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsKmsiSettingMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsKmsiSettingTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMappedAttributeAttributeMapping { /** * (Updatable) If specified, indicates a subset of mappedActions to which this attribute-mapping applies.If not specified, this attribute-mapping applies to all mappedActions that use mappedAttributes * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ appliesToActions: string[]; /** * (Updatable) The name or expression of an attribute that corresponds to the Oracle Identity Cloud Service Resource referred in the \"idcsResourceType\" attribute. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ idcsAttributeName: string; /** * (Updatable) The name or expression of an attribute defined in the schema of the Managed Object Class. This is the SCIM compliant Oracle Identity Cloud Service Name of the attribute that maps to the \"idcsName\" attribute in the schema of an Managed Object Class. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ managedObjectAttributeName: string; /** * (Updatable) If true, indicates that this attribute must have a value. This attribute maps to the \"required\" sub-attribute in the schema of an Managed Object Class. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ required: boolean; /** * (Updatable) Indicates the format of the assertion attribute. Also stores AttributeNamespace for WSFed1.1. * * **Added In:** 17.4.2 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ samlFormat: string; } interface DomainsMappedAttributeIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMappedAttributeIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMappedAttributeMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsMappedAttributeTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyApiKeyIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyApiKeyIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyApiKeyMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsMyApiKeyTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyApiKeyUser { /** * (Updatable) The user's display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The username. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * The user's OCID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The user's ID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsMyAuthTokenIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyAuthTokenIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyAuthTokenMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsMyAuthTokenTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyAuthTokenUser { /** * (Updatable) The user's display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The username. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * The user's OCID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The user's ID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsMyCustomerSecretKeyIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyCustomerSecretKeyIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyCustomerSecretKeyMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsMyCustomerSecretKeyTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyCustomerSecretKeyUser { /** * (Updatable) The user's display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The user's name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * The user's OCID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The user's ID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsMyOauth2clientCredentialIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyOauth2clientCredentialIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyOauth2clientCredentialMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsMyOauth2clientCredentialScope { /** * Audience * * **SCIM++ Properties:** * * caseExact: false * * type: string * * mutability: readWrite * * required: true * * returned: default */ audience: string; /** * Scope * * **SCIM++ Properties:** * * caseExact: false * * idcsScimCompliant: false * * type: string * * mutability: readWrite * * multiValued: false * * required: true * * returned: default */ scope: string; } interface DomainsMyOauth2clientCredentialTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyOauth2clientCredentialUser { /** * (Updatable) The user's display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The username. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * The user's OCID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The user's ID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsMyRequestApprovalDetail { /** * (Updatable) Approval Type (Escalation or Regular) * * **Added In:** 2307071836 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * returned: default * * type: string * * uniqueness: none * * mutability: readOnly */ approvalType: string; /** * (Updatable) Approver display name * * **Added In:** 2307071836 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * returned: default * * type: string * * uniqueness: none * * mutability: readOnly */ approverDisplayName: string; /** * (Updatable) Approver Id * * **Added In:** 2307071836 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * returned: default * * type: string * * uniqueness: none * * mutability: readOnly */ approverId: string; /** * (Updatable) Approval Justification * * **Added In:** 2307071836 * * **SCIM++ Properties:** * * multiValued: false * * idcsSearchable: false * * returned: default * * type: string * * uniqueness: none * * mutability: readOnly */ justification: string; /** * (Updatable) Approval Order * * **Added In:** 2307071836 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * returned: default * * type: integer * * uniqueness: none * * mutability: readOnly */ order: number; /** * (Updatable) Approval Status * * **Added In:** 2307071836 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * returned: default * * type: string * * uniqueness: none * * mutability: readOnly */ status: string; /** * (Updatable) Approval Update Time * * **Added In:** 2307071836 * * **SCIM++ Properties:** * * multiValued: false * * idcsSearchable: false * * returned: default * * type: dateTime * * uniqueness: none * * mutability: readOnly */ timeUpdated: string; } interface DomainsMyRequestIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyRequestIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyRequestMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsMyRequestRequesting { /** * Resource description * * **Added In:** 2307071836 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ description: string; /** * Resource display name * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) Resource URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * Requestable type. Allowed values are Group and App. * * **SCIM++ Properties:** * * caseExact: true * * idcsCsvAttributeName: Requestable Type * * idcsDefaultValue: Group * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * Resource identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsCsvAttributeName: requestingId * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyRequestRequestor { /** * User display name * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) User URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * User identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsCsvAttributeName: requestorId * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyRequestTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMySmtpCredentialIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMySmtpCredentialIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMySmtpCredentialMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsMySmtpCredentialTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMySmtpCredentialUser { /** * (Updatable) User display name * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) User name * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * User's ocid * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * User's id * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsMySupportAccountIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMySupportAccountIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMySupportAccountMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsMySupportAccountTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMySupportAccountUser { /** * (Updatable) User display name * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) User name * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * User's ocid * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this Support Account * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * User's id * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsMyUserDbCredentialIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyUserDbCredentialIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyUserDbCredentialMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsMyUserDbCredentialTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsMyUserDbCredentialUser { /** * (Updatable) The user display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The username. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * The user's OCID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The user's identifier. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: always * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsNetworkPerimeterIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsNetworkPerimeterIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsNetworkPerimeterIpAddress { /** * (Updatable) type of the ip address value * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) Value of exact ipaddress or the range in CIDR or the range with start and end ip addresses * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; /** * (Updatable) Indicates the type of Ip Address example, IPV4 or IPV6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsNetworkPerimeterMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsNetworkPerimeterTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsNotificationSettingEventSetting { /** * (Updatable) Specify if notifications are enabled for the event * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ enabled: boolean; /** * (Updatable) IDCS-generated event * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ eventId: string; } interface DomainsNotificationSettingFromEmailAddress { /** * (Updatable) Display name for the From email address * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string */ displayName: string; /** * (Updatable) From address verification mode. If postmaster account is available then 'domain' mode is used or entire valid email can be verified using 'email' mode * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ validate: string; /** * (Updatable) Validation status for the From email address * * **SCIM++ Properties:** * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string */ validationStatus: string; /** * (Updatable) Value of the From email address * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ value: string; } interface DomainsNotificationSettingIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsNotificationSettingIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsNotificationSettingMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsNotificationSettingTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsOauth2clientCredentialIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsOauth2clientCredentialIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsOauth2clientCredentialMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsOauth2clientCredentialScope { /** * Audience * * **SCIM++ Properties:** * * caseExact: false * * type: string * * mutability: readWrite * * required: true * * returned: default */ audience: string; /** * Scope * * **SCIM++ Properties:** * * caseExact: false * * idcsScimCompliant: false * * type: string * * mutability: readWrite * * multiValued: false * * required: true * * returned: default */ scope: string; } interface DomainsOauth2clientCredentialTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsOauth2clientCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). * * **Added In:** 2205182039 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: writeOnly * * required: false * * returned: never * * type: boolean * * uniqueness: none */ allowSelfChange: boolean; } interface DomainsOauth2clientCredentialUser { /** * (Updatable) The user's display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The username. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * The user's OCID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The user's ID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsOauthClientCertificateIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsOauthClientCertificateIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsOauthClientCertificateMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsOauthClientCertificateTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsOauthPartnerCertificateIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsOauthPartnerCertificateIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsOauthPartnerCertificateMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsOauthPartnerCertificateTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsPasswordPolicyConfiguredPasswordPolicyRule { /** * (Updatable) The specific password policy rule * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: always * * type: string * * uniqueness: none */ key: string; /** * (Updatable) User-friendly text that describes a specific password policy rule * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsPasswordPolicyGroup { /** * (Updatable) Group Display Name * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The URI of the corresponding Group resource to which the password policy belongs * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The identifier of the group. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsPasswordPolicyIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsPasswordPolicyIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsPasswordPolicyMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsPasswordPolicyTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsPolicyIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsPolicyIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsPolicyMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsPolicyPolicyType { /** * (Updatable) PolicyType URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) PolicyType identifier. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsPolicyRule { /** * (Updatable) Rule name * * **Added In:** 17.4.2 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ name: string; /** * (Updatable) Rule URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Position of the rule in evaluation order. No duplicates allowed. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none */ sequence: number; /** * (Updatable) Rule identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsPolicyTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsRuleConditionGroup { /** * (Updatable) Condition or ConditionGroup name * * **Added In:** 17.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) ConditionGroup URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) A label that indicates whether this is Condition or ConditionGroup. * * **SCIM++ Properties:** * * idcsDefaultValue: Condition * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) Condition or ConditionGroup identifier. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsRuleIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsRuleIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsRuleMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsRulePolicyType { /** * (Updatable) PolicyType URI * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) PolicyType identifier * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsRuleReturn { /** * (Updatable) Attribute name of an individual value to be returned. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) The Groovy script that is run to generate output for the rule, if the policy type allows the return value to be a Groovy script. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ returnGroovy: string; /** * (Updatable) Attribute value of some attribute to be returned. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsRuleTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSecurityQuestionIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSecurityQuestionIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSecurityQuestionMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsSecurityQuestionQuestionText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ default: boolean; /** * The locale * * **SCIM++ Properties:** * * caseExact: false * * idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(locale)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ locale: string; /** * The question text * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsSecurityQuestionSettingIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSecurityQuestionSettingIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSecurityQuestionSettingMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsSecurityQuestionSettingTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSecurityQuestionTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileAfterSubmitText { /** * (Updatable) If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ default: boolean; /** * (Updatable) Type of user's locale e.g. en-CA * * **SCIM++ Properties:** * * caseExact: false * * idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ locale: string; /** * (Updatable) Localized value of after submit text in corresponding locale * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileConsentText { /** * (Updatable) If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ default: boolean; /** * (Updatable) Type of user's locale e.g. en-CA * * **SCIM++ Properties:** * * caseExact: false * * idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ locale: string; /** * (Updatable) Localized value of consent text in corresponding locale * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileDefaultGroup { /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) URI of the Default Group * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Identifier of the Default Group. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileDisplayName { /** * (Updatable) If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ default: boolean; /** * (Updatable) Type of user's locale e.g. en-CA * * **SCIM++ Properties:** * * caseExact: false * * idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ locale: string; /** * (Updatable) Localized value of displayName in corresponding locale * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileEmailTemplate { /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) URI of the Email Template * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Identifier of the Email Template. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileFooterText { /** * (Updatable) If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ default: boolean; /** * (Updatable) Type of user's locale e.g. en-CA * * **SCIM++ Properties:** * * caseExact: false * * idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ locale: string; /** * (Updatable) Localized value of footer text in corresponding locale * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileHeaderText { /** * (Updatable) If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ default: boolean; /** * (Updatable) Type of user's locale e.g. en-CA * * **SCIM++ Properties:** * * caseExact: false * * idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ locale: string; /** * (Updatable) Localized value of header text in corresponding locale * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsSelfRegistrationProfileTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSelfRegistrationProfileUserAttribute { /** * (Updatable) If this attribute can be deleted * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ deletable: boolean; /** * (Updatable) **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none Fully Qualified Attribute Name */ fullyQualifiedAttributeName: string; /** * (Updatable) Metadata of the user attribute * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ metadata: string; /** * (Updatable) **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none Sequence Number for the attribute */ seqNumber: number; /** * (Updatable) name of the attribute * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsSettingCertificateValidation { /** * (Updatable) Use CRL as Fallback. * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ crlCheckOnOcspFailureEnabled: boolean; /** * (Updatable) CRL is enabled Configuration * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ crlEnabled: boolean; /** * (Updatable) CRL Location. * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ crlLocation: string; /** * (Updatable) The CRL refresh interval in minutes * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ crlRefreshInterval: number; /** * (Updatable) OCSP is enabled Configuration * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ ocspEnabled: boolean; /** * (Updatable) OCSP Responder URL * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ocspResponderUrl: string; /** * (Updatable) This setting says, OCSP Responder URL present in the issued certificate must be used. Otherwise, OCSP Responder URL from IDP or Settings. * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ ocspSettingsResponderUrlPreferred: boolean; /** * (Updatable) OCSP Signing Certificate Alias * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ocspSigningCertificateAlias: string; /** * (Updatable) The OCSP Timeout duration in minutes * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * idcsMaxValue: 10 * * idcsMinValue: 1 * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ ocspTimeoutDuration: number; /** * (Updatable) OCSP Accept unknown response status from ocsp responder. * * **Added In:** 2010242156 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ ocspUnknownResponseStatusAllowed: boolean; } interface DomainsSettingCloudGateCorsSettings { /** * (Updatable) Allow Null Origin (CORS) for this tenant. * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ cloudGateCorsAllowNullOrigin: boolean; /** * (Updatable) Cloud Gate Allowed Cross-Origin Resource Sharing (CORS) Origins for this tenant. * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ cloudGateCorsAllowedOrigins: string[]; /** * (Updatable) Enable Cloud Gate Cross-Origin Resource Sharing (CORS) for this tenant. * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ cloudGateCorsEnabled: boolean; /** * (Updatable) List of Response Headers Cloud Gate is allowed to expose in the CORS Response Header: Access-Control-Expose-Headers. * * **Added In:** 2205182039 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ cloudGateCorsExposedHeaders: string[]; /** * (Updatable) Maximum number of seconds a CORS Pre-flight Response may be cached by client. * * **Added In:** 2205182039 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ cloudGateCorsMaxAge: number; } interface DomainsSettingCompanyName { /** * (Updatable) Locale * * **SCIM++ Properties:** * * idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(companyNames.locale)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ locale: string; /** * (Updatable) Company name * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ value: string; } interface DomainsSettingDefaultCompanyName { /** * (Updatable) Locale * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(companyNames.locale)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string */ locale: string; /** * (Updatable) Company name * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string */ value: string; } interface DomainsSettingDefaultImage { /** * (Updatable) A human-readable name, primarily used for display purposes * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string */ display: string; /** * (Updatable) Indicates the image type * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string */ type: string; /** * (Updatable) Image URI * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: reference */ value: string; } interface DomainsSettingDefaultLoginText { /** * (Updatable) Locale * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(loginTexts.locale)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string */ locale: string; /** * (Updatable) Login text * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * idcsSanitize: true */ value: string; } interface DomainsSettingIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSettingIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSettingImage { /** * (Updatable) A human-readable name, primarily used for display purposes * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string */ display: string; /** * (Updatable) Indicates the image type * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ type: string; /** * (Updatable) Image URI * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: reference */ value: string; } interface DomainsSettingLoginText { /** * (Updatable) Locale * * **SCIM++ Properties:** * * idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(loginTexts.locale)" * * idcsCanonicalValueSourceResourceType: AllowedValue * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ locale: string; /** * (Updatable) Login text * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * idcsSanitize: true * * type: string */ value: string; } interface DomainsSettingMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsSettingPurgeConfig { /** * (Updatable) Resource Name * * **Deprecated Since: 19.1.6** * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string */ resourceName: string; /** * (Updatable) Retention Period * * **Deprecated Since: 19.1.6** * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer */ retentionPeriod: number; } interface DomainsSettingTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSettingTenantCustomClaim { /** * (Updatable) Indicates if the custom claim is associated with all scopes * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ allScopes: boolean; /** * (Updatable) Indicates if the custom claim is an expression * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none */ expression: boolean; /** * (Updatable) Indicates under what scenario the custom claim will be return * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ mode: string; /** * (Updatable) Custom claim name * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: server */ name: string; /** * (Updatable) Scopes associated with a specific custom claim * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ scopes: string[]; /** * (Updatable) Indicates what type of token the custom claim will be embedded * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ tokenType: string; /** * (Updatable) Custom claim value * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSmtpCredentialIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSmtpCredentialIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSmtpCredentialMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsSmtpCredentialTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSmtpCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). * * **Added In:** 2205182039 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: writeOnly * * required: false * * returned: never * * type: boolean * * uniqueness: none */ allowSelfChange: boolean; } interface DomainsSmtpCredentialUser { /** * (Updatable) User display name * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) User name * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * User's ocid * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * User's id * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsSocialIdentityProviderIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSocialIdentityProviderIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSocialIdentityProviderJitProvAssignedGroup { /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **Added In:** 2309290043 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; ref: string; /** * (Updatable) Group identifier * * **Added In:** 2309290043 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsSocialIdentityProviderMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsSocialIdentityProviderRelayIdpParamMapping { /** * (Updatable) Key or name of the relayParam. * * **Added In:** 2305190132 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ relayParamKey: string; /** * (Updatable) Value of the relayParam (if defined) * * **Added In:** 2305190132 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ relayParamValue: string; } interface DomainsSocialIdentityProviderTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserAddress { /** * (Updatable) The country name component. * * **SCIM++ Properties:** * * caseExact: false * * idcsCanonicalValueSourceFilter: attrName eq "countries" and attrValues.value eq "upper($(country))" * * idcsCanonicalValueSourceResourceType: AllowedValue * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ country: string; /** * (Updatable) The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ formatted: string; /** * (Updatable) The city or locality component. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ locality: string; /** * (Updatable) The zipcode or postal code component. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ postalCode: string; /** * (Updatable) A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ primary: boolean; /** * (Updatable) The state or region component. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ region: string; /** * (Updatable) The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. This attribute MAY contain newlines. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ streetAddress: string; /** * (Updatable) A label indicating the attribute's function; e.g., 'work' or 'home'. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; } interface DomainsUserDbCredentialIdcsCreatedBy { /** * The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserDbCredentialIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserDbCredentialMeta { /** * The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsUserDbCredentialTag { /** * Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserDbCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). * * **Added In:** 2205182039 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: writeOnly * * required: false * * returned: never * * type: boolean * * uniqueness: none */ allowSelfChange: boolean; } interface DomainsUserDbCredentialUser { /** * (Updatable) The user display name. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The username. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * The user's OCID. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI that corresponds to the user linked to this credential. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * The user's identifier. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: always * * type: string * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface DomainsUserEmail { /** * (Updatable) Pending e-mail address verification * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ pendingVerificationData: string; /** * (Updatable) A Boolean value that indicates whether the email address is the primary email address. The primary attribute value 'true' MUST appear no more than once. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ primary: boolean; /** * (Updatable) A Boolean value that indicates whether the email address is the secondary email address. The secondary attribute value 'true' MUST appear no more than once. * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ secondary: boolean; /** * (Updatable) Type of email address * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) Email address * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; /** * (Updatable) A Boolean value that indicates whether or not the e-mail address is verified * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ verified: boolean; } interface DomainsUserEntitlement { /** * (Updatable) A human readable name, primarily used for display purposes. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ primary: boolean; /** * (Updatable) A label indicating the attribute's function. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The value of an entitlement. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserGroup { /** * (Updatable) Date when the member is Added to the group * * **Added In:** 2105200541 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ dateAdded: string; /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) An identifier for the Resource as defined by the Service Consumer. READ-ONLY. * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ externalId: string; /** * (Updatable) The membership OCID. * * **Added In:** 2103141444 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ membershipOcid: string; /** * (Updatable) A human readable name for Group as defined by the Service Consumer. READ-ONLY. * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ nonUniqueDisplay: string; /** * (Updatable) The OCID of the User's group. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the corresponding Group resource to which the user belongs * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) A label indicating the attribute's function; e.g., 'direct' or 'indirect'. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The identifier of the User's group. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserIdcsCreatedBy { /** * (Updatable) The displayName of the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that created this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who created this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserIdcsLastModifiedBy { /** * (Updatable) The displayName of the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The OCID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The type of resource, User or App, that modified this Resource * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The ID of the SCIM resource that represents the User or App who modified this Resource * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserIm { /** * (Updatable) A human-readable name, primarily used for display purposes * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) A Boolean value that indicates the 'primary' or preferred attribute value for this attribute--for example, the preferred messenger or primary messenger. The primary attribute value 'true' MUST appear no more than once. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ primary: boolean; /** * (Updatable) A label that indicates the attribute's function--for example, 'aim', 'gtalk', or 'mobile' * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) User's instant messaging address * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserMeta { /** * (Updatable) The DateTime the Resource was added to the Service Provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ created: string; /** * (Updatable) The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastModified: string; /** * (Updatable) The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ location: string; /** * (Updatable) Name of the resource type of the resource--for example, Users or Groups * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ resourceType: string; /** * (Updatable) The version of the Resource being returned. This value must be the same as the ETag HTTP response header. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ version: string; } interface DomainsUserName { /** * (Updatable) Last name * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: Last Name * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ familyName: string; /** * (Updatable) Full name * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ formatted: string; /** * (Updatable) First name * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: First Name * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ givenName: string; /** * (Updatable) Prefix * * **SCIM++ Properties:** * * idcsCsvAttributeName: Honorific Prefix * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ honorificPrefix: string; /** * (Updatable) Suffix * * **SCIM++ Properties:** * * idcsCsvAttributeName: Honorific Suffix * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ honorificSuffix: string; /** * (Updatable) Middle name * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: Middle Name * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ middleName: string; } interface DomainsUserPhoneNumber { /** * (Updatable) A human-readable name, primarily used for display purposes. READ ONLY * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) A Boolean value that indicates the 'primary' or preferred attribute value for this attribute--for example, the preferred phone number or primary phone number. The primary attribute value 'true' MUST appear no more than once. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ primary: boolean; /** * (Updatable) A label that indicates the attribute's function- for example, 'work', 'home', or 'mobile' * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) User's phone number * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; /** * (Updatable) A Boolean value that indicates if the phone number is verified. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ verified: boolean; } interface DomainsUserPhoto { /** * (Updatable) A human readable name, primarily used for display purposes. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g., the preferred photo or thumbnail. The primary attribute value 'true' MUST appear no more than once. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ primary: boolean; /** * (Updatable) A label indicating the attribute's function; e.g., 'photo' or 'thumbnail'. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) URL of a photo for the User * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: reference * * uniqueness: none */ value: string; } interface DomainsUserRole { /** * (Updatable) A human readable name, primarily used for display purposes. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ primary: boolean; /** * (Updatable) A label indicating the attribute's function. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The value of a role. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserTag { /** * (Updatable) Key or name of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ key: string; /** * (Updatable) Value of the tag. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasextensionenterprise20user { /** * (Updatable) Identifies the name of a cost center. * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: Cost Center * * idcsCsvAttributeNameMappings: [[columnHeaderName:Cost Center]] * * idcsPii: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ costCenter: string; /** * (Updatable) Identifies the name of a department. * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: Department * * idcsCsvAttributeNameMappings: [[columnHeaderName:Department]] * * idcsPii: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ department: string; /** * (Updatable) Identifies the name of a division. * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: Division * * idcsCsvAttributeNameMappings: [[columnHeaderName:Division]] * * idcsPii: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ division: string; /** * (Updatable) Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization. * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: Employee Number * * idcsCsvAttributeNameMappings: [[columnHeaderName:Employee Number]] * * idcsPii: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ employeeNumber: string; /** * (Updatable) The User's manager. A complex type that optionally allows Service Providers to represent organizational hierarchy by referencing the 'id' attribute of another User. * * **SCIM++ Properties:** * * idcsCsvAttributeNameMappings: [[columnHeaderName:Manager, deprecatedColumnHeaderName:Manager Name, mapsTo:manager.value]] * * idcsPii: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ manager: outputs.Identity.DomainsUserUrnietfparamsscimschemasextensionenterprise20userManager; /** * (Updatable) Identifies the name of an organization. * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: Organization * * idcsCsvAttributeNameMappings: [[columnHeaderName:Organization Name, deprecatedColumnHeaderName:Organization]] * * idcsPii: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ organization: string; } interface DomainsUserUrnietfparamsscimschemasextensionenterprise20userManager { /** * (Updatable) The displayName of the User's manager. OPTIONAL and READ-ONLY. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ displayName: string; /** * (Updatable) The URI of the SCIM resource representing the User's manager. RECOMMENDED. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The id of the SCIM resource representing the User's manager. RECOMMENDED. * * **SCIM++ Properties:** * * idcsCsvAttributeName: Manager Name * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionOciTags { /** * (Updatable) Oracle Cloud Infrastructure Defined Tags * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsCompositeKey: [namespace, key, value] * * type: complex * * idcsSearchable: true * * required: false * * mutability: readWrite * * multiValued: true * * returned: default */ definedTags: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionOciTagsDefinedTag[]; /** * (Updatable) Oracle Cloud Infrastructure Freeform Tags * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsCompositeKey: [key, value] * * idcsSearchable: true * * type: complex * * required: false * * mutability: readWrite * * returned: default * * multiValued: true */ freeformTags: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionOciTagsFreeformTag[]; /** * (Updatable) Oracle Cloud Infrastructure Tag slug * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * type: binary * * mutability: readOnly * * returned: request */ tagSlug: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionOciTagsDefinedTag { /** * (Updatable) Oracle Cloud Infrastructure Tag key * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ key: string; /** * (Updatable) Oracle Cloud Infrastructure Tag namespace * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ namespace: string; /** * (Updatable) Oracle Cloud Infrastructure Tag value * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * required: true * * idcsReturnEmptyWhenNull: true * * mutability: readWrite * * returned: default * * type: string * * idcsSearchable: true * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionOciTagsFreeformTag { /** * (Updatable) Oracle Cloud Infrastructure Tag key * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * type: string * * required: true * * mutability: readWrite * * returned: default * * idcsSearchable: true * * uniqueness: none */ key: string; /** * (Updatable) Oracle Cloud Infrastructure Tag value * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * caseExact: false * * required: true * * idcsReturnEmptyWhenNull: true * * mutability: readWrite * * returned: default * * type: string * * idcsSearchable: true * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionadaptiveUser { /** * (Updatable) Risk Level * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ riskLevel: string; /** * (Updatable) The risk score pertaining to the user. * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsCompositeKey: [value] * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: complex * * uniqueness: none */ riskScores: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionadaptiveUserRiskScore[]; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionadaptiveUserRiskScore { /** * (Updatable) Last update timestamp for the risk score * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: dateTime * * uniqueness: none */ lastUpdateTimestamp: string; /** * (Updatable) Risk Provider Profile URI: URI that corresponds to risk source identifier. * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Risk Level * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ riskLevel: string; /** * (Updatable) Risk Score value * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: integer * * uniqueness: none * * idcsMaxValue: 100 * * idcsMinValue: 0 */ score: number; /** * (Updatable) Risk Provider Profile Source * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ source: string; /** * (Updatable) Risk Provider Profile status * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ status: string; /** * (Updatable) Risk Provider Profile: Identifier for the provider service from which the risk score was received. * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensioncapabilitiesUser { /** * (Updatable) Indicates whether a user can use API keys. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ canUseApiKeys: boolean; /** * (Updatable) Indicates whether a user can use Auth tokens. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ canUseAuthTokens: boolean; /** * (Updatable) Specifies whether user can access the Console. * * **Added In:** 2206280902 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ canUseConsole: boolean; /** * (Updatable) Indicates whether a user can use Console passwords. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ canUseConsolePassword: boolean; /** * (Updatable) Indicates whether a user can use customer secret keys. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ canUseCustomerSecretKeys: boolean; /** * (Updatable) Indicates whether a user can use database credentials. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ canUseDbCredentials: boolean; /** * (Updatable) Indicates whether a user can use OAuth2 client credentials. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ canUseOauth2clientCredentials: boolean; /** * (Updatable) Indicates whether a user can use SMTP credentials. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ canUseSmtpCredentials: boolean; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensiondbCredentialsUser { /** * (Updatable) The number of failed login attempts. The value is reset to 0 after a successful login. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: integer * * uniqueness: none */ dbLoginAttempts: number; /** * (Updatable) The database username. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * multiValued: false * * mutability: readWrite * * required: false * * type: string * * returned: request * * caseExact: false * * uniqueness: none * * idcsSearchable: true */ dbUserName: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensiondbUserUser { /** * (Updatable) DB global roles to which the user is granted access. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * idcsSensitive: none * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ dbGlobalRoles: string[]; /** * (Updatable) DB domain level schema to which the user is granted access. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * idcsSensitive: none * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ domainLevelSchema: string; /** * (Updatable) DB instance level schema to which the user is granted access. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * idcsSensitive: none * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ instanceLevelSchema: string; /** * (Updatable) If true, indicates this is a database user. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ isDbUser: boolean; /** * (Updatable) Password Verifiers for DB User. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * idcsCompositeKey: [type] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ passwordVerifiers: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensiondbUserUserPasswordVerifier[]; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensiondbUserUserPasswordVerifier { /** * (Updatable) Type of database password verifier (for example, MR-SHA512 or SSHA). * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) Hash value of database password verifier. * * **Added In:** 18.2.2 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * idcsSensitive: none * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionkerberosUserUser { /** * (Updatable) A list of kerberos realm users for an Oracle Identity Cloud Service User * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: complex * * uniqueness: none */ realmUsers: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionkerberosUserUserRealmUser[]; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionkerberosUserUserRealmUser { /** * (Updatable) Principal Name of the KerberosRealmUser associated with the Oracle Identity Cloud Service User. * * **SCIM++ Properties:** * * idcsPii: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ principalName: string; /** * (Updatable) Realm Name for the KerberosRealmUser associated with the Oracle Identity Cloud Service User. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ realmName: string; /** * (Updatable) The URI of the corresponding KerberosRealmUser resource associated with the Oracle Identity Cloud Service User. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) id of the KerberosRealmUser associated with the Oracle Identity Cloud Service User. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUser { /** * (Updatable) A list of bypass codes that belongs to the user. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ bypassCodes: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserBypassCode[]; /** * (Updatable) A list of devices enrolled by the user. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ devices: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserDevice[]; /** * (Updatable) The number of incorrect multi factor authentication sign in attempts made by this user. The user is locked if this reaches the threshold specified in the maxIncorrectAttempts attribute in AuthenticationFactorSettings. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * idcsRequiresWriteForAccessFlows: true * * idcsRequiresImmediateReadAfterWriteForAccessFlows: true * * required: false * * returned: default * * type: integer * * uniqueness: none */ loginAttempts: number; /** * (Updatable) The date when the user enrolled in multi factor authentication. This will be set to null, when the user resets their factors. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: dateTime * * uniqueness: none */ mfaEnabledOn: string; /** * (Updatable) User MFA Ignored Apps Identifiers * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ mfaIgnoredApps: string[]; /** * (Updatable) The user opted for MFA. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: default * * type: string * * uniqueness: none */ mfaStatus: string; /** * (Updatable) The preferred authentication factor type. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ preferredAuthenticationFactor: string; /** * (Updatable) The preferred authentication method. * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ preferredAuthenticationMethod: string; /** * (Updatable) The user's preferred device. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ preferredDevice: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserPreferredDevice; /** * (Updatable) The preferred third-party vendor name. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ preferredThirdPartyVendor: string; /** * (Updatable) A list of trusted User Agents owned by this user. Multi-Factored Authentication uses Trusted User Agents to authenticate users. A User Agent is software application that a user uses to issue requests. For example, a User Agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, oneof several executing on a particular mobile device). A User Agent is trusted once the Multi-Factor Authentication has verified it in some way. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: complex * * uniqueness: none */ trustedUserAgents: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserTrustedUserAgent[]; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserBypassCode { /** * (Updatable) The URI of the corresponding BypassCode resource which belongs to user * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The user's bypass code identifier. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserDevice { /** * (Updatable) The authentication method. * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ authenticationMethod: string; /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The device authentication factor status. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ factorStatus: string; /** * (Updatable) The device authentication factor type. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ factorType: string; /** * (Updatable) The last sync time for device. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lastSyncTime: string; /** * (Updatable) The URI of the corresponding Device resource which belongs to user. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The device's status. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ status: string; /** * (Updatable) The third-party factor vendor name. * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ thirdPartyVendorName: string; /** * (Updatable) The user's device identifier. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserPreferredDevice { /** * (Updatable) The device display name. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The URI that corresponds to the device resource. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The user's preferred device identifier. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserTrustedUserAgent { /** * (Updatable) A human-readable identifier for this trusted user agent, used primarily for display purposes. READ-ONLY. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The URI of the corresponding trusted user agent resource. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The user's trusted user agent identifier. * * **Added In:** 18.3.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordStateUser { /** * (Updatable) Applicable Password Policy * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ applicablePasswordPolicy: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordStateUserApplicablePasswordPolicy; /** * (Updatable) Indicates that the current password MAY NOT be changed and all other password expiry settings SHALL be ignored * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ cantChange: boolean; /** * (Updatable) Indicates that the password expiry policy will not be applied for the current Resource * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ cantExpire: boolean; /** * (Updatable) Indicates that the password has expired * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ expired: boolean; /** * (Updatable) A DateTime that specifies the date and time when last failed password validation was set * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: dateTime * * uniqueness: none */ lastFailedValidationDate: string; /** * (Updatable) A DateTime that specifies the date and time when the current password was set * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: dateTime * * uniqueness: none */ lastSuccessfulSetDate: string; /** * (Updatable) A DateTime that specifies the date and time when last successful password validation was set * * **Added In:** 2011192329 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: dateTime * * uniqueness: none */ lastSuccessfulValidationDate: string; /** * (Updatable) Indicates that the subject password value MUST change on next login. If not changed, typically the account is locked. The value may be set indirectly when the subject's current password expires or directly set by an administrator. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ mustChange: boolean; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordStateUserApplicablePasswordPolicy { /** * (Updatable) Password Policy Display Name * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) PasswordPolicy priority * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: integer * * uniqueness: none */ priority: number; /** * (Updatable) The URI of the corresponding PasswordPolicy resource. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The identifier of the password policy. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordlessUser { /** * (Updatable) Factor Identifier ID * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ factorIdentifier: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordlessUserFactorIdentifier; /** * (Updatable) Authentication Factor Method * * **Added In:** 2009232244 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ factorMethod: string; /** * (Updatable) Authentication Factor Type * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ factorType: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordlessUserFactorIdentifier { /** * (Updatable) Factor Identifier display name * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The URI that corresponds to the device resource * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The identifier of the User's preferred device * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionposixUser { /** * (Updatable) General information about the POSIX account such as their real name and phone number * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ gecos: string; /** * (Updatable) Primary Group identifier of the POSIX user * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: integer * * uniqueness: none */ gidNumber: number; /** * (Updatable) The absolute path to the home directory of the POSIX account * * **SCIM++ Properties:** * * caseExact: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ homeDirectory: string; /** * (Updatable) The path to the login shell of the POSIX account * * **SCIM++ Properties:** * * caseExact: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ loginShell: string; /** * (Updatable) Integer uniquely identifying a user in a POSIX administrative domain * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: integer * * uniqueness: server */ uidNumber: number; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUser { /** * (Updatable) The schema used to mnage security question and answers provided by a user for account recovery and/or MFA. While setting up security questions, a user can also provide a hint for the answer. * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: complex * * uniqueness: none */ secQuestions: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUserSecQuestion[]; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUserSecQuestion { /** * (Updatable) The answer provided by a user for a security question. * * **SCIM++ Properties:** * * idcsCsvAttributeName: Answer * * idcsSearchable: false * * idcsSensitive: hash * * multiValued: false * * mutability: writeOnly * * required: true * * returned: never * * type: string * * uniqueness: none * * idcsPii: true */ answer: string; /** * (Updatable) The hint for an answer that's given by user when setting up a security question. * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ hintText: string; /** * (Updatable) The URI of the corresponding Security Question resource. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The identifier of the question selected by the user when setting up a security question. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * (Updatable) If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). * * **Added In:** 2205182039 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: writeOnly * * required: false * * returned: never * * type: boolean * * uniqueness: none */ allowSelfChange: boolean; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionselfRegistrationUser { /** * (Updatable) A boolean value that indicates whether the consent is granted. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: boolean * * uniqueness: none */ consentGranted: boolean; /** * (Updatable) Self registration profile used when user is self registered. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: request * * type: complex * * uniqueness: none */ selfRegistrationProfile: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionselfRegistrationUserSelfRegistrationProfile; /** * (Updatable) User token used for auto-login. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ userToken: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionselfRegistrationUserSelfRegistrationProfile { /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ display: string; /** * (Updatable) URI of the profile. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Self Registration Profile Id * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionsffUser { /** * (Updatable) SFF auth keys clob * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: string * * uniqueness: none */ sffAuthKeys: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionsocialAccountUser { /** * (Updatable) Description: * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * idcsPii: true * * type: complex * * uniqueness: none */ socialAccounts: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionsocialAccountUserSocialAccount[]; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionsocialAccountUserSocialAccount { /** * (Updatable) A human readable name, primarily used for display purposes. READ-ONLY. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The URI of the corresponding SocialAccount resource linked with the user * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensiontermsOfUseUser { /** * (Updatable) Description: * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: request * * type: complex * * uniqueness: none */ termsOfUseConsents: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensiontermsOfUseUserTermsOfUseConsent[]; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensiontermsOfUseUserTermsOfUseConsent { /** * (Updatable) The URI of the corresponding TermsOfUseConsent resource linked with the user * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUser { /** * (Updatable) A list of API keys corresponding to user. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ apiKeys: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserApiKey[]; /** * (Updatable) A list of Auth tokens corresponding to user. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ authTokens: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserAuthToken[]; /** * (Updatable) A list of customer secret keys corresponding to user. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ customerSecretKeys: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserCustomerSecretKey[]; /** * (Updatable) A list of database credentials corresponding to user. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ dbCredentials: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserDbCredential[]; /** * (Updatable) A list of OAuth2 client credentials corresponding to a user. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ oAuth2clientCredentials: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserOAuth2clientCredential[]; /** * (Updatable) A list of SMTP credentials corresponding to user. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ smtpCredentials: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserSmtpCredential[]; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserApiKey { /** * (Updatable) The user's API key value. * * **Added In:** 2106240046 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ key: string; /** * (Updatable) The user's API key OCID. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the corresponding ApiKey resource to which the user belongs. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The user's API key identifier. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserAuthToken { /** * (Updatable) The user's Auth token OCID. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the corresponding AuthToken resource to which the user belongs. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The user's Auth token identifier. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserCustomerSecretKey { /** * (Updatable) The user's customer secret key OCID. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the corresponding CustomerSecretKey resource to which the user belongs. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The user's customer secret key identifier. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserDbCredential { /** * (Updatable) The user's database credential OCID. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the corresponding UserDbCredential resource to which the user belongs. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The user's database credential identifier. * * **Added In:** 2102181953 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserOAuth2clientCredential { /** * (Updatable) The user's OAuth2 client credential OCID. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the corresponding OAuth2ClientCredential resource to which the user belongs. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The user's OAuth2 client credential identifier. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserSmtpCredential { /** * (Updatable) The user's Auth token OCID. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the corresponding SmtpCredential resource to which the user belongs. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The user's SMTP credential identifier. * * **Added In:** 2012271618 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserStateUser { /** * (Updatable) The last failed login date. * * **SCIM++ Properties:** * * idcsSearchable: false * * idcsAllowUpdatesInReadOnlyMode: true * * multiValued: false * * mutability: readOnly * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: request * * type: dateTime * * uniqueness: none */ lastFailedLoginDate: string; /** * (Updatable) The last successful login date. * * **SCIM++ Properties:** * * idcsSearchable: true * * idcsAllowUpdatesInReadOnlyMode: true * * multiValued: false * * mutability: readOnly * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: request * * type: dateTime * * uniqueness: none */ lastSuccessfulLoginDate: string; /** * (Updatable) A complex attribute that indicates an account is locked (blocking any new sessions). * * **SCIM++ Properties:** * * idcsCsvAttributeNameMappings: [[columnHeaderName:Locked, mapsTo:locked.on], [columnHeaderName:Locked Reason, mapsTo:locked.reason], [columnHeaderName:Locked Date, mapsTo:locked.lockDate]] * * idcsSearchable: false * * idcsAllowUpdatesInReadOnlyMode: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ locked: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserLocked; /** * (Updatable) The number of failed login attempts. The value is reset to 0 after a successful login. * * **SCIM++ Properties:** * * idcsSearchable: false * * idcsAllowUpdatesInReadOnlyMode: true * * multiValued: false * * mutability: readOnly * * idcsRequiresWriteForAccessFlows: true * * idcsRequiresImmediateReadAfterWriteForAccessFlows: true * * required: false * * returned: request * * type: integer * * uniqueness: none */ loginAttempts: number; /** * (Updatable) The maximum number of concurrent sessions for a user. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsMaxValue: 999 * * idcsMinValue: 1 * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: integer * * uniqueness: none */ maxConcurrentSessions: number; /** * (Updatable) The previous successful login date. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: request * * type: dateTime * * uniqueness: none */ previousSuccessfulLoginDate: string; /** * (Updatable) The number of failed recovery attempts. The value is reset to 0 after a successful login. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: request * * type: integer * * uniqueness: none */ recoveryAttempts: number; /** * (Updatable) The number of failed account recovery enrollment attempts. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: integer * * uniqueness: none */ recoveryEnrollAttempts: number; /** * (Updatable) A complex attribute that indicates a password recovery is locked (blocking any new sessions). * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ recoveryLocked: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserRecoveryLocked; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserLocked { /** * (Updatable) Indicates whether the user password is expired. If this value is false, password expiry is still evaluated during user login. * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: boolean * * uniqueness: none */ expired: boolean; /** * (Updatable) The date and time that the current resource was locked. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lockDate: string; /** * (Updatable) Indicates that the account is locked. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * idcsRequiresWriteForAccessFlows: true * * idcsRequiresImmediateReadAfterWriteForAccessFlows: true * * required: false * * returned: default * * type: boolean * * uniqueness: none */ on: boolean; /** * (Updatable) Indicates the reason for locking the account. Valid values are: 0 - failed password login attempts, 1 - admin lock, 2 - failed reset password attempts, 3 - failed MFA login attempts, 4 - failed MFA login attempts for federated user, 5 - failed Database login attempts * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * idcsRequiresWriteForAccessFlows: true * * idcsRequiresImmediateReadAfterWriteForAccessFlows: true * * required: false * * returned: default * * type: integer * * uniqueness: none */ reason: number; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserRecoveryLocked { /** * (Updatable) The date and time that the current resource was locked. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: default * * type: dateTime * * uniqueness: none */ lockDate: string; /** * (Updatable) Indicates that the recovery is locked. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: default * * type: boolean * * uniqueness: none */ on: boolean; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUser { /** * (Updatable) Boolean value to prompt user to setup account recovery during login. * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: request * * type: boolean * * uniqueness: none */ accountRecoveryRequired: boolean; /** * (Updatable) Accounts assigned to this User. Each value of this attribute refers to an app-specific identity that is owned by this User. Therefore, this attribute is a convenience that allows one to see on each User the Apps to which that User has access. * * **SCIM++ Properties:** * * idcsPii: true * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ accounts: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserAccount[]; /** * (Updatable) A list of all AppRoles to which this User belongs directly, indirectly or implicitly. The User could belong directly because the User is a member of the AppRole, could belong indirectly because the User is a member of a Group that is a member of the AppRole, or could belong implicitly because the AppRole is public. * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ appRoles: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserAppRole[]; /** * (Updatable) The app against which the user will authenticate. The value is not persisted but rather calculated. If the user's delegatedAuthenticationTargetApp is set, that value is returned. Otherwise, the app returned by evaluating the user's applicable Delegated Authentication Policy is returned. * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ applicableAuthenticationTargetApps: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserApplicableAuthenticationTargetApp[]; /** * (Updatable) A Boolean value indicating whether or not to send email notification after creating the user. This attribute is not used in update/replace operations. * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeNameMappings: [[columnHeaderName:ByPass Notification]] * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: never * * type: boolean * * uniqueness: none */ bypassNotification: boolean; /** * (Updatable) User creation mechanism * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeNameMappings: [[defaultValue:import]] * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: request * * type: string * * uniqueness: none */ creationMechanism: string; /** * (Updatable) If set, indicates the user's preferred authentication target app. If not set and the user's \"syncedFromApp\" is set and is enabled for delegated authentication, it is used. Otherwise, the user authenticates locally to Oracle Identity Cloud Service. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none */ delegatedAuthenticationTargetApp: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserDelegatedAuthenticationTargetApp; /** * (Updatable) A Boolean value indicating whether or not to hide the getting started page * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ doNotShowGettingStarted: boolean; /** * (Updatable) Grants to this User. Each value of this attribute refers to a Grant to this User of some App (and optionally of some entitlement). Therefore, this attribute is a convenience that allows one to see on each User all of the Grants to that User. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ grants: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserGrant[]; /** * (Updatable) Specifies date time when a User's group membership was last modified. * * **Added In:** 2304270343 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: dateTime * * uniqueness: none */ groupMembershipLastModified: string; /** * (Updatable) Description: * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsCompositeKey: [value, idcsAppRoleId] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex */ idcsAppRolesLimitedToGroups: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserIdcsAppRolesLimitedToGroup[]; /** * (Updatable) A Boolean value indicating whether or not a user is enrolled for account recovery * * **Added In:** 19.1.4 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: boolean * * uniqueness: none */ isAccountRecoveryEnrolled: boolean; /** * (Updatable) A Boolean value indicating whether or not authentication request by this user should be delegated to a remote app. This value should be true only when the User was originally synced from an app which is enabled for delegated authentication * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: never * * type: boolean * * uniqueness: none */ isAuthenticationDelegated: boolean; /** * (Updatable) A Boolean value indicating whether or not the user is federated. * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: Federated * * idcsCsvAttributeNameMappings: [[columnHeaderName:Federated]] * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * idcsRequiresWriteForAccessFlows: true * * required: false * * returned: default * * type: boolean * * uniqueness: none */ isFederatedUser: boolean; /** * (Updatable) A Boolean value indicating whether or not group membership is normalized for this user. * * **Deprecated Since: 19.3.3** * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: never * * type: boolean * * uniqueness: none */ isGroupMembershipNormalized: boolean; /** * (Updatable) A Boolean value Indicates whether this User's group membership has been sync'ed from Group.members to UsersGroups. * * **Added In:** 19.3.3 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: never * * type: boolean * * uniqueness: none */ isGroupMembershipSyncedToUsersGroups: boolean; /** * (Updatable) Specifies the EmailTemplate to be used when sending notification to the user this request is for. If specified, it overrides the default EmailTemplate for this event. * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: writeOnly * * required: false * * returned: never * * type: string * * uniqueness: none */ notificationEmailTemplateId: string; /** * (Updatable) User's preferred landing page following login, logout and reset password. * * **Added In:** 2302092332 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ preferredUiLandingPage: string; /** * (Updatable) Indicates if User is a Service User * * **Added In:** 2306131901 * * **SCIM++ Properties:** * * caseExact: false * * idcsCsvAttributeName: Service User * * idcsCsvAttributeNameMappings: [[columnHeaderName:Service User]] * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: boolean * * uniqueness: none */ serviceUser: boolean; /** * (Updatable) A supplemental status indicating the reason why a user is disabled * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ status: string; /** * (Updatable) A list of Support Accounts corresponding to user. * * **Added In:** 2103141444 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readOnly * * required: false * * returned: request * * type: complex * * uniqueness: none */ supportAccounts: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserSupportAccount[]; /** * (Updatable) Managed App or an Identity Source from where the user is synced. If enabled, this Managed App or Identity Source can be used for performing delegated authentication. * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: complex * * uniqueness: none */ syncedFromApp: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserSyncedFromApp; /** * (Updatable) A Boolean value indicating whether to bypass notification and return user token to be used by an external client to control the user flow. * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: false * * returned: never * * type: boolean * * uniqueness: none */ userFlowControlledByExternalClient: boolean; /** * (Updatable) Registration provider * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: immutable * * required: false * * returned: default * * type: string * * uniqueness: none */ userProvider: string; /** * (Updatable) User token returned if userFlowControlledByExternalClient is true * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: complex * * uniqueness: none */ userTokens: outputs.Identity.DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserUserToken[]; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserAccount { /** * (Updatable) Status of the account * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ active: boolean; /** * (Updatable) The ID of the App to which this Account gives access. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ appId: string; /** * (Updatable) Name of the account assigned to the User. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ name: string; /** * (Updatable) The URI of the Account assigned to the User. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The Id of the Account assigned to the User. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserAppRole { /** * (Updatable) If true, then the role provides administrative access privileges. READ-ONLY. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: boolean * * uniqueness: none */ adminRole: boolean; /** * (Updatable) The ID of the App that defines this AppRole. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ appId: string; /** * (Updatable) The name (Client ID) of the App that defines this AppRole. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ appName: string; /** * (Updatable) The display name of the AppRole assigned to the User. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The name (if any) under which this AppRole should appear in this User's group-memberships for reasons of backward compatibility. Oracle Identity Cloud Service distinguishes between Groups and AppRoles, but some services still expect AppRoles appear as if they were service-instance-specific Groups. * * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ legacyGroupName: string; /** * (Updatable) The URI of the AppRole assigned to the User. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The kind of membership this User has in the AppRole. A value of 'direct' indicates that the User is a member of the AppRole. A value of 'indirect' indicates that the User is a member of a Group that is a member of the AppRole. A value of 'implicit' indicates that the AppRole is public. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: request * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The Id of the AppRole assigned to the User. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: true * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserApplicableAuthenticationTargetApp { /** * (Updatable) App Display Name * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) App URI * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) Timeout interval for Synchronization TargetAction in milliseconds * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: integer * * uniqueness: none */ targetRequestTimeout: number; /** * (Updatable) A label that indicates whether this is an App or IdentitySource. * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) App identifier * * **Added In:** 18.1.6 * * **SCIM++ Properties:** * * caseExact: true * * multiValued: false * * mutability: readOnly * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserDelegatedAuthenticationTargetApp { /** * (Updatable) App Display Name * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) App URI * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) A label that indicates whether this is an App or IdentitySource. * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * idcsDefaultValue: IdentitySource * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) App identifier * * **Added In:** 17.4.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserGrant { /** * (Updatable) The ID of the App in this Grant. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ appId: string; /** * (Updatable) Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ grantMechanism: string; /** * (Updatable) Grantor identifier * * **Added In:** 20.1.3 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ grantorId: string; /** * (Updatable) The URI of this Grant to this User. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The ID of this Grant to this User. * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserIdcsAppRolesLimitedToGroup { /** * (Updatable) Group display name * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) The id of the Oracle Identity Cloud Service AppRole grant limited to one or more Groups. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsCsvAttributeName: IDCS AppRole Name * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ idcsAppRoleId: string; /** * (Updatable) The ocid of a Group the AppRole Grant is limited to * * **Added In:** 2202230830 * * **SCIM++ Properties:** * * idcsCsvAttributeName: Group Ocid * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the SCIM resource representing the Group manager. RECOMMENDED. * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) The id of a Group the AppRole Grant is limited to * * **Added In:** 19.2.1 * * **SCIM++ Properties:** * * idcsCsvAttributeName: Group Name * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserSupportAccount { /** * (Updatable) The OCID of the user's support account. * * **Added In:** 2103141444 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ ocid: string; /** * (Updatable) The URI of the corresponding Support Account resource to which the user belongs * * **Added In:** 2103141444 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) User Support User Id * * **Added In:** 2103141444 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ userId: string; /** * (Updatable) User Support Account Provider * * **Added In:** 2103141444 * * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ userProvider: string; /** * (Updatable) The identifier of the User's support Account. * * **Added In:** 2103141444 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: always * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserSyncedFromApp { /** * (Updatable) App Display Name * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) App URI * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) A label that indicates whether this is an App or IdentitySource. * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * idcsDefaultValue: IdentitySource * * idcsSearchable: false * * multiValued: false * * mutability: immutable * * required: true * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) App identifier * * **Added In:** 18.2.6 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserUserToken { /** * (Updatable) User Token URI * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: reference * * uniqueness: none */ ref: string; /** * (Updatable) User Token identifier * * **Added In:** 18.4.2 * * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readOnly * * required: false * * returned: default * * type: string * * uniqueness: none */ value: string; } interface DomainsUserX509certificate { /** * (Updatable) A human readable name, primarily used for display purposes. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ display: string; /** * (Updatable) A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: boolean * * uniqueness: none */ primary: boolean; /** * (Updatable) A label indicating the attribute's function. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none */ type: string; /** * (Updatable) The value of a X509 certificate. * * **SCIM++ Properties:** * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: binary * * uniqueness: none * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ value: string; } interface GetAllowedDomainLicenseTypesAllowedDomainLicenseType { /** * The license type description. */ description: string; /** * The license type identifier. Example: "oracle-apps-premium" */ licenseType: string; /** * The license type name. Example: "Oracle Apps Premium" */ name: string; } interface GetAllowedDomainLicenseTypesFilter { /** * The license type name. Example: "Oracle Apps Premium" */ name: string; regex?: boolean; values: string[]; } interface GetApiKeysApiKey { /** * The key's fingerprint (e.g., 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef). */ fingerprint: string; /** * An Oracle-assigned identifier for the key, in this format: TENANCY_OCID/USER_OCID/KEY_FINGERPRINT. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveStatus: string; /** * The key's value. */ keyValue: string; /** * The API key's current state. */ state: string; /** * Date and time the `ApiKey` object was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The OCID of the user. */ userId: string; } interface GetApiKeysFilter { name: string; regex?: boolean; values: string[]; } interface GetAuthTokensFilter { name: string; regex?: boolean; values: string[]; } interface GetAuthTokensToken { /** * The description you assign to the auth token. Does not have to be unique, and it's changeable. */ description: string; /** * The OCID of the auth token. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; /** * The token's current state. */ state: string; /** * Date and time the `AuthToken` object was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Date and time when this auth token will expire, in the format defined by RFC3339. Null if it never expires. Example: `2016-08-25T21:10:29.600Z` */ timeExpires: string; /** * The auth token. The value is available only in the response for `CreateAuthToken`, and not for `ListAuthTokens` or `UpdateAuthToken`. */ token: string; /** * The OCID of the user. */ userId: string; } interface GetAuthenticationPolicyNetworkPolicy { /** * Network Source ids */ networkSourceIds: string[]; } interface GetAuthenticationPolicyPasswordPolicy { /** * At least one lower case character required. */ isLowercaseCharactersRequired: boolean; /** * At least one numeric character required. */ isNumericCharactersRequired: boolean; /** * At least one special character required. */ isSpecialCharactersRequired: boolean; /** * At least one uppercase character required. */ isUppercaseCharactersRequired: boolean; /** * User name is allowed to be part of the password. */ isUsernameContainmentAllowed: boolean; /** * Minimum password length required. */ minimumPasswordLength: number; } interface GetAvailabilityDomainsAvailabilityDomain { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * The OCID of the Availability Domain. */ id: string; /** * The name of the Availability Domain. */ name: string; } interface GetAvailabilityDomainsFilter { /** * The name of the Availability Domain. */ name: string; regex?: boolean; values: string[]; } interface GetCompartmentsCompartment { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the compartment. Does not have to be unique, and it's changeable. */ description: string; enableDelete: boolean; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the compartment. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; /** * Indicates whether or not the compartment is accessible for the user making the request. Returns true when the user has INSPECT permissions directly on a resource in the compartment or indirectly (permissions can be on a resource in a subcompartment). */ isAccessible: boolean; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Date and time the compartment was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetCompartmentsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetCostTrackingTagsFilter { /** * The name assigned to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed. */ name: string; regex?: boolean; /** * The list of allowed values for a definedTag value. */ values: string[]; } interface GetCostTrackingTagsTag { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the tag. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the tag definition. */ id: string; /** * Indicates whether the tag is enabled for cost tracking. */ isCostTracking: boolean; /** * Indicates whether the tag is retired. See [Retiring Key Definitions and Namespace Definitions](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#Retiring). */ isRetired: boolean; /** * The name assigned to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed. */ name: string; /** * The tag's current state. After creating a tag, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tag, make sure its `lifecycleState` is INACTIVE before using it. If you delete a tag, you cannot delete another tag until the deleted tag's `lifecycleState` changes from DELETING to DELETED. */ state: string; /** * The OCID of the namespace that contains the tag definition. */ tagNamespaceId: string; /** * The name of the tag namespace that contains the tag definition. */ tagNamespaceName: string; /** * Date and time the tag was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Validates a definedTag value. Each validator performs validation steps in addition to the standard validation for definedTag values. For more information, see [Limits on Tags](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#Limits). */ validators: outputs.Identity.GetCostTrackingTagsTagValidator[]; } interface GetCostTrackingTagsTagValidator { /** * Specifies the type of validation: a static value (no validation) or a list. */ validatorType: string; /** * The list of allowed values for a definedTag value. */ values: string[]; } interface GetCustomerSecretKeysCustomerSecretKey { /** * The display name you assign to the secret key. Does not have to be unique, and it's changeable. */ displayName: string; /** * The access key portion of the key pair. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; key: string; /** * The secret key's current state. */ state: string; /** * Date and time the `CustomerSecretKey` object was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: `2016-08-25T21:10:29.600Z` */ timeExpires: string; /** * The OCID of the user. */ userId: string; } interface GetCustomerSecretKeysFilter { name: string; regex?: boolean; values: string[]; } interface GetDbCredentialsDbCredential { /** * The description you assign to the DB credential. Does not have to be unique, and it's changeable. */ description: string; /** * The OCID of the DB credential. */ id: string; lifecycleDetails: string; password: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Date and time the `DbCredential` object was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires. Example: `2016-08-25T21:10:29.600Z` */ timeExpires: string; /** * The OCID of the user. */ userId: string; } interface GetDbCredentialsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetDomainReplicaRegion { /** * A REPLICATION_ENABLED region, e.g. us-ashburn-1. See [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) for the full list of supported region names. */ region: string; /** * The current state. */ state: string; /** * Region agnostic domain URL. */ url: string; } interface GetDomainsAccountMgmtInfoApp { /** * If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App and only administrative operations can be performed. */ active: boolean; /** * Application icon. */ appIcon: string; /** * Application thumbnail. */ appThumbnail: string; /** * The base URI for all of the scopes defined in this App. The value of 'audience' is combined with the 'value' of each scope to form an 'fqs' or fully qualified scope. */ audience: string; /** * Application description */ description: string; /** * Resource Type display name */ display: string; /** * If true, this App is an AliasApp and it cannot be granted to an end user directly */ isAliasApp: boolean; /** * If true, sync from the managed app will be performed as authoritative sync. */ isAuthoritative: boolean; /** * If true, this App allows runtime services to log end users in to this App automatically */ isLoginTarget: boolean; /** * If true, indicates that access to this App requires an account. That is, in order to log in to the App, a User must use an application-specific identity that is maintained in the remote identity-repository of that App. */ isManagedApp: boolean; /** * If true, indicates that this application acts as an OAuth Resource. */ isOauthResource: boolean; /** * If true, this application is an Oracle Public Cloud service-instance. */ isOpcService: boolean; /** * If true, indicates that this application accepts an Oracle Identity Cloud Service user as a login-identity (does not require an account) and relies on authorization of the user's memberships in AppRoles */ isUnmanagedApp: boolean; /** * The protocol that runtime services will use to log end users in to this App automatically. If 'OIDC', then runtime services use the OpenID Connect protocol. If 'SAML', then runtime services use the Security Assertion Markup Language protocol. */ loginMechanism: string; /** * If true, customer is not billed for runtime operations of the app. */ meterAsOpcService: boolean; /** * UserWalletArtifact URI */ ref: string; /** * This Uniform Resource Name (URN) value identifies the type of Oracle Public Cloud service of which this app is an instance. */ serviceTypeUrn: string; /** * If true, this App will be displayed in the MyApps page of each end-user who has access to the App. */ showInMyApps: boolean; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfoIdcsCreatedBy { /** * Resource Type display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * UserWalletArtifact URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfoIdcsLastModifiedBy { /** * Resource Type display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * UserWalletArtifact URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfoMatchingOwner { /** * Resource Type display name */ display: string; /** * The email address of this user */ email: string; /** * UserWalletArtifact URI */ ref: string; /** * User name */ userName: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfoMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Resource Type of the Account */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAccountMgmtInfoObjectClass { /** * Resource Type display name */ display: string; /** * UserWalletArtifact URI */ ref: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfoOwner { /** * Resource Type display name */ display: string; /** * The email address of this user */ email: string; /** * UserWalletArtifact URI */ ref: string; /** * User name */ userName: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfoResourceType { /** * Resource Type display name */ display: string; /** * UserWalletArtifact URI */ ref: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfoTag { /** * Key or name of the tag. */ key: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfoUserWalletArtifact { /** * UserWalletArtifact URI */ ref: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfosAccountMgmtInfo { accountMgmtInfoId: string; /** * Type of Account */ accountType: string; /** * If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App and only administrative operations can be performed. */ active: boolean; /** * Application on which the account is based */ apps: outputs.Identity.GetDomainsAccountMgmtInfosAccountMgmtInfoApp[]; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * Unique key for this AccountMgmtInfo, which is used to prevent duplicate AccountMgmtInfo resources. Key is composed of a subset of app, owner and accountType. */ compositeKey: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * If true, a back-fill grant will not be created for a connected managed app as part of account creation. */ doNotBackFillGrants: boolean; /** * If true, the operation will not be performed on the target */ doNotPerformActionOnTarget: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * If true, this account has been marked as a favorite of the User who owns it */ favorite: boolean; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsAccountMgmtInfosAccountMgmtInfoIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsAccountMgmtInfosAccountMgmtInfoIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * If true, indicates that this managed object is an account, which is an identity that represents a user in the context of a specific application */ isAccount: boolean; /** * Last accessed timestamp of an application */ lastAccessed: string; /** * Matching owning users of the account */ matchingOwners: outputs.Identity.GetDomainsAccountMgmtInfosAccountMgmtInfoMatchingOwner[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsAccountMgmtInfosAccountMgmtInfoMeta[]; /** * Name of the Account */ name: string; /** * Object-class of the Account */ objectClasses: outputs.Identity.GetDomainsAccountMgmtInfosAccountMgmtInfoObjectClass[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The context in which the operation is performed on the account. */ operationContext: string; /** * Owning user of the account */ owners: outputs.Identity.GetDomainsAccountMgmtInfosAccountMgmtInfoOwner[]; /** * If true, then the response to the account creation operation on a connected managed app returns a preview of the account data that is evaluated by the attribute value generation policy. Note that an account will not be created on the target application when this attribute is set to true. */ previewOnly: boolean; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * Resource Type of the Account */ resourceTypes: outputs.Identity.GetDomainsAccountMgmtInfosAccountMgmtInfoResourceType[]; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Last recorded sync response for the account */ syncResponse: string; /** * Last recorded sync situation for the account */ syncSituation: string; /** * Last sync timestamp of the account */ syncTimestamp: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsAccountMgmtInfosAccountMgmtInfoTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Unique identifier of the Account */ uid: string; /** * The UserWalletArtifact that contains the credentials that the system will use when performing Secure Form-Fill to log the user in to this application */ userWalletArtifacts: outputs.Identity.GetDomainsAccountMgmtInfosAccountMgmtInfoUserWalletArtifact[]; } interface GetDomainsAccountMgmtInfosAccountMgmtInfoApp { /** * If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App and only administrative operations can be performed. */ active: boolean; /** * Application icon. */ appIcon: string; /** * Application thumbnail. */ appThumbnail: string; /** * The base URI for all of the scopes defined in this App. The value of 'audience' is combined with the 'value' of each scope to form an 'fqs' or fully qualified scope. */ audience: string; /** * Application description */ description: string; /** * Resource Type display name */ display: string; /** * If true, this App is an AliasApp and it cannot be granted to an end user directly */ isAliasApp: boolean; /** * If true, sync from the managed app will be performed as authoritative sync. */ isAuthoritative: boolean; /** * If true, this App allows runtime services to log end users in to this App automatically */ isLoginTarget: boolean; /** * If true, indicates that access to this App requires an account. That is, in order to log in to the App, a User must use an application-specific identity that is maintained in the remote identity-repository of that App. */ isManagedApp: boolean; /** * If true, indicates that this application acts as an OAuth Resource. */ isOauthResource: boolean; /** * If true, this application is an Oracle Public Cloud service-instance. */ isOpcService: boolean; /** * If true, indicates that this application accepts an Oracle Identity Cloud Service user as a login-identity (does not require an account) and relies on authorization of the user's memberships in AppRoles */ isUnmanagedApp: boolean; /** * The protocol that runtime services will use to log end users in to this App automatically. If 'OIDC', then runtime services use the OpenID Connect protocol. If 'SAML', then runtime services use the Security Assertion Markup Language protocol. */ loginMechanism: string; /** * If true, customer is not billed for runtime operations of the app. */ meterAsOpcService: boolean; /** * UserWalletArtifact URI */ ref: string; /** * This Uniform Resource Name (URN) value identifies the type of Oracle Public Cloud service of which this app is an instance. */ serviceTypeUrn: string; /** * If true, this App will be displayed in the MyApps page of each end-user who has access to the App. */ showInMyApps: boolean; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfosAccountMgmtInfoIdcsCreatedBy { /** * Resource Type display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * UserWalletArtifact URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfosAccountMgmtInfoIdcsLastModifiedBy { /** * Resource Type display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * UserWalletArtifact URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfosAccountMgmtInfoMatchingOwner { /** * Resource Type display name */ display: string; /** * The email address of this user */ email: string; /** * UserWalletArtifact URI */ ref: string; /** * User name */ userName: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfosAccountMgmtInfoMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Resource Type of the Account */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAccountMgmtInfosAccountMgmtInfoObjectClass { /** * Resource Type display name */ display: string; /** * UserWalletArtifact URI */ ref: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfosAccountMgmtInfoOwner { /** * Resource Type display name */ display: string; /** * The email address of this user */ email: string; /** * UserWalletArtifact URI */ ref: string; /** * User name */ userName: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfosAccountMgmtInfoResourceType { /** * Resource Type display name */ display: string; /** * UserWalletArtifact URI */ ref: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfosAccountMgmtInfoTag { /** * Key or name of the tag. */ key: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountMgmtInfosAccountMgmtInfoUserWalletArtifact { /** * UserWalletArtifact URI */ ref: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsAccountRecoverySettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAccountRecoverySettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAccountRecoverySettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAccountRecoverySettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsAccountRecoverySettingsAccountRecoverySetting { accountRecoverySettingId: string; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * The account recovery factor used (for example, email, mobile number (SMS), security questions, mobile application push or TOTP) to verify the identity of the user and reset the user's password. */ factors: string[]; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsAccountRecoverySettingsAccountRecoverySettingIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsAccountRecoverySettingsAccountRecoverySettingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Indicates how many minutes to disable account recovery for the user. The default value is 30 metric minutes. */ lockoutDuration: number; /** * Indicates the maximum number of failed account recovery attempts allowed for the user. */ maxIncorrectAttempts: number; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsAccountRecoverySettingsAccountRecoverySettingMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsAccountRecoverySettingsAccountRecoverySettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsAccountRecoverySettingsAccountRecoverySettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAccountRecoverySettingsAccountRecoverySettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAccountRecoverySettingsAccountRecoverySettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAccountRecoverySettingsAccountRecoverySettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsApiKeyIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsApiKeyIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsApiKeyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsApiKeyTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsApiKeyUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsApiKeysApiKey { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Fingerprint */ fingerprint: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsApiKeysApiKeyIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsApiKeysApiKeyIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Key or name of the tag. */ key: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsApiKeysApiKeyMeta[]; /** * The user's OCID. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsApiKeysApiKeyTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Controls whether a user can update themselves or not via User related APIs */ urnietfparamsscimschemasoracleidcsextensionselfChangeUsers: outputs.Identity.GetDomainsApiKeysApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser[]; /** * The user linked to the API key. */ users: outputs.Identity.GetDomainsApiKeysApiKeyUser[]; } interface GetDomainsApiKeysApiKeyIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsApiKeysApiKeyIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsApiKeysApiKeyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsApiKeysApiKeyTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsApiKeysApiKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsApiKeysApiKeyUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsAppAccount { /** * If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App, and only administrative operations can be performed. */ active: boolean; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * Owner identifier */ ownerId: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppAdminRole { /** * The description of the AppRole. */ description: string; /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppAliasApp { /** * The description of the AppRole. */ description: string; /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppAllowedScope { /** * The fully qualified value of this scope within this App. A fully qualified scope combines the 'value' of each scope with the value of 'audience'. Each value of 'fqs' must be unique across the system. Used only when this App acts as an OAuth Resource. */ fqs: string; /** * The ID of the App that defines this scope. */ idOfDefiningApp: string; /** * If true, indicates that this value must be protected. */ readOnly: boolean; } interface GetDomainsAppAllowedTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * If true, indicates that this value must be protected. */ readOnly: boolean; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppAppSignonPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppAppsNetworkPerimeter { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppAsOpcService { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppAttrRenderingMetadata { /** * Data type of the attribute. */ datatype: string; /** * Help text for the attribute. It can contain HTML tags. */ helptext: string; /** * Label for the attribute to be shown in the UI. */ label: string; /** * Maximum length of the attribute. */ maxLength: number; /** * Maximum size of the attribute. */ maxSize: number; /** * Minimum length of the attribute. */ minLength: number; /** * Minimum size of the attribute.. */ minSize: number; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * Display sequence of the bundle configuration property. */ order: number; /** * If true, indicates that this value must be protected. */ readOnly: boolean; /** * Regular expression of the attribute for validation. */ regexp: string; /** * If true, this flatfile bundle configuration property is required to connect to the target connected managed app. This attribute maps to \"isRequired\" attribute in \"ConfigurationProperty\" in ICF. */ required: boolean; /** * UI widget to use for the attribute. */ section: string; /** * Indicates whether the attribute is to be shown on the application creation UI. */ visible: boolean; /** * UI widget to use for the attribute. */ widget: string; } interface GetDomainsAppBasedOnTemplate { /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; /** * Unique well-known identifier used to reference connector bundle. */ wellKnownId: string; } interface GetDomainsAppCertificate { /** * Certificate alias */ certAlias: string; /** * Certificate kid */ kid: string; /** * sha1Thumbprint */ sha1thumbprint: string; /** * Base-64-encoded certificate. */ x509base64certificate: string; /** * Certificate x5t */ x5t: string; } interface GetDomainsAppCloudControlProperty { /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * The value(s) of the property. */ values: string[]; } interface GetDomainsAppEditableAttribute { /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; } interface GetDomainsAppGrant { /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * Grantee identifier */ granteeId: string; /** * Grantee resource type. Allowed values are User and Group. */ granteeType: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppGrantedAppRole { /** * If true, then this granted AppRole confers administrative privileges within the App that defines it. Otherwise, the granted AppRole confers only functional privileges. */ adminRole: boolean; /** * ID of the resource */ appId: string; /** * The name of the App that defines this AppRole, which is granted to this App. The App that defines the AppRole acts as the producer; the App to which the AppRole is granted acts as a consumer. */ appName: string; /** * Display-name of the AppRole. */ display: string; /** * The name of the legacy group associated with this AppRole. */ legacyGroupName: string; /** * If true, indicates that this value must be protected. */ readOnly: boolean; /** * URI of the AppRole. */ ref: string; /** * Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. */ type: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppIdcsCreatedBy { /** * Display-name of the AppRole. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * URI of the AppRole. */ ref: string; /** * Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. */ type: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppIdcsLastModifiedBy { /** * Display-name of the AppRole. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * URI of the AppRole. */ ref: string; /** * Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. */ type: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppIdentityProvider { /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppIdpPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Object class resource type */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAppProtectableSecondaryAudience { /** * If true, indicates that this value must be protected. */ readOnly: boolean; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppRadiusPolicy { _ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppRoleApp { /** * Member display name */ display: string; /** * Application name */ name: string; /** * The URI corresponding to the member Resource of this Group */ ref: string; /** * The serviceInstanceIdentifier of the App that defines this AppRole. This value will match the opcServiceInstanceGUID of any service-instance that the App represents. */ serviceInstanceIdentifier: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppRoleIdcsCreatedBy { /** * Member display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI corresponding to the member Resource of this Group */ ref: string; /** * Indicates the type of Resource--for example, User, Group or DynamicResourceGroup */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppRoleIdcsLastModifiedBy { /** * Member display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI corresponding to the member Resource of this Group */ ref: string; /** * Indicates the type of Resource--for example, User, Group or DynamicResourceGroup */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppRoleMember { /** * Member display name */ display: string; /** * The URI corresponding to the member Resource of this Group */ ref: string; /** * Indicates the type of Resource--for example, User, Group or DynamicResourceGroup */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppRoleMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAppRoleTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppRolesAppRole { /** * If true, the role provides administrative access privileges. */ adminRole: boolean; /** * A unique identifier for the application that references this role. */ apps: outputs.Identity.GetDomainsAppRolesAppRoleApp[]; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * If true, this AppRole can be granted to Apps. */ availableToClients: boolean; /** * If true, this AppRole can be granted to Groups. */ availableToGroups: boolean; /** * If true, this AppRole can be granted to Users. */ availableToUsers: boolean; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * AppRole description */ description: string; /** * AppRole name */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsAppRolesAppRoleIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsAppRolesAppRoleIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * The name of the legacy group associated with this AppRole. */ legacyGroupName: string; /** * If true, indicates that this Oracle Identity Cloud Service AppRole can be granted to a delegated administrator whose scope is limited to users that are members of one or more groups. */ limitedToOneOrMoreGroups: boolean; /** * AppRole localization name */ localizedDisplayName: string; /** * AppRole members - when requesting members attribute, it is recommended to use startIndex and count to return members in pages instead of in a single response, eg : #attributes=members[startIndex=1%26count=10] */ members: outputs.Identity.GetDomainsAppRolesAppRoleMember[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsAppRolesAppRoleMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * If true, this AppRole is available automatically to every Oracle Identity Cloud Service User in this tenancy. There is no need to grant it to individual Users or Groups. */ public: boolean; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsAppRolesAppRoleTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * AppRole unique name */ uniqueName: string; } interface GetDomainsAppRolesAppRoleApp { /** * Member display name */ display: string; /** * Application name */ name: string; /** * The URI corresponding to the member Resource of this Group */ ref: string; /** * The serviceInstanceIdentifier of the App that defines this AppRole. This value will match the opcServiceInstanceGUID of any service-instance that the App represents. */ serviceInstanceIdentifier: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppRolesAppRoleIdcsCreatedBy { /** * Member display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI corresponding to the member Resource of this Group */ ref: string; /** * Indicates the type of Resource--for example, User, Group or DynamicResourceGroup */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppRolesAppRoleIdcsLastModifiedBy { /** * Member display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI corresponding to the member Resource of this Group */ ref: string; /** * Indicates the type of Resource--for example, User, Group or DynamicResourceGroup */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppRolesAppRoleMember { /** * Member display name */ display: string; /** * The URI corresponding to the member Resource of this Group */ ref: string; /** * Indicates the type of Resource--for example, User, Group or DynamicResourceGroup */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppRolesAppRoleMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAppRolesAppRoleTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppSamlServiceProvider { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppScope { /** * The description of the AppRole. */ description: string; /** * Display name of the flatfile bundle configuration property. This attribute maps to \"displayName\" attribute in \"ConfigurationProperty\" in ICF. */ displayName: string; /** * The fully qualified value of this scope within this App. A fully qualified scope combines the 'value' of each scope with the value of 'audience'. Each value of 'fqs' must be unique across the system. Used only when this App acts as an OAuth Resource. */ fqs: string; /** * If true, indicates that this value must be protected. */ readOnly: boolean; /** * If true, indicates that a user must provide consent to access this scope. Note: Used only when this App acts as an OAuth Resource. */ requiresConsent: boolean; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppServiceParam { /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppSignonPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppTermsOfUse { /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppTrustPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionOciTag { /** * Oracle Cloud Infrastructure Defined Tags */ definedTags: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag[]; /** * Oracle Cloud Infrastructure Freeform Tags */ freeformTags: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag[]; /** * Oracle Cloud Infrastructure Tag slug */ tagSlug: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * Oracle Cloud Infrastructure Tag namespace */ namespace: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensiondbcsApp { /** * Description: */ domainApps: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensiondbcsAppDomainApp[]; /** * The name of the Enterprise Domain that contains any number of DBInstances. If specified, the value must be unique. A non-null value indicates that App represents a DBDomain. A value of null indicates that the App represents an DB-instance. */ domainName: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensiondbcsAppDomainApp { /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppApp { /** * Allow Authz policy decision expiry time in seconds. */ allowAuthzDecisionTtl: number; /** * Allow Authz Policy. */ allowAuthzPolicies: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAllowAuthzPolicy[]; /** * A list of AppResources of this App. */ appResources: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAppResource[]; /** * Deny Authz policy decision expiry time in seconds. */ denyAuthzDecisionTtl: number; /** * Deny Authz Policy. */ denyAuthzPolicies: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppDenyAuthzPolicy[]; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAllowAuthzPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAppResource { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppDenyAuthzPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppApp { /** * FormFill Application Configuration CLOB which has to be maintained in Form-Fill APP for legacy code to do Form-Fill injection */ configuration: string; /** * Indicates how FormFill obtains the username and password of the account that FormFill will use to sign into the target App. */ formCredMethod: string; /** * Credential Sharing Group to which this form-fill application belongs. */ formCredentialSharingGroupId: string; /** * A list of application-formURLs that FormFill should match against any formUrl that the user-specifies when signing in to the target service. Each item in the list also indicates how FormFill should interpret that formUrl. */ formFillUrlMatches: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppAppFormFillUrlMatch[]; /** * Type of the FormFill application like WebApplication, MainFrameApplication, WindowsApplication. Initially, we will support only WebApplication. */ formType: string; /** * If true, indicates that system is allowed to show the password in plain-text for this account after re-authentication. */ revealPasswordOnForm: boolean; /** * If true, indicates that each of the Form-Fill-related attributes that can be inherited from the template actually will be inherited from the template. If false, indicates that the AppTemplate disabled inheritance for these Form-Fill-related attributes. */ syncFromTemplate: boolean; /** * Indicates the custom expression, which can combine concat and substring operations with literals and with any attribute of the Oracle Identity Cloud Service User */ userNameFormExpression: string; /** * Format for generating a username. This value can be Username or Email Address; any other value will be treated as a custom expression. A custom expression may combine 'concat' and 'substring' operations with literals and with any attribute of the Oracle Identity Cloud Service user. */ userNameFormTemplate: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppAppFormFillUrlMatch { /** * An application formUrl that FormFill will match against any formUrl that a User enters in trying to access the target-service which this App represents. */ formUrl: string; /** * Indicates how to interpret the value of 'formUrl' when matching against a user-specified formUrl. The system currently supports only 'Exact', which indicates that the value of 'formUrl' should be treated as a literal value. */ formUrlMatchType: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplate { /** * FormFill Application Configuration CLOB which has to be maintained in Form-Fill APP for legacy code to do Form-Fill injection */ configuration: string; /** * Indicates how FormFill obtains the username and password of the account that FormFill will use to sign into the target App. */ formCredMethod: string; /** * Credential Sharing Group to which this form-fill application belongs. */ formCredentialSharingGroupId: string; /** * A list of application-formURLs that FormFill should match against any formUrl that the user-specifies when signing in to the target service. Each item in the list also indicates how FormFill should interpret that formUrl. */ formFillUrlMatches: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplateFormFillUrlMatch[]; /** * Type of the FormFill application like WebApplication, MainFrameApplication, WindowsApplication. Initially, we will support only WebApplication. */ formType: string; /** * If true, indicates that system is allowed to show the password in plain-text for this account after re-authentication. */ revealPasswordOnForm: boolean; /** * If true, indicates that each of the Form-Fill-related attributes that can be inherited from the template actually will be inherited from the template. If false, indicates that the AppTemplate disabled inheritance for these Form-Fill-related attributes. */ syncFromTemplate: boolean; /** * Indicates the custom expression, which can combine concat and substring operations with literals and with any attribute of the Oracle Identity Cloud Service User */ userNameFormExpression: string; /** * Format for generating a username. This value can be Username or Email Address; any other value will be treated as a custom expression. A custom expression may combine 'concat' and 'substring' operations with literals and with any attribute of the Oracle Identity Cloud Service user. */ userNameFormTemplate: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplateFormFillUrlMatch { /** * An application formUrl that FormFill will match against any formUrl that a User enters in trying to access the target-service which this App represents. */ formUrl: string; /** * Indicates how to interpret the value of 'formUrl' when matching against a user-specified formUrl. The system currently supports only 'Exact', which indicates that the value of 'formUrl' should be treated as a literal value. */ formUrlMatchType: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionkerberosRealmApp { /** * The type of salt that the system will use to encrypt Kerberos-specific artifacts of this App unless another type of salt is specified. */ defaultEncryptionSaltType: string; /** * The primary key that the system should use to encrypt artifacts that are specific to this Kerberos realm -- for example, to encrypt the Principal Key in each KerberosRealmUser. */ masterKey: string; /** * Max Renewable Age in seconds */ maxRenewableAge: number; /** * Max Ticket Life in seconds */ maxTicketLife: number; /** * The name of the Kerberos Realm that this App uses for authentication. */ realmName: string; /** * The types of salt that are available for the system to use when encrypting Kerberos-specific artifacts for this App. */ supportedEncryptionSaltTypes: string[]; /** * Ticket Flags */ ticketFlags: number; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappApp { /** * If true, then the account form will be displayed in the Oracle Identity Cloud Service UI to interactively create or update an account for this App. If a value is not specified for this attribute, a default value of \"false\" will be assumed as the value for this attribute. */ accountFormVisible: boolean; /** * If true, admin has granted consent to perform managed app run-time operations. */ adminConsentGranted: boolean; /** * ConnectorBundle configuration properties */ bundleConfigurationProperties: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundleConfigurationProperty[]; /** * Configurable options maintaining a pool of ICF connector instances. Values for sub attributes can be set only if the ConnectorBundle referenced in the App has connectorPoolingSupported set to true */ bundlePoolConfigurations: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundlePoolConfiguration[]; /** * If true, the managed app can be authoritative. */ canBeAuthoritative: boolean; /** * If true, the accounts of the application are managed through an ICF connector bundle */ connected: boolean; /** * ConnectorBundle */ connectorBundles: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppConnectorBundle[]; /** * If true, send activation email to new users created from authoritative sync. */ enableAuthSyncNewUserNotification: boolean; /** * If true, sync run-time operations are enabled for this App. */ enableSync: boolean; /** * If true, send sync summary as notification upon job completion. */ enableSyncSummaryReportNotification: boolean; /** * Flat file connector bundle configuration properties */ flatFileBundleConfigurationProperties: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileBundleConfigurationProperty[]; /** * Flat file connector bundle to sync from a flat file. */ flatFileConnectorBundles: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileConnectorBundle[]; /** * IdentityBridges associated with this App */ identityBridges: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppIdentityBridge[]; /** * If true, sync from the managed app will be performed as authoritative sync. */ isAuthoritative: boolean; /** * If true, the managed app is a directory. */ isDirectory: boolean; /** * If true, the managed app is an On-Premise app. */ isOnPremiseApp: boolean; /** * If true, the managed app supports schema customization. */ isSchemaCustomizationSupported: boolean; /** * If true, the managed app supports schema discovery. */ isSchemaDiscoverySupported: boolean; /** * If true, the managed app requires 3-legged OAuth for authorization. */ isThreeLeggedOauthEnabled: boolean; /** * If true, indicates that Oracle Identity Cloud Service can use two-legged OAuth to connect to this ManagedApp. */ isTwoLeggedOauthEnabled: boolean; /** * Object classes */ objectClasses: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppObjectClass[]; /** * The most recent DateTime that the configuration of this App was updated. AppServices updates this timestamp whenever AppServices updates an App's configuration with respect to synchronization. */ syncConfigLastModified: string; /** * The value of this attribute persists any OAuth access token that the system uses to connect to this ManagedApp. The system obtains this access token using an OAuth protocol flow that could be two-legged or three-legged. A two-legged flow involves only the requester and the server. A three-legged flow also requires the consent of a user -- in this case the consent of an administrator. */ threeLeggedOauthCredentials: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppThreeLeggedOauthCredential[]; /** * Three legged OAuth provider name in Oracle Identity Cloud Service. */ threeLeggedOauthProviderName: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundleConfigurationProperty { /** * If true, this flatfile bundle configuration property value is confidential and will be encrypted in Oracle Identity Cloud Service. This attribute maps to \"isConfidential\" attribute in \"ConfigurationProperty\" in ICF. */ confidential: boolean; /** * Display name of the flatfile bundle configuration property. This attribute maps to \"displayName\" attribute in \"ConfigurationProperty\" in ICF. */ displayName: string; /** * Help message of the flatfile bundle configuration property. This attribute maps to \"helpMessage\" attribute in \"ConfigurationProperty\" in ICF. */ helpMessage: string; /** * ICF data type of flatfile the bundle configuration property. This attribute maps to \"type\" attribute in \"ConfigurationProperty\" in ICF. */ icfType: string; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * Display sequence of the bundle configuration property. */ order: number; /** * If true, this flatfile bundle configuration property is required to connect to the target connected managed app. This attribute maps to \"isRequired\" attribute in \"ConfigurationProperty\" in ICF. */ required: boolean; /** * ID of the AppRole. */ values: string[]; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundlePoolConfiguration { /** * Maximum number of connector instances in the pool that are idle and active. */ maxIdle: number; /** * Maximum number of connector instances in the pool that are idle and active. */ maxObjects: number; /** * Maximum time (in milliseconds) to wait for a free connector instance to become available before failing. */ maxWait: number; /** * Minimum time (in milliseconds) to wait before evicting an idle conenctor instance from the pool. */ minEvictableIdleTimeMillis: number; /** * Minimum number of idle connector instances in the pool. */ minIdle: number; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppConnectorBundle { /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. */ type: string; /** * ID of the AppRole. */ value: string; /** * Unique well-known identifier used to reference connector bundle. */ wellKnownId: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileBundleConfigurationProperty { /** * If true, this flatfile bundle configuration property value is confidential and will be encrypted in Oracle Identity Cloud Service. This attribute maps to \"isConfidential\" attribute in \"ConfigurationProperty\" in ICF. */ confidential: boolean; /** * Display name of the flatfile bundle configuration property. This attribute maps to \"displayName\" attribute in \"ConfigurationProperty\" in ICF. */ displayName: string; /** * Help message of the flatfile bundle configuration property. This attribute maps to \"helpMessage\" attribute in \"ConfigurationProperty\" in ICF. */ helpMessage: string; /** * ICF data type of flatfile the bundle configuration property. This attribute maps to \"type\" attribute in \"ConfigurationProperty\" in ICF. */ icfType: string; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * Display sequence of the bundle configuration property. */ order: number; /** * If true, this flatfile bundle configuration property is required to connect to the target connected managed app. This attribute maps to \"isRequired\" attribute in \"ConfigurationProperty\" in ICF. */ required: boolean; /** * ID of the AppRole. */ values: string[]; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileConnectorBundle { /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; /** * Unique well-known identifier used to reference connector bundle. */ wellKnownId: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppIdentityBridge { /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppObjectClass { /** * Display-name of the AppRole. */ display: string; /** * If true, the object class represents an account. The isAccountObjectClass attribute value 'true' MUST appear no more than once. */ isAccountObjectClass: boolean; /** * URI of the AppRole. */ ref: string; /** * Object class resource type */ resourceType: string; /** * Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. */ type: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppThreeLeggedOauthCredential { /** * Access Token */ accessToken: string; /** * Access token expiry */ accessTokenExpiry: string; /** * Refresh Token */ refreshToken: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionmulticloudServiceAppApp { /** * The multicloud platform service URL which the application will invoke for runtime operations such as AWSCredentials api invocation */ multicloudPlatformUrl: string; /** * Specifies the service type for which the application is configured for multicloud integration. For applicable external service types, app will invoke multicloud service for runtime operations */ multicloudServiceType: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionopcServiceApp { /** * Current Federation Mode */ currentFederationMode: string; /** * Current Synchronization Mode */ currentSynchronizationMode: string; /** * If true, indicates that enablement is in progress started but not completed */ enablingNextFedSyncModes: boolean; /** * Next Federation Mode */ nextFederationMode: string; /** * Next Synchronization Mode */ nextSynchronizationMode: string; /** * This value identifies the OPC region in which the service is running. */ region: string; /** * This value specifies the unique identifier assigned to an instance of an Oracle Public Cloud service app. */ serviceInstanceIdentifier: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionradiusAppApp { /** * If true, capture the client IP address from the RADIUS request packet. IP Address is used for auditing, policy-evaluation and country-code calculation. */ captureClientIp: boolean; /** * This is the IP address of the RADIUS Client like Oracle Database server. It can be only IP address and not hostname. */ clientIp: string; /** * Vendor-specific identifier of the attribute in the RADIUS response that will contain the end-user's country code. This is an integer-value in the range 1 to 255 */ countryCodeResponseAttributeId: string; /** * The name of the attribute that contains the Internet Protocol address of the end-user. */ endUserIpAttribute: string; /** * RADIUS attribute that RADIUS-enabled system uses to pass the group membership */ groupMembershipRadiusAttribute: string; /** * In a successful authentication response, Oracle Identity Cloud Service will pass user's group information restricted to groups persisted in this attribute, in the specified RADIUS attribute. */ groupMembershipToReturns: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionradiusAppAppGroupMembershipToReturn[]; /** * Configure the groupNameFormat based on vendor in order to pass it to RADIUS infra */ groupNameFormat: string; /** * Indicates to include groups in RADIUS response */ includeGroupInResponse: boolean; /** * Indicates if password and OTP are passed in the same sign-in request or not. */ passwordAndOtpTogether: boolean; /** * This is the port of RADIUS Proxy which RADIUS client will connect to. */ port: string; /** * ID used to identify a particular vendor. */ radiusVendorSpecificId: string; /** * Configure the responseFormat based on vendor in order to pass it to RADIUS infra */ responseFormat: string; /** * The delimiter used if group membership responseFormat is a delimited list instead of repeating attributes */ responseFormatDelimiter: string; /** * Secret key used to secure communication between RADIUS Proxy and RADIUS client */ secretKey: string; /** * Value consists of type of RADIUS App. Type can be Oracle Database, VPN etc */ typeOfRadiusApp: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionradiusAppAppGroupMembershipToReturn { /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionrequestableApp { /** * Flag controlling whether resource can be request by user through self service console. */ requestable: boolean; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderApp { /** * The attribute represents the URL to which the SAML Assertions will be sent by the SAML IdP. */ assertionConsumerUrl: string; /** * If true, indicates that the system must encrypt the Security Assertion Markup Language (SAML) assertion. */ encryptAssertion: boolean; /** * This attribute indicates the encryption algorithm used to encrypt the SAML assertion. */ encryptionAlgorithm: string; /** * This attribute represents the encryption certificate that an App uses to encrypt the Security Assertion Markup Language (SAML) assertion. */ encryptionCertificate: string; /** * Specifies the preferred federation protocol (SAML2.0 or WS-Fed1.1). */ federationProtocol: string; /** * Each value of this attribute describes an attribute of Group that will be sent in a Security Assertion Markup Language (SAML) assertion. */ groupAssertionAttributes: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppGroupAssertionAttribute[]; /** * Hok Assertion Consumer Service Url */ hokAcsUrl: string; /** * If enabled, then the SAML Service supports Hok for this App. */ hokRequired: boolean; /** * If true, then the signing certificate is included in the signature. */ includeSigningCertInSignature: boolean; /** * This attribute indicates the key encryption algorithm. */ keyEncryptionAlgorithm: string; /** * Records the notification timestamp for the SP whose signing certificate is about to expire. */ lastNotificationSentTime: string; /** * This attribute represents the HTTP binding that would be used while logout. */ logoutBinding: string; /** * If true, then the SAML Service supports logout for this App. */ logoutEnabled: boolean; /** * The URL to which the partner sends the logout request. */ logoutRequestUrl: string; /** * The URL to which the partner sends the logout response. */ logoutResponseUrl: string; /** * This attribute represents the metadata of a Security Provider in the Security Assertion Markup Language protocol. */ metadata: string; /** * This can be any string, but there are a set of standard nameIdFormats. If a nameIdFormat other than the standard list is chosen, it will be considered a custom nameidformat. The standard nameidformats include: saml-x509, saml-emailaddress, saml-windowsnamequalifier, saml-kerberos, saml-persistent, saml-transient, saml-unspecified, saml-none, and saml-persistent-opaque. */ nameIdFormat: string; /** * **Deprecated Since: 18.2.2** */ nameIdUserstoreAttribute: string; /** * Use to construct the outgoing SAML attributes */ outboundAssertionAttributes: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppOutboundAssertionAttribute[]; /** * The ID of the Provider. This value corresponds to the entityID from the Service Provider metadata. */ partnerProviderId: string; /** * The pattern of the Provider. This value corresponds to the entityID from the Service Provider metadata. */ partnerProviderPattern: string; /** * Indicates which part of the response should be signed. A value of \"Assertion\" indicates that the Assertion should be signed. A value of \"Response\" indicates that the SSO Response should be signed. A value of \"AssertionAndResponse\" indicates that both the Assertion and the SSO Response should be signed. */ signResponseOrAssertion: string; /** * This attribute represents the algorithm used to hash the signature. */ signatureHashAlgorithm: string; /** * This attribute represents the signing certificate that an App uses to verify the signed authentication request. */ signingCertificate: string; /** * This attribute represents the Succinct ID. */ succinctId: string; /** * The alternate Provider ID to be used as the Oracle Identity Cloud Service providerID (instead of the one in SamlSettings) when interacting with this SP. */ tenantProviderId: string; /** * Each value of this attribute describes an attribute of User that will be sent in a Security Assertion Markup Language (SAML) assertion. */ userAssertionAttributes: outputs.Identity.GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppUserAssertionAttribute[]; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppGroupAssertionAttribute { /** * Indicates the filter types that are supported for the Group assertion attributes. */ condition: string; /** * Indicates the format of the assertion attribute. */ format: string; /** * Indicates the group name that are supported for the group assertion attributes. */ groupName: string; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppOutboundAssertionAttribute { /** * Mapped Attribute Direction */ direction: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppUserAssertionAttribute { /** * Indicates the format of the assertion attribute. */ format: string; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * This attribute specifies which user attribute should be used to create the value of the SAML assertion attribute. The userstore attribute can be constructed by using attributes from the Oracle Identity Cloud Service Core Users schema.
Note: Attributes from extensions to the Core User schema are not supported in v1.0. */ userStoreAttributeName: string; } interface GetDomainsAppUrnietfparamsscimschemasoracleidcsextensionwebTierPolicyApp { /** * If this Attribute is true, resource ref id and resource ref name attributes will we included in wtp json response. */ resourceRef: boolean; /** * Webtier policy AZ Control */ webTierPolicyAzControl: string; /** * Store the web tier policy for an application as a string in Javascript Object Notification (JSON) format. */ webTierPolicyJson: string; } interface GetDomainsAppUserRole { /** * The description of the AppRole. */ description: string; /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsApprovalWorkflowApprovalWorkflowStep { /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The order of the ApprovalWorkflowSteps. */ order: number; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowAssignmentApprovalWorkflow { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowAssignmentAssignedTo { /** * Description */ description: string; /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowAssignmentIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowAssignmentIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowAssignmentMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsApprovalWorkflowAssignmentTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignment { /** * Details of the Approval Workflow */ approvalWorkflows: outputs.Identity.GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentApprovalWorkflow[]; /** * Details of resource for which Approval Workflow is assigned */ assignedTos: outputs.Identity.GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentAssignedTo[]; /** * Type of approval workflow assignment to the resource. Resources like Group have only one workflow associated (default assignment type is membership), but resources like TemporalBusinessRole can have atleast 2 AWs attached, one for membership to TPR, another for activation of that TPR membership */ assignmentType: string; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentApprovalWorkflow { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentAssignedTo { /** * Description */ description: string; /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsApprovalWorkflowAssignmentsApprovalWorkflowAssignmentTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowMaxDuration { /** * The unit of the max duration. */ unit: string; /** * Value of the tag. */ value: number; } interface GetDomainsApprovalWorkflowMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsApprovalWorkflowStepApprover { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Type of ApprovalWorkflowStep */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowStepIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Type of ApprovalWorkflowStep */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowStepIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Type of ApprovalWorkflowStep */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowStepMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsApprovalWorkflowStepTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowStepsApprovalWorkflowStep { /** * Approvers of the ApprovalWorkflowStep. */ approvers: outputs.Identity.GetDomainsApprovalWorkflowStepsApprovalWorkflowStepApprover[]; /** * approversExpressions of ApprovalWorkflowStep */ approversExpressions: string[]; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsApprovalWorkflowStepsApprovalWorkflowStepIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsApprovalWorkflowStepsApprovalWorkflowStepIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsApprovalWorkflowStepsApprovalWorkflowStepMeta[]; /** * Minimum number of Approvals required for this step. */ minimumApprovals: number; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Order of the ApprovalWorkflowStep. */ order: number; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsApprovalWorkflowStepsApprovalWorkflowStepTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Type of ApprovalWorkflowStep */ type: string; } interface GetDomainsApprovalWorkflowStepsApprovalWorkflowStepApprover { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Type of ApprovalWorkflowStep */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowStepsApprovalWorkflowStepIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Type of ApprovalWorkflowStep */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowStepsApprovalWorkflowStepIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Type of ApprovalWorkflowStep */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowStepsApprovalWorkflowStepMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsApprovalWorkflowStepsApprovalWorkflowStepTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowsApprovalWorkflow { /** * ApprovalWorkflowSteps applicable for the ApprovalWorkflowInstance. */ approvalWorkflowSteps: outputs.Identity.GetDomainsApprovalWorkflowsApprovalWorkflowApprovalWorkflowStep[]; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description of the ApprovalWorkflow. */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsApprovalWorkflowsApprovalWorkflowIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsApprovalWorkflowsApprovalWorkflowIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Max duration of the ApprovalWorkflow must be acted at all levels. */ maxDurations: outputs.Identity.GetDomainsApprovalWorkflowsApprovalWorkflowMaxDuration[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsApprovalWorkflowsApprovalWorkflowMeta[]; /** * Name of the ApprovalWorkflow. */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsApprovalWorkflowsApprovalWorkflowTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsApprovalWorkflowsApprovalWorkflowApprovalWorkflowStep { /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The order of the ApprovalWorkflowSteps. */ order: number; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowsApprovalWorkflowIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowsApprovalWorkflowIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsApprovalWorkflowsApprovalWorkflowMaxDuration { /** * The unit of the max duration. */ unit: string; /** * Value of the tag. */ value: number; } interface GetDomainsApprovalWorkflowsApprovalWorkflowMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsApprovalWorkflowsApprovalWorkflowTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsAppsApp { /** * Access token expiry */ accessTokenExpiry: number; /** * Accounts of App */ accounts: outputs.Identity.GetDomainsAppsAppAccount[]; /** * If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App, and only administrative operations can be performed. */ active: boolean; /** * A list of AppRoles defined by this UnmanagedApp. Membership in each of these AppRoles confers administrative privilege within this App. */ adminRoles: outputs.Identity.GetDomainsAppsAppAdminRole[]; /** * Each value of this internal attribute refers to an Oracle Public Cloud infrastructure App on which this App depends. */ aliasApps: outputs.Identity.GetDomainsAppsAppAliasApp[]; /** * If true, indicates that the system should allow all URL-schemes within each value of the 'redirectUris' attribute. Also indicates that the system should not attempt to confirm that each value of the 'redirectUris' attribute is a valid URI. In particular, the system should not confirm that the domain component of the URI is a top-level domain and the system should not confirm that the hostname portion is a valid system that is reachable over the network. */ allUrlSchemesAllowed: boolean; /** * If true, any managed App that is based on this template is checked for access control that is, access to this app is subject to successful authorization at SSO service, viz. app grants to start with. */ allowAccessControl: boolean; /** * If true, indicates that the Refresh Token is allowed when this App acts as an OAuth Resource. */ allowOffline: boolean; /** * List of grant-types that this App is allowed to use when it acts as an OAuthClient. */ allowedGrants: string[]; /** * OPTIONAL. Required only when this App acts as an OAuthClient. Supported values are 'introspect' and 'onBehalfOfUser'. The value 'introspect' allows the client to look inside the access-token. The value 'onBehalfOfUser' overrides how the client's privileges are combined with the privileges of the Subject User. Ordinarily, authorization calculates the set of effective privileges as the intersection of the client's privileges and the user's privileges. The value 'onBehalfOf' indicates that authorization should ignore the privileges of the client and use only the user's privileges to calculate the effective privileges. */ allowedOperations: string[]; /** * A list of scopes (exposed by this App or by other Apps) that this App is allowed to access when it acts as an OAuthClient. */ allowedScopes: outputs.Identity.GetDomainsAppsAppAllowedScope[]; /** * A list of tags, acting as an OAuthClient, this App is allowed to access. */ allowedTags: outputs.Identity.GetDomainsAppsAppAllowedTag[]; /** * Application icon. */ appIcon: string; /** * App Sign-on Policy. */ appSignonPolicies: outputs.Identity.GetDomainsAppsAppAppSignonPolicy[]; /** * Application thumbnail. */ appThumbnail: string; /** * Network Perimeter */ appsNetworkPerimeters: outputs.Identity.GetDomainsAppsAppAppsNetworkPerimeter[]; /** * OPCService facet of the application. */ asOpcServices: outputs.Identity.GetDomainsAppsAppAsOpcService[]; /** * Label for the attribute to be shown in the UI. */ attrRenderingMetadatas: outputs.Identity.GetDomainsAppsAppAttrRenderingMetadata[]; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The base URI for all of the scopes defined in this App. The value of 'audience' is combined with the 'value' of each scope to form an 'fqs' or fully qualified scope. */ audience: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Application template on which the application is based. */ basedOnTemplates: outputs.Identity.GetDomainsAppsAppBasedOnTemplate[]; /** * If true, indicates that consent should be skipped for all scopes */ bypassConsent: boolean; /** * Callback Service URL */ callbackServiceUrl: string; /** * Each value of this attribute represent a certificate that this App uses when it acts as an OAuthClient. */ certificates: outputs.Identity.GetDomainsAppsAppCertificate[]; /** * Network Perimeters checking mode */ clientIpChecking: string; /** * This value is the credential of this App, which this App supplies as a password when this App authenticates to the Oracle Public Cloud infrastructure. This value is also the client secret of this App when it acts as an OAuthClient. */ clientSecret: string; /** * Specifies the type of access that this App has when it acts as an OAuthClient. */ clientType: string; /** * A collection of arbitrary properties that scope the privileges of a cloud-control App. */ cloudControlProperties: outputs.Identity.GetDomainsAppsAppCloudControlProperty[]; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * Contact Email Address */ contactEmailAddress: string; /** * Service Names allow to use Oracle Cloud Infrastructure signature for client authentication instead of client credentials */ delegatedServiceNames: string[]; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * The description of the AppRole. */ description: string; /** * Indicates whether the application is allowed to be access using kmsi token. */ disableKmsiTokenAuthentication: boolean; /** * Display name of the flatfile bundle configuration property. This attribute maps to \"displayName\" attribute in \"ConfigurationProperty\" in ICF. */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * App attributes editable by subject */ editableAttributes: outputs.Identity.GetDomainsAppsAppEditableAttribute[]; /** * This attribute specifies the URL of the page to which an application will redirect an end-user in case of error. */ errorPageUrl: string; forceDelete: boolean; /** * A list of AppRoles that are granted to this App (and that are defined by other Apps). Within the Oracle Public Cloud infrastructure, this allows AppID-based association. Such an association allows this App to act as a consumer and thus to access resources of another App that acts as a producer. */ grantedAppRoles: outputs.Identity.GetDomainsAppsAppGrantedAppRole[]; /** * Grants assigned to the app */ grants: outputs.Identity.GetDomainsAppsAppGrant[]; /** * Hashed Client Secret. This hash-value is used to verify the 'clientSecret' credential of this App */ hashedClientSecret: string; /** * Home Page URL */ homePageUrl: string; /** * URL of application icon. */ icon: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * Encryption Alogrithm to use for encrypting ID token. */ idTokenEncAlgo: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsAppsAppIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsAppsAppIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A list of IdentityProvider assigned to app. A user trying to access this app will be automatically redirected to configured IdP during the authentication phase, before being able to access App. */ identityProviders: outputs.Identity.GetDomainsAppsAppIdentityProvider[]; /** * IDP Policy. */ idpPolicies: outputs.Identity.GetDomainsAppsAppIdpPolicy[]; /** * If true, this App is an internal infrastructure App. */ infrastructure: boolean; /** * If true, this App is an AliasApp and it cannot be granted to an end-user directly. */ isAliasApp: boolean; /** * If true, this application acts as database service Application */ isDatabaseService: boolean; /** * If true, this app acts as Enterprise app with Authentication and URL Authz policy. */ isEnterpriseApp: boolean; /** * If true, this application acts as FormFill Application */ isFormFill: boolean; /** * If true, indicates that this App supports Kerberos Authentication */ isKerberosRealm: boolean; /** * If true, this App allows runtime services to log end users into this App automatically. */ isLoginTarget: boolean; /** * If true, indicates that access to this App requires an account. That is, in order to log in to the App, a User must use an application-specific identity that is maintained in the remote identity-repository of that App. */ isManagedApp: boolean; /** * If true, indicates that the App should be visible in each end-user's mobile application. */ isMobileTarget: boolean; /** * If true, indicates the app is used for multicloud service integration. */ isMulticloudServiceApp: boolean; /** * If true, this application acts as an OAuth Client */ isOauthClient: boolean; /** * If true, indicates that this application acts as an OAuth Resource. */ isOauthResource: boolean; /** * This flag indicates if the App is capable of validating obligations with the token for allowing access to the App. */ isObligationCapable: boolean; /** * If true, this application is an Oracle Public Cloud service-instance. */ isOpcService: boolean; /** * If true, this application acts as an Radius App */ isRadiusApp: boolean; /** * If true, then this App acts as a SAML Service Provider. */ isSamlServiceProvider: boolean; /** * If true, indicates that this application accepts an Oracle Cloud Identity Service User as a login-identity (does not require an account) and relies for authorization on the User's memberships in AppRoles. */ isUnmanagedApp: boolean; /** * If true, the webtier policy is active */ isWebTierPolicy: boolean; /** * The URL of the landing page for this App, which is the first page that an end user should see if runtime services log that end user in to this App automatically. */ landingPageUrl: string; /** * This attribute specifies the callback URL for the social linking operation. */ linkingCallbackUrl: string; /** * The protocol that runtime services will use to log end users in to this App automatically. If 'OIDC', then runtime services use the OpenID Connect protocol. If 'SAML', then runtime services use Security Assertion Markup Language protocol. */ loginMechanism: string; /** * This attribute specifies the URL of the page that the App uses when an end-user signs in to that App. */ loginPageUrl: string; /** * This attribute specifies the URL of the page that the App uses when an end-user signs out. */ logoutPageUrl: string; /** * OAuth will use this URI to logout if this App wants to participate in SSO, and if this App's session gets cleared as part of global logout. Note: This attribute is used only if this App acts as an OAuthClient. */ logoutUri: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsAppsAppMeta[]; /** * Indicates whether the application is billed as an OPCService. If true, customer is not billed for runtime operations of the app. */ meterAsOpcService: boolean; /** * If true, this App was migrated from an earlier version of Oracle Public Cloud infrastructure (and may therefore require special handling from runtime services such as OAuth or SAML). If false, this App requires no special handling from runtime services. */ migrated: boolean; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Each value of this attribute is the URI of a landing page within this App. It is used only when this App, acting as an OAuthClient, initiates the logout flow and wants to be redirected back to one of its landing pages. */ postLogoutRedirectUris: string[]; /** * Privacy Policy URL */ privacyPolicyUrl: string; /** * Application Logo URL */ productLogoUrl: string; /** * Product Name */ productName: string; /** * A list of secondary audiences--additional URIs to be added automatically to any OAuth token that allows access to this App. Note: This attribute is used mainly for backward compatibility in certain Oracle Public Cloud Apps. */ protectableSecondaryAudiences: outputs.Identity.GetDomainsAppsAppProtectableSecondaryAudience[]; /** * RADIUS Policy assigned to this application. */ radiusPolicies: outputs.Identity.GetDomainsAppsAppRadiusPolicy[]; /** * If true, this App requires an upgrade and mandates attention from application administrator. The flag is used by UI to indicate this app is ready to upgrade. */ readyToUpgrade: boolean; /** * OPTIONAL. Each value is a URI within this App. This attribute is required when this App acts as an OAuthClient and is involved in three-legged flows (authorization-code flows). */ redirectUris: string[]; /** * Expiry-time in seconds for a Refresh Token. Any token that allows access to this App, once refreshed, will expire after the specified duration. */ refreshTokenExpiry: number; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * An attribute that refers to the SAML Service Provider that runtime services will use to log an end user in to this App automatically. Note that this will be used only if the loginMechanism is 'SAML'. */ samlServiceProviders: outputs.Identity.GetDomainsAppsAppSamlServiceProvider[]; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Scopes defined by this App. Used when this App acts as an OAuth Resource. */ scopes: outputs.Identity.GetDomainsAppsAppScope[]; /** * A list of secondary audiences--additional URIs to be added automatically to any OAuth token that allows access to this App. Note: This attribute is used mainly for backward compatibility in certain Oracle Public Cloud Apps. */ secondaryAudiences: string[]; /** * Custom attribute that is required to compute other attribute values during app creation. */ serviceParams: outputs.Identity.GetDomainsAppsAppServiceParam[]; /** * This Uniform Resource Name (URN) value identifies the type of Oracle Public Cloud service of which this app is an instance. */ serviceTypeUrn: string; /** * This value specifies the version of the Oracle Public Cloud service of which this App is an instance */ serviceTypeVersion: string; /** * If true, this app will be displayed in the MyApps page of each end-user who has access to the App. */ showInMyApps: boolean; /** * Sign-on Policy. */ signonPolicies: outputs.Identity.GetDomainsAppsAppSignonPolicy[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsAppsAppTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Terms of Service URL */ termsOfServiceUrl: string; /** * Terms Of Use. */ termsOfUses: outputs.Identity.GetDomainsAppsAppTermsOfUse[]; /** * Trust Policies. */ trustPolicies: outputs.Identity.GetDomainsAppsAppTrustPolicy[]; /** * Indicates the scope of trust for this App when acting as an OAuthClient. A value of 'Explicit' indicates that the App is allowed to access only the scopes of OAuthResources that are explicitly specified as 'allowedScopes'. A value of 'Account' indicates that the App is allowed implicitly to access any scope of any OAuthResource within the same Oracle Cloud Account. A value of 'Tags' indicates that the App is allowed to access any scope of any OAuthResource with a matching tag within the same Oracle Cloud Account. A value of 'Default' indicates that the Tenant default trust scope configured in the Tenant Settings is used. */ trustScope: string; /** * Oracle Cloud Infrastructure Tags. */ urnietfparamsscimschemasoracleidcsextensionOciTags: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionOciTag[]; /** * This extension provides attributes for database service facet of an App */ urnietfparamsscimschemasoracleidcsextensiondbcsApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensiondbcsApp[]; /** * This extension defines the Enterprise App related attributes. */ urnietfparamsscimschemasoracleidcsextensionenterpriseAppApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppApp[]; /** * This extension provides attributes for Form-Fill facet of App */ urnietfparamsscimschemasoracleidcsextensionformFillAppApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppApp[]; /** * This extension provides attributes for Form-Fill facet of AppTemplate */ urnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplates: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplate[]; /** * Kerberos Realm */ urnietfparamsscimschemasoracleidcsextensionkerberosRealmApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionkerberosRealmApp[]; /** * Managed App */ urnietfparamsscimschemasoracleidcsextensionmanagedappApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappApp[]; /** * This extension defines attributes specific to Apps that represent instances of Multicloud Service App */ urnietfparamsscimschemasoracleidcsextensionmulticloudServiceAppApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmulticloudServiceAppApp[]; /** * This extension defines attributes specific to Apps that represent instances of an Oracle Public Cloud (OPC) service. */ urnietfparamsscimschemasoracleidcsextensionopcServiceApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionopcServiceApp[]; /** * This extension defines attributes specific to Apps that represent instances of Radius App. */ urnietfparamsscimschemasoracleidcsextensionradiusAppApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionradiusAppApp[]; /** * Requestable App */ urnietfparamsscimschemasoracleidcsextensionrequestableApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionrequestableApp[]; /** * This extension defines attributes related to the Service Providers configuration. */ urnietfparamsscimschemasoracleidcsextensionsamlServiceProviderApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderApp[]; /** * WebTier Policy */ urnietfparamsscimschemasoracleidcsextensionwebTierPolicyApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionwebTierPolicyApp[]; /** * A list of AppRoles defined by this UnmanagedApp. Membership in each of these AppRoles confers end-user privilege within this App. */ userRoles: outputs.Identity.GetDomainsAppsAppUserRole[]; } interface GetDomainsAppsAppAccount { /** * If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App, and only administrative operations can be performed. */ active: boolean; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * Owner identifier */ ownerId: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppAdminRole { /** * The description of the AppRole. */ description: string; /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppAliasApp { /** * The description of the AppRole. */ description: string; /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppAllowedScope { /** * The fully qualified value of this scope within this App. A fully qualified scope combines the 'value' of each scope with the value of 'audience'. Each value of 'fqs' must be unique across the system. Used only when this App acts as an OAuth Resource. */ fqs: string; /** * The ID of the App that defines this scope. */ idOfDefiningApp: string; /** * If true, indicates that this value must be protected. */ readOnly: boolean; } interface GetDomainsAppsAppAllowedTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * If true, indicates that this value must be protected. */ readOnly: boolean; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppAppSignonPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppAppsNetworkPerimeter { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppAsOpcService { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppAttrRenderingMetadata { /** * Data type of the attribute. */ datatype: string; /** * Help text for the attribute. It can contain HTML tags. */ helptext: string; /** * Label for the attribute to be shown in the UI. */ label: string; /** * Maximum length of the attribute. */ maxLength: number; /** * Maximum size of the attribute. */ maxSize: number; /** * Minimum length of the attribute. */ minLength: number; /** * Minimum size of the attribute.. */ minSize: number; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * Display sequence of the bundle configuration property. */ order: number; /** * If true, indicates that this value must be protected. */ readOnly: boolean; /** * Regular expression of the attribute for validation. */ regexp: string; /** * If true, this flatfile bundle configuration property is required to connect to the target connected managed app. This attribute maps to \"isRequired\" attribute in \"ConfigurationProperty\" in ICF. */ required: boolean; /** * UI widget to use for the attribute. */ section: string; /** * Indicates whether the attribute is to be shown on the application creation UI. */ visible: boolean; /** * UI widget to use for the attribute. */ widget: string; } interface GetDomainsAppsAppBasedOnTemplate { /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; /** * Unique well-known identifier used to reference connector bundle. */ wellKnownId: string; } interface GetDomainsAppsAppCertificate { /** * Certificate alias */ certAlias: string; /** * Certificate kid */ kid: string; /** * sha1Thumbprint */ sha1thumbprint: string; /** * Base-64-encoded certificate. */ x509base64certificate: string; /** * Certificate x5t */ x5t: string; } interface GetDomainsAppsAppCloudControlProperty { /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * The value(s) of the property. */ values: string[]; } interface GetDomainsAppsAppEditableAttribute { /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; } interface GetDomainsAppsAppGrant { /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * Grantee identifier */ granteeId: string; /** * Grantee resource type. Allowed values are User and Group. */ granteeType: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppGrantedAppRole { /** * If true, then this granted AppRole confers administrative privileges within the App that defines it. Otherwise, the granted AppRole confers only functional privileges. */ adminRole: boolean; /** * The id of the App that defines this AppRole, which is granted to this App. The App that defines the AppRole acts as the producer; the App to which the AppRole is granted acts as a consumer. */ appId: string; /** * The name of the App that defines this AppRole, which is granted to this App. The App that defines the AppRole acts as the producer; the App to which the AppRole is granted acts as a consumer. */ appName: string; /** * Display-name of the AppRole. */ display: string; /** * The name of the legacy group associated with this AppRole. */ legacyGroupName: string; /** * If true, indicates that this value must be protected. */ readOnly: boolean; /** * URI of the AppRole. */ ref: string; /** * Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. */ type: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppIdcsCreatedBy { /** * Display-name of the AppRole. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * URI of the AppRole. */ ref: string; /** * Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. */ type: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppIdcsLastModifiedBy { /** * Display-name of the AppRole. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * URI of the AppRole. */ ref: string; /** * Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. */ type: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppIdentityProvider { /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppIdpPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Object class resource type */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAppsAppProtectableSecondaryAudience { /** * If true, indicates that this value must be protected. */ readOnly: boolean; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppRadiusPolicy { _ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppSamlServiceProvider { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppScope { /** * The description of the AppRole. */ description: string; /** * Display name of the flatfile bundle configuration property. This attribute maps to \"displayName\" attribute in \"ConfigurationProperty\" in ICF. */ displayName: string; /** * The fully qualified value of this scope within this App. A fully qualified scope combines the 'value' of each scope with the value of 'audience'. Each value of 'fqs' must be unique across the system. Used only when this App acts as an OAuth Resource. */ fqs: string; /** * If true, indicates that this value must be protected. */ readOnly: boolean; /** * If true, indicates that a user must provide consent to access this scope. Note: Used only when this App acts as an OAuth Resource. */ requiresConsent: boolean; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppServiceParam { /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppSignonPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppTermsOfUse { /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppTrustPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionOciTag { /** * Oracle Cloud Infrastructure Defined Tags */ definedTags: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag[]; /** * Oracle Cloud Infrastructure Freeform Tags */ freeformTags: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag[]; /** * Oracle Cloud Infrastructure Tag slug */ tagSlug: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * Oracle Cloud Infrastructure Tag namespace */ namespace: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensiondbcsApp { /** * Description: */ domainApps: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensiondbcsAppDomainApp[]; /** * The name of the Enterprise Domain that contains any number of DBInstances. If specified, the value must be unique. A non-null value indicates that App represents a DBDomain. A value of null indicates that the App represents an DB-instance. */ domainName: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensiondbcsAppDomainApp { /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppApp { /** * Allow Authz policy decision expiry time in seconds. */ allowAuthzDecisionTtl: number; /** * Allow Authz Policy. */ allowAuthzPolicies: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAllowAuthzPolicy[]; /** * A list of AppResources of this App. */ appResources: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAppResource[]; /** * Deny Authz policy decision expiry time in seconds. */ denyAuthzDecisionTtl: number; /** * Deny Authz Policy. */ denyAuthzPolicies: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppDenyAuthzPolicy[]; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAllowAuthzPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppAppResource { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionenterpriseAppAppDenyAuthzPolicy { /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppApp { /** * FormFill Application Configuration CLOB which has to be maintained in Form-Fill APP for legacy code to do Form-Fill injection */ configuration: string; /** * Indicates how FormFill obtains the username and password of the account that FormFill will use to sign into the target App. */ formCredMethod: string; /** * Credential Sharing Group to which this form-fill application belongs. */ formCredentialSharingGroupId: string; /** * A list of application-formURLs that FormFill should match against any formUrl that the user-specifies when signing in to the target service. Each item in the list also indicates how FormFill should interpret that formUrl. */ formFillUrlMatches: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppAppFormFillUrlMatch[]; /** * Type of the FormFill application like WebApplication, MainFrameApplication, WindowsApplication. Initially, we will support only WebApplication. */ formType: string; /** * If true, indicates that system is allowed to show the password in plain-text for this account after re-authentication. */ revealPasswordOnForm: boolean; /** * If true, indicates that each of the Form-Fill-related attributes that can be inherited from the template actually will be inherited from the template. If false, indicates that the AppTemplate disabled inheritance for these Form-Fill-related attributes. */ syncFromTemplate: boolean; /** * Indicates the custom expression, which can combine concat and substring operations with literals and with any attribute of the Oracle Identity Cloud Service User */ userNameFormExpression: string; /** * Format for generating a username. This value can be Username or Email Address; any other value will be treated as a custom expression. A custom expression may combine 'concat' and 'substring' operations with literals and with any attribute of the Oracle Identity Cloud Service user. */ userNameFormTemplate: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppAppFormFillUrlMatch { /** * An application formUrl that FormFill will match against any formUrl that a User enters in trying to access the target-service which this App represents. */ formUrl: string; /** * Indicates how to interpret the value of 'formUrl' when matching against a user-specified formUrl. The system currently supports only 'Exact', which indicates that the value of 'formUrl' should be treated as a literal value. */ formUrlMatchType: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplate { /** * FormFill Application Configuration CLOB which has to be maintained in Form-Fill APP for legacy code to do Form-Fill injection */ configuration: string; /** * Indicates how FormFill obtains the username and password of the account that FormFill will use to sign into the target App. */ formCredMethod: string; /** * Credential Sharing Group to which this form-fill application belongs. */ formCredentialSharingGroupId: string; /** * A list of application-formURLs that FormFill should match against any formUrl that the user-specifies when signing in to the target service. Each item in the list also indicates how FormFill should interpret that formUrl. */ formFillUrlMatches: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplateFormFillUrlMatch[]; /** * Type of the FormFill application like WebApplication, MainFrameApplication, WindowsApplication. Initially, we will support only WebApplication. */ formType: string; /** * If true, indicates that system is allowed to show the password in plain-text for this account after re-authentication. */ revealPasswordOnForm: boolean; /** * If true, indicates that each of the Form-Fill-related attributes that can be inherited from the template actually will be inherited from the template. If false, indicates that the AppTemplate disabled inheritance for these Form-Fill-related attributes. */ syncFromTemplate: boolean; /** * Indicates the custom expression, which can combine concat and substring operations with literals and with any attribute of the Oracle Identity Cloud Service User */ userNameFormExpression: string; /** * Format for generating a username. This value can be Username or Email Address; any other value will be treated as a custom expression. A custom expression may combine 'concat' and 'substring' operations with literals and with any attribute of the Oracle Identity Cloud Service user. */ userNameFormTemplate: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionformFillAppTemplateAppTemplateFormFillUrlMatch { /** * An application formUrl that FormFill will match against any formUrl that a User enters in trying to access the target-service which this App represents. */ formUrl: string; /** * Indicates how to interpret the value of 'formUrl' when matching against a user-specified formUrl. The system currently supports only 'Exact', which indicates that the value of 'formUrl' should be treated as a literal value. */ formUrlMatchType: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionkerberosRealmApp { /** * The type of salt that the system will use to encrypt Kerberos-specific artifacts of this App unless another type of salt is specified. */ defaultEncryptionSaltType: string; /** * The primary key that the system should use to encrypt artifacts that are specific to this Kerberos realm -- for example, to encrypt the Principal Key in each KerberosRealmUser. */ masterKey: string; /** * Max Renewable Age in seconds */ maxRenewableAge: number; /** * Max Ticket Life in seconds */ maxTicketLife: number; /** * The name of the Kerberos Realm that this App uses for authentication. */ realmName: string; /** * The types of salt that are available for the system to use when encrypting Kerberos-specific artifacts for this App. */ supportedEncryptionSaltTypes: string[]; /** * Ticket Flags */ ticketFlags: number; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappApp { /** * If true, then the account form will be displayed in the Oracle Identity Cloud Service UI to interactively create or update an account for this App. If a value is not specified for this attribute, a default value of \"false\" will be assumed as the value for this attribute. */ accountFormVisible: boolean; /** * If true, admin has granted consent to perform managed app run-time operations. */ adminConsentGranted: boolean; /** * ConnectorBundle configuration properties */ bundleConfigurationProperties: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundleConfigurationProperty[]; /** * Configurable options maintaining a pool of ICF connector instances. Values for sub attributes can be set only if the ConnectorBundle referenced in the App has connectorPoolingSupported set to true */ bundlePoolConfigurations: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundlePoolConfiguration[]; /** * If true, the managed app can be authoritative. */ canBeAuthoritative: boolean; /** * If true, the accounts of the application are managed through an ICF connector bundle */ connected: boolean; /** * ConnectorBundle */ connectorBundles: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppConnectorBundle[]; /** * If true, send activation email to new users created from authoritative sync. */ enableAuthSyncNewUserNotification: boolean; /** * If true, sync run-time operations are enabled for this App. */ enableSync: boolean; /** * If true, send sync summary as notification upon job completion. */ enableSyncSummaryReportNotification: boolean; /** * Flat file connector bundle configuration properties */ flatFileBundleConfigurationProperties: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileBundleConfigurationProperty[]; /** * Flat file connector bundle to sync from a flat file. */ flatFileConnectorBundles: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileConnectorBundle[]; /** * IdentityBridges associated with this App */ identityBridges: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppIdentityBridge[]; /** * If true, sync from the managed app will be performed as authoritative sync. */ isAuthoritative: boolean; /** * If true, the managed app is a directory. */ isDirectory: boolean; /** * If true, the managed app is an On-Premise app. */ isOnPremiseApp: boolean; /** * If true, the managed app supports schema customization. */ isSchemaCustomizationSupported: boolean; /** * If true, the managed app supports schema discovery. */ isSchemaDiscoverySupported: boolean; /** * If true, the managed app requires 3-legged OAuth for authorization. */ isThreeLeggedOauthEnabled: boolean; /** * If true, indicates that Oracle Identity Cloud Service can use two-legged OAuth to connect to this ManagedApp. */ isTwoLeggedOauthEnabled: boolean; /** * Object classes */ objectClasses: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppObjectClass[]; /** * The most recent DateTime that the configuration of this App was updated. AppServices updates this timestamp whenever AppServices updates an App's configuration with respect to synchronization. */ syncConfigLastModified: string; /** * The value of this attribute persists any OAuth access token that the system uses to connect to this ManagedApp. The system obtains this access token using an OAuth protocol flow that could be two-legged or three-legged. A two-legged flow involves only the requester and the server. A three-legged flow also requires the consent of a user -- in this case the consent of an administrator. */ threeLeggedOauthCredentials: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppThreeLeggedOauthCredential[]; /** * Three legged OAuth provider name in Oracle Identity Cloud Service. */ threeLeggedOauthProviderName: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundleConfigurationProperty { /** * If true, this flatfile bundle configuration property value is confidential and will be encrypted in Oracle Identity Cloud Service. This attribute maps to \"isConfidential\" attribute in \"ConfigurationProperty\" in ICF. */ confidential: boolean; /** * Display name of the flatfile bundle configuration property. This attribute maps to \"displayName\" attribute in \"ConfigurationProperty\" in ICF. */ displayName: string; /** * Help message of the flatfile bundle configuration property. This attribute maps to \"helpMessage\" attribute in \"ConfigurationProperty\" in ICF. */ helpMessage: string; /** * ICF data type of flatfile the bundle configuration property. This attribute maps to \"type\" attribute in \"ConfigurationProperty\" in ICF. */ icfType: string; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * Display sequence of the bundle configuration property. */ order: number; /** * If true, this flatfile bundle configuration property is required to connect to the target connected managed app. This attribute maps to \"isRequired\" attribute in \"ConfigurationProperty\" in ICF. */ required: boolean; /** * ID of the AppRole. */ values: string[]; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppBundlePoolConfiguration { /** * Maximum number of connector instances in the pool that are idle and active. */ maxIdle: number; /** * Maximum number of connector instances in the pool that are idle and active. */ maxObjects: number; /** * Maximum time (in milliseconds) to wait for a free connector instance to become available before failing. */ maxWait: number; /** * Minimum time (in milliseconds) to wait before evicting an idle conenctor instance from the pool. */ minEvictableIdleTimeMillis: number; /** * Minimum number of idle connector instances in the pool. */ minIdle: number; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppConnectorBundle { /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. */ type: string; /** * ID of the AppRole. */ value: string; /** * Unique well-known identifier used to reference connector bundle. */ wellKnownId: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileBundleConfigurationProperty { /** * If true, this flatfile bundle configuration property value is confidential and will be encrypted in Oracle Identity Cloud Service. This attribute maps to \"isConfidential\" attribute in \"ConfigurationProperty\" in ICF. */ confidential: boolean; /** * Display name of the flatfile bundle configuration property. This attribute maps to \"displayName\" attribute in \"ConfigurationProperty\" in ICF. */ displayName: string; /** * Help message of the flatfile bundle configuration property. This attribute maps to \"helpMessage\" attribute in \"ConfigurationProperty\" in ICF. */ helpMessage: string; /** * ICF data type of flatfile the bundle configuration property. This attribute maps to \"type\" attribute in \"ConfigurationProperty\" in ICF. */ icfType: string; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * Display sequence of the bundle configuration property. */ order: number; /** * If true, this flatfile bundle configuration property is required to connect to the target connected managed app. This attribute maps to \"isRequired\" attribute in \"ConfigurationProperty\" in ICF. */ required: boolean; /** * ID of the AppRole. */ values: string[]; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppFlatFileConnectorBundle { /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; /** * Unique well-known identifier used to reference connector bundle. */ wellKnownId: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppIdentityBridge { /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppObjectClass { /** * Display-name of the AppRole. */ display: string; /** * If true, the object class represents an account. The isAccountObjectClass attribute value 'true' MUST appear no more than once. */ isAccountObjectClass: boolean; /** * URI of the AppRole. */ ref: string; /** * Object class resource type */ resourceType: string; /** * Object Class type. Allowed values are AccountObjectClass, ManagedObjectClass. */ type: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmanagedappAppThreeLeggedOauthCredential { /** * Access Token */ accessToken: string; /** * Access token expiry */ accessTokenExpiry: string; /** * Refresh Token */ refreshToken: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionmulticloudServiceAppApp { /** * The multicloud platform service URL which the application will invoke for runtime operations such as AWSCredentials api invocation */ multicloudPlatformUrl: string; /** * Specifies the service type for which the application is configured for multicloud integration. For applicable external service types, app will invoke multicloud service for runtime operations */ multicloudServiceType: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionopcServiceApp { /** * Current Federation Mode */ currentFederationMode: string; /** * Current Synchronization Mode */ currentSynchronizationMode: string; /** * If true, indicates that enablement is in progress started but not completed */ enablingNextFedSyncModes: boolean; /** * Next Federation Mode */ nextFederationMode: string; /** * Next Synchronization Mode */ nextSynchronizationMode: string; /** * This value identifies the OPC region in which the service is running. */ region: string; /** * This value specifies the unique identifier assigned to an instance of an Oracle Public Cloud service app. */ serviceInstanceIdentifier: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionradiusAppApp { /** * If true, capture the client IP address from the RADIUS request packet. IP Address is used for auditing, policy-evaluation and country-code calculation. */ captureClientIp: boolean; /** * This is the IP address of the RADIUS Client like Oracle Database server. It can be only IP address and not hostname. */ clientIp: string; /** * Vendor-specific identifier of the attribute in the RADIUS response that will contain the end-user's country code. This is an integer-value in the range 1 to 255 */ countryCodeResponseAttributeId: string; /** * The name of the attribute that contains the Internet Protocol address of the end-user. */ endUserIpAttribute: string; /** * RADIUS attribute that RADIUS-enabled system uses to pass the group membership */ groupMembershipRadiusAttribute: string; /** * In a successful authentication response, Oracle Identity Cloud Service will pass user's group information restricted to groups persisted in this attribute, in the specified RADIUS attribute. */ groupMembershipToReturns: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionradiusAppAppGroupMembershipToReturn[]; /** * Configure the groupNameFormat based on vendor in order to pass it to RADIUS infra */ groupNameFormat: string; /** * Indicates to include groups in RADIUS response */ includeGroupInResponse: boolean; /** * Indicates if password and OTP are passed in the same sign-in request or not. */ passwordAndOtpTogether: boolean; /** * This is the port of RADIUS Proxy which RADIUS client will connect to. */ port: string; /** * ID used to identify a particular vendor. */ radiusVendorSpecificId: string; /** * Configure the responseFormat based on vendor in order to pass it to RADIUS infra */ responseFormat: string; /** * The delimiter used if group membership responseFormat is a delimited list instead of repeating attributes */ responseFormatDelimiter: string; /** * Secret key used to secure communication between RADIUS Proxy and RADIUS client */ secretKey: string; /** * Value consists of type of RADIUS App. Type can be Oracle Database, VPN etc */ typeOfRadiusApp: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionradiusAppAppGroupMembershipToReturn { /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionrequestableApp { /** * Flag controlling whether resource can be request by user through self service console. */ requestable: boolean; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderApp { /** * The attribute represents the URL to which the SAML Assertions will be sent by the SAML IdP. */ assertionConsumerUrl: string; /** * If true, indicates that the system must encrypt the Security Assertion Markup Language (SAML) assertion. */ encryptAssertion: boolean; /** * This attribute indicates the encryption algorithm used to encrypt the SAML assertion. */ encryptionAlgorithm: string; /** * This attribute represents the encryption certificate that an App uses to encrypt the Security Assertion Markup Language (SAML) assertion. */ encryptionCertificate: string; /** * Specifies the preferred federation protocol (SAML2.0 or WS-Fed1.1). */ federationProtocol: string; /** * Each value of this attribute describes an attribute of Group that will be sent in a Security Assertion Markup Language (SAML) assertion. */ groupAssertionAttributes: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppGroupAssertionAttribute[]; /** * Hok Assertion Consumer Service Url */ hokAcsUrl: string; /** * If enabled, then the SAML Service supports Hok for this App. */ hokRequired: boolean; /** * If true, then the signing certificate is included in the signature. */ includeSigningCertInSignature: boolean; /** * This attribute indicates the key encryption algorithm. */ keyEncryptionAlgorithm: string; /** * Records the notification timestamp for the SP whose signing certificate is about to expire. */ lastNotificationSentTime: string; /** * This attribute represents the HTTP binding that would be used while logout. */ logoutBinding: string; /** * If true, then the SAML Service supports logout for this App. */ logoutEnabled: boolean; /** * The URL to which the partner sends the logout request. */ logoutRequestUrl: string; /** * The URL to which the partner sends the logout response. */ logoutResponseUrl: string; /** * This attribute represents the metadata of a Security Provider in the Security Assertion Markup Language protocol. */ metadata: string; /** * This can be any string, but there are a set of standard nameIdFormats. If a nameIdFormat other than the standard list is chosen, it will be considered a custom nameidformat. The standard nameidformats include: saml-x509, saml-emailaddress, saml-windowsnamequalifier, saml-kerberos, saml-persistent, saml-transient, saml-unspecified, saml-none, and saml-persistent-opaque. */ nameIdFormat: string; /** * **Deprecated Since: 18.2.2** */ nameIdUserstoreAttribute: string; /** * Use to construct the outgoing SAML attributes */ outboundAssertionAttributes: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppOutboundAssertionAttribute[]; /** * The ID of the Provider. This value corresponds to the entityID from the Service Provider metadata. */ partnerProviderId: string; /** * The pattern of the Provider. This value corresponds to the entityID from the Service Provider metadata. */ partnerProviderPattern: string; /** * Indicates which part of the response should be signed. A value of \"Assertion\" indicates that the Assertion should be signed. A value of \"Response\" indicates that the SSO Response should be signed. A value of \"AssertionAndResponse\" indicates that both the Assertion and the SSO Response should be signed. */ signResponseOrAssertion: string; /** * This attribute represents the algorithm used to hash the signature. */ signatureHashAlgorithm: string; /** * This attribute represents the signing certificate that an App uses to verify the signed authentication request. */ signingCertificate: string; /** * This attribute represents the Succinct ID. */ succinctId: string; /** * The alternate Provider ID to be used as the Oracle Identity Cloud Service providerID (instead of the one in SamlSettings) when interacting with this SP. */ tenantProviderId: string; /** * Each value of this attribute describes an attribute of User that will be sent in a Security Assertion Markup Language (SAML) assertion. */ userAssertionAttributes: outputs.Identity.GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppUserAssertionAttribute[]; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppGroupAssertionAttribute { /** * Indicates the filter types that are supported for the Group assertion attributes. */ condition: string; /** * Indicates the format of the assertion attribute. */ format: string; /** * Indicates the group name that are supported for the group assertion attributes. */ groupName: string; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppOutboundAssertionAttribute { /** * Mapped Attribute Direction */ direction: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionsamlServiceProviderAppUserAssertionAttribute { /** * Indicates the format of the assertion attribute. */ format: string; /** * The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion */ name: string; /** * This attribute specifies which user attribute should be used to create the value of the SAML assertion attribute. The userstore attribute can be constructed by using attributes from the Oracle Identity Cloud Service Core Users schema.
Note: Attributes from extensions to the Core User schema are not supported in v1.0. */ userStoreAttributeName: string; } interface GetDomainsAppsAppUrnietfparamsscimschemasoracleidcsextensionwebTierPolicyApp { /** * If this Attribute is true, resource ref id and resource ref name attributes will we included in wtp json response. */ resourceRef: boolean; /** * Webtier policy AZ Control */ webTierPolicyAzControl: string; /** * Store the web tier policy for an application as a string in Javascript Object Notification (JSON) format. */ webTierPolicyJson: string; } interface GetDomainsAppsAppUserRole { /** * The description of the AppRole. */ description: string; /** * Display-name of the AppRole. */ display: string; /** * URI of the AppRole. */ ref: string; /** * ID of the AppRole. */ value: string; } interface GetDomainsAuthTokenIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsAuthTokenIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsAuthTokenMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAuthTokenTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsAuthTokenUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsAuthTokenUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsAuthTokensAuthToken { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * When the user's credential expire. */ expiresOn: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsAuthTokensAuthTokenIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsAuthTokensAuthTokenIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsAuthTokensAuthTokenMeta[]; /** * The user's OCID. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * The user's credential status. */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsAuthTokensAuthTokenTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * token */ token: string; /** * Controls whether a user can update themselves or not via User related APIs */ urnietfparamsscimschemasoracleidcsextensionselfChangeUsers: outputs.Identity.GetDomainsAuthTokensAuthTokenUrnietfparamsscimschemasoracleidcsextensionselfChangeUser[]; /** * The user linked to the Auth token. */ users: outputs.Identity.GetDomainsAuthTokensAuthTokenUser[]; } interface GetDomainsAuthTokensAuthTokenIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsAuthTokensAuthTokenIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsAuthTokensAuthTokenMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAuthTokensAuthTokenTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsAuthTokensAuthTokenUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsAuthTokensAuthTokenUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsAuthenticationFactorSettingBypassCodeSetting { /** * Expiry (in minutes) of any bypass code that is generated by the help desk */ helpDeskCodeExpiryInMins: number; /** * If true, indicates that help desk bypass code generation is enabled */ helpDeskGenerationEnabled: boolean; /** * The maximum number of times that any bypass code that is generated by the help desk can be used */ helpDeskMaxUsage: number; /** * Exact length of the bypass code to be generated */ length: number; /** * The maximum number of bypass codes that can be issued to any user */ maxActive: number; /** * If true, indicates that self-service bypass code generation is enabled */ selfServiceGenerationEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingClientAppSetting { /** * Indicates what protection policy that the system applies on a device. By default, the value is NONE, which indicates that the system applies no protection policy. A value of APP_PIN indicates that the system requires a Personal Identification Number (PIN). A value of DEVICE_BIOMETRIC_OR_APP_PIN indicates that either a PIN or a biometric authentication factor is required. */ deviceProtectionPolicy: string; /** * The period of time in seconds that the system will lock a user out of the service after that user exceeds the maximum number of login failures */ initialLockoutPeriodInSecs: number; /** * The size of the key that the system uses to generate the public-private key pair */ keyPairLength: number; /** * The pattern of escalation that the system follows, in locking a particular user out of the service. */ lockoutEscalationPattern: string; /** * The maximum number of times that a particular user can fail to login before the system locks that user out of the service */ maxFailuresBeforeLockout: number; /** * The maximum number of login failures that the system will allow before raising a warning and sending an alert via email */ maxFailuresBeforeWarning: number; /** * The maximum period of time that the system will lock a particular user out of the service regardless of what the configured pattern of escalation would otherwise dictate */ maxLockoutIntervalInSecs: number; /** * Minimum length of the Personal Identification Number (PIN) */ minPinLength: number; /** * The period of time in days after which a client should refresh its policy by re-reading that policy from the server */ policyUpdateFreqInDays: number; /** * Indicates which algorithm the system will use to sign requests */ requestSigningAlgo: string; /** * Indicates the type of encoding that the system should use to generate a shared secret */ sharedSecretEncoding: string; /** * If true, indicates that the system should require the user to unlock the client app for each request. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. */ unlockAppForEachRequestEnabled: boolean; /** * Specifies the period of time in seconds after which the client App should require the user to unlock the App. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. A value of zero means that it is disabled. */ unlockAppIntervalInSecs: number; /** * If true, indicates that the system should require the user to unlock the client App, when the client App comes to the foreground in the display of the device. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. */ unlockOnAppForegroundEnabled: boolean; /** * If true, indicates that the system should require the user to unlock the client App whenever the App is started. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. */ unlockOnAppStartEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingCompliancePolicy { /** * The action to be taken if the value of the attribute is not as expected */ action: string; /** * The name of the attribute being evaluated */ name: string; /** * Value of the tag. */ value: string; } interface GetDomainsAuthenticationFactorSettingEmailSetting { /** * Custom redirect Url which will be used in email link */ emailLinkCustomUrl: string; /** * Specifies whether Email link is enabled or not. */ emailLinkEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingEndpointRestriction { /** * Maximum number of days until an endpoint can be trusted */ maxEndpointTrustDurationInDays: number; /** * Maximum number of enrolled devices per user */ maxEnrolledDevices: number; /** * An integer that represents the maximum number of failed MFA logins before an account is locked */ maxIncorrectAttempts: number; /** * Max number of trusted endpoints per user */ maxTrustedEndpoints: number; /** * Specify if trusted endpoints are enabled */ trustedEndpointsEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAuthenticationFactorSettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAuthenticationFactorSettingIdentityStoreSetting { /** * If true, indicates that Multi-Factor Authentication should use the mobile number in the identity store */ mobileNumberEnabled: boolean; /** * If true, indicates that the user can update the mobile number in the user's Multi-Factor Authentication profile */ mobileNumberUpdateEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAuthenticationFactorSettingNotificationSetting { /** * If true, indicates that the Mobile App Pull Notification channel is enabled for authentication */ pullEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsAuthenticationFactorSettingThirdPartyFactor { /** * To enable Duo Security factor */ duoSecurity: boolean; } interface GetDomainsAuthenticationFactorSettingTotpSetting { /** * The period of time (in minutes) that a one-time passcode remains valid that the system sends by email. */ emailOtpValidityDurationInMins: number; /** * Exact length of the email one-time passcode. */ emailPasscodeLength: number; /** * The hashing algorithm to be used to calculate a One-Time Passcode. By default, the system uses SHA1. */ hashingAlgorithm: string; /** * The period of time (in seconds) that a JSON Web Token (JWT) is valid */ jwtValidityDurationInSecs: number; /** * The duration of time (in days) after which the shared secret has to be refreshed */ keyRefreshIntervalInDays: number; /** * Exact length of the One-Time Passcode that the system should generate */ passcodeLength: number; /** * The period of time (in minutes) for which a One-Time Passcode that the system sends by Short Message Service (SMS) or by voice remains valid */ smsOtpValidityDurationInMins: number; /** * Exact length of the Short Message Service (SMS) One-Time Passcode */ smsPasscodeLength: number; /** * Time (in secs) to be used as the time step */ timeStepInSecs: number; /** * The tolerance/step-size that the system should use when validating a One-Time Passcode */ timeStepTolerance: number; } interface GetDomainsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionfidoAuthenticationFactorSetting { /** * Attribute used to define the type of attestation required. */ attestation: string; /** * Attribute used to define authenticator selection attachment. */ authenticatorSelectionAttachment: string; /** * Flag used to indicate authenticator selection is required or not */ authenticatorSelectionRequireResidentKey: boolean; /** * Attribute used to define authenticator selection resident key requirement. */ authenticatorSelectionResidentKey: string; /** * Attribute used to define authenticator selection verification. */ authenticatorSelectionUserVerification: string; /** * Number of domain levels Oracle Identity Cloud Service should use for origin comparision */ domainValidationLevel: number; /** * Flag used to indicate whether we need to restrict creation of multiple credentials in same authenticator */ excludeCredentials: boolean; /** * List of server supported public key algorithms */ publicKeyTypes: string[]; /** * Timeout for the fido authentication to complete */ timeout: number; } interface GetDomainsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSetting { /** * Settings related to Duo Security */ duoSecuritySettings: outputs.Identity.GetDomainsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSettingDuoSecuritySetting[]; } interface GetDomainsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSettingDuoSecuritySetting { /** * Hostname to access the Duo security account */ apiHostname: string; /** * Attestation key to attest the request and response between Duo Security */ attestationKey: string; /** * Integration key from Duo Security authenticator */ integrationKey: string; /** * Secret key from Duo Security authenticator */ secretKey: string; /** * User attribute mapping value */ userMappingAttribute: string; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSetting { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; authenticationFactorSettingId: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * If true, indicates that email will not be enrolled as a MFA factor automatically if it a account recovery factor */ autoEnrollEmailFactorDisabled: boolean; /** * If true, indicates that Bypass Code is enabled for authentication */ bypassCodeEnabled: boolean; /** * Settings related to the bypass code, such as bypass code length, bypass code expiry, max active bypass codes, and so on */ bypassCodeSettings: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingBypassCodeSetting[]; /** * Settings related to compliance, Personal Identification Number (PIN) policy, and so on */ clientAppSettings: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingClientAppSetting[]; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * Compliance Policy that defines actions to be taken when a condition is violated */ compliancePolicies: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingCompliancePolicy[]; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * If true, indicates that the EMAIL channel is enabled for authentication */ emailEnabled: boolean; /** * Settings related to Email Factor, such as enabled email magic link factor, custom url for Email Link */ emailSettings: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingEmailSetting[]; /** * Settings that describe the set of restrictions that the system should apply to devices and trusted endpoints of a user */ endpointRestrictions: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingEndpointRestriction[]; /** * If true, indicates that the Fido Authenticator channels are enabled for authentication */ fidoAuthenticatorEnabled: boolean; /** * If true, indicates that 'Show backup factor(s)' button will be hidden during authentication */ hideBackupFactorEnabled: boolean; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Settings related to the use of a user's profile details from the identity store */ identityStoreSettings: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingIdentityStoreSetting[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingMeta[]; /** * Specifies the category of people for whom Multi-Factor Authentication is enabled. This is a readOnly attribute which reflects the value of mfaEnabledCategory attribute in SsoSettings */ mfaEnabledCategory: string; /** * Specifies if Multi-Factor Authentication enrollment is mandatory or optional for a user */ mfaEnrollmentType: string; /** * Settings related to the Mobile App Notification channel, such as pull */ notificationSettings: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingNotificationSetting[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * If true, indicates that the phone (PHONE_CALL) channel is enabled for authentication */ phoneCallEnabled: boolean; /** * If true, indicates that the Mobile App Push Notification channel is enabled for authentication */ pushEnabled: boolean; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * If true, indicates that Security Questions are enabled for authentication */ securityQuestionsEnabled: boolean; /** * If true, indicates that the Short Message Service (SMS) channel is enabled for authentication */ smsEnabled: boolean; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Settings related to third-party factor */ thirdPartyFactors: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingThirdPartyFactor[]; /** * If true, indicates that the Mobile App One Time Passcode channel is enabled for authentication */ totpEnabled: boolean; /** * Settings related to Time-Based One-Time Passcodes (TOTP), such as hashing algo, totp time step, passcode length, and so on */ totpSettings: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingTotpSetting[]; /** * This extension defines attributes used to manage Multi-Factor Authentication settings of fido authentication */ urnietfparamsscimschemasoracleidcsextensionfidoAuthenticationFactorSettings: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionfidoAuthenticationFactorSetting[]; /** * This extension defines attributes used to manage Multi-Factor Authentication settings of third party provider */ urnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSettings: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSetting[]; /** * Factors for which enrollment should be blocked for End User */ userEnrollmentDisabledFactors: string[]; /** * If true, indicates that the Yubico OTP is enabled for authentication */ yubicoOtpEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingBypassCodeSetting { /** * Expiry (in minutes) of any bypass code that is generated by the help desk */ helpDeskCodeExpiryInMins: number; /** * If true, indicates that help desk bypass code generation is enabled */ helpDeskGenerationEnabled: boolean; /** * The maximum number of times that any bypass code that is generated by the help desk can be used */ helpDeskMaxUsage: number; /** * Exact length of the bypass code to be generated */ length: number; /** * The maximum number of bypass codes that can be issued to any user */ maxActive: number; /** * If true, indicates that self-service bypass code generation is enabled */ selfServiceGenerationEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingClientAppSetting { /** * Indicates what protection policy that the system applies on a device. By default, the value is NONE, which indicates that the system applies no protection policy. A value of APP_PIN indicates that the system requires a Personal Identification Number (PIN). A value of DEVICE_BIOMETRIC_OR_APP_PIN indicates that either a PIN or a biometric authentication factor is required. */ deviceProtectionPolicy: string; /** * The period of time in seconds that the system will lock a user out of the service after that user exceeds the maximum number of login failures */ initialLockoutPeriodInSecs: number; /** * The size of the key that the system uses to generate the public-private key pair */ keyPairLength: number; /** * The pattern of escalation that the system follows, in locking a particular user out of the service. */ lockoutEscalationPattern: string; /** * The maximum number of times that a particular user can fail to login before the system locks that user out of the service */ maxFailuresBeforeLockout: number; /** * The maximum number of login failures that the system will allow before raising a warning and sending an alert via email */ maxFailuresBeforeWarning: number; /** * The maximum period of time that the system will lock a particular user out of the service regardless of what the configured pattern of escalation would otherwise dictate */ maxLockoutIntervalInSecs: number; /** * Minimum length of the Personal Identification Number (PIN) */ minPinLength: number; /** * The period of time in days after which a client should refresh its policy by re-reading that policy from the server */ policyUpdateFreqInDays: number; /** * Indicates which algorithm the system will use to sign requests */ requestSigningAlgo: string; /** * Indicates the type of encoding that the system should use to generate a shared secret */ sharedSecretEncoding: string; /** * If true, indicates that the system should require the user to unlock the client app for each request. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. */ unlockAppForEachRequestEnabled: boolean; /** * Specifies the period of time in seconds after which the client App should require the user to unlock the App. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. A value of zero means that it is disabled. */ unlockAppIntervalInSecs: number; /** * If true, indicates that the system should require the user to unlock the client App, when the client App comes to the foreground in the display of the device. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. */ unlockOnAppForegroundEnabled: boolean; /** * If true, indicates that the system should require the user to unlock the client App whenever the App is started. In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. */ unlockOnAppStartEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingCompliancePolicy { /** * The action to be taken if the value of the attribute is not as expected */ action: string; /** * The name of the attribute being evaluated */ name: string; /** * Value of the tag. */ value: string; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingEmailSetting { /** * Custom redirect Url which will be used in email link */ emailLinkCustomUrl: string; /** * Specifies whether Email link is enabled or not. */ emailLinkEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingEndpointRestriction { /** * Maximum number of days until an endpoint can be trusted */ maxEndpointTrustDurationInDays: number; /** * Maximum number of enrolled devices per user */ maxEnrolledDevices: number; /** * An integer that represents the maximum number of failed MFA logins before an account is locked */ maxIncorrectAttempts: number; /** * Max number of trusted endpoints per user */ maxTrustedEndpoints: number; /** * Specify if trusted endpoints are enabled */ trustedEndpointsEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingIdentityStoreSetting { /** * If true, indicates that Multi-Factor Authentication should use the mobile number in the identity store */ mobileNumberEnabled: boolean; /** * If true, indicates that the user can update the mobile number in the user's Multi-Factor Authentication profile */ mobileNumberUpdateEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingNotificationSetting { /** * If true, indicates that the Mobile App Pull Notification channel is enabled for authentication */ pullEnabled: boolean; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingThirdPartyFactor { /** * To enable Duo Security factor */ duoSecurity: boolean; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingTotpSetting { /** * The period of time (in minutes) that a one-time passcode remains valid that the system sends by email. */ emailOtpValidityDurationInMins: number; /** * Exact length of the email one-time passcode. */ emailPasscodeLength: number; /** * The hashing algorithm to be used to calculate a One-Time Passcode. By default, the system uses SHA1. */ hashingAlgorithm: string; /** * The period of time (in seconds) that a JSON Web Token (JWT) is valid */ jwtValidityDurationInSecs: number; /** * The duration of time (in days) after which the shared secret has to be refreshed */ keyRefreshIntervalInDays: number; /** * Exact length of the One-Time Passcode that the system should generate */ passcodeLength: number; /** * The period of time (in minutes) for which a One-Time Passcode that the system sends by Short Message Service (SMS) or by voice remains valid */ smsOtpValidityDurationInMins: number; /** * Exact length of the Short Message Service (SMS) One-Time Passcode */ smsPasscodeLength: number; /** * Time (in secs) to be used as the time step */ timeStepInSecs: number; /** * The tolerance/step-size that the system should use when validating a One-Time Passcode */ timeStepTolerance: number; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionfidoAuthenticationFactorSetting { /** * Attribute used to define the type of attestation required. */ attestation: string; /** * Attribute used to define authenticator selection attachment. */ authenticatorSelectionAttachment: string; /** * Flag used to indicate authenticator selection is required or not */ authenticatorSelectionRequireResidentKey: boolean; /** * Attribute used to define authenticator selection resident key requirement. */ authenticatorSelectionResidentKey: string; /** * Attribute used to define authenticator selection verification. */ authenticatorSelectionUserVerification: string; /** * Number of domain levels Oracle Identity Cloud Service should use for origin comparision */ domainValidationLevel: number; /** * Flag used to indicate whether we need to restrict creation of multiple credentials in same authenticator */ excludeCredentials: boolean; /** * List of server supported public key algorithms */ publicKeyTypes: string[]; /** * Timeout for the fido authentication to complete */ timeout: number; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSetting { /** * Settings related to Duo Security */ duoSecuritySettings: outputs.Identity.GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSettingDuoSecuritySetting[]; } interface GetDomainsAuthenticationFactorSettingsAuthenticationFactorSettingUrnietfparamsscimschemasoracleidcsextensionthirdPartyAuthenticationFactorSettingDuoSecuritySetting { /** * Hostname to access the Duo security account */ apiHostname: string; /** * Attestation key to attest the request and response between Duo Security */ attestationKey: string; /** * Integration key from Duo Security authenticator */ integrationKey: string; /** * Secret key from Duo Security authenticator */ secretKey: string; /** * User attribute mapping value */ userMappingAttribute: string; } interface GetDomainsBrandingSettingCompanyName { /** * Locale */ locale: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingDefaultCompanyName { /** * Locale */ locale: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingDefaultImage { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Indicates the image type */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingDefaultLoginText { /** * Locale */ locale: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingIdcsCreatedBy { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Indicates the image type */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingIdcsLastModifiedBy { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Indicates the image type */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingImage { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Indicates the image type */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingLoginText { /** * Locale */ locale: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsBrandingSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingsBrandingSetting { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; brandingSettingId: string; /** * Name of the company in different locales */ companyNames: outputs.Identity.GetDomainsBrandingSettingsBrandingSettingCompanyName[]; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * Indicates if the branding is default or is custom branding */ customBranding: boolean; /** * Storage URL location where the sanitized custom css is located */ customCssLocation: string; /** * Storage URL location where the sanitized custom html is located */ customHtmlLocation: string; /** * Custom translations (JSON String) */ customTranslation: string; /** * Default name of the Company in different locales */ defaultCompanyNames: outputs.Identity.GetDomainsBrandingSettingsBrandingSettingDefaultCompanyName[]; /** * References to various images */ defaultImages: outputs.Identity.GetDomainsBrandingSettingsBrandingSettingDefaultImage[]; /** * Default Login text in different locales */ defaultLoginTexts: outputs.Identity.GetDomainsBrandingSettingsBrandingSettingDefaultLoginText[]; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Indicates if Terms of Use is enabled in UI */ enableTermsOfUse: boolean; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsBrandingSettingsBrandingSettingIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsBrandingSettingsBrandingSettingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * References to various images */ images: outputs.Identity.GetDomainsBrandingSettingsBrandingSettingImage[]; /** * Indicates if 'hosted' option was selected */ isHostedPage: boolean; /** * Locale */ locale: string; /** * Login text in different locales */ loginTexts: outputs.Identity.GetDomainsBrandingSettingsBrandingSettingLoginText[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsBrandingSettingsBrandingSettingMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Preferred written or spoken language used for localized user interfaces */ preferredLanguage: string; /** * Privacy Policy URL */ privacyPolicyUrl: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsBrandingSettingsBrandingSettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Terms of Use URL */ termsOfUseUrl: string; /** * User's timezone */ timezone: string; } interface GetDomainsBrandingSettingsBrandingSettingCompanyName { /** * Locale */ locale: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingsBrandingSettingDefaultCompanyName { /** * Locale */ locale: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingsBrandingSettingDefaultImage { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Indicates the image type */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingsBrandingSettingDefaultLoginText { /** * Locale */ locale: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingsBrandingSettingIdcsCreatedBy { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Indicates the image type */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingsBrandingSettingIdcsLastModifiedBy { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Indicates the image type */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingsBrandingSettingImage { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Indicates the image type */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingsBrandingSettingLoginText { /** * Locale */ locale: string; /** * Value of the tag. */ value: string; } interface GetDomainsBrandingSettingsBrandingSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsBrandingSettingsBrandingSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsCloudGateIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * URI of the upstream server */ ref: string; /** * Type of Cloud Gate */ type: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGateIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * URI of the upstream server */ ref: string; /** * Type of Cloud Gate */ type: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGateMapping { /** * The ID of the App being mapped to */ appId: string; /** * The id of the Cloud Gate Mapping */ mappingId: string; /** * The name (Client ID) of the App being mapped to */ name: string; /** * Any additional settings for this upstream server in nginx configuration form */ nginxSettings: string; /** * The Web Tier policy name used for the App that is mapped to this Cloud Gate */ policyName: string; /** * NGINX ProxyPass entry for this Mapping */ proxyPass: string; /** * URI of the upstream server */ ref: string; /** * Resource prefix for this mapping. This will be used to define the location block */ resourcePrefix: string; /** * Server Name for the Server Block */ serverId: string; /** * Upstream server group instance for the Mapping. This is one of the upstream server group IDs(upstream blocks) from the associated Cloud Gate list */ upstreamServerGroupId: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGateMappingCloudGate { /** * The URI to the upstream block entry */ ref: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingGatewayApp { /** * The name (Client ID) of the gateway application protected by this Cloud Gate. */ name: string; /** * The URI to the upstream block entry */ ref: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI to the upstream block entry */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI to the upstream block entry */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsCloudGateMappingServer { /** * The URI to the upstream block entry */ ref: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingTag { /** * Key or name of the tag. */ key: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingUpstreamServerGroup { /** * The URI to the upstream block entry */ ref: string; /** * SSL flag for the Upstream Block */ ssl: boolean; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingsCloudGateMapping { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Reference to owning Cloud Gate */ cloudGates: outputs.Identity.GetDomainsCloudGateMappingsCloudGateMappingCloudGate[]; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Brief description for this Cloud Gate */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Reference to gateway application protected by this Cloud Gate */ gatewayApps: outputs.Identity.GetDomainsCloudGateMappingsCloudGateMappingGatewayApp[]; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsCloudGateMappingsCloudGateMappingIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsCloudGateMappingsCloudGateMappingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Indicates whether this resource was created by OPC */ isOpcService: boolean; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsCloudGateMappingsCloudGateMappingMeta[]; /** * More NGINX Settings. JSON encoded key value pairs similar to WTP encoding */ nginxSettings: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The Web Tier policy name used for the App that is mapped to the owning Cloud Gate */ policyName: string; /** * NGINX ProxyPass entry for this Mapping */ proxyPass: string; /** * Resource prefix for this mapping. This will be used to define the location block */ resourcePrefix: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Reference to server block for this mapping */ servers: outputs.Identity.GetDomainsCloudGateMappingsCloudGateMappingServer[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsCloudGateMappingsCloudGateMappingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Reference to upstream block for this mapping */ upstreamServerGroups: outputs.Identity.GetDomainsCloudGateMappingsCloudGateMappingUpstreamServerGroup[]; } interface GetDomainsCloudGateMappingsCloudGateMappingCloudGate { /** * The URI to the upstream block entry */ ref: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingsCloudGateMappingGatewayApp { /** * The name (Client ID) of the gateway application protected by this Cloud Gate. */ name: string; /** * The URI to the upstream block entry */ ref: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingsCloudGateMappingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI to the upstream block entry */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingsCloudGateMappingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI to the upstream block entry */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingsCloudGateMappingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsCloudGateMappingsCloudGateMappingServer { /** * The URI to the upstream block entry */ ref: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingsCloudGateMappingTag { /** * Key or name of the tag. */ key: string; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMappingsCloudGateMappingUpstreamServerGroup { /** * The URI to the upstream block entry */ ref: string; /** * SSL flag for the Upstream Block */ ssl: boolean; /** * The id of the upstream block entry. */ value: string; } interface GetDomainsCloudGateMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsCloudGateOauthClient { /** * The Client ID of the OAuth app for this CloudGate. */ clientId: string; /** * URI of the upstream server */ ref: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGateServer { /** * Any incoming request to cloud gate is finally sent to this host, if selected during load balancing */ hostName: string; /** * Any additional settings for this upstream server in nginx configuration form */ nginxSettings: string; /** * Port for the Upstream Server */ port: number; /** * Server Name for the Server Block */ serverId: string; /** * SSL flag for the Upstream Block */ ssl: boolean; } interface GetDomainsCloudGateServerCloudGate { /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsCloudGateServerIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsCloudGateServerIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsCloudGateServerMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsCloudGateServerTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsCloudGateServersCloudGateServer { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Reference to owning Cloud Gate */ cloudGates: outputs.Identity.GetDomainsCloudGateServersCloudGateServerCloudGate[]; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Brief description for this Cloud Gate server block */ description: string; /** * Display name for the Server block */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Hostname for the Server block */ hostName: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsCloudGateServersCloudGateServerIdcsCreatedBy[]; idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsCloudGateServersCloudGateServerIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Indicates whether this resource was created by OPC */ isOpcService: boolean; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsCloudGateServersCloudGateServerMeta[]; /** * More nginx Settings. JSON encoded text block */ nginxSettings: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Port for the Server Block */ port: number; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * SSL flag for the Server Block */ ssl: boolean; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsCloudGateServersCloudGateServerTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsCloudGateServersCloudGateServerCloudGate { /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsCloudGateServersCloudGateServerIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsCloudGateServersCloudGateServerIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsCloudGateServersCloudGateServerMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsCloudGateServersCloudGateServerTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsCloudGateTag { /** * Key or name of the tag. */ key: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGateUpstreamServer { /** * Display name of upstream server */ displayName: string; /** * Upstream Server Group instance for the upstream server. This is one of the upstreamServerGroup IDs(upstream blocks) from the associated Cloud Gate list */ groupId: string; /** * Any incoming request to cloud gate is finally sent to this host, if selected during load balancing */ hostName: string; /** * Any additional settings for this upstream server in nginx configuration form */ nginxSettings: string; /** * Port for the Upstream Server */ port: number; /** * URI of the upstream server */ ref: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGateUpstreamServerGroup { /** * Display name of upstream server */ displayName: string; /** * Any additional settings for this upstream server in nginx configuration form */ nginxSettings: string; /** * URI of the upstream server */ ref: string; /** * SSL flag for the Upstream Block */ ssl: boolean; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGatesCloudGate { /** * Activation status for this Cloud Gate */ active: boolean; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Brief description for this Cloud Gate */ description: string; /** * Display name of upstream server */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsCloudGatesCloudGateIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsCloudGatesCloudGateIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Indicates whether this resource was created by OPC */ isOpcService: boolean; /** * Last updated timestamp for this CloudGate's servers and mappings. */ lastModifiedTime: string; /** * A list of Cloud Gate Mappings that map Apps to this Cloud Gate */ mappings: outputs.Identity.GetDomainsCloudGatesCloudGateMapping[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsCloudGatesCloudGateMeta[]; /** * A reference to the OAuth client App used by this Cloud Gate instance. */ oauthClients: outputs.Identity.GetDomainsCloudGatesCloudGateOauthClient[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of Server Blocks on this Cloud Gate */ servers: outputs.Identity.GetDomainsCloudGatesCloudGateServer[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsCloudGatesCloudGateTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Type of Cloud Gate */ type: string; /** * A list of upstream server groups */ upstreamServerGroups: outputs.Identity.GetDomainsCloudGatesCloudGateUpstreamServerGroup[]; /** * A list of upstream servers */ upstreamServers: outputs.Identity.GetDomainsCloudGatesCloudGateUpstreamServer[]; } interface GetDomainsCloudGatesCloudGateIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * URI of the upstream server */ ref: string; /** * Type of Cloud Gate */ type: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGatesCloudGateIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * URI of the upstream server */ ref: string; /** * Type of Cloud Gate */ type: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGatesCloudGateMapping { /** * The ID of the App being mapped to */ appId: string; /** * The id of the Cloud Gate Mapping */ mappingId: string; /** * The name (Client ID) of the App being mapped to */ name: string; /** * Any additional settings for this upstream server in nginx configuration form */ nginxSettings: string; /** * The Web Tier policy name used for the App that is mapped to this Cloud Gate */ policyName: string; /** * NGINX ProxyPass entry for this Mapping */ proxyPass: string; /** * URI of the upstream server */ ref: string; /** * Resource prefix for this mapping. This will be used to define the location block */ resourcePrefix: string; /** * Server Name for the Server Block */ serverId: string; /** * Upstream server group instance for the Mapping. This is one of the upstream server group IDs(upstream blocks) from the associated Cloud Gate list */ upstreamServerGroupId: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGatesCloudGateMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsCloudGatesCloudGateOauthClient { /** * The Client ID of the OAuth app for this CloudGate. */ clientId: string; /** * URI of the upstream server */ ref: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGatesCloudGateServer { /** * Any incoming request to cloud gate is finally sent to this host, if selected during load balancing */ hostName: string; /** * Any additional settings for this upstream server in nginx configuration form */ nginxSettings: string; /** * Port for the Upstream Server */ port: number; /** * Server Name for the Server Block */ serverId: string; /** * SSL flag for the Upstream Block */ ssl: boolean; } interface GetDomainsCloudGatesCloudGateTag { /** * Key or name of the tag. */ key: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGatesCloudGateUpstreamServer { /** * Display name of upstream server */ displayName: string; /** * Upstream Server Group instance for the upstream server. This is one of the upstreamServerGroup IDs(upstream blocks) from the associated Cloud Gate list */ groupId: string; /** * Any incoming request to cloud gate is finally sent to this host, if selected during load balancing */ hostName: string; /** * Any additional settings for this upstream server in nginx configuration form */ nginxSettings: string; /** * Port for the Upstream Server */ port: number; /** * URI of the upstream server */ ref: string; /** * ID of the upstream server */ value: string; } interface GetDomainsCloudGatesCloudGateUpstreamServerGroup { /** * Display name of upstream server */ displayName: string; /** * Any additional settings for this upstream server in nginx configuration form */ nginxSettings: string; /** * URI of the upstream server */ ref: string; /** * SSL flag for the Upstream Block */ ssl: boolean; /** * ID of the upstream server */ value: string; } interface GetDomainsConditionIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsConditionIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsConditionMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsConditionTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsConditionsCondition { /** * AttributeName - RHS of condition */ attributeName: string; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * attributeValue - RHS of condition */ attributeValue: string; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Condition Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Evaluate the condition if this expression returns true, else skip condition evaluation */ evaluateConditionIf: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsConditionsConditionIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsConditionsConditionIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsConditionsConditionMeta[]; /** * Condition name */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * **SCIM++ Properties:** * * caseExact: true * * idcsSearchable: false * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: string * * uniqueness: none Operator in the condition. It support all SCIM operators like eq, gt, lt, le, sw etc */ operator: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsConditionsConditionTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsConditionsConditionIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsConditionsConditionIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsConditionsConditionMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsConditionsConditionTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsCustomerSecretKeyIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsCustomerSecretKeyIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsCustomerSecretKeyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsCustomerSecretKeyTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsCustomerSecretKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsCustomerSecretKeyUser { /** * The user's display name. */ display: string; /** * The user's name. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsCustomerSecretKeysCustomerSecretKey { /** * The access key. */ accessKey: string; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Display Name */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * When the user's credential expire. */ expiresOn: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsCustomerSecretKeysCustomerSecretKeyIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsCustomerSecretKeysCustomerSecretKeyIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsCustomerSecretKeysCustomerSecretKeyMeta[]; /** * The user's OCID. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * The secret key. */ secretKey: string; /** * The user's credential status. */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsCustomerSecretKeysCustomerSecretKeyTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Controls whether a user can update themselves or not via User related APIs */ urnietfparamsscimschemasoracleidcsextensionselfChangeUsers: outputs.Identity.GetDomainsCustomerSecretKeysCustomerSecretKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser[]; /** * User linked to customer secret key */ users: outputs.Identity.GetDomainsCustomerSecretKeysCustomerSecretKeyUser[]; } interface GetDomainsCustomerSecretKeysCustomerSecretKeyIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsCustomerSecretKeysCustomerSecretKeyIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsCustomerSecretKeysCustomerSecretKeyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsCustomerSecretKeysCustomerSecretKeyTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsCustomerSecretKeysCustomerSecretKeyUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsCustomerSecretKeysCustomerSecretKeyUser { /** * The user's display name. */ display: string; /** * The user's name. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsDomain { adminEmail: string; adminFirstName: string; adminLastName: string; adminUserName: string; /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The domain descripition */ description: string; /** * The mutable display name of the domain */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The home region for the domain. See [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) for the full list of supported region names. Example: `us-phoenix-1` */ homeRegion: string; /** * The region specific domain URL */ homeRegionUrl: string; /** * The OCID of the domain */ id: string; /** * Indicate if the domain is visible at login screen or not */ isHiddenOnLogin: boolean; isNotificationBypassed: boolean; isPrimaryEmailRequired: boolean; /** * The domain license type */ licenseType: string; /** * Any additional details about the current state of the Domain. */ lifecycleDetails: string; /** * The regions domain is replication to. */ replicaRegions: outputs.Identity.GetDomainsDomainReplicaRegion[]; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Date and time the domain was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The domain type */ type: string; /** * The region agnostic domain URL */ url: string; } interface GetDomainsDomainReplicaRegion { /** * A REPLICATION_ENABLED region, e.g. us-ashburn-1. See [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) for the full list of supported region names. */ region: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The region agnostic domain URL */ url: string; } interface GetDomainsDynamicResourceGroupDynamicGroupAppRole { /** * If true, then the role provides administrative access privileges. READ-ONLY. */ adminRole: boolean; /** * App identifier */ appId: string; /** * Name of parent App. READ-ONLY. */ appName: string; /** * The displayName of the User or App who modified this Resource */ display: string; /** * The name of the legacy group associated with this AppRole. */ legacyGroupName: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupGrant { /** * App identifier */ appId: string; /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsDynamicResourceGroupTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTag { /** * Oracle Cloud Infrastructure Defined Tags */ definedTags: outputs.Identity.GetDomainsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag[]; /** * Oracle Cloud Infrastructure Freeform Tags */ freeformTags: outputs.Identity.GetDomainsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag[]; /** * Oracle Cloud Infrastructure Tag slug */ tagSlug: string; } interface GetDomainsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * Oracle Cloud Infrastructure Tag namespace */ namespace: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupsDynamicResourceGroup { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * text that explains the purpose of this Dynamic Resource Group */ description: string; /** * User-friendly, mutable identifier */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * A list of appRoles that are currently granted to this Dynamic Resource Group. The Identity service will assert these AppRoles for any resource that satisfies the matching-rule of this DynamicResourceGroup. */ dynamicGroupAppRoles: outputs.Identity.GetDomainsDynamicResourceGroupsDynamicResourceGroupDynamicGroupAppRole[]; /** * Grants assigned to group */ grants: outputs.Identity.GetDomainsDynamicResourceGroupsDynamicResourceGroupGrant[]; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsDynamicResourceGroupsDynamicResourceGroupIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsDynamicResourceGroupsDynamicResourceGroupIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Store as a string the matching-rule for this Dynamic Resource Group. This may match any number of Apps in this Domain, as well as matching any number of Oracle Cloud Infrastructure resources that are not in any Domain but that are in the Oracle Cloud Infrastructure Compartment that contains this Domain. */ matchingRule: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsDynamicResourceGroupsDynamicResourceGroupMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsDynamicResourceGroupsDynamicResourceGroupTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Oracle Cloud Infrastructure Tags. */ urnietfparamsscimschemasoracleidcsextensionOciTags: outputs.Identity.GetDomainsDynamicResourceGroupsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTag[]; } interface GetDomainsDynamicResourceGroupsDynamicResourceGroupDynamicGroupAppRole { /** * If true, then the role provides administrative access privileges. READ-ONLY. */ adminRole: boolean; /** * App identifier */ appId: string; /** * Name of parent App. READ-ONLY. */ appName: string; /** * The displayName of the User or App who modified this Resource */ display: string; /** * The name of the legacy group associated with this AppRole. */ legacyGroupName: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupsDynamicResourceGroupGrant { /** * App identifier */ appId: string; /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupsDynamicResourceGroupIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupsDynamicResourceGroupIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupsDynamicResourceGroupMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsDynamicResourceGroupsDynamicResourceGroupTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTag { /** * Oracle Cloud Infrastructure Defined Tags */ definedTags: outputs.Identity.GetDomainsDynamicResourceGroupsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag[]; /** * Oracle Cloud Infrastructure Freeform Tags */ freeformTags: outputs.Identity.GetDomainsDynamicResourceGroupsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag[]; /** * Oracle Cloud Infrastructure Tag slug */ tagSlug: string; } interface GetDomainsDynamicResourceGroupsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * Oracle Cloud Infrastructure Tag namespace */ namespace: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsDynamicResourceGroupsDynamicResourceGroupUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * Oracle Cloud Infrastructure Tag value */ value: string; } interface GetDomainsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetDomainsGrantApp { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantAppEntitlementCollection { /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantEntitlement { /** * The name of the attribute whose value (specified by attributeValue) confers privilege within the service-instance (specified by app). */ attributeName: string; /** * The value of the attribute (specified by attributeName) that confers privilege within the service-instance (specified by app). If attributeName is 'appRoles', then attributeValue is the ID of the AppRole. */ attributeValue: string; } interface GetDomainsGrantGrantee { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantGrantor { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsGrantTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantsGrant { /** * Application-Entitlement-Collection that is being granted. Each Grant must grant either an App or an App-Entitlement-Collection. */ appEntitlementCollections: outputs.Identity.GetDomainsGrantsGrantAppEntitlementCollection[]; /** * Application that is being granted. Each Grant must grant either an App or an App-Entitlement-Collection. */ apps: outputs.Identity.GetDomainsGrantsGrantApp[]; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * Unique key of grant, composed by combining a subset of app, entitlement, grantee, grantor and grantMechanism. Used to prevent duplicate Grants. */ compositeKey: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * The entitlement or privilege that is being granted */ entitlements: outputs.Identity.GetDomainsGrantsGrantEntitlement[]; /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * Store granted attribute-values as a string in Javascript Object Notation (JSON) format. */ grantedAttributeValuesJson: string; /** * Grantee beneficiary. The grantee may be a User, Group, App or DynamicResourceGroup. */ grantees: outputs.Identity.GetDomainsGrantsGrantGrantee[]; /** * User conferring the grant to the beneficiary */ grantors: outputs.Identity.GetDomainsGrantsGrantGrantor[]; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsGrantsGrantIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsGrantsGrantIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * If true, this Grant has been fulfilled successfully. */ isFulfilled: boolean; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsGrantsGrantMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsGrantsGrantTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsGrantsGrantApp { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantsGrantAppEntitlementCollection { /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantsGrantEntitlement { /** * The name of the attribute whose value (specified by attributeValue) confers privilege within the service-instance (specified by app). */ attributeName: string; /** * The value of the attribute (specified by attributeName) that confers privilege within the service-instance (specified by app). If attributeName is 'appRoles', then attributeValue is the ID of the AppRole. */ attributeValue: string; } interface GetDomainsGrantsGrantGrantee { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantsGrantGrantor { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantsGrantIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantsGrantIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsGrantsGrantMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsGrantsGrantTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsGroupIdcsCreatedBy { /** * App Display Name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupIdcsLastModifiedBy { /** * App Display Name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupMember { /** * The date and time that the member was added to the group. */ dateAdded: string; /** * App Display Name */ display: string; /** * The membership OCID. */ membershipOcid: string; /** * PasswordPolicy Name */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsGroupTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensionOciTag { /** * Oracle Cloud Infrastructure Defined Tags */ definedTags: outputs.Identity.GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag[]; /** * Oracle Cloud Infrastructure Freeform Tags */ freeformTags: outputs.Identity.GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag[]; /** * Oracle Cloud Infrastructure Tag slug */ tagSlug: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * Oracle Cloud Infrastructure Tag namespace */ namespace: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroup { /** * DBCS Domain-level schema-name. This attribute refers implicitly to a value of 'domainLevelSchemaNames' for a particular DB Domain. */ domainLevelSchema: string; /** * DBCS Domain-level schema-names. Each value is specific to a DB Domain. */ domainLevelSchemaNames: outputs.Identity.GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupDomainLevelSchemaName[]; /** * DBCS instance-level schema-name. This attribute refers implicitly to a value of 'instanceLevelSchemaNames' for a particular DB Instance. */ instanceLevelSchema: string; /** * DBCS instance-level schema-names. Each schema-name is specific to a DB Instance. */ instanceLevelSchemaNames: outputs.Identity.GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupInstanceLevelSchemaName[]; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupDomainLevelSchemaName { /** * DBCS Domain Name */ domainName: string; /** * The DBCS schema-name granted to this Group for the DB instance that 'dbInstanceId' specifies. */ schemaName: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupInstanceLevelSchemaName { /** * App Id of DBCS App instance */ dbInstanceId: string; /** * The DBCS schema-name granted to this Group for the DB instance that 'dbInstanceId' specifies. */ schemaName: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiondynamicGroup { /** * Membership rule */ membershipRule: string; /** * Membership type */ membershipType: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroup { /** * A list of appRoles that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated */ appRoles: outputs.Identity.GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupAppRole[]; /** * Source from which this group got created. */ creationMechanism: string; /** * Group description */ description: string; /** * Grants assigned to group */ grants: outputs.Identity.GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupGrant[]; /** * Group owners */ owners: outputs.Identity.GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupOwner[]; /** * Password Policy associated with this Group. */ passwordPolicies: outputs.Identity.GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupPasswordPolicy[]; /** * The entity that created this Group. */ syncedFromApps: outputs.Identity.GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupSyncedFromApp[]; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupAppRole { /** * If true, then the role provides administrative access privileges. READ-ONLY. */ adminRole: boolean; /** * App identifier */ appId: string; /** * Name of parent App. READ-ONLY. */ appName: string; /** * App Display Name */ display: string; /** * The name of the legacy group associated with this AppRole. */ legacyGroupName: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupGrant { /** * App identifier */ appId: string; /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * App URI */ ref: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupOwner { /** * App Display Name */ display: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupPasswordPolicy { /** * PasswordPolicy Name */ name: string; /** * PasswordPolicy priority */ priority: number; /** * App URI */ ref: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupSyncedFromApp { /** * App Display Name */ display: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensionposixGroup { /** * Integer uniquely identifying a group in a POSIX administrative domain */ gidNumber: number; } interface GetDomainsGroupUrnietfparamsscimschemasoracleidcsextensionrequestableGroup { /** * Flag controlling whether group membership can be request by user through self service console. */ requestable: boolean; } interface GetDomainsGroupsGroup { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * The Group display name. */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; forceDelete: boolean; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsGroupsGroupIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsGroupsGroupIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * The group members. Important: When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use 'startIndex' and 'count' to return members in pages instead of in a single response, for example: #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant. */ members: outputs.Identity.GetDomainsGroupsGroupMember[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsGroupsGroupMeta[]; /** * A human readable name for the group as defined by the Service Consumer. */ nonUniqueDisplayName: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsGroupsGroupTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Oracle Cloud Infrastructure Tags. */ urnietfparamsscimschemasoracleidcsextensionOciTags: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensionOciTag[]; /** * Schema for Database Service Resource */ urnietfparamsscimschemasoracleidcsextensiondbcsGroups: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroup[]; /** * Dynamic Group */ urnietfparamsscimschemasoracleidcsextensiondynamicGroups: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiondynamicGroup[]; /** * Oracle Identity Cloud Service Group */ urnietfparamsscimschemasoracleidcsextensiongroupGroups: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroup[]; /** * POSIX Group extension */ urnietfparamsscimschemasoracleidcsextensionposixGroups: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensionposixGroup[]; /** * Requestable Group */ urnietfparamsscimschemasoracleidcsextensionrequestableGroups: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensionrequestableGroup[]; } interface GetDomainsGroupsGroupIdcsCreatedBy { /** * App Display Name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupIdcsLastModifiedBy { /** * App Display Name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupMember { /** * The date and time that the member was added to the group. */ dateAdded: string; /** * App Display Name */ display: string; /** * The membership OCID. */ membershipOcid: string; /** * PasswordPolicy Name */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsGroupsGroupTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensionOciTag { /** * Oracle Cloud Infrastructure Defined Tags */ definedTags: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag[]; /** * Oracle Cloud Infrastructure Freeform Tags */ freeformTags: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag[]; /** * Oracle Cloud Infrastructure Tag slug */ tagSlug: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * Oracle Cloud Infrastructure Tag namespace */ namespace: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag { /** * Oracle Cloud Infrastructure Tag key */ key: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroup { /** * DBCS Domain-level schema-name. This attribute refers implicitly to a value of 'domainLevelSchemaNames' for a particular DB Domain. */ domainLevelSchema: string; /** * DBCS Domain-level schema-names. Each value is specific to a DB Domain. */ domainLevelSchemaNames: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupDomainLevelSchemaName[]; /** * DBCS instance-level schema-name. This attribute refers implicitly to a value of 'instanceLevelSchemaNames' for a particular DB Instance. */ instanceLevelSchema: string; /** * DBCS instance-level schema-names. Each schema-name is specific to a DB Instance. */ instanceLevelSchemaNames: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupInstanceLevelSchemaName[]; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupDomainLevelSchemaName { /** * DBCS Domain Name */ domainName: string; /** * The DBCS schema-name granted to this Group for the DB instance that 'dbInstanceId' specifies. */ schemaName: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiondbcsGroupInstanceLevelSchemaName { /** * App Id of DBCS App instance */ dbInstanceId: string; /** * The DBCS schema-name granted to this Group for the DB instance that 'dbInstanceId' specifies. */ schemaName: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiondynamicGroup { /** * Membership rule */ membershipRule: string; /** * Membership type */ membershipType: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroup { /** * A list of appRoles that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated */ appRoles: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupAppRole[]; /** * Source from which this group got created. */ creationMechanism: string; /** * Group description */ description: string; /** * Grants assigned to group */ grants: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupGrant[]; /** * Group owners */ owners: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupOwner[]; /** * Password Policy associated with this Group. */ passwordPolicies: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupPasswordPolicy[]; /** * The entity that created this Group. */ syncedFromApps: outputs.Identity.GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupSyncedFromApp[]; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupAppRole { /** * If true, then the role provides administrative access privileges. READ-ONLY. */ adminRole: boolean; /** * App identifier */ appId: string; /** * Name of parent App. READ-ONLY. */ appName: string; /** * App Display Name */ display: string; /** * The name of the legacy group associated with this AppRole. */ legacyGroupName: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupGrant { /** * App identifier */ appId: string; /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * App URI */ ref: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupOwner { /** * App Display Name */ display: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupPasswordPolicy { /** * PasswordPolicy Name */ name: string; /** * PasswordPolicy priority */ priority: number; /** * App URI */ ref: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupSyncedFromApp { /** * App Display Name */ display: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensionposixGroup { /** * Integer uniquely identifying a group in a POSIX administrative domain */ gidNumber: number; } interface GetDomainsGroupsGroupUrnietfparamsscimschemasoracleidcsextensionrequestableGroup { /** * Flag controlling whether group membership can be request by user through self service console. */ requestable: boolean; } interface GetDomainsIdentityProofingProviderClaimMapping { /** * Matching attribute. */ attrMatch: string; /** * Verifiable Claims. */ verifiableClaim: string; } interface GetDomainsIdentityProofingProviderConfiguration { /** * Name of the Identity Proofing Provider. */ name: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProviderIdcsCreatedBy { /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier (OCID) for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProviderIdcsLastModifiedBy { /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier (OCID) for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProviderIdcsLockedBy { /** * The URI of the SCIM resource that represents the User or App who Locked this Resource. */ _ref: string; /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier (OCID) for the SCIM Resource. */ ocid: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProviderMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsIdentityProofingProviderRuntimeData { /** * Name of the attribute. */ attrName: string; /** * Value of the attribute. */ attrValue: string; } interface GetDomainsIdentityProofingProviderTemplateConfiguration { /** * Name of the Identity Proofing Provider configuration. */ name: string; /** * Sensitivity of the Identity Proofing configuration. */ sensitivity: boolean; /** * The type of resource, User or App, that locked this Resource. */ type: string; } interface GetDomainsIdentityProofingProviderTemplateIdcsCreatedBy { /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProviderTemplateIdcsLastModifiedBy { /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProviderTemplateIdcsLockedBy { /** * The URI of the SCIM resource that represents the User or App who Locked this Resource. */ _ref: string; /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProviderTemplateMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplate { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (OCID) in which the resource lives. */ compartmentOcid: string; /** * Proofing Provider Configuration Template. */ configurations: outputs.Identity.GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplateConfiguration[]; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (OCID) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplateIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplateIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * The User or App who locked the Resource. */ idcsLockedBies: outputs.Identity.GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplateIdcsLockedBy[]; /** * The most recent DateTime the resource was locked. */ idcsLockedOn: string; /** * Operations that are locked on the resource. */ idcsLockedOperations: string[]; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Name of the Identity Proofing Provider. */ identityProofingProviderTemplateProvider: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplateMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Service type supported by the Identity Proofing Provider. */ serviceTypes: string[]; /** * Oracle Cloud Infrastructure Tenant Id (OCID) in which the resource lives. */ tenancyOcid: string; /** * verification URL. */ verificationUrl: string; } interface GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplateConfiguration { /** * Name of the Identity Proofing Provider configuration. */ name: string; /** * Sensitivity of the Identity Proofing configuration. */ sensitivity: boolean; /** * The type of resource, User or App, that locked this Resource. */ type: string; } interface GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplateIdcsCreatedBy { /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplateIdcsLastModifiedBy { /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplateIdcsLockedBy { /** * The URI of the SCIM resource that represents the User or App who Locked this Resource. */ _ref: string; /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProviderTemplatesIdentityProofingProviderTemplateMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsIdentityProofingProvidersIdentityProofingProvider { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Configure the verification claims and IAM Domain user attribute mapping. */ claimMappings: outputs.Identity.GetDomainsIdentityProofingProvidersIdentityProofingProviderClaimMapping[]; /** * Oracle Cloud Infrastructure Compartment Id (OCID) in which the resource lives. */ compartmentOcid: string; /** * Configure the verification provider. */ configurations: outputs.Identity.GetDomainsIdentityProofingProvidersIdentityProofingProviderConfiguration[]; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description field to add comments and additional information about the Identity Proofing Provider. */ description: string; /** * Oracle Cloud Infrastructure Domain Id (OCID) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsIdentityProofingProvidersIdentityProofingProviderIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsIdentityProofingProvidersIdentityProofingProviderIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * The User or App who locked the Resource. */ idcsLockedBies: outputs.Identity.GetDomainsIdentityProofingProvidersIdentityProofingProviderIdcsLockedBy[]; /** * The most recent DateTime the resource was locked. */ idcsLockedOn: string; /** * Operations that are locked on the resource. */ idcsLockedOperations: string[]; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * The Identity Proofing Provider. */ identityProofingProviderProvider: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsIdentityProofingProvidersIdentityProofingProviderMeta[]; /** * Name of the Identity Proofing Provider. */ name: string; /** * Unique Oracle Cloud Infrastructure identifier (OCID) for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * Identity Proofing runtime custom data. */ runtimeDatas: outputs.Identity.GetDomainsIdentityProofingProvidersIdentityProofingProviderRuntimeData[]; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Status of the Identity Proofing Provider. */ status: string; /** * Oracle Cloud Infrastructure Tenant Id (OCID) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsIdentityProofingProvidersIdentityProofingProviderClaimMapping { /** * Matching attribute. */ attrMatch: string; /** * Verifiable Claims. */ verifiableClaim: string; } interface GetDomainsIdentityProofingProvidersIdentityProofingProviderConfiguration { /** * Name of the Identity Proofing Provider. */ name: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProvidersIdentityProofingProviderIdcsCreatedBy { /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier (OCID) for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProvidersIdentityProofingProviderIdcsLastModifiedBy { /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier (OCID) for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProvidersIdentityProofingProviderIdcsLockedBy { /** * The URI of the SCIM resource that represents the User or App who Locked this Resource. */ _ref: string; /** * The displayName of the User or App who locked this Resource. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier (OCID) for the SCIM Resource. */ ocid: string; /** * The type of resource, User or App, that locked this Resource. */ type: string; /** * The ID of the SCIM resource that represents the User or App who LOCKED this Resource. */ value: string; } interface GetDomainsIdentityProofingProvidersIdentityProofingProviderMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsIdentityProofingProvidersIdentityProofingProviderRuntimeData { /** * Name of the attribute. */ attrName: string; /** * Value of the attribute. */ attrValue: string; } interface GetDomainsIdentityPropagationTrustCaCertChain { /** * A list of PEM-encoded intermediate CA certificates. */ intermediateCas: string[]; /** * A list of PEM-encoded root CA certificates. */ rootCas: string[]; } interface GetDomainsIdentityPropagationTrustClaimValidation { /** * The name of the the Identity Propagation Trust. */ name: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentityPropagationTrustIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of the inbound token from the Identity cloud provider. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentityPropagationTrustIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of the inbound token from the Identity cloud provider. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentityPropagationTrustImpersonationServiceUser { /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The rule expression to be used for matching the inbound token for impersonation. */ rule: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentityPropagationTrustKeytab { /** * The OCID of the secret. The secret content corresponding to the OCID is expected to be in Base64 encoded content type. */ secretOcid: string; /** * The version of the secret. When the version is not specified, then the latest secret version is used during runtime. */ secretVersion: number; } interface GetDomainsIdentityPropagationTrustMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsIdentityPropagationTrustTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentityPropagationTrustsIdentityPropagationTrust { /** * The Identity cloud provider service identifier, for example, the Azure Tenancy ID, AWS Account ID, or GCP Project ID. */ accountId: string; /** * If true, specifies that this Identity Propagation Trust is in an enabled state. The default value is false. */ active: boolean; /** * Allow customers to define whether the resulting token should contain the authenticated user as the subject or whether the token should impersonate another Application Principal in IAM. */ allowImpersonation: boolean; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Certificate trust store. This is required if identity propagation type is X509. */ caCertChains: outputs.Identity.GetDomainsIdentityPropagationTrustsIdentityPropagationTrustCaCertChain[]; /** * A list of claims to propagate in RPST */ claimPropagations: string[]; /** * A list of claim validations */ claimValidations: outputs.Identity.GetDomainsIdentityPropagationTrustsIdentityPropagationTrustClaimValidation[]; /** * The claim name that identifies to whom the JWT/SAML token is issued. If AWS, then \"aud\" or \"client_id\". If Azure, then \"appid\". If GCP, then \"aud\". */ clientClaimName: string; /** * The value that corresponds to the client claim name used to identify to whom the token is issued. */ clientClaimValues: string[]; /** * The clock skew (in secs) that's allowed for the token issue and expiry time. */ clockSkewSeconds: number; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * The description of the Identity Propagation Trust. */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsIdentityPropagationTrustsIdentityPropagationTrustIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsIdentityPropagationTrustsIdentityPropagationTrustIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Defines the external workload that acts as impersonating resource principal. */ impersonatingResource: string; /** * The Impersonating Principal. */ impersonationServiceUsers: outputs.Identity.GetDomainsIdentityPropagationTrustsIdentityPropagationTrustImpersonationServiceUser[]; /** * The issuer claim of the Identity provider. */ issuer: string; /** * The keytab stored in the tenancy's Vault. This is required if the identity propagation type is 'SPNEGO'. */ keytabs: outputs.Identity.GetDomainsIdentityPropagationTrustsIdentityPropagationTrustKeytab[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsIdentityPropagationTrustsIdentityPropagationTrustMeta[]; /** * The name of the the Identity Propagation Trust. */ name: string; /** * The value of all the authorized OAuth Clients. */ oauthClients: string[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Store the public key if public key cert. */ publicCertificate: string; /** * The cloud provider's public key API of SAML and OIDC providers for signature validation. */ publicKeyEndpoint: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Used for locating the subject claim from the incoming token. */ subjectClaimName: string; /** * Subject Mapping Attribute to which the value from subject claim name value would be used for identity lookup. */ subjectMappingAttribute: string; /** * The type of the resource against which lookup will be made in the identity domain in IAM for the incoming subject claim value. */ subjectType: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsIdentityPropagationTrustsIdentityPropagationTrustTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * The type of the inbound token from the Identity cloud provider. */ type: string; } interface GetDomainsIdentityPropagationTrustsIdentityPropagationTrustCaCertChain { /** * A list of PEM-encoded intermediate CA certificates. */ intermediateCas: string[]; /** * A list of PEM-encoded root CA certificates. */ rootCas: string[]; } interface GetDomainsIdentityPropagationTrustsIdentityPropagationTrustClaimValidation { /** * The name of the the Identity Propagation Trust. */ name: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentityPropagationTrustsIdentityPropagationTrustIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of the inbound token from the Identity cloud provider. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentityPropagationTrustsIdentityPropagationTrustIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of the inbound token from the Identity cloud provider. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentityPropagationTrustsIdentityPropagationTrustImpersonationServiceUser { /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The rule expression to be used for matching the inbound token for impersonation. */ rule: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentityPropagationTrustsIdentityPropagationTrustKeytab { /** * The OCID of the secret. The secret content corresponding to the OCID is expected to be in Base64 encoded content type. */ secretOcid: string; /** * The version of the secret. When the version is not specified, then the latest secret version is used during runtime. */ secretVersion: number; } interface GetDomainsIdentityPropagationTrustsIdentityPropagationTrustMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsIdentityPropagationTrustsIdentityPropagationTrustTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentityProviderCorrelationPolicy { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Group URI */ ref: string; /** * Identity Provider Type */ type: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProviderIdcsCreatedBy { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Group URI */ ref: string; /** * Identity Provider Type */ type: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProviderIdcsLastModifiedBy { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Group URI */ ref: string; /** * Identity Provider Type */ type: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProviderJitUserProvAssignedGroup { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Group URI */ ref: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProviderJitUserProvAttribute { /** * Group URI */ ref: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProviderJitUserProvGroupMapping { /** * IDP Group Name */ idpGroup: string; /** * Group URI */ ref: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProviderMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsIdentityProviderTag { /** * Key or name of the tag. */ key: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProviderUrnietfparamsscimschemasoracleidcsextensionsocialIdentityProvider { /** * Social IDP Access token URL */ accessTokenUrl: string; /** * Whether account linking is enabled */ accountLinkingEnabled: boolean; /** * Admin scope to request */ adminScopes: string[]; /** * Apple Developer ID */ appleDevId: string; /** * Apple Private Key ID */ appleKeyId: string; /** * Social IDP Authorization URL */ authzUrl: string; /** * Whether social auto redirect is enabled. The IDP policy should be configured with only one Social IDP, and without username/password selected. */ autoRedirectEnabled: boolean; /** * Whether the client credential is contained in payload */ clientCredentialInPayload: boolean; /** * Social IDP allowed clock skew time */ clockSkewInSeconds: number; /** * Social IDP Client Application Client ID */ consumerKey: string; /** * Social IDP Client Application Client Secret */ consumerSecret: string; /** * Discovery URL */ discoveryUrl: string; /** * Id attribute used for account linking */ idAttribute: string; /** * Lists the groups each social JIT-provisioned user is a member. Just-in-Time user-provisioning applies this static list when jitProvGroupStaticListEnabled:true. */ jitProvAssignedGroups: outputs.Identity.GetDomainsIdentityProviderUrnietfparamsscimschemasoracleidcsextensionsocialIdentityProviderJitProvAssignedGroup[]; /** * Set to true to indicate Social JIT User Provisioning Groups should be assigned from a static list */ jitProvGroupStaticListEnabled: boolean; /** * Social IDP User profile URL */ profileUrl: string; /** * redirect URL for social idp */ redirectUrl: string; /** * Whether registration is enabled */ registrationEnabled: boolean; /** * Scope to request */ scopes: string[]; /** * Service Provider Name */ serviceProviderName: string; /** * Whether Social JIT Provisioning is enabled */ socialJitProvisioningEnabled: boolean; /** * Status */ status: string; } interface GetDomainsIdentityProviderUrnietfparamsscimschemasoracleidcsextensionsocialIdentityProviderJitProvAssignedGroup { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Group URI */ ref: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProviderUrnietfparamsscimschemasoracleidcsextensionx509identityProvider { /** * X509 Certificate Matching Attribute */ certMatchAttribute: string; /** * Fallback on CRL Validation if OCSP fails. */ crlCheckOnOcspFailureEnabled: boolean; /** * Set to true to enable CRL Validation */ crlEnabled: boolean; /** * CRL Location URL */ crlLocation: string; /** * Fetch the CRL contents every X minutes */ crlReloadDuration: number; /** * Set to true to enable EKU Validation */ ekuValidationEnabled: boolean; /** * List of EKU which needs to be validated */ ekuValues: string[]; /** * Allow access if OCSP response is UNKNOWN or OCSP Responder does not respond within the timeout duration */ ocspAllowUnknownResponseStatus: boolean; /** * Describes if the OCSP response is signed */ ocspEnableSignedResponse: boolean; /** * Set to true to enable OCSP Validation */ ocspEnabled: boolean; /** * This property specifies OCSP Responder URL. */ ocspResponderUrl: string; /** * Revalidate OCSP status for user after X hours */ ocspRevalidateTime: number; /** * This property specifies the OCSP Server alias name */ ocspServerName: string; /** * OCSP Trusted Certificate Chain */ ocspTrustCertChains: string[]; /** * Check for specific conditions of other certificate attributes */ otherCertMatchAttribute: string; /** * Certificate alias list to create a chain for the incoming client certificate */ signingCertificateChains: string[]; /** * This property specifies the userstore attribute value that must match the incoming certificate attribute. */ userMatchAttribute: string; } interface GetDomainsIdentityProvidersIdentityProvider { /** * Assertion attribute name. */ assertionAttribute: string; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * HTTP binding to use for authentication requests. */ authnRequestBinding: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * Correlation policy */ correlationPolicies: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderCorrelationPolicy[]; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Set to true to indicate Partner enabled. */ enabled: boolean; /** * Encryption certificate */ encryptionCertificate: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Identity Provider Icon URL. */ iconUrl: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Identity Provider SSO URL */ idpSsoUrl: string; /** * Set to true to include the signing certificate in the signature. */ includeSigningCertInSignature: boolean; /** * Refers to every group of which a JIT-provisioned User should be a member. Just-in-Time user-provisioning applies this static list when jitUserProvGroupStaticListEnabled:true. */ jitUserProvAssignedGroups: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderJitUserProvAssignedGroup[]; /** * Set to true to indicate JIT User Creation is enabled */ jitUserProvAttributeUpdateEnabled: boolean; /** * Assertion To User Mapping */ jitUserProvAttributes: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderJitUserProvAttribute[]; /** * Set to true to indicate JIT User Creation is enabled */ jitUserProvCreateUserEnabled: boolean; /** * Set to true to indicate JIT User Provisioning is enabled */ jitUserProvEnabled: boolean; /** * Set to true to indicate JIT User Provisioning Groups should be assigned based on assertion attribute */ jitUserProvGroupAssertionAttributeEnabled: boolean; /** * The default value is 'Overwrite', which tells Just-In-Time user-provisioning to replace any current group-assignments for a User with those assigned by assertions and/or those assigned statically. Specify 'Merge' if you want Just-In-Time user-provisioning to combine its group-assignments with those the user already has. */ jitUserProvGroupAssignmentMethod: string; /** * Property to indicate the mode of group mapping */ jitUserProvGroupMappingMode: string; /** * The list of mappings between the Identity Domain Group and the IDP group. */ jitUserProvGroupMappings: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderJitUserProvGroupMapping[]; /** * Name of the assertion attribute containing the users groups */ jitUserProvGroupSamlAttributeName: string; /** * Set to true to indicate JIT User Provisioning Groups should be assigned from a static list */ jitUserProvGroupStaticListEnabled: boolean; /** * Set to true to indicate ignoring absence of group while provisioning */ jitUserProvIgnoreErrorOnAbsentGroups: boolean; /** * Records the notification timestamp for the IdP whose signing certificate is about to expire */ lastNotificationSentTime: string; /** * HTTP binding to use for logout. */ logoutBinding: string; /** * Set to true to enable logout. */ logoutEnabled: boolean; /** * Logout request URL */ logoutRequestUrl: string; /** * Logout response URL */ logoutResponseUrl: string; /** * Metadata */ metadata: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderMeta[]; /** * Default authentication request name ID format. */ nameIdFormat: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Unique name of the trusted Identity Provider. */ partnerName: string; /** * Provider ID */ partnerProviderId: string; /** * SAML SP authentication type. */ requestedAuthenticationContexts: string[]; /** * This SP requires requests SAML IdP to enforce re-authentication. */ requireForceAuthn: boolean; /** * SAML SP must accept encrypted assertion only. */ requiresEncryptedAssertion: boolean; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * SAML SP HoK Enabled. */ samlHoKrequired: boolean; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * The serviceInstanceIdentifier of the App that hosts this IdP. This value will match the opcServiceInstanceGUID of any service-instance that the IdP represents. */ serviceInstanceIdentifier: string; /** * Set to true to indicate whether to show IdP in login page or not. */ shownOnLoginPage: boolean; /** * Signature hash algorithm. */ signatureHashAlgorithm: string; /** * Signing certificate */ signingCertificate: string; /** * Succinct ID */ succinctId: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * The alternate Provider ID to be used as the Oracle Identity Cloud Service providerID (instead of the one in SamlSettings) when interacting with this IdP. */ tenantProviderId: string; /** * Identity Provider Type */ type: string; /** * Social Identity Provider Extension Schema */ urnietfparamsscimschemasoracleidcsextensionsocialIdentityProviders: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderUrnietfparamsscimschemasoracleidcsextensionsocialIdentityProvider[]; /** * X509 Identity Provider Extension Schema */ urnietfparamsscimschemasoracleidcsextensionx509identityProviders: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderUrnietfparamsscimschemasoracleidcsextensionx509identityProvider[]; /** * User mapping method. */ userMappingMethod: string; /** * This property specifies the userstore attribute value that must match the incoming assertion attribute value or the incoming nameid attribute value in order to identify the user during SSO.
You can construct the userMappingStoreAttribute value by specifying attributes from the Oracle Identity Cloud Service Core Users schema. For examples of how to construct the userMappingStoreAttribute value, see the Example of a Request Body section of the Examples tab for the POST and PUT methods of the /IdentityProviders endpoint. */ userMappingStoreAttribute: string; } interface GetDomainsIdentityProvidersIdentityProviderCorrelationPolicy { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Group URI */ ref: string; /** * Identity Provider Type */ type: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProvidersIdentityProviderIdcsCreatedBy { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Group URI */ ref: string; /** * Identity Provider Type */ type: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProvidersIdentityProviderIdcsLastModifiedBy { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Group URI */ ref: string; /** * Identity Provider Type */ type: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProvidersIdentityProviderJitUserProvAssignedGroup { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Group URI */ ref: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProvidersIdentityProviderJitUserProvAttribute { /** * Group URI */ ref: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProvidersIdentityProviderJitUserProvGroupMapping { /** * IDP Group Name */ idpGroup: string; /** * Group URI */ ref: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProvidersIdentityProviderMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsIdentityProvidersIdentityProviderTag { /** * Key or name of the tag. */ key: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProvidersIdentityProviderUrnietfparamsscimschemasoracleidcsextensionsocialIdentityProvider { /** * Social IDP Access token URL */ accessTokenUrl: string; /** * Whether account linking is enabled */ accountLinkingEnabled: boolean; /** * Admin scope to request */ adminScopes: string[]; /** * Apple Developer ID */ appleDevId: string; /** * Apple Private Key ID */ appleKeyId: string; /** * Social IDP Authorization URL */ authzUrl: string; /** * Whether social auto redirect is enabled. The IDP policy should be configured with only one Social IDP, and without username/password selected. */ autoRedirectEnabled: boolean; /** * Whether the client credential is contained in payload */ clientCredentialInPayload: boolean; /** * Social IDP allowed clock skew time */ clockSkewInSeconds: number; /** * Social IDP Client Application Client ID */ consumerKey: string; /** * Social IDP Client Application Client Secret */ consumerSecret: string; /** * Discovery URL */ discoveryUrl: string; /** * Id attribute used for account linking */ idAttribute: string; /** * Lists the groups each social JIT-provisioned user is a member. Just-in-Time user-provisioning applies this static list when jitProvGroupStaticListEnabled:true. */ jitProvAssignedGroups: outputs.Identity.GetDomainsIdentityProvidersIdentityProviderUrnietfparamsscimschemasoracleidcsextensionsocialIdentityProviderJitProvAssignedGroup[]; /** * Set to true to indicate Social JIT User Provisioning Groups should be assigned from a static list */ jitProvGroupStaticListEnabled: boolean; /** * Social IDP User profile URL */ profileUrl: string; /** * redirect URL for social idp */ redirectUrl: string; /** * Whether registration is enabled */ registrationEnabled: boolean; /** * Scope to request */ scopes: string[]; /** * Service Provider Name */ serviceProviderName: string; /** * Whether Social JIT Provisioning is enabled */ socialJitProvisioningEnabled: boolean; /** * Status */ status: string; } interface GetDomainsIdentityProvidersIdentityProviderUrnietfparamsscimschemasoracleidcsextensionsocialIdentityProviderJitProvAssignedGroup { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Group URI */ ref: string; /** * Group identifier */ value: string; } interface GetDomainsIdentityProvidersIdentityProviderUrnietfparamsscimschemasoracleidcsextensionx509identityProvider { /** * X509 Certificate Matching Attribute */ certMatchAttribute: string; /** * Fallback on CRL Validation if OCSP fails. */ crlCheckOnOcspFailureEnabled: boolean; /** * Set to true to enable CRL Validation */ crlEnabled: boolean; /** * CRL Location URL */ crlLocation: string; /** * Fetch the CRL contents every X minutes */ crlReloadDuration: number; /** * Set to true to enable EKU Validation */ ekuValidationEnabled: boolean; /** * List of EKU which needs to be validated */ ekuValues: string[]; /** * Allow access if OCSP response is UNKNOWN or OCSP Responder does not respond within the timeout duration */ ocspAllowUnknownResponseStatus: boolean; /** * Describes if the OCSP response is signed */ ocspEnableSignedResponse: boolean; /** * Set to true to enable OCSP Validation */ ocspEnabled: boolean; /** * This property specifies OCSP Responder URL. */ ocspResponderUrl: string; /** * Revalidate OCSP status for user after X hours */ ocspRevalidateTime: number; /** * This property specifies the OCSP Server alias name */ ocspServerName: string; /** * OCSP Trusted Certificate Chain */ ocspTrustCertChains: string[]; /** * Check for specific conditions of other certificate attributes */ otherCertMatchAttribute: string; /** * Certificate alias list to create a chain for the incoming client certificate */ signingCertificateChains: string[]; /** * This property specifies the userstore attribute value that must match the incoming certificate attribute. */ userMatchAttribute: string; } interface GetDomainsIdentitySettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The token type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentitySettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The token type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentitySettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsIdentitySettingMyProfile { /** * Whether to allow users to change their own password. */ allowEndUsersToChangeTheirPassword: boolean; /** * Whether to allow users to link or unlink their support accounts. */ allowEndUsersToLinkTheirSupportAccount: boolean; /** * Whether to allow users to update their capabilities. */ allowEndUsersToManageTheirCapabilities: boolean; /** * Whether to allow users to update their security settings. */ allowEndUsersToUpdateTheirSecuritySettings: boolean; } interface GetDomainsIdentitySettingPosixGid { /** * The number at which the Posix Uid Manual assignment ends. */ manualAssignmentEndsAt: number; /** * The number from which the Posix Uid Manual assignment starts. */ manualAssignmentStartsFrom: number; } interface GetDomainsIdentitySettingPosixUid { /** * The number at which the Posix Uid Manual assignment ends. */ manualAssignmentEndsAt: number; /** * The number from which the Posix Uid Manual assignment starts. */ manualAssignmentStartsFrom: number; } interface GetDomainsIdentitySettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentitySettingToken { /** * Indicates the number of minutes after which the token expires automatically. */ expiresAfter: number; /** * The token type. */ type: string; } interface GetDomainsIdentitySettingsIdentitySetting { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Indicates whether to show the 'user-is-locked' message during authentication if the user is already locked. The default value is false, which tells the system to show a generic 'authentication-failure' message. This is the most secure behavior. If the option is set to true, the system shows a more detailed 'error-message' that says the user is locked. This is more helpful but is less secure, for example, because the difference in error-messages could be used to determine which usernames exist and which do not. */ emitLockedMessageWhenUserIsLocked: boolean; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsIdentitySettingsIdentitySettingIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsIdentitySettingsIdentitySettingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; identitySettingId: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsIdentitySettingsIdentitySettingMeta[]; /** * Whether to allow users to update their own profile. */ myProfiles: outputs.Identity.GetDomainsIdentitySettingsIdentitySettingMyProfile[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * A list of Posix Gid settings. */ posixGids: outputs.Identity.GetDomainsIdentitySettingsIdentitySettingPosixGid[]; /** * A list of Posix Uid settings. */ posixUids: outputs.Identity.GetDomainsIdentitySettingsIdentitySettingPosixUid[]; /** * Indicates whether the primary email is required. */ primaryEmailRequired: boolean; /** * Indicates whether to remove non-RFC5322 compliant emails before creating a user. */ removeInvalidEmails: boolean; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * **Added In:** 2302092332 */ returnInactiveOverLockedMessage: boolean; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsIdentitySettingsIdentitySettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * A list of tokens and their expiry length. */ tokens: outputs.Identity.GetDomainsIdentitySettingsIdentitySettingToken[]; /** * Indicates whether a user is allowed to change their own recovery email. */ userAllowedToSetRecoveryEmail: boolean; } interface GetDomainsIdentitySettingsIdentitySettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The token type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentitySettingsIdentitySettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The token type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentitySettingsIdentitySettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsIdentitySettingsIdentitySettingMyProfile { /** * Whether to allow users to change their own password. */ allowEndUsersToChangeTheirPassword: boolean; /** * Whether to allow users to link or unlink their support accounts. */ allowEndUsersToLinkTheirSupportAccount: boolean; /** * Whether to allow users to update their capabilities. */ allowEndUsersToManageTheirCapabilities: boolean; /** * Whether to allow users to update their security settings. */ allowEndUsersToUpdateTheirSecuritySettings: boolean; } interface GetDomainsIdentitySettingsIdentitySettingPosixGid { /** * The number at which the Posix Uid Manual assignment ends. */ manualAssignmentEndsAt: number; /** * The number from which the Posix Uid Manual assignment starts. */ manualAssignmentStartsFrom: number; } interface GetDomainsIdentitySettingsIdentitySettingPosixUid { /** * The number at which the Posix Uid Manual assignment ends. */ manualAssignmentEndsAt: number; /** * The number from which the Posix Uid Manual assignment starts. */ manualAssignmentStartsFrom: number; } interface GetDomainsIdentitySettingsIdentitySettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsIdentitySettingsIdentitySettingToken { /** * Indicates the number of minutes after which the token expires automatically. */ expiresAfter: number; /** * The token type. */ type: string; } interface GetDomainsKmsiSettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsKmsiSettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsKmsiSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsKmsiSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsKmsiSettingsKmsiSetting { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsKmsiSettingsKmsiSettingIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsKmsiSettingsKmsiSettingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Identifier represents KMSI feature is enabled or not. */ kmsiFeatureEnabled: boolean; /** * Identifier represents KMSI to be prompted to user or not. */ kmsiPromptEnabled: boolean; kmsiSettingId: string; /** * Timestamp of when the KmsiSettings was enabled last time. */ lastEnabledOn: string; /** * Identifier represents duration in days within which kmsi token must be used. */ lastUsedValidityInDays: number; /** * Identifier represents maximum KMSI sessions allowed in the system. */ maxAllowedSessions: number; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsKmsiSettingsKmsiSettingMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsKmsiSettingsKmsiSettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Identifier represents validity duration in days. */ tokenValidityInDays: number; /** * Identifier represents whether user is prompted for ToU or not. */ touPromptDisabled: boolean; } interface GetDomainsKmsiSettingsKmsiSettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsKmsiSettingsKmsiSettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsKmsiSettingsKmsiSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsKmsiSettingsKmsiSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsMappedAttributeAttributeMapping { /** * If specified, indicates a subset of mappedActions to which this attribute-mapping applies.If not specified, this attribute-mapping applies to all mappedActions that use mappedAttributes */ appliesToActions: string[]; /** * The name or expression of an attribute that corresponds to the Oracle Identity Cloud Service Resource referred in the \"idcsResourceType\" attribute. */ idcsAttributeName: string; /** * The name or expression of an attribute defined in the schema of the Managed Object Class. This is the SCIM compliant Oracle Identity Cloud Service Name of the attribute that maps to the \"idcsName\" attribute in the schema of an Managed Object Class. */ managedObjectAttributeName: string; /** * If true, indicates that this attribute must have a value. This attribute maps to the \"required\" sub-attribute in the schema of an Managed Object Class. */ required: boolean; /** * Indicates the format of the assertion attribute. Also stores AttributeNamespace for WSFed1.1. */ samlFormat: string; } interface GetDomainsMappedAttributeIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMappedAttributeIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMappedAttributeMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMappedAttributeTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsMappedAttributesMappedAttribute { /** * A list of attribute mappings between Oracle Identity Cloud Service Resource Type and Account Object Class */ attributeMappings: outputs.Identity.GetDomainsMappedAttributesMappedAttributeAttributeMapping[]; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Direction of the attribute mapping. inbound indicates mapping is from source ManagedObjectClass to Oracle Identity Cloud Service ResourceType. outbound indicates mapping is from Oracle Identity Cloud Service Resource Type to target ManagedObjectClass. */ direction: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMappedAttributesMappedAttributeIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMappedAttributesMappedAttributeIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * The Oracle Identity Cloud Service Resource Type for which the mapping is being done */ idcsResourceType: string; mappedAttributeId: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMappedAttributesMappedAttributeMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Soft Reference to store Resource ID that holds the mapping */ refResourceId: string; /** * The Reference Resource Type that holds the mapping */ refResourceType: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMappedAttributesMappedAttributeTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsMappedAttributesMappedAttributeAttributeMapping { /** * If specified, indicates a subset of mappedActions to which this attribute-mapping applies.If not specified, this attribute-mapping applies to all mappedActions that use mappedAttributes */ appliesToActions: string[]; /** * The name or expression of an attribute that corresponds to the Oracle Identity Cloud Service Resource referred in the \"idcsResourceType\" attribute. */ idcsAttributeName: string; /** * The name or expression of an attribute defined in the schema of the Managed Object Class. This is the SCIM compliant Oracle Identity Cloud Service Name of the attribute that maps to the \"idcsName\" attribute in the schema of an Managed Object Class. */ managedObjectAttributeName: string; /** * If true, indicates that this attribute must have a value. This attribute maps to the \"required\" sub-attribute in the schema of an Managed Object Class. */ required: boolean; /** * Indicates the format of the assertion attribute. Also stores AttributeNamespace for WSFed1.1. */ samlFormat: string; } interface GetDomainsMappedAttributesMappedAttributeIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMappedAttributesMappedAttributeIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMappedAttributesMappedAttributeMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMappedAttributesMappedAttributeTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyApiKeyIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyApiKeyIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyApiKeyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyApiKeyTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsMyApiKeyUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsMyApiKeysMyApiKey { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Fingerprint */ fingerprint: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyApiKeysMyApiKeyIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyApiKeysMyApiKeyIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Key or name of the tag. */ key: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyApiKeysMyApiKeyMeta[]; /** * The user's OCID. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyApiKeysMyApiKeyTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * The user linked to the API key. */ users: outputs.Identity.GetDomainsMyApiKeysMyApiKeyUser[]; } interface GetDomainsMyApiKeysMyApiKeyIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyApiKeysMyApiKeyIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyApiKeysMyApiKeyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyApiKeysMyApiKeyTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsMyApiKeysMyApiKeyUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsMyAppsMyApp { /** * Type of the Acccount */ accountType: string; /** * If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App, and only administrative operations can be performed. */ active: boolean; /** * Application on which the account is based */ apps: outputs.Identity.GetDomainsMyAppsMyAppApp[]; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * If true, this account has been marked as a favorite of the User who owns it. */ favorite: boolean; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyAppsMyAppIdcsCreatedBy[]; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyAppsMyAppIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * If true, indicates that this managed object is an account, which is an identity that represents a user in the context of a specific application. */ isAccount: boolean; /** * Last accessed timestamp of an application */ lastAccessed: string; /** * The URL that will be used to launch the application. */ launchUrl: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyAppsMyAppMeta[]; /** * Name of the Account */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Owning user of the account */ owners: outputs.Identity.GetDomainsMyAppsMyAppOwner[]; /** * The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyAppsMyAppTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Unique identifier of the Account. */ uid: string; /** * The UserWalletArtifact that contains the credentials that the system will use in performing Secure Form-Fill to log the User into this application. */ userWalletArtifacts: outputs.Identity.GetDomainsMyAppsMyAppUserWalletArtifact[]; } interface GetDomainsMyAppsMyAppApp { /** * If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML. If false, all runtime services are disabled for this App, and only administrative operations can be performed. */ active: boolean; /** * Application icon. */ appIcon: string; /** * Application thumbnail. */ appThumbnail: string; /** * Application description */ description: string; /** * User display name */ display: string; /** * If true, this App is an AliasApp and it cannot be granted to an end user directly */ isAliasApp: boolean; /** * If true, this App allows runtime services to log end users into this App automatically. */ isLoginTarget: boolean; /** * If true, this application is an Oracle Public Cloud service-instance. */ isOpcService: boolean; /** * The protocol that runtime services will use to log end users in to this App automatically. If 'OIDC', then runtime services use the OpenID Connect protocol. If 'SAML', then runtime services use Security Assertion Markup Language protocol. */ loginMechanism: string; /** * UserWalletArtifact URI */ ref: string; /** * This Uniform Resource Name (URN) value identifies the type of Oracle Public Cloud service of which this app is an instance. */ serviceTypeUrn: string; /** * If true, this App will be displayed in the MyApps page of each end-user who has access to this App. */ showInMyApps: boolean; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsMyAppsMyAppIdcsCreatedBy { /** * User display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * UserWalletArtifact URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsMyAppsMyAppIdcsLastModifiedBy { /** * User display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * UserWalletArtifact URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsMyAppsMyAppMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyAppsMyAppOwner { /** * User display name */ display: string; /** * UserWalletArtifact URI */ ref: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsMyAppsMyAppTag { /** * Key or name of the tag. */ key: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsMyAppsMyAppUserWalletArtifact { /** * UserWalletArtifact URI */ ref: string; /** * UserWalletArtifact identifier */ value: string; } interface GetDomainsMyAuthTokenIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyAuthTokenIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyAuthTokenMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyAuthTokenTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsMyAuthTokenUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsMyAuthTokensMyAuthToken { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * When the user's credential expire. */ expiresOn: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyAuthTokensMyAuthTokenIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyAuthTokensMyAuthTokenIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyAuthTokensMyAuthTokenMeta[]; /** * The user's OCID. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * The user's credential status. */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyAuthTokensMyAuthTokenTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * The user linked to the Auth token. */ users: outputs.Identity.GetDomainsMyAuthTokensMyAuthTokenUser[]; } interface GetDomainsMyAuthTokensMyAuthTokenIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyAuthTokensMyAuthTokenIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyAuthTokensMyAuthTokenMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyAuthTokensMyAuthTokenTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsMyAuthTokensMyAuthTokenUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsMyCompletedApprovalIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyCompletedApprovalIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyCompletedApprovalMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Requested Resource type */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyCompletedApprovalTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyCompletedApprovalsMyCompletedApproval { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Time by when ApprovalWorkflowInstance expires */ expires: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyCompletedApprovalsMyCompletedApprovalIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyCompletedApprovalsMyCompletedApprovalIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Justification for approval */ justification: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyCompletedApprovalsMyCompletedApprovalMeta[]; myCompletedApprovalId: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The time that the Request was created */ requestCreatedTime: string; /** * Request Details */ requestDetails: string; /** * The Unique Identifier of the request. */ requestId: string; /** * The Oracle Cloud Infrastructure Unique Identifier of the request. */ requestOcid: string; /** * Requested Resource display name */ resourceDisplayName: string; /** * Requested Resource type */ resourceType: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * The time that the user responded to the Approval */ responseTime: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Status of the approver's response on the approval */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyCompletedApprovalsMyCompletedApprovalTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsMyCompletedApprovalsMyCompletedApprovalIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyCompletedApprovalsMyCompletedApprovalIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyCompletedApprovalsMyCompletedApprovalMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Requested Resource type */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyCompletedApprovalsMyCompletedApprovalTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyCustomerSecretKeyIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyCustomerSecretKeyIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyCustomerSecretKeyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyCustomerSecretKeyTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsMyCustomerSecretKeyUser { /** * The user's display name. */ display: string; /** * The user's name. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsMyCustomerSecretKeysMyCustomerSecretKey { /** * The access key. */ accessKey: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Display Name */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * When the user's credential expire. */ expiresOn: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyCustomerSecretKeysMyCustomerSecretKeyIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyCustomerSecretKeysMyCustomerSecretKeyIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyCustomerSecretKeysMyCustomerSecretKeyMeta[]; /** * The user's OCID. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * The user's credential status. */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyCustomerSecretKeysMyCustomerSecretKeyTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * User linked to customer secret key */ users: outputs.Identity.GetDomainsMyCustomerSecretKeysMyCustomerSecretKeyUser[]; } interface GetDomainsMyCustomerSecretKeysMyCustomerSecretKeyIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyCustomerSecretKeysMyCustomerSecretKeyIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyCustomerSecretKeysMyCustomerSecretKeyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyCustomerSecretKeysMyCustomerSecretKeyTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsMyCustomerSecretKeysMyCustomerSecretKeyUser { /** * The user's display name. */ display: string; /** * The user's name. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsMyDeviceAdditionalAttribute { /** * Key or name of the tag. */ key: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDeviceAuthenticationFactor { /** * Authentication Factor public key issued by client */ publicKey: string; /** * Device Status */ status: string; /** * The type of resource, User or App, that modified this Resource */ type: string; } interface GetDomainsMyDeviceIdcsCreatedBy { /** * User display name */ display: string; /** * The OCID of the user */ ocid: string; /** * The URI that corresponds to the member Resource of this device */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDeviceIdcsLastModifiedBy { /** * User display name */ display: string; /** * The OCID of the user */ ocid: string; /** * The URI that corresponds to the member Resource of this device */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDeviceMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyDeviceNonCompliance { /** * Device Compliance Action */ action: string; /** * Device Compliance name */ name: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDevicePushNotificationTarget { /** * The URI that corresponds to the member Resource of this device */ ref: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDeviceTag { /** * Key or name of the tag. */ key: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDeviceThirdPartyFactor { /** * The URI that corresponds to the member Resource of this device */ ref: string; /** * Type of the third party authentication factor */ thirdPartyFactorType: string; /** * The vendor name of the third party factor */ thirdPartyVendorName: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDeviceUser { /** * User display name */ display: string; /** * The OCID of the user */ ocid: string; /** * The URI that corresponds to the member Resource of this device */ ref: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDevicesMyDevice { /** * Device additional attributes */ additionalAttributes: outputs.Identity.GetDomainsMyDevicesMyDeviceAdditionalAttribute[]; /** * Mobile Authenticator App Version */ appVersion: string; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * Authentication Factors */ authenticationFactors: outputs.Identity.GetDomainsMyDevicesMyDeviceAuthenticationFactor[]; /** * Authentication method used in device. For FIDO, it will contain SECURITY_KEY/WINDOWS_HELLO etc */ authenticationMethod: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Device base public Key */ basePublicKey: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * Country code of user's Phone Number */ countryCode: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Device hardware name/model */ deviceType: string; /** * Unique id sent from device */ deviceUuid: string; /** * Device friendly display name */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Attribute added for replication log, it is not used by IDCS, just added as place holder */ expiresOn: number; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyDevicesMyDeviceIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyDevicesMyDeviceIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Flag that indicates whether the device is enrolled for account recovery */ isAccRecEnabled: boolean; /** * Device Compliance Status */ isCompliant: boolean; /** * Last Sync time for device */ lastSyncTime: string; /** * The most recent timestamp when the device was successfully validated using one time passcode */ lastValidatedTime: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyDevicesMyDeviceMeta[]; myDeviceId: string; /** * Device Non Compliances */ nonCompliances: outputs.Identity.GetDomainsMyDevicesMyDeviceNonCompliance[]; /** * The OCID of the user */ ocid: string; /** * Mobile Authenticator App Package Id */ packageId: string; /** * User's Phone Number */ phoneNumber: string; /** * Device Platform */ platform: string; /** * Push Notification target. Reference to Device notification related resource */ pushNotificationTargets: outputs.Identity.GetDomainsMyDevicesMyDevicePushNotificationTarget[]; /** * Additional comments/reasons for the change in device status */ reason: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Attribute added for replication log, it is not used by IDCS, it is actual encrypted TOTP seed for the user */ seed: string; /** * Attribute added for replication log, it is not used by IDCS, the DEK that encrypts the specific seed for that user */ seedDekId: string; /** * Device Status */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyDevicesMyDeviceTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * User's third-party authentication factor details */ thirdPartyFactors: outputs.Identity.GetDomainsMyDevicesMyDeviceThirdPartyFactor[]; /** * Device member */ users: outputs.Identity.GetDomainsMyDevicesMyDeviceUser[]; } interface GetDomainsMyDevicesMyDeviceAdditionalAttribute { /** * Key or name of the tag. */ key: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDevicesMyDeviceAuthenticationFactor { /** * Authentication Factor public key issued by client */ publicKey: string; /** * Device Status */ status: string; /** * The type of resource, User or App, that modified this Resource */ type: string; } interface GetDomainsMyDevicesMyDeviceIdcsCreatedBy { /** * User display name */ display: string; /** * The OCID of the user */ ocid: string; /** * The URI that corresponds to the member Resource of this device */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDevicesMyDeviceIdcsLastModifiedBy { /** * User display name */ display: string; /** * The OCID of the user */ ocid: string; /** * The URI that corresponds to the member Resource of this device */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDevicesMyDeviceMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyDevicesMyDeviceNonCompliance { /** * Device Compliance Action */ action: string; /** * Device Compliance name */ name: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDevicesMyDevicePushNotificationTarget { /** * The URI that corresponds to the member Resource of this device */ ref: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDevicesMyDeviceTag { /** * Key or name of the tag. */ key: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDevicesMyDeviceThirdPartyFactor { /** * The URI that corresponds to the member Resource of this device */ ref: string; /** * Type of the third party authentication factor */ thirdPartyFactorType: string; /** * The vendor name of the third party factor */ thirdPartyVendorName: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyDevicesMyDeviceUser { /** * User display name */ display: string; /** * The OCID of the user */ ocid: string; /** * The URI that corresponds to the member Resource of this device */ ref: string; /** * The identifier of the user */ value: string; } interface GetDomainsMyGroupsMyGroup { /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * The Group display name. */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyGroupsMyGroupIdcsCreatedBy[]; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyGroupsMyGroupIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * The group members. Important: When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use 'startIndex' and 'count' to return members in pages instead of in a single response, for example: #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant. */ members: outputs.Identity.GetDomainsMyGroupsMyGroupMember[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyGroupsMyGroupMeta[]; /** * A human readable name for the group as defined by the Service Consumer. */ nonUniqueDisplayName: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyGroupsMyGroupTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Oracle Identity Cloud Service Group */ urnietfparamsscimschemasoracleidcsextensiongroupGroups: outputs.Identity.GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroup[]; /** * POSIX Group extension */ urnietfparamsscimschemasoracleidcsextensionposixGroups: outputs.Identity.GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensionposixGroup[]; } interface GetDomainsMyGroupsMyGroupIdcsCreatedBy { /** * App Display Name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyGroupsMyGroupIdcsLastModifiedBy { /** * App Display Name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyGroupsMyGroupMember { /** * The date and time that the member was added to the group. */ dateAdded: string; /** * App Display Name */ display: string; /** * The membership OCID. */ membershipOcid: string; /** * PasswordPolicy Name */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyGroupsMyGroupMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyGroupsMyGroupTag { /** * Key or name of the tag. */ key: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroup { /** * A list of appRoles that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated */ appRoles: outputs.Identity.GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupAppRole[]; /** * Source from which this group got created. */ creationMechanism: string; /** * Group description */ description: string; /** * Grants assigned to group */ grants: outputs.Identity.GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupGrant[]; /** * Group owners */ owners: outputs.Identity.GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupOwner[]; /** * Password Policy associated with this Group. */ passwordPolicies: outputs.Identity.GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupPasswordPolicy[]; /** * The entity that created this Group. */ syncedFromApps: outputs.Identity.GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupSyncedFromApp[]; } interface GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupAppRole { /** * If true, then the role provides administrative access privileges. READ-ONLY. */ adminRole: boolean; /** * App identifier */ appId: string; /** * Name of parent App. READ-ONLY. */ appName: string; /** * App Display Name */ display: string; /** * The name of the legacy group associated with this AppRole. */ legacyGroupName: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupGrant { /** * App identifier */ appId: string; /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * App URI */ ref: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupOwner { /** * App Display Name */ display: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupPasswordPolicy { /** * PasswordPolicy Name */ name: string; /** * PasswordPolicy priority */ priority: number; /** * App URI */ ref: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupSyncedFromApp { /** * App Display Name */ display: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyGroupsMyGroupUrnietfparamsscimschemasoracleidcsextensionposixGroup { /** * Integer uniquely identifying a group in a POSIX administrative domain */ gidNumber: number; } interface GetDomainsMyOauth2clientCredentialIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyOauth2clientCredentialIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyOauth2clientCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyOauth2clientCredentialScope { /** * Audience */ audience: string; /** * Scope */ scope: string; } interface GetDomainsMyOauth2clientCredentialTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsMyOauth2clientCredentialUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsMyOauth2clientCredentialsMyOauth2clientCredential { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * When the user's credentials expire. */ expiresOn: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Specifies whether the secret must be reset. */ isResetSecret: boolean; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialMeta[]; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Scopes */ scopes: outputs.Identity.GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialScope[]; /** * The user's credential status. */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * The user linked to the OAuth2 client credential. */ users: outputs.Identity.GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialUser[]; } interface GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialScope { /** * Audience */ audience: string; /** * Scope */ scope: string; } interface GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsMyOauth2clientCredentialsMyOauth2clientCredentialUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsMyPendingApprovalIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyPendingApprovalIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyPendingApprovalMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Requested Resource type */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyPendingApprovalTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyPendingApprovalsMyPendingApproval { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Time by when ApprovalWorkflowInstance expires */ expires: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyPendingApprovalsMyPendingApprovalIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyPendingApprovalsMyPendingApprovalIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Justification for approval */ justification: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyPendingApprovalsMyPendingApprovalMeta[]; myPendingApprovalId: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The time that the Request was created */ requestCreatedTime: string; /** * Request Details */ requestDetails: string; /** * The Unique Identifier of the request. */ requestId: string; /** * The Oracle Cloud Infrastructure Unique Identifier of the request. */ requestOcid: string; /** * Requested Resource display name */ resourceDisplayName: string; /** * Requested Resource type */ resourceType: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * The time that the user responded to the Approval */ responseTime: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Status of the approver's response on the approval */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyPendingApprovalsMyPendingApprovalTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsMyPendingApprovalsMyPendingApprovalIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyPendingApprovalsMyPendingApprovalIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyPendingApprovalsMyPendingApprovalMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Requested Resource type */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyPendingApprovalsMyPendingApprovalTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroup { /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * The Group display name. */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupIdcsCreatedBy[]; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * The group members. Important: When requesting group members, a maximum of 10,000 members can be returned in a single request. If the response contains more than 10,000 members, the request will fail. Use 'startIndex' and 'count' to return members in pages instead of in a single response, for example: #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant. */ members: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupMember[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupMeta[]; /** * A human readable name for the group as defined by the Service Consumer. */ nonUniqueDisplayName: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Oracle Identity Cloud Service Group */ urnietfparamsscimschemasoracleidcsextensiongroupGroups: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroup[]; /** * Requestable Group */ urnietfparamsscimschemasoracleidcsextensionrequestableGroups: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensionrequestableGroup[]; } interface GetDomainsMyRequestableGroupsMyRequestableGroupIdcsCreatedBy { /** * App Display Name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroupIdcsLastModifiedBy { /** * App Display Name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroupMember { /** * The date and time that the member was added to the group. */ dateAdded: string; /** * App Display Name */ display: string; /** * The membership OCID. */ membershipOcid: string; /** * PasswordPolicy Name */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroupMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroupTag { /** * Key or name of the tag. */ key: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroup { /** * A list of appRoles that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated */ appRoles: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupAppRole[]; /** * Source from which this group got created. */ creationMechanism: string; /** * Group description */ description: string; /** * Grants assigned to group */ grants: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupGrant[]; /** * Group owners */ owners: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupOwner[]; /** * Password Policy associated with this Group. */ passwordPolicies: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupPasswordPolicy[]; /** * The entity that created this Group. */ syncedFromApps: outputs.Identity.GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupSyncedFromApp[]; } interface GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupAppRole { /** * If true, then the role provides administrative access privileges. READ-ONLY. */ adminRole: boolean; /** * App identifier */ appId: string; /** * Name of parent App. READ-ONLY. */ appName: string; /** * App Display Name */ display: string; /** * The name of the legacy group associated with this AppRole. */ legacyGroupName: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupGrant { /** * App identifier */ appId: string; /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * App URI */ ref: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupOwner { /** * App Display Name */ display: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupPasswordPolicy { /** * PasswordPolicy Name */ name: string; /** * PasswordPolicy priority */ priority: number; /** * App URI */ ref: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensiongroupGroupSyncedFromApp { /** * App Display Name */ display: string; /** * App URI */ ref: string; /** * The type of the entity that created this Group. */ type: string; /** * The ID of the App. */ value: string; } interface GetDomainsMyRequestableGroupsMyRequestableGroupUrnietfparamsscimschemasoracleidcsextensionrequestableGroup { /** * Flag controlling whether group membership can be request by user through self service console. */ requestable: boolean; } interface GetDomainsMyRequestsMyRequest { /** * Requestor can set action to CANCEL to cancel the request or to ESCALATE to escalate the request while the request status is IN_PROGRESS. Requestor can't escalate the request if canceling or escalation is in progress. */ action: string; /** * Approvals created for this request. */ approvalDetails: outputs.Identity.GetDomainsMyRequestsMyRequestApprovalDetail[]; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Time by when Request expires */ expires: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyRequestsMyRequestIdcsCreatedBy[]; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyRequestsMyRequestIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * justification */ justification: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyRequestsMyRequestMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Requestable resource reference. */ requestings: outputs.Identity.GetDomainsMyRequestsMyRequestRequesting[]; /** * Requesting User */ requestors: outputs.Identity.GetDomainsMyRequestsMyRequestRequestor[]; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * status */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyRequestsMyRequestTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsMyRequestsMyRequestApprovalDetail { /** * Approval Type (Escalation or Regular) */ approvalType: string; /** * Approver display name */ approverDisplayName: string; /** * Approver Id */ approverId: string; /** * justification */ justification: string; /** * Approval Order */ order: number; /** * status */ status: string; /** * Approval Update Time */ timeUpdated: string; } interface GetDomainsMyRequestsMyRequestIdcsCreatedBy { /** * User display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * User URI */ ref: string; /** * Requestable type. Allowed values are Group and App. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyRequestsMyRequestIdcsLastModifiedBy { /** * User display name */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * User URI */ ref: string; /** * Requestable type. Allowed values are Group and App. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyRequestsMyRequestMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyRequestsMyRequestRequesting { /** * Resource description */ description: string; /** * User display name */ display: string; /** * User URI */ ref: string; /** * Requestable type. Allowed values are Group and App. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyRequestsMyRequestRequestor { /** * User display name */ display: string; /** * User URI */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsMyRequestsMyRequestTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsMySmtpCredentialIdcsCreatedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsMySmtpCredentialIdcsLastModifiedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsMySmtpCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMySmtpCredentialTag { /** * Key or name of the tag. */ key: string; /** * User's id */ value: string; } interface GetDomainsMySmtpCredentialUser { /** * User display name */ display: string; /** * User name */ name: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * User's id */ value: string; } interface GetDomainsMySmtpCredentialsMySmtpCredential { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * User credential expires on */ expiresOn: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMySmtpCredentialsMySmtpCredentialIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMySmtpCredentialsMySmtpCredentialIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMySmtpCredentialsMySmtpCredentialMeta[]; /** * User's ocid */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * User credential status */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMySmtpCredentialsMySmtpCredentialTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * User name */ userName: string; /** * User linked to smtp credential */ users: outputs.Identity.GetDomainsMySmtpCredentialsMySmtpCredentialUser[]; } interface GetDomainsMySmtpCredentialsMySmtpCredentialIdcsCreatedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsMySmtpCredentialsMySmtpCredentialIdcsLastModifiedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsMySmtpCredentialsMySmtpCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMySmtpCredentialsMySmtpCredentialTag { /** * Key or name of the tag. */ key: string; /** * User's id */ value: string; } interface GetDomainsMySmtpCredentialsMySmtpCredentialUser { /** * User display name */ display: string; /** * User name */ name: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * User's id */ value: string; } interface GetDomainsMySupportAccountIdcsCreatedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this Support Account */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsMySupportAccountIdcsLastModifiedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this Support Account */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsMySupportAccountMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMySupportAccountTag { /** * Key or name of the tag. */ key: string; /** * User's id */ value: string; } interface GetDomainsMySupportAccountUser { /** * User display name */ display: string; /** * User name */ name: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this Support Account */ ref: string; /** * User's id */ value: string; } interface GetDomainsMySupportAccountsMySupportAccount { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMySupportAccountsMySupportAccountIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMySupportAccountsMySupportAccountIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMySupportAccountsMySupportAccountMeta[]; /** * User Support Account Provider */ mySupportAccountProvider: string; /** * User's ocid */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMySupportAccountsMySupportAccountTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * User Support Account Token */ token: string; /** * User Support User Id */ userId: string; /** * User linked to Support Account */ users: outputs.Identity.GetDomainsMySupportAccountsMySupportAccountUser[]; } interface GetDomainsMySupportAccountsMySupportAccountIdcsCreatedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this Support Account */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsMySupportAccountsMySupportAccountIdcsLastModifiedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this Support Account */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsMySupportAccountsMySupportAccountMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMySupportAccountsMySupportAccountTag { /** * Key or name of the tag. */ key: string; /** * User's id */ value: string; } interface GetDomainsMySupportAccountsMySupportAccountUser { /** * User display name */ display: string; /** * User name */ name: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this Support Account */ ref: string; /** * User's id */ value: string; } interface GetDomainsMyTrustedUserAgentIdcsCreatedBy { /** * Friendly name of the User to be used for purposes of display. */ display: string; /** * The OCID of the user */ ocid: string; /** * Full URI to the user for whom the trust-token was issued. */ ref: string; /** * Trusted Factor */ type: string; /** * The SCIM ID of the user for whom the trust-token was issued. */ value: string; } interface GetDomainsMyTrustedUserAgentIdcsLastModifiedBy { /** * Friendly name of the User to be used for purposes of display. */ display: string; /** * The OCID of the user */ ocid: string; /** * Full URI to the user for whom the trust-token was issued. */ ref: string; /** * Trusted Factor */ type: string; /** * The SCIM ID of the user for whom the trust-token was issued. */ value: string; } interface GetDomainsMyTrustedUserAgentMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyTrustedUserAgentTag { /** * Key or name of the tag. */ key: string; /** * The SCIM ID of the user for whom the trust-token was issued. */ value: string; } interface GetDomainsMyTrustedUserAgentTrustedFactor { /** * Trusted Factor Type. Local, X509, SAML SOCIAL */ category: string; /** * trust factor creation time */ creationTime: string; /** * Trusted Factor */ type: string; } interface GetDomainsMyTrustedUserAgentUser { /** * Friendly name of the User to be used for purposes of display. */ display: string; /** * The OCID of the user */ ocid: string; /** * Full URI to the user for whom the trust-token was issued. */ ref: string; /** * The SCIM ID of the user for whom the trust-token was issued. */ value: string; } interface GetDomainsMyTrustedUserAgentsMyTrustedUserAgent { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Validation period of the trust token. */ expiryTime: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyTrustedUserAgentsMyTrustedUserAgentIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyTrustedUserAgentsMyTrustedUserAgentIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Indicates when this token was used lastime. */ lastUsedOn: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyTrustedUserAgentsMyTrustedUserAgentMeta[]; myTrustedUserAgentId: string; /** * The name of the User Agent that the user wants the system to trust and to use in Multi-Factor Authentication. */ name: string; /** * The OCID of the user */ ocid: string; /** * User agent platform for which the trust token has been issued. */ platform: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyTrustedUserAgentsMyTrustedUserAgentTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * The token type being created. This token is used as trusted and kmsi token. */ tokenType: string; /** * Trust token for the user agent. This is a random string value that will be updated whenever a token that has been issued is verified successfully. */ trustToken: string; /** * Trusted 2FA Factors */ trustedFactors: outputs.Identity.GetDomainsMyTrustedUserAgentsMyTrustedUserAgentTrustedFactor[]; /** * user for whom the trust-token was issued */ users: outputs.Identity.GetDomainsMyTrustedUserAgentsMyTrustedUserAgentUser[]; } interface GetDomainsMyTrustedUserAgentsMyTrustedUserAgentIdcsCreatedBy { /** * Friendly name of the User to be used for purposes of display. */ display: string; /** * The OCID of the user */ ocid: string; /** * Full URI to the user for whom the trust-token was issued. */ ref: string; /** * Trusted Factor */ type: string; /** * The SCIM ID of the user for whom the trust-token was issued. */ value: string; } interface GetDomainsMyTrustedUserAgentsMyTrustedUserAgentIdcsLastModifiedBy { /** * Friendly name of the User to be used for purposes of display. */ display: string; /** * The OCID of the user */ ocid: string; /** * Full URI to the user for whom the trust-token was issued. */ ref: string; /** * Trusted Factor */ type: string; /** * The SCIM ID of the user for whom the trust-token was issued. */ value: string; } interface GetDomainsMyTrustedUserAgentsMyTrustedUserAgentMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyTrustedUserAgentsMyTrustedUserAgentTag { /** * Key or name of the tag. */ key: string; /** * The SCIM ID of the user for whom the trust-token was issued. */ value: string; } interface GetDomainsMyTrustedUserAgentsMyTrustedUserAgentTrustedFactor { /** * Trusted Factor Type. Local, X509, SAML SOCIAL */ category: string; /** * trust factor creation time */ creationTime: string; /** * Trusted Factor */ type: string; } interface GetDomainsMyTrustedUserAgentsMyTrustedUserAgentUser { /** * Friendly name of the User to be used for purposes of display. */ display: string; /** * The OCID of the user */ ocid: string; /** * Full URI to the user for whom the trust-token was issued. */ ref: string; /** * The SCIM ID of the user for whom the trust-token was issued. */ value: string; } interface GetDomainsMyUserDbCredentialIdcsCreatedBy { /** * The user display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's identifier. */ value: string; } interface GetDomainsMyUserDbCredentialIdcsLastModifiedBy { /** * The user display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's identifier. */ value: string; } interface GetDomainsMyUserDbCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyUserDbCredentialTag { /** * Key or name of the tag. */ key: string; /** * The user's identifier. */ value: string; } interface GetDomainsMyUserDbCredentialUser { /** * The user display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's identifier. */ value: string; } interface GetDomainsMyUserDbCredentialsMyUserDbCredential { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * The user's database password. */ dbPassword: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Indicates that the database password has expired. */ expired: boolean; /** * When the user credential expires. */ expiresOn: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsMyUserDbCredentialsMyUserDbCredentialIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsMyUserDbCredentialsMyUserDbCredentialIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A DateTime that specifies the date and time when the current database password was set. */ lastSetDate: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsMyUserDbCredentialsMyUserDbCredentialMeta[]; /** * The user's database password with mixed salt. */ mixedDbPassword: string; /** * The mixed salt of the password. */ mixedSalt: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * The salt of the password. */ salt: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * User credential status */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsMyUserDbCredentialsMyUserDbCredentialTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * The user linked to the database credential. */ users: outputs.Identity.GetDomainsMyUserDbCredentialsMyUserDbCredentialUser[]; } interface GetDomainsMyUserDbCredentialsMyUserDbCredentialIdcsCreatedBy { /** * The user display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's identifier. */ value: string; } interface GetDomainsMyUserDbCredentialsMyUserDbCredentialIdcsLastModifiedBy { /** * The user display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's identifier. */ value: string; } interface GetDomainsMyUserDbCredentialsMyUserDbCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsMyUserDbCredentialsMyUserDbCredentialTag { /** * Key or name of the tag. */ key: string; /** * The user's identifier. */ value: string; } interface GetDomainsMyUserDbCredentialsMyUserDbCredentialUser { /** * The user display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's identifier. */ value: string; } interface GetDomainsNetworkPerimeterIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * type of the ip address value */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsNetworkPerimeterIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * type of the ip address value */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsNetworkPerimeterIpAddress { /** * type of the ip address value */ type: string; /** * Value of the tag. */ value: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsNetworkPerimeterMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsNetworkPerimeterTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsNetworkPerimetersNetworkPerimeter { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * NetworkPerimeter Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsNetworkPerimetersNetworkPerimeterIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsNetworkPerimetersNetworkPerimeterIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * IPAddresses or Ranges assigned to the NetworkPerimeter */ ipAddresses: outputs.Identity.GetDomainsNetworkPerimetersNetworkPerimeterIpAddress[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsNetworkPerimetersNetworkPerimeterMeta[]; /** * NetworkPerimeter name */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsNetworkPerimetersNetworkPerimeterTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsNetworkPerimetersNetworkPerimeterIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * type of the ip address value */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsNetworkPerimetersNetworkPerimeterIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * type of the ip address value */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsNetworkPerimetersNetworkPerimeterIpAddress { /** * type of the ip address value */ type: string; /** * Value of the tag. */ value: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsNetworkPerimetersNetworkPerimeterMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsNetworkPerimetersNetworkPerimeterTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsNotificationSettingEventSetting { /** * Specify if notifications are enabled for the event */ enabled: boolean; /** * IDCS-generated event */ eventId: string; } interface GetDomainsNotificationSettingFromEmailAddress { /** * Display name for the From email address */ displayName: string; /** * From address verification mode. If postmaster account is available then 'domain' mode is used or entire valid email can be verified using 'email' mode */ validate: string; /** * Validation status for the From email address */ validationStatus: string; /** * Value of the tag. */ value: string; } interface GetDomainsNotificationSettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsNotificationSettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsNotificationSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsNotificationSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsNotificationSettingsNotificationSetting { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Event settings */ eventSettings: outputs.Identity.GetDomainsNotificationSettingsNotificationSettingEventSetting[]; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * From email address to be used in the notification emails */ fromEmailAddresses: outputs.Identity.GetDomainsNotificationSettingsNotificationSettingFromEmailAddress[]; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsNotificationSettingsNotificationSettingIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsNotificationSettingsNotificationSettingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsNotificationSettingsNotificationSettingMeta[]; /** * Tenant level settings for the notification service */ notificationEnabled: boolean; notificationSettingId: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * If true and admin changed user's primary email, send user's profile changed email to old and new primary email address. */ sendNotificationToOldAndNewPrimaryEmailsWhenAdminChangesPrimaryEmail: boolean; /** * Indicates whether to allow notifications on a secondary email. */ sendNotificationsToSecondaryEmail: boolean; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsNotificationSettingsNotificationSettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Specify if the notification service is in test mode */ testModeEnabled: boolean; /** * List of the test recipient email addresses */ testRecipients: string[]; } interface GetDomainsNotificationSettingsNotificationSettingEventSetting { /** * Specify if notifications are enabled for the event */ enabled: boolean; /** * IDCS-generated event */ eventId: string; } interface GetDomainsNotificationSettingsNotificationSettingFromEmailAddress { /** * Display name for the From email address */ displayName: string; /** * From address verification mode. If postmaster account is available then 'domain' mode is used or entire valid email can be verified using 'email' mode */ validate: string; /** * Validation status for the From email address */ validationStatus: string; /** * Value of the tag. */ value: string; } interface GetDomainsNotificationSettingsNotificationSettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsNotificationSettingsNotificationSettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsNotificationSettingsNotificationSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsNotificationSettingsNotificationSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauth2clientCredentialIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsOauth2clientCredentialIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsOauth2clientCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsOauth2clientCredentialScope { /** * Audience */ audience: string; /** * Scope */ scope: string; } interface GetDomainsOauth2clientCredentialTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsOauth2clientCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsOauth2clientCredentialUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsOauth2clientCredentialsOauth2clientCredential { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * When the user's credentials expire. */ expiresOn: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsOauth2clientCredentialsOauth2clientCredentialIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsOauth2clientCredentialsOauth2clientCredentialIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Specifies whether the secret must be reset. */ isResetSecret: boolean; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsOauth2clientCredentialsOauth2clientCredentialMeta[]; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Scopes */ scopes: outputs.Identity.GetDomainsOauth2clientCredentialsOauth2clientCredentialScope[]; /** * Secret */ secret: string; /** * The user's credential status. */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsOauth2clientCredentialsOauth2clientCredentialTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Controls whether a user can update themselves or not via User related APIs */ urnietfparamsscimschemasoracleidcsextensionselfChangeUsers: outputs.Identity.GetDomainsOauth2clientCredentialsOauth2clientCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser[]; /** * The user linked to the OAuth2 client credential. */ users: outputs.Identity.GetDomainsOauth2clientCredentialsOauth2clientCredentialUser[]; } interface GetDomainsOauth2clientCredentialsOauth2clientCredentialIdcsCreatedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsOauth2clientCredentialsOauth2clientCredentialIdcsLastModifiedBy { /** * The user's display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's ID. */ value: string; } interface GetDomainsOauth2clientCredentialsOauth2clientCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsOauth2clientCredentialsOauth2clientCredentialScope { /** * Audience */ audience: string; /** * Scope */ scope: string; } interface GetDomainsOauth2clientCredentialsOauth2clientCredentialTag { /** * Key or name of the tag. */ key: string; /** * The user's ID. */ value: string; } interface GetDomainsOauth2clientCredentialsOauth2clientCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsOauth2clientCredentialsOauth2clientCredentialUser { /** * The user's display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's ID. */ value: string; } interface GetDomainsOauthClientCertificateIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthClientCertificateIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthClientCertificateMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsOauthClientCertificateTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthClientCertificatesOauthClientCertificate { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Certificate end date */ certEndDate: string; /** * Certificate start date */ certStartDate: string; /** * Certificate alias */ certificateAlias: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsOauthClientCertificatesOauthClientCertificateIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsOauthClientCertificatesOauthClientCertificateIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Key store ID */ keyStoreId: string; /** * Key store name */ keyStoreName: string; /** * Key store password */ keyStorePassword: string; /** * Map */ map: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsOauthClientCertificatesOauthClientCertificateMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * SHA-1 Thumbprint */ sha1thumbprint: string; /** * SHA-256 Thumbprint */ sha256thumbprint: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsOauthClientCertificatesOauthClientCertificateTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Base 64Key data attribute */ x509base64certificate: string; } interface GetDomainsOauthClientCertificatesOauthClientCertificateIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthClientCertificatesOauthClientCertificateIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthClientCertificatesOauthClientCertificateMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsOauthClientCertificatesOauthClientCertificateTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthPartnerCertificateIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthPartnerCertificateIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthPartnerCertificateMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsOauthPartnerCertificateTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthPartnerCertificatesOauthPartnerCertificate { /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Certificate end date */ certEndDate: string; /** * Certificate start date */ certStartDate: string; /** * Certificate alias */ certificateAlias: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsOauthPartnerCertificatesOauthPartnerCertificateIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsOauthPartnerCertificatesOauthPartnerCertificateIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Key store ID */ keyStoreId: string; /** * Key store name */ keyStoreName: string; /** * Key store password */ keyStorePassword: string; /** * Map */ map: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsOauthPartnerCertificatesOauthPartnerCertificateMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * SHA-1 Thumbprint */ sha1thumbprint: string; /** * SHA-256 Thumbprint */ sha256thumbprint: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsOauthPartnerCertificatesOauthPartnerCertificateTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Base 64Key data attribute */ x509base64certificate: string; } interface GetDomainsOauthPartnerCertificatesOauthPartnerCertificateIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthPartnerCertificatesOauthPartnerCertificateIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOauthPartnerCertificatesOauthPartnerCertificateMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsOauthPartnerCertificatesOauthPartnerCertificateTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentConsentSignedBy { /** * Name of the User or App that signed consent. */ displayName: string; /** * Policy Resource Ocid */ ocid: string; /** * The Modified Resource type - Policy, Rule, ConditionGroup, or Condition. A label that indicates the resource type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Policy Resource Ocid */ ocid: string; ref: string; /** * The Modified Resource type - Policy, Rule, ConditionGroup, or Condition. A label that indicates the resource type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Policy Resource Ocid */ ocid: string; ref: string; /** * The Modified Resource type - Policy, Rule, ConditionGroup, or Condition. A label that indicates the resource type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsOciConsoleSignOnPolicyConsentModifiedResource { /** * Policy Resource Ocid */ ocid: string; /** * The Modified Resource type - Policy, Rule, ConditionGroup, or Condition. A label that indicates the resource type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentPolicyResource { /** * Policy Resource Ocid */ ocid: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentsFilter { name: string; regex?: boolean; values: string[]; } interface GetDomainsOciConsoleSignOnPolicyConsentsResource { /** * Change Type - MODIFIED or RESTORED_TO_FACTORY_DEFAULT */ changeType: string; /** * Client IP of the Consent Signer */ clientIp: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * User or App that signs the consent. */ consentSignedBies: outputs.Identity.GetDomainsOciConsoleSignOnPolicyConsentsResourceConsentSignedBy[]; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsOciConsoleSignOnPolicyConsentsResourceIdcsCreatedBy[]; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsOciConsoleSignOnPolicyConsentsResourceIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * The justification for the change when an identity domain administrator opts to modify the Oracle security defaults for the "Security Policy for Oracle Cloud Infrastructure Console" sign-on policy shipped by Oracle. */ justification: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsOciConsoleSignOnPolicyConsentsResourceMeta[]; /** * The modified Policy, Rule, ConditionGroup or Condition during consent signing. */ modifiedResources: outputs.Identity.GetDomainsOciConsoleSignOnPolicyConsentsResourceModifiedResource[]; /** * The recipients of the email notification for the change in consent. */ notificationRecipients: string[]; /** * Policy Resource Ocid */ ocid: string; /** * Policy Resource */ policyResources: outputs.Identity.GetDomainsOciConsoleSignOnPolicyConsentsResourcePolicyResource[]; /** * The detailed reason for the change when an identity domain administrator opts to modify the Oracle security defaults for the "Security Policy for Oracle Cloud Infrastructure Console" sign-on policy shipped by Oracle. */ reason: string; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Time when Consent was signed. */ timeConsentSigned: string; } interface GetDomainsOciConsoleSignOnPolicyConsentsResourceConsentSignedBy { /** * Name of the User or App that signed consent. */ displayName: string; /** * Policy Resource Ocid */ ocid: string; /** * The Modified Resource type - Policy, Rule, ConditionGroup, or Condition. A label that indicates the resource type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentsResourceIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Policy Resource Ocid */ ocid: string; ref: string; /** * The Modified Resource type - Policy, Rule, ConditionGroup, or Condition. A label that indicates the resource type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentsResourceIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Policy Resource Ocid */ ocid: string; ref: string; /** * The Modified Resource type - Policy, Rule, ConditionGroup, or Condition. A label that indicates the resource type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentsResourceMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsOciConsoleSignOnPolicyConsentsResourceModifiedResource { /** * Policy Resource Ocid */ ocid: string; /** * The Modified Resource type - Policy, Rule, ConditionGroup, or Condition. A label that indicates the resource type. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentsResourcePolicyResource { /** * Policy Resource Ocid */ ocid: string; /** * Value of the tag. */ value: string; } interface GetDomainsOciConsoleSignOnPolicyConsentsTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsPasswordPoliciesPasswordPolicy { /** * A String value whose contents indicate a set of characters that can appear, in any sequence, in a password value */ allowedChars: string; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * List of password policy rules that have values set. This map of stringKey:stringValue pairs can be used to aid users while setting/resetting password */ configuredPasswordPolicyRules: outputs.Identity.GetDomainsPasswordPoliciesPasswordPolicyConfiguredPasswordPolicyRule[]; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * A String that describes the password policy */ description: string; /** * A delimiter used to separate characters in the dictionary file */ dictionaryDelimiter: string; /** * A Reference value that contains the URI of a dictionary of words not allowed to appear within a password value */ dictionaryLocation: string; /** * Indicates whether the password can match a dictionary word */ dictionaryWordDisallowed: boolean; /** * A String value whose contents indicate a set of characters that cannot appear, in any sequence, in a password value */ disallowedChars: string; /** * A String value whose contents indicate a set of substrings that cannot appear, in any sequence, in a password value */ disallowedSubstrings: string[]; /** * List of User attributes whose values are not allowed in the password. */ disallowedUserAttributeValues: string[]; /** * The number of distinct characters between old password and new password */ distinctCharacters: number; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Indicates a sequence of characters that match the user's first name of given name cannot be the password. Password validation against policy will be ignored if length of first name is less than or equal to 3 characters. */ firstNameDisallowed: boolean; /** * Indicates whether all of the users should be forced to reset their password on the next login (to comply with new password policy changes) */ forcePasswordReset: boolean; /** * A list of groups that the password policy belongs to. */ groups: outputs.Identity.GetDomainsPasswordPoliciesPasswordPolicyGroup[]; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsPasswordPoliciesPasswordPolicyIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsPasswordPoliciesPasswordPolicyIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Indicates a sequence of characters that match the user's last name of given name cannot be the password. Password validation against policy will be ignored if length of last name is less than or equal to 3 characters. */ lastNameDisallowed: boolean; /** * The time period in minutes to lock out a user account when the threshold of invalid login attempts is reached. The available range is from 5 through 1440 minutes (24 hours). */ lockoutDuration: number; /** * An integer that represents the maximum number of failed logins before an account is locked */ maxIncorrectAttempts: number; /** * The maximum password length (in characters). A value of 0 or no value indicates no maximum length restriction. */ maxLength: number; /** * The maximum number of repeated characters allowed in a password. A value of 0 or no value indicates no such restriction. */ maxRepeatedChars: number; /** * The maximum number of special characters in a password. A value of 0 or no value indicates no maximum special characters restriction. */ maxSpecialChars: number; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsPasswordPoliciesPasswordPolicyMeta[]; /** * The minimum number of a combination of alphabetic and numeric characters in a password. A value of 0 or no value indicates no minimum alphanumeric character restriction. */ minAlphaNumerals: number; /** * The minimum number of alphabetic characters in a password. A value of 0 or no value indicates no minimum alphas restriction. */ minAlphas: number; /** * The minimum password length (in characters). A value of 0 or no value indicates no minimum length restriction. */ minLength: number; /** * The minimum number of lowercase alphabetic characters in a password. A value of 0 or no value indicates no minimum lowercase restriction. */ minLowerCase: number; /** * The minimum number of numeric characters in a password. A value of 0 or no value indicates no minimum numeric character restriction. */ minNumerals: number; /** * Minimum time after which the user can resubmit the reset password request */ minPasswordAge: number; /** * The minimum number of special characters in a password. A value of 0 or no value indicates no minimum special characters restriction. */ minSpecialChars: number; /** * The minimum number of unique characters in a password. A value of 0 or no value indicates no minimum unique characters restriction. */ minUniqueChars: number; /** * The minimum number of uppercase alphabetic characters in a password. A value of 0 or no value indicates no minimum uppercase restriction. */ minUpperCase: number; /** * A String that is the name of the policy to display to the user. This is the only mandatory attribute for a password policy. */ name: string; /** * The number of passwords that will be kept in history that may not be used as a password */ numPasswordsInHistory: number; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An integer indicating the number of days before which the user should be warned about password expiry. */ passwordExpireWarning: number; /** * The number of days after which the password expires automatically */ passwordExpiresAfter: number; /** * Indicates whether the password policy is configured as Simple, Standard, or Custom. */ passwordStrength: string; /** * Password policy priority */ priority: number; /** * A String value whose contents indicate a set of characters that must appear, in any sequence, in a password value */ requiredChars: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Indicates that the password must begin with an alphabetic character */ startsWithAlphabet: boolean; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsPasswordPoliciesPasswordPolicyTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Indicates a sequence of characters that match the username cannot be the password. Password validation against policy will be ignored if length of user name is less than or equal to 3 characters. */ userNameDisallowed: boolean; } interface GetDomainsPasswordPoliciesPasswordPolicyConfiguredPasswordPolicyRule { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsPasswordPoliciesPasswordPolicyGroup { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsPasswordPoliciesPasswordPolicyIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsPasswordPoliciesPasswordPolicyIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsPasswordPoliciesPasswordPolicyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsPasswordPoliciesPasswordPolicyTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsPasswordPolicyConfiguredPasswordPolicyRule { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsPasswordPolicyGroup { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsPasswordPolicyIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsPasswordPolicyIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsPasswordPolicyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsPasswordPolicyTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsPoliciesPolicy { /** * If true, Policy is active. */ active: boolean; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Policy Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsPoliciesPolicyIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsPoliciesPolicyIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsPoliciesPolicyMeta[]; /** * Rule name */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The Groovy script that is run instead of the policy, if the policy type allows the policy to be a Groovy script. */ policyGroovy: string; /** * PolicyType on which the policy is based */ policyTypes: outputs.Identity.GetDomainsPoliciesPolicyPolicyType[]; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * Rules assigned to this policy */ rules: outputs.Identity.GetDomainsPoliciesPolicyRule[]; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsPoliciesPolicyTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsPoliciesPolicyIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Rule URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsPoliciesPolicyIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Rule URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsPoliciesPolicyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsPoliciesPolicyPolicyType { /** * Rule URI */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsPoliciesPolicyRule { /** * Rule name */ name: string; /** * Rule URI */ ref: string; /** * Position of the rule in evaluation order. No duplicates allowed. */ sequence: number; /** * Value of the tag. */ value: string; } interface GetDomainsPoliciesPolicyTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsPolicyIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Rule URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsPolicyIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Rule URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsPolicyMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsPolicyPolicyType { /** * Rule URI */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsPolicyRule { /** * Rule name */ name: string; /** * Rule URI */ ref: string; /** * Position of the rule in evaluation order. No duplicates allowed. */ sequence: number; /** * Value of the tag. */ value: string; } interface GetDomainsPolicyTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsResourceTypeSchemaAttributesResourceTypeSchemaAttribute { /** * A collection of canonical values. Applicable Service Providers MUST specify the canonical types specified in the core schema specification--for example, \"work\", \"home\". */ canonicalValues: string[]; /** * Specifies if the String attribute is case-sensitive */ caseExact: boolean; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * The attribute's human-readable description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Specifies User mutability for this attribute */ endUserMutability: string; /** * Specifies the list of User mutabilities allowed */ endUserMutabilityAllowedValues: string[]; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * Indicates that the schema has been added since this release number */ idcsAddedSinceReleaseNumber: string; /** * Indicates that the schema has been added since version */ idcsAddedSinceVersion: number; /** * Specifies whether the attribute is cacheable. True by default for all attributes. If attribute with idcsAttributeCachable = false, is present \"attributesToGet\" while executing GET/SEARCH on cacheable resource, Cache is missed and data is fetched from Data Provider. */ idcsAttributeCacheable: boolean; /** * Specifies if the attribute can be used for mapping with external identity sources such as AD or LDAP. If isSchemaMappable: false for the schema in which this attribute is defined, then this flag is ignored */ idcsAttributeMappable: boolean; /** * Specifies whether changes to this attribute value are audited */ idcsAuditable: boolean; /** * Sequence tracking ID name for the attribute */ idcsAutoIncrementSeqName: string; /** * Filter to use when getting canonical values for this schema attribute */ idcsCanonicalValueSourceFilter: string; /** * Specifies the Resource type to read from for dynamic canonical values */ idcsCanonicalValueSourceResourceType: string; /** * The set of one or more sub attributes' names of a CMVA, whose values uniquely identify an instance of a CMVA */ idcsCompositeKeys: string[]; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsResourceTypeSchemaAttributesResourceTypeSchemaAttributeIdcsCreatedBy[]; /** * The attribute defining the CSV column header name for import/export */ idcsCsvColumnHeaderName: string; /** * custom attribute flag. */ idcsCustomAttribute: boolean; /** * Indicates that the schema has been deprecated since this release number */ idcsDeprecatedSinceReleaseNumber: string; /** * Indicates that the schema has been deprecated since version */ idcsDeprecatedSinceVersion: number; /** * Specifies the user-friendly displayable attribute name or catalog key used for localization */ idcsDisplayName: string; /** * Localized schema attribute display name for use by UI client for displaying attribute labels */ idcsDisplayNameMessageId: string; /** * **SCIM++ Properties:** * * caseExact: false * * multiValued: false * * mutability: readOnly * * required: false * * idcsSearchable: true * * returned: default * * type: boolean * * uniqueness: none Whether the CMVA attribute will be fetched or not for current resource in AbstractResourceManager update operation before calling data provider update. Default is true. */ idcsFetchComplexAttributeValues: boolean; /** * Specifies the mapper to use when mapping this attribute value from DataProvider-specific semantics */ idcsFromTargetMapper: string; /** * Fully qualified name of this attribute */ idcsFullyQualifiedName: string; /** * Specifies whether this attribute value was generated */ idcsGenerated: boolean; /** * Maps to ICF data type */ idcsIcfAttributeType: string; /** * Maps to ICF target attribute name */ idcsIcfBundleAttributeName: string; /** * Metadata to identify the ICF required attribute */ idcsIcfRequired: boolean; /** * Specifies the indirectly referenced Resources */ idcsIndirectRefResourceAttributes: string[]; /** * Specifies whether the schema attribute is for internal use only. Internal attributes are not exposed via REST. This attribute overrides mutability for create/update if the request is internal and the attribute internalflag is set to True. This attribute overrides the return attribute while building SCIM response attributes when both the request is internal and the schema attribute is internal. */ idcsInternal: boolean; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsResourceTypeSchemaAttributesResourceTypeSchemaAttributeIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Specifies the maximum length of the attribute */ idcsMaxLength: number; /** * Specifies the maximum value of the integer attribute */ idcsMaxValue: number; /** * Specifies the minimum length of the attribute */ idcsMinLength: number; /** * Specifies the minimum value of the integer attribute */ idcsMinValue: number; /** * If true, specifies that the attribute can have multiple language values set for the attribute on which this is set. */ idcsMultiLanguage: boolean; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Specifies the referenced Resource attribute */ idcsRefResourceAttribute: string; /** * Specifies the directly referenced Resources */ idcsRefResourceAttributes: string[]; /** * Schema URN string that this attribute belongs to */ idcsSchemaUrn: string; /** * Indicates if the attribute is scim compliant, default is true */ idcsScimCompliant: boolean; /** * Specifies whether this attribute can be included in a search filter */ idcsSearchable: boolean; /** * Flag to specify if the attribute should be encrypted or hashed */ idcsSensitive: string; /** * Target attribute name that this attribute gets mapped to for persistence */ idcsTargetAttributeName: string; /** * Old Target attribute name from child table for CSVA attribute prior to migration. This maintains this attribute used to get mapped to for persistence */ idcsTargetAttributeNameToMigrateFrom: string; /** * Target normalized attribute name that this normalized value of attribute gets mapped to for persistence. Only set for caseExact=false & searchable attributes. Do not use by default. */ idcsTargetNormAttributeName: string; /** * Target index name created for this attribute for performance */ idcsTargetUniqueConstraintName: string; /** * Specifies the mapper to use when mapping this attribute value to DataProvider-specific semantics */ idcsToTargetMapper: string; /** * Trims any leading and trailing blanks from String values. Default is True. */ idcsTrimStringValue: boolean; /** * Validate payload reference value during create, replace, and update. Default is True. */ idcsValidateReference: boolean; /** * Specifies whether the value of the Resource attribute is persisted */ idcsValuePersisted: boolean; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsResourceTypeSchemaAttributesResourceTypeSchemaAttributeMeta[]; /** * Indicates the attribute's plurality */ multiValued: boolean; /** * Specifies if the attribute is mutable */ mutability: string; /** * Attribute's name */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The names of the Resource types that may be referenced--for example, User. This is only applicable for attributes that are of the \"reference\" data type. */ referenceTypes: string[]; /** * Specifies if the attribute is required */ required: boolean; /** * ResourceType this attribute belongs to. */ resourceType: string; /** * A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request */ returned: string; /** * The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsResourceTypeSchemaAttributesResourceTypeSchemaAttributeTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * The attribute's data type--for example, String */ type: string; /** * A single keyword value that specifies how the Service Provider enforces uniqueness of attribute values. A server MAY reject an invalid value based on uniqueness by returning an HTTP response code of 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the Service Provider enforces. For example, a client could make a value unique while the server has the uniqueness of \"none\". */ uniqueness: string; } interface GetDomainsResourceTypeSchemaAttributesResourceTypeSchemaAttributeIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The attribute's data type--for example, String */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsResourceTypeSchemaAttributesResourceTypeSchemaAttributeIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The attribute's data type--for example, String */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsResourceTypeSchemaAttributesResourceTypeSchemaAttributeMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * ResourceType this attribute belongs to. */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsResourceTypeSchemaAttributesResourceTypeSchemaAttributeTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsRuleConditionGroup { /** * Attribute name of an individual value to be returned. */ name: string; /** * PolicyType URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsRuleIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * PolicyType URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsRuleIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * PolicyType URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsRuleMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsRulePolicyType { /** * PolicyType URI */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsRuleReturn { /** * Attribute name of an individual value to be returned. */ name: string; /** * The Groovy script that is run to generate output for the rule, if the policy type allows the return value to be a Groovy script. */ returnGroovy: string; /** * Value of the tag. */ value: string; } interface GetDomainsRuleTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsRulesRule { /** * If true, rule is active */ active: boolean; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * SCIM filters */ condition: string; /** * Condition or ConditionGroup assigned to the rule */ conditionGroups: outputs.Identity.GetDomainsRulesRuleConditionGroup[]; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Rule Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsRulesRuleIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsRulesRuleIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Shows if the rule is locked */ locked: boolean; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsRulesRuleMeta[]; /** * Attribute name of an individual value to be returned. */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * PolicyType on which the policy is based */ policyTypes: outputs.Identity.GetDomainsRulesRulePolicyType[]; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * The return values are the then portion of a Rule */ returns: outputs.Identity.GetDomainsRulesRuleReturn[]; /** * The Groovy script that is run instead of the rule, if policy type allows the rule to be a Groovy script. */ ruleGroovy: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsRulesRuleTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsRulesRuleConditionGroup { /** * Attribute name of an individual value to be returned. */ name: string; /** * PolicyType URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsRulesRuleIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * PolicyType URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsRulesRuleIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * PolicyType URI */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsRulesRuleMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsRulesRulePolicyType { /** * PolicyType URI */ ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsRulesRuleReturn { /** * Attribute name of an individual value to be returned. */ name: string; /** * The Groovy script that is run to generate output for the rule, if the policy type allows the return value to be a Groovy script. */ returnGroovy: string; /** * Value of the tag. */ value: string; } interface GetDomainsRulesRuleTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * This indicates if the question is a Custom Question added by the Security Admin. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * This indicates if the question is a Custom Question added by the Security Admin. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSecurityQuestionQuestionText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * The locale */ locale: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionSettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionSettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSecurityQuestionSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionSettingsSecurityQuestionSetting { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsSecurityQuestionSettingsSecurityQuestionSettingIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsSecurityQuestionSettingsSecurityQuestionSettingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Indicates the maximum length of following fields Security Questions, Answer and Hint */ maxFieldLength: number; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsSecurityQuestionSettingsSecurityQuestionSettingMeta[]; /** * Indicates the minimum length of answer for security questions */ minAnswerLength: number; /** * Indicates the number of security questions that a user must answer */ numQuestionsToAns: number; /** * Indicates the number of security questions a user must setup */ numQuestionsToSetup: number; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; securityQuestionSettingId: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsSecurityQuestionSettingsSecurityQuestionSettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsSecurityQuestionSettingsSecurityQuestionSettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionSettingsSecurityQuestionSettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionSettingsSecurityQuestionSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSecurityQuestionSettingsSecurityQuestionSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionsSecurityQuestion { /** * This indicates if the question is selected by the Security Admin and is available for the end user. */ active: boolean; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsSecurityQuestionsSecurityQuestionIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsSecurityQuestionsSecurityQuestionIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsSecurityQuestionsSecurityQuestionMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Locale values for the Question */ questionTexts: outputs.Identity.GetDomainsSecurityQuestionsSecurityQuestionQuestionText[]; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsSecurityQuestionsSecurityQuestionTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * This indicates if the question is a Custom Question added by the Security Admin. */ type: string; } interface GetDomainsSecurityQuestionsSecurityQuestionIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * This indicates if the question is a Custom Question added by the Security Admin. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionsSecurityQuestionIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * This indicates if the question is a Custom Question added by the Security Admin. */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionsSecurityQuestionMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSecurityQuestionsSecurityQuestionQuestionText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * The locale */ locale: string; /** * Value of the tag. */ value: string; } interface GetDomainsSecurityQuestionsSecurityQuestionTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsSelfRegistrationProfileAfterSubmitText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * Type of user's locale e.g. en-CA */ locale: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfileConsentText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * Type of user's locale e.g. en-CA */ locale: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfileDefaultGroup { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfileDisplayName { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * Type of user's locale e.g. en-CA */ locale: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfileEmailTemplate { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfileFooterText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * Type of user's locale e.g. en-CA */ locale: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfileHeaderText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * Type of user's locale e.g. en-CA */ locale: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfileIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfileIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfileMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSelfRegistrationProfileTag { /** * Key or name of the tag. */ key: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfileUserAttribute { /** * If this attribute can be deleted */ deletable: boolean; /** * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none Fully Qualified Attribute Name */ fullyQualifiedAttributeName: string; /** * Metadata of the user attribute */ metadata: string; /** * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none Sequence Number for the attribute */ seqNumber: number; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfile { /** * **SCIM++ Properties:** * * caseExact: false * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: boolean * * uniqueness: none A Boolean value that indicates whether Account verification email is required to be sent before login or not */ activationEmailRequired: boolean; /** * A Boolean value that indicates whether the profile is enabled or not */ active: boolean; /** * Text to be displayed on UI after doing self registration */ afterSubmitTexts: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileAfterSubmitText[]; /** * A Multivalue String value for Email domains which are valid for this profile */ allowedEmailDomains: string[]; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean value that indicates whether the consent text is present. */ consentTextPresent: boolean; /** * Consent text */ consentTexts: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileConsentText[]; /** * Default groups assigned to the user */ defaultGroups: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileDefaultGroup[]; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * A Multivalue String Value for Email domains to be handled as exceptions */ disallowedEmailDomains: string[]; /** * Registration page name */ displayNames: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileDisplayName[]; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Email template */ emailTemplates: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileEmailTemplate[]; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * References to footer logo */ footerLogo: string; /** * Footer text */ footerTexts: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileFooterText[]; /** * Reference to header logo */ headerLogo: string; /** * Header text */ headerTexts: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileHeaderText[]; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileMeta[]; /** * Name of the profile */ name: string; /** * Number of days redirect URL is valid */ numberOfDaysRedirectUrlIsValid: number; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * This URL will be replaced in email notification sent to user. When activation email required is set to true, user is created in \"pending verification\" state, upon clicking this link user will be able to activate himself. When activation email required is set to false, user is created in \"verified\" state, this link will be used to verify user's email. */ redirectUrl: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A Boolean value that indicates whether the profile should be displayed on login page */ showOnLoginPage: boolean; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * **SCIM++ Properties:** * * idcsCompositeKey: [value] * * idcsSearchable: true * * multiValued: true * * mutability: readWrite * * required: false * * returned: default * * type: complex * * uniqueness: none User Attributes */ userAttributes: outputs.Identity.GetDomainsSelfRegistrationProfilesSelfRegistrationProfileUserAttribute[]; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileAfterSubmitText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * Type of user's locale e.g. en-CA */ locale: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileConsentText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * Type of user's locale e.g. en-CA */ locale: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileDefaultGroup { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileDisplayName { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * Type of user's locale e.g. en-CA */ locale: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileEmailTemplate { /** * The displayName of the User or App who modified this Resource */ display: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileFooterText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * Type of user's locale e.g. en-CA */ locale: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileHeaderText { /** * If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true. */ default: boolean; /** * Type of user's locale e.g. en-CA */ locale: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileTag { /** * Key or name of the tag. */ key: string; /** * name of the attribute */ value: string; } interface GetDomainsSelfRegistrationProfilesSelfRegistrationProfileUserAttribute { /** * If this attribute can be deleted */ deletable: boolean; /** * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: false * * returned: default * * type: string * * uniqueness: none Fully Qualified Attribute Name */ fullyQualifiedAttributeName: string; /** * Metadata of the user attribute */ metadata: string; /** * **SCIM++ Properties:** * * idcsSearchable: true * * multiValued: false * * mutability: readWrite * * required: true * * returned: default * * type: integer * * uniqueness: none Sequence Number for the attribute */ seqNumber: number; /** * name of the attribute */ value: string; } interface GetDomainsSettingCertificateValidation { /** * Use CRL as Fallback. */ crlCheckOnOcspFailureEnabled: boolean; /** * CRL is enabled Configuration */ crlEnabled: boolean; /** * CRL Location. */ crlLocation: string; /** * The CRL refresh interval in minutes */ crlRefreshInterval: number; /** * OCSP is enabled Configuration */ ocspEnabled: boolean; /** * OCSP Responder URL */ ocspResponderUrl: string; /** * This setting says, OCSP Responder URL present in the issued certificate must be used. Otherwise, OCSP Responder URL from IDP or Settings. */ ocspSettingsResponderUrlPreferred: boolean; /** * OCSP Signing Certificate Alias */ ocspSigningCertificateAlias: string; /** * The OCSP Timeout duration in minutes */ ocspTimeoutDuration: number; /** * OCSP Accept unknown response status from ocsp responder. */ ocspUnknownResponseStatusAllowed: boolean; } interface GetDomainsSettingCloudGateCorsSetting { /** * Allow Null Origin (CORS) for this tenant. */ cloudGateCorsAllowNullOrigin: boolean; /** * Cloud Gate Allowed Cross-Origin Resource Sharing (CORS) Origins for this tenant. */ cloudGateCorsAllowedOrigins: string[]; /** * Enable Cloud Gate Cross-Origin Resource Sharing (CORS) for this tenant. */ cloudGateCorsEnabled: boolean; /** * List of Response Headers Cloud Gate is allowed to expose in the CORS Response Header: Access-Control-Expose-Headers. */ cloudGateCorsExposedHeaders: string[]; /** * Maximum number of seconds a CORS Pre-flight Response may be cached by client. */ cloudGateCorsMaxAge: number; } interface GetDomainsSettingCompanyName { /** * Locale */ locale: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingDefaultCompanyName { /** * Locale */ locale: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingDefaultImage { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Indicates the image type */ type: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingDefaultLoginText { /** * Locale */ locale: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingIdcsCreatedBy { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Indicates the image type */ type: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingIdcsLastModifiedBy { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Indicates the image type */ type: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingImage { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Indicates the image type */ type: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingLoginText { /** * Locale */ locale: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSettingPurgeConfig { /** * Resource Name */ resourceName: string; /** * Retention Period */ retentionPeriod: number; } interface GetDomainsSettingTag { /** * Key or name of the tag. */ key: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingTenantCustomClaim { /** * Indicates if the custom claim is associated with all scopes */ allScopes: boolean; /** * Indicates if the custom claim is an expression */ expression: boolean; /** * Indicates under what scenario the custom claim will be return */ mode: string; /** * Custom claim name */ name: string; /** * Scopes associated with a specific custom claim */ scopes: string[]; /** * Indicates what type of token the custom claim will be embedded */ tokenType: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingsSetting { /** * Indicates whether all the Apps in this customer tenancy should trust each other. A value of true overrides the 'defaultTrustScope' attribute here in Settings, as well as any App-specific 'trustScope' attribute, to force in effect 'trustScope=Account' for every App in this customer tenancy. */ accountAlwaysTrustScope: boolean; /** * One or more email domains allowed in a user's email field. If unassigned, any domain is allowed. */ allowedDomains: string[]; /** * If specified, indicates the set of Urls which can be returned to after successful forgot password flow */ allowedForgotPasswordFlowReturnUrls: string[]; /** * If specified, indicates the set of allowed notification redirect Urls which can be specified as the value of \"notificationRedirectUrl\" in the POST .../admin/v1/MePasswordResetRequestor request payload, which will then be included in the reset password email notification sent to a user as part of the forgot password / password reset flow. */ allowedNotificationRedirectUrls: string[]; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * Audit Event retention period. If set, overrides default of 30 days after which Audit Events will be purged */ auditEventRetentionPeriod: number; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Certificate Validation Config */ certificateValidations: outputs.Identity.GetDomainsSettingsSettingCertificateValidation[]; /** * The attribute to store the cloud account name */ cloudAccountName: string; /** * A complex attribute that specifies the Cloud Gate cross origin resource sharing settings. */ cloudGateCorsSettings: outputs.Identity.GetDomainsSettingsSettingCloudGateCorsSetting[]; /** * If specified, indicates the custom SIM Migrator Url which can be used while SIM to Oracle Identity Cloud Service CloudAccount Migration. */ cloudMigrationCustomUrl: string; /** * CloudAccountMigration: Enable Custom SIM Migrator Url. */ cloudMigrationUrlEnabled: boolean; /** * Name of the company in different locales */ companyNames: outputs.Identity.GetDomainsSettingsSettingCompanyName[]; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * Contact emails used to notify tenants. Can be one or more user or group alias emails. */ contactEmails: string[]; /** * This value indicates whether Customer Service Representatives can login and have readOnly or readWrite access. A value of 'none' means CSR cannot login to the services. */ csrAccess: string; /** * Indicates if the branding is default or custom */ customBranding: boolean; /** * Storage URL location where the sanitized custom css is located */ customCssLocation: string; /** * Storage URL location where the sanitized custom html is located */ customHtmlLocation: string; /** * Custom translations (JSON String) */ customTranslation: string; /** * Default name of the Company in different locales */ defaultCompanyNames: outputs.Identity.GetDomainsSettingsSettingDefaultCompanyName[]; /** * References to various images */ defaultImages: outputs.Identity.GetDomainsSettingsSettingDefaultImage[]; /** * Default Login text in different locales */ defaultLoginTexts: outputs.Identity.GetDomainsSettingsSettingDefaultLoginText[]; /** * **Deprecated Since: 18.3.6** */ defaultTrustScope: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * The level of diagnostic logging that is currently in effect. A level of 0 (zero) indicates that diagnostic logging is disabled. A level of 1 (one) indicates that diagnostic logging is enabled. */ diagnosticLevel: number; /** * Controls whether DiagnosticRecords for external search-operations (against SCIM resource-types in the Admin service) identify returned resources. If true, indicates that for each successful external search-operation at least one DiagnosticRecord will include at least one identifier for each matching resource that is returned in that search-response. If false, no DiagnosticRecord should be expected to identify returned resources for a search-operation. The default value is false. */ diagnosticRecordForSearchIdentifiesReturnedResources: boolean; /** * The end time up to which diagnostic recording is switched on */ diagnosticTracingUpto: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Indicates if Terms of Use is enabled in UI */ enableTermsOfUse: boolean; /** * An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant. */ externalId: string; /** * Maximum duration for IAM User Principal Session Token expiry */ iamUpstSessionExpiry: number; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsSettingsSettingIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsSettingsSettingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * References to various images */ images: outputs.Identity.GetDomainsSettingsSettingImage[]; /** * Indicates if 'hosted' option was selected */ isHostedPage: boolean; /** * Tenant issuer. */ issuer: string; /** * Locale */ locale: string; /** * Login text in different locales */ loginTexts: outputs.Identity.GetDomainsSettingsSettingLoginText[]; /** * Limit the maximum return of CMVA for an App */ maxNoOfAppCmvaToReturn: number; /** * Limit the maximum return of members for an AppRole */ maxNoOfAppRoleMembersToReturn: number; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsSettingsSettingMeta[]; /** * Database Migration Status */ migrationStatus: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * On-Premises provisioning feature toggle. */ onPremisesProvisioning: boolean; /** * Preferred written or spoken language used for localized user interfaces */ preferredLanguage: string; /** * Previous Tenant issuer. This is an Oracle Identity Cloud Service internal attribute which is not meant to be directly modified by ID Admin. Even if the request body (Settings) contains this attribute, the actual value will be set according to the Oracle Identity Cloud Service internal logic rather than solely based on the value provided in the request payload. */ prevIssuer: string; /** * Privacy Policy URL */ privacyPolicyUrl: string; /** * Purge Configs for different Resource Types */ purgeConfigs: outputs.Identity.GetDomainsSettingsSettingPurgeConfig[]; /** * If reAuthWhenChangingMyAuthenticationFactors is true (default), this attribute specifies which re-authentication factor to use. Allowed value is \"password\". */ reAuthFactors: string[]; /** * Specifies whether re-authentication is required or not when a user changes one of their security factors such as password or email. Default is true to ensure more secure behavior. */ reAuthWhenChangingMyAuthenticationFactors: boolean; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * By default, a service admin can list all users in stripe. If true, a service admin cannot list other users. */ serviceAdminCannotListOtherUsers: boolean; settingId: string; /** * Indicates if access on SigningCert is allowed to public or not */ signingCertPublicAccess: boolean; /** * **Added In:** 20.1.3 */ subMappingAttr: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsSettingsSettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Custom claims associated with the specific tenant */ tenantCustomClaims: outputs.Identity.GetDomainsSettingsSettingTenantCustomClaim[]; /** * Terms of Use URL */ termsOfUseUrl: string; /** * User's timezone */ timezone: string; } interface GetDomainsSettingsSettingCertificateValidation { /** * Use CRL as Fallback. */ crlCheckOnOcspFailureEnabled: boolean; /** * CRL is enabled Configuration */ crlEnabled: boolean; /** * CRL Location. */ crlLocation: string; /** * The CRL refresh interval in minutes */ crlRefreshInterval: number; /** * OCSP is enabled Configuration */ ocspEnabled: boolean; /** * OCSP Responder URL */ ocspResponderUrl: string; /** * This setting says, OCSP Responder URL present in the issued certificate must be used. Otherwise, OCSP Responder URL from IDP or Settings. */ ocspSettingsResponderUrlPreferred: boolean; /** * OCSP Signing Certificate Alias */ ocspSigningCertificateAlias: string; /** * The OCSP Timeout duration in minutes */ ocspTimeoutDuration: number; /** * OCSP Accept unknown response status from ocsp responder. */ ocspUnknownResponseStatusAllowed: boolean; } interface GetDomainsSettingsSettingCloudGateCorsSetting { /** * Allow Null Origin (CORS) for this tenant. */ cloudGateCorsAllowNullOrigin: boolean; /** * Cloud Gate Allowed Cross-Origin Resource Sharing (CORS) Origins for this tenant. */ cloudGateCorsAllowedOrigins: string[]; /** * Enable Cloud Gate Cross-Origin Resource Sharing (CORS) for this tenant. */ cloudGateCorsEnabled: boolean; /** * List of Response Headers Cloud Gate is allowed to expose in the CORS Response Header: Access-Control-Expose-Headers. */ cloudGateCorsExposedHeaders: string[]; /** * Maximum number of seconds a CORS Pre-flight Response may be cached by client. */ cloudGateCorsMaxAge: number; } interface GetDomainsSettingsSettingCompanyName { /** * Locale */ locale: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingsSettingDefaultCompanyName { /** * Locale */ locale: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingsSettingDefaultImage { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Indicates the image type */ type: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingsSettingDefaultLoginText { /** * Locale */ locale: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingsSettingIdcsCreatedBy { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Indicates the image type */ type: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingsSettingIdcsLastModifiedBy { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * Indicates the image type */ type: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingsSettingImage { /** * A human-readable name, primarily used for display purposes */ display: string; /** * Indicates the image type */ type: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingsSettingLoginText { /** * Locale */ locale: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingsSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSettingsSettingPurgeConfig { /** * Resource Name */ resourceName: string; /** * Retention Period */ retentionPeriod: number; } interface GetDomainsSettingsSettingTag { /** * Key or name of the tag. */ key: string; /** * Custom claim value */ value: string; } interface GetDomainsSettingsSettingTenantCustomClaim { /** * Indicates if the custom claim is associated with all scopes */ allScopes: boolean; /** * Indicates if the custom claim is an expression */ expression: boolean; /** * Indicates under what scenario the custom claim will be return */ mode: string; /** * Custom claim name */ name: string; /** * Scopes associated with a specific custom claim */ scopes: string[]; /** * Indicates what type of token the custom claim will be embedded */ tokenType: string; /** * Custom claim value */ value: string; } interface GetDomainsSmtpCredentialIdcsCreatedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsSmtpCredentialIdcsLastModifiedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsSmtpCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSmtpCredentialTag { /** * Key or name of the tag. */ key: string; /** * User's id */ value: string; } interface GetDomainsSmtpCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsSmtpCredentialUser { /** * User display name */ display: string; /** * User name */ name: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * User's id */ value: string; } interface GetDomainsSmtpCredentialsSmtpCredential { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * User credential expires on */ expiresOn: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsSmtpCredentialsSmtpCredentialIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsSmtpCredentialsSmtpCredentialIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsSmtpCredentialsSmtpCredentialMeta[]; /** * User's ocid */ ocid: string; /** * Password */ password: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * User credential status */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsSmtpCredentialsSmtpCredentialTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Controls whether a user can update themselves or not via User related APIs */ urnietfparamsscimschemasoracleidcsextensionselfChangeUsers: outputs.Identity.GetDomainsSmtpCredentialsSmtpCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser[]; /** * User name */ userName: string; /** * User linked to smtp credential */ users: outputs.Identity.GetDomainsSmtpCredentialsSmtpCredentialUser[]; } interface GetDomainsSmtpCredentialsSmtpCredentialIdcsCreatedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsSmtpCredentialsSmtpCredentialIdcsLastModifiedBy { /** * User display name */ display: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * User's id */ value: string; } interface GetDomainsSmtpCredentialsSmtpCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSmtpCredentialsSmtpCredentialTag { /** * Key or name of the tag. */ key: string; /** * User's id */ value: string; } interface GetDomainsSmtpCredentialsSmtpCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsSmtpCredentialsSmtpCredentialUser { /** * User display name */ display: string; /** * User name */ name: string; /** * User's ocid */ ocid: string; /** * The URI that corresponds to the user linked to this credential */ ref: string; /** * User's id */ value: string; } interface GetDomainsSocialIdentityProviderIdcsCreatedBy { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSocialIdentityProviderIdcsLastModifiedBy { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSocialIdentityProviderJitProvAssignedGroup { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsSocialIdentityProviderMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSocialIdentityProviderRelayIdpParamMapping { /** * Key or name of the relayParam. */ relayParamKey: string; /** * Value of the relayParam (if defined) */ relayParamValue: string; } interface GetDomainsSocialIdentityProviderTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsSocialIdentityProvidersSocialIdentityProvider { /** * Social IDP Access token URL */ accessTokenUrl: string; /** * Whether account linking is enabled */ accountLinkingEnabled: boolean; /** * Admin scope to request */ adminScopes: string[]; /** * Apple Developer ID */ appleDevId: string; /** * Apple Private Key ID */ appleKeyId: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Social IDP Authorization URL */ authzUrl: string; /** * Whether social auto redirect is enabled. The IDP policy should be configured with only one Social IDP, and without username/password selected. */ autoRedirectEnabled: boolean; /** * Whether the client credential is contained in payload */ clientCredentialInPayload: boolean; /** * Social IDP allowed clock skew time */ clockSkewInSeconds: number; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * Social IDP Client Application Client ID */ consumerKey: string; /** * Social IDP Client Application Client Secret */ consumerSecret: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Social IDP description */ description: string; /** * Discovery URL */ discoveryUrl: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Whether the IDP is enabled or not */ enabled: boolean; /** * ICON URL for social idp */ iconUrl: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * Id attribute used for account linking */ idAttribute: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsSocialIdentityProvidersSocialIdentityProviderIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsSocialIdentityProvidersSocialIdentityProviderIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * Lists the groups each social JIT-provisioned user is a member. Just-in-Time user-provisioning applies this static list when jitProvGroupStaticListEnabled:true. */ jitProvAssignedGroups: outputs.Identity.GetDomainsSocialIdentityProvidersSocialIdentityProviderJitProvAssignedGroup[]; /** * Set to true to indicate Social JIT User Provisioning Groups should be assigned from a static list */ jitProvGroupStaticListEnabled: boolean; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsSocialIdentityProvidersSocialIdentityProviderMeta[]; /** * Social provider name */ name: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * Social IDP User profile URL */ profileUrl: string; /** * redirect URL for social idp */ redirectUrl: string; /** * Social IDP Refresh token URL */ refreshTokenUrl: string; /** * Whether registration is enabled */ registrationEnabled: boolean; /** * Relay Param variable for Social IDP */ relayIdpParamMappings: outputs.Identity.GetDomainsSocialIdentityProvidersSocialIdentityProviderRelayIdpParamMapping[]; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * Scope to request */ scopes: string[]; /** * Service Provider Name */ serviceProviderName: string; /** * Whether show on login */ showOnLogin: boolean; /** * Whether Social JIT Provisioning is enabled */ socialJitProvisioningEnabled: boolean; /** * Status */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsSocialIdentityProvidersSocialIdentityProviderTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; } interface GetDomainsSocialIdentityProvidersSocialIdentityProviderIdcsCreatedBy { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSocialIdentityProvidersSocialIdentityProviderIdcsLastModifiedBy { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsSocialIdentityProvidersSocialIdentityProviderJitProvAssignedGroup { /** * A human readable name, primarily used for display purposes. READ-ONLY. */ display: string; ref: string; /** * Value of the tag. */ value: string; } interface GetDomainsSocialIdentityProvidersSocialIdentityProviderMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsSocialIdentityProvidersSocialIdentityProviderRelayIdpParamMapping { /** * Key or name of the relayParam. */ relayParamKey: string; /** * Value of the relayParam (if defined) */ relayParamValue: string; } interface GetDomainsSocialIdentityProvidersSocialIdentityProviderTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsUserAddress { /** * The country name component. */ country: string; /** * Full name */ formatted: string; /** * The city or locality component. */ locality: string; /** * The zipcode or postal code component. */ postalCode: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * The state or region component. */ region: string; /** * The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. This attribute MAY contain newlines. */ streetAddress: string; /** * A label indicating the attribute's function. */ type: string; } interface GetDomainsUserAttributesSettingAttributeSetting { /** * End User mutability */ endUserMutability: string; /** * Specifies the list of User mutabilities allowed. */ endUserMutabilityCanonicalValues: string[]; /** * Fully-qualified attribute or complex mapping Name */ name: string; } interface GetDomainsUserAttributesSettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsUserAttributesSettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsUserAttributesSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsUserAttributesSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsUserAttributesSettingsUserAttributesSetting { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * User Schema Attribute Settings */ attributeSettings: outputs.Identity.GetDomainsUserAttributesSettingsUserAttributesSettingAttributeSetting[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsUserAttributesSettingsUserAttributesSettingIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsUserAttributesSettingsUserAttributesSettingIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsUserAttributesSettingsUserAttributesSettingMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsUserAttributesSettingsUserAttributesSettingTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; userAttributesSettingId: string; } interface GetDomainsUserAttributesSettingsUserAttributesSettingAttributeSetting { /** * End User mutability */ endUserMutability: string; /** * Specifies the list of User mutabilities allowed. */ endUserMutabilityCanonicalValues: string[]; /** * Fully-qualified attribute or complex mapping Name */ name: string; } interface GetDomainsUserAttributesSettingsUserAttributesSettingIdcsCreatedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsUserAttributesSettingsUserAttributesSettingIdcsLastModifiedBy { /** * The displayName of the User or App who modified this Resource */ display: string; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ ocid: string; /** * The URI of the SCIM resource that represents the User or App who modified this Resource */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * Value of the tag. */ value: string; } interface GetDomainsUserAttributesSettingsUserAttributesSettingMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsUserAttributesSettingsUserAttributesSettingTag { /** * Key or name of the tag. */ key: string; /** * Value of the tag. */ value: string; } interface GetDomainsUserDbCredentialIdcsCreatedBy { /** * The user display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's identifier. */ value: string; } interface GetDomainsUserDbCredentialIdcsLastModifiedBy { /** * The user display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's identifier. */ value: string; } interface GetDomainsUserDbCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsUserDbCredentialTag { /** * Key or name of the tag. */ key: string; /** * The user's identifier. */ value: string; } interface GetDomainsUserDbCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsUserDbCredentialUser { /** * The user display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's identifier. */ value: string; } interface GetDomainsUserDbCredentialsUserDbCredential { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * The user's database password. */ dbPassword: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description */ description: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * Indicates that the database password has expired. */ expired: boolean; /** * When the user credential expires. */ expiresOn: string; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsUserDbCredentialsUserDbCredentialIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsUserDbCredentialsUserDbCredentialIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * A DateTime that specifies the date and time when the current database password was set. */ lastSetDate: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsUserDbCredentialsUserDbCredentialMeta[]; /** * The user's database password with mixed salt. */ mixedDbPassword: string; /** * The mixed salt of the password. */ mixedSalt: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * The salt of the password. */ salt: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * User credential status */ status: string; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsUserDbCredentialsUserDbCredentialTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * Controls whether a user can update themselves or not via User related APIs */ urnietfparamsscimschemasoracleidcsextensionselfChangeUsers: outputs.Identity.GetDomainsUserDbCredentialsUserDbCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser[]; /** * The user linked to the database credential. */ users: outputs.Identity.GetDomainsUserDbCredentialsUserDbCredentialUser[]; } interface GetDomainsUserDbCredentialsUserDbCredentialIdcsCreatedBy { /** * The user display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's identifier. */ value: string; } interface GetDomainsUserDbCredentialsUserDbCredentialIdcsLastModifiedBy { /** * The user display name. */ display: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The type of resource, User or App, that modified this Resource */ type: string; /** * The user's identifier. */ value: string; } interface GetDomainsUserDbCredentialsUserDbCredentialMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsUserDbCredentialsUserDbCredentialTag { /** * Key or name of the tag. */ key: string; /** * The user's identifier. */ value: string; } interface GetDomainsUserDbCredentialsUserDbCredentialUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsUserDbCredentialsUserDbCredentialUser { /** * The user display name. */ display: string; /** * The username. */ name: string; /** * The user's OCID. */ ocid: string; /** * The URI that corresponds to the user linked to this credential. */ ref: string; /** * The user's identifier. */ value: string; } interface GetDomainsUserEmail { /** * Pending e-mail address verification */ pendingVerificationData: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A Boolean value that indicates whether the email address is the secondary email address. The secondary attribute value 'true' MUST appear no more than once. */ secondary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; /** * A Boolean value that indicates if the phone number is verified. */ verified: boolean; } interface GetDomainsUserEntitlement { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserGroup { /** * Date when the member is Added to the group */ dateAdded: string; /** * A human readable name, primarily used for display purposes. */ display: string; /** * An identifier for the Resource as defined by the Service Consumer. READ-ONLY. */ externalId: string; /** * The membership OCID. */ membershipOcid: string; /** * A human readable name for Group as defined by the Service Consumer. READ-ONLY. */ nonUniqueDisplay: string; /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserIdcsCreatedBy { /** * A human readable name, primarily used for display purposes. */ display: string; /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserIdcsLastModifiedBy { /** * A human readable name, primarily used for display purposes. */ display: string; /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserIm { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsUserName { /** * Last name */ familyName: string; /** * Full name */ formatted: string; /** * First name */ givenName: string; /** * Prefix */ honorificPrefix: string; /** * Suffix */ honorificSuffix: string; /** * Middle name */ middleName: string; } interface GetDomainsUserPhoneNumber { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; /** * A Boolean value that indicates if the phone number is verified. */ verified: boolean; } interface GetDomainsUserPhoto { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserRole { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserTag { /** * The user's API key value. */ key: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasextensionenterprise20user { /** * Identifies the name of a cost center. */ costCenter: string; /** * Identifies the name of a department. */ department: string; /** * Identifies the name of a division. */ division: string; /** * Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization. */ employeeNumber: string; /** * The User's manager. A complex type that optionally allows Service Providers to represent organizational hierarchy by referencing the 'id' attribute of another User. */ managers: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasextensionenterprise20userManager[]; /** * Identifies the name of an organization. */ organization: string; } interface GetDomainsUserUrnietfparamsscimschemasextensionenterprise20userManager { /** * The displayName of the User's manager. OPTIONAL and READ-ONLY. */ displayName: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionOciTag { /** * Oracle Cloud Infrastructure Defined Tags */ definedTags: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag[]; /** * Oracle Cloud Infrastructure Freeform Tags */ freeformTags: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag[]; /** * Oracle Cloud Infrastructure Tag slug */ tagSlug: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag { /** * The user's API key value. */ key: string; /** * Oracle Cloud Infrastructure Tag namespace */ namespace: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag { /** * The user's API key value. */ key: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionadaptiveUser { /** * Risk Level */ riskLevel: string; /** * The risk score pertaining to the user. */ riskScores: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionadaptiveUserRiskScore[]; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionadaptiveUserRiskScore { /** * Last update timestamp for the risk score */ lastUpdateTimestamp: string; /** * User Token URI */ ref: string; /** * Risk Level */ riskLevel: string; /** * Risk Score value */ score: number; /** * Risk Provider Profile Source */ source: string; /** * A supplemental status indicating the reason why a user is disabled */ status: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensioncapabilitiesUser { /** * Indicates whether a user can use API keys. */ canUseApiKeys: boolean; /** * Indicates whether a user can use Auth tokens. */ canUseAuthTokens: boolean; /** * Specifies whether user can access the Console. */ canUseConsole: boolean; /** * Indicates whether a user can use Console passwords. */ canUseConsolePassword: boolean; /** * Indicates whether a user can use customer secret keys. */ canUseCustomerSecretKeys: boolean; /** * Indicates whether a user can use database credentials. */ canUseDbCredentials: boolean; /** * Indicates whether a user can use OAuth2 client credentials. */ canUseOauth2clientCredentials: boolean; /** * Indicates whether a user can use SMTP credentials. */ canUseSmtpCredentials: boolean; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensiondbCredentialsUser { /** * The number of failed login attempts. The value is reset to 0 after a successful login. */ dbLoginAttempts: number; /** * The database username. */ dbUserName: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensiondbUserUser { /** * DB global roles to which the user is granted access. */ dbGlobalRoles: string[]; /** * DB domain level schema to which the user is granted access. */ domainLevelSchema: string; /** * DB instance level schema to which the user is granted access. */ instanceLevelSchema: string; /** * If true, indicates this is a database user. */ isDbUser: boolean; /** * Password Verifiers for DB User. */ passwordVerifiers: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensiondbUserUserPasswordVerifier[]; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensiondbUserUserPasswordVerifier { /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionkerberosUserUser { /** * A list of kerberos realm users for an Oracle Identity Cloud Service User */ realmUsers: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionkerberosUserUserRealmUser[]; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionkerberosUserUserRealmUser { /** * Principal Name of the KerberosRealmUser associated with the Oracle Identity Cloud Service User. */ principalName: string; /** * Realm Name for the KerberosRealmUser associated with the Oracle Identity Cloud Service User. */ realmName: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUser { /** * A list of bypass codes that belongs to the user. */ bypassCodes: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserBypassCode[]; /** * A list of devices enrolled by the user. */ devices: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserDevice[]; /** * The number of failed login attempts. The value is reset to 0 after a successful login. */ loginAttempts: number; /** * The date when the user enrolled in multi factor authentication. This will be set to null, when the user resets their factors. */ mfaEnabledOn: string; /** * User MFA Ignored Apps Identifiers */ mfaIgnoredApps: string[]; /** * The user opted for MFA. */ mfaStatus: string; /** * The preferred authentication factor type. */ preferredAuthenticationFactor: string; /** * The preferred authentication method. */ preferredAuthenticationMethod: string; /** * The user's preferred device. */ preferredDevices: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserPreferredDevice[]; /** * The preferred third-party vendor name. */ preferredThirdPartyVendor: string; /** * A list of trusted User Agents owned by this user. Multi-Factored Authentication uses Trusted User Agents to authenticate users. A User Agent is software application that a user uses to issue requests. For example, a User Agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, oneof several executing on a particular mobile device). A User Agent is trusted once the Multi-Factor Authentication has verified it in some way. */ trustedUserAgents: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserTrustedUserAgent[]; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserBypassCode { /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserDevice { /** * The authentication method. */ authenticationMethod: string; /** * A human readable name, primarily used for display purposes. */ display: string; /** * The device authentication factor status. */ factorStatus: string; /** * Authentication Factor Type */ factorType: string; /** * The last sync time for device. */ lastSyncTime: string; /** * User Token URI */ ref: string; /** * A supplemental status indicating the reason why a user is disabled */ status: string; /** * The third-party factor vendor name. */ thirdPartyVendorName: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserPreferredDevice { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionmfaUserTrustedUserAgent { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordStateUser { /** * Applicable Password Policy */ applicablePasswordPolicies: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordStateUserApplicablePasswordPolicy[]; /** * Indicates that the current password MAY NOT be changed and all other password expiry settings SHALL be ignored */ cantChange: boolean; /** * Indicates that the password expiry policy will not be applied for the current Resource */ cantExpire: boolean; /** * Indicates whether the user password is expired. If this value is false, password expiry is still evaluated during user login. */ expired: boolean; /** * A DateTime that specifies the date and time when last failed password validation was set */ lastFailedValidationDate: string; /** * A DateTime that specifies the date and time when the current password was set */ lastSuccessfulSetDate: string; /** * A DateTime that specifies the date and time when last successful password validation was set */ lastSuccessfulValidationDate: string; /** * Indicates that the subject password value MUST change on next login. If not changed, typically the account is locked. The value may be set indirectly when the subject's current password expires or directly set by an administrator. */ mustChange: boolean; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordStateUserApplicablePasswordPolicy { /** * A human readable name, primarily used for display purposes. */ display: string; /** * PasswordPolicy priority */ priority: number; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordlessUser { /** * Factor Identifier ID */ factorIdentifiers: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordlessUserFactorIdentifier[]; /** * Authentication Factor Method */ factorMethod: string; /** * Authentication Factor Type */ factorType: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionpasswordlessUserFactorIdentifier { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionposixUser { /** * General information about the POSIX account such as their real name and phone number */ gecos: string; /** * Primary Group identifier of the POSIX user */ gidNumber: number; /** * The absolute path to the home directory of the POSIX account */ homeDirectory: string; /** * The path to the login shell of the POSIX account */ loginShell: string; /** * Integer uniquely identifying a user in a POSIX administrative domain */ uidNumber: number; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUser { /** * The schema used to mnage security question and answers provided by a user for account recovery and/or MFA. While setting up security questions, a user can also provide a hint for the answer. */ secQuestions: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUserSecQuestion[]; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUserSecQuestion { /** * The answer provided by a user for a security question. */ answer: string; /** * The hint for an answer that's given by user when setting up a security question. */ hintText: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionselfRegistrationUser { /** * A boolean value that indicates whether the consent is granted. */ consentGranted: boolean; /** * Self registration profile used when user is self registered. */ selfRegistrationProfiles: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionselfRegistrationUserSelfRegistrationProfile[]; /** * User token returned if userFlowControlledByExternalClient is true */ userToken: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionselfRegistrationUserSelfRegistrationProfile { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionsffUser { /** * SFF auth keys clob */ sffAuthKeys: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionsocialAccountUser { /** * Description: */ socialAccounts: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionsocialAccountUserSocialAccount[]; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionsocialAccountUserSocialAccount { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensiontermsOfUseUser { /** * Description: */ termsOfUseConsents: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensiontermsOfUseUserTermsOfUseConsent[]; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensiontermsOfUseUserTermsOfUseConsent { /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUser { /** * A list of API keys corresponding to user. */ apiKeys: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserApiKey[]; /** * A list of Auth tokens corresponding to user. */ authTokens: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserAuthToken[]; /** * A list of customer secret keys corresponding to user. */ customerSecretKeys: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserCustomerSecretKey[]; /** * A list of database credentials corresponding to user. */ dbCredentials: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserDbCredential[]; /** * A list of OAuth2 client credentials corresponding to a user. */ oAuth2clientCredentials: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserOAuth2clientCredential[]; /** * A list of SMTP credentials corresponding to user. */ smtpCredentials: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserSmtpCredential[]; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserApiKey { /** * The user's API key value. */ key: string; /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserAuthToken { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserCustomerSecretKey { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserDbCredential { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserOAuth2clientCredential { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserSmtpCredential { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserStateUser { /** * The last failed login date. */ lastFailedLoginDate: string; /** * The last successful login date. */ lastSuccessfulLoginDate: string; /** * A complex attribute that indicates an account is locked (blocking any new sessions). */ lockeds: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserLocked[]; /** * The number of failed login attempts. The value is reset to 0 after a successful login. */ loginAttempts: number; /** * The maximum number of concurrent sessions for a user. */ maxConcurrentSessions: number; /** * The previous successful login date. */ previousSuccessfulLoginDate: string; /** * The number of failed recovery attempts. The value is reset to 0 after a successful login. */ recoveryAttempts: number; /** * The number of failed account recovery enrollment attempts. */ recoveryEnrollAttempts: number; /** * A complex attribute that indicates a password recovery is locked (blocking any new sessions). */ recoveryLockeds: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserRecoveryLocked[]; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserLocked { /** * Indicates whether the user password is expired. If this value is false, password expiry is still evaluated during user login. */ expired: boolean; /** * The date and time that the current resource was locked. */ lockDate: string; /** * Indicates that the recovery is locked. */ on: boolean; /** * Indicates the reason for locking the account. Valid values are: 0 - failed password login attempts, 1 - admin lock, 2 - failed reset password attempts, 3 - failed MFA login attempts, 4 - failed MFA login attempts for federated user, 5 - failed Database login attempts */ reason: number; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserRecoveryLocked { /** * The date and time that the current resource was locked. */ lockDate: string; /** * Indicates that the recovery is locked. */ on: boolean; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUser { /** * Boolean value to prompt user to setup account recovery during login. */ accountRecoveryRequired: boolean; /** * Accounts assigned to this User. Each value of this attribute refers to an app-specific identity that is owned by this User. Therefore, this attribute is a convenience that allows one to see on each User the Apps to which that User has access. */ accounts: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserAccount[]; /** * A list of all AppRoles to which this User belongs directly, indirectly or implicitly. The User could belong directly because the User is a member of the AppRole, could belong indirectly because the User is a member of a Group that is a member of the AppRole, or could belong implicitly because the AppRole is public. */ appRoles: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserAppRole[]; /** * The app against which the user will authenticate. The value is not persisted but rather calculated. If the user's delegatedAuthenticationTargetApp is set, that value is returned. Otherwise, the app returned by evaluating the user's applicable Delegated Authentication Policy is returned. */ applicableAuthenticationTargetApps: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserApplicableAuthenticationTargetApp[]; /** * A Boolean value indicating whether or not to send email notification after creating the user. This attribute is not used in update/replace operations. */ bypassNotification: boolean; /** * User creation mechanism */ creationMechanism: string; /** * If set, indicates the user's preferred authentication target app. If not set and the user's \"syncedFromApp\" is set and is enabled for delegated authentication, it is used. Otherwise, the user authenticates locally to Oracle Identity Cloud Service. */ delegatedAuthenticationTargetApps: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserDelegatedAuthenticationTargetApp[]; /** * A Boolean value indicating whether or not to hide the getting started page */ doNotShowGettingStarted: boolean; /** * Grants to this User. Each value of this attribute refers to a Grant to this User of some App (and optionally of some entitlement). Therefore, this attribute is a convenience that allows one to see on each User all of the Grants to that User. */ grants: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserGrant[]; /** * Specifies date time when a User's group membership was last modified. */ groupMembershipLastModified: string; /** * Description: */ idcsAppRolesLimitedToGroups: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserIdcsAppRolesLimitedToGroup[]; /** * A Boolean value indicating whether or not a user is enrolled for account recovery */ isAccountRecoveryEnrolled: boolean; /** * A Boolean value indicating whether or not authentication request by this user should be delegated to a remote app. This value should be true only when the User was originally synced from an app which is enabled for delegated authentication */ isAuthenticationDelegated: boolean; /** * A Boolean value indicating whether or not the user is federated. */ isFederatedUser: boolean; /** * A Boolean value indicating whether or not group membership is normalized for this user. */ isGroupMembershipNormalized: boolean; /** * A Boolean value Indicates whether this User's group membership has been sync'ed from Group.members to UsersGroups. */ isGroupMembershipSyncedToUsersGroups: boolean; /** * Specifies the EmailTemplate to be used when sending notification to the user this request is for. If specified, it overrides the default EmailTemplate for this event. */ notificationEmailTemplateId: string; /** * User's preferred landing page following login, logout and reset password. */ preferredUiLandingPage: string; /** * Indicates if User is a Service User */ serviceUser: boolean; /** * A supplemental status indicating the reason why a user is disabled */ status: string; /** * A list of Support Accounts corresponding to user. */ supportAccounts: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserSupportAccount[]; /** * Managed App or an Identity Source from where the user is synced. If enabled, this Managed App or Identity Source can be used for performing delegated authentication. */ syncedFromApps: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserSyncedFromApp[]; /** * A Boolean value indicating whether to bypass notification and return user token to be used by an external client to control the user flow. */ userFlowControlledByExternalClient: boolean; /** * User Support Account Provider */ userProvider: string; /** * User token returned if userFlowControlledByExternalClient is true */ userTokens: outputs.Identity.GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserUserToken[]; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserAccount { /** * Status of the account */ active: boolean; /** * The ID of the App in this Grant. */ appId: string; /** * Name of the account assigned to the User. */ name: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserAppRole { /** * If true, then the role provides administrative access privileges. READ-ONLY. */ adminRole: boolean; /** * The ID of the App in this Grant. */ appId: string; /** * The name (Client ID) of the App that defines this AppRole. */ appName: string; /** * A human readable name, primarily used for display purposes. */ display: string; /** * The name (if any) under which this AppRole should appear in this User's group-memberships for reasons of backward compatibility. Oracle Identity Cloud Service distinguishes between Groups and AppRoles, but some services still expect AppRoles appear as if they were service-instance-specific Groups. */ legacyGroupName: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserApplicableAuthenticationTargetApp { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * Timeout interval for Synchronization TargetAction in milliseconds */ targetRequestTimeout: number; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserDelegatedAuthenticationTargetApp { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserGrant { /** * The ID of the App in this Grant. */ appId: string; /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * Grantor identifier */ grantorId: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserIdcsAppRolesLimitedToGroup { /** * A human readable name, primarily used for display purposes. */ display: string; /** * The id of the Oracle Identity Cloud Service AppRole grant limited to one or more Groups. */ idcsAppRoleId: string; /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserSupportAccount { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * ID of the resource */ userId: string; /** * User Support Account Provider */ userProvider: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserSyncedFromApp { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserUrnietfparamsscimschemasoracleidcsextensionuserUserUserToken { /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUserX509certificate { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUser { /** * Status of the account */ active: boolean; /** * A physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes. */ addresses: outputs.Identity.GetDomainsUsersUserAddress[]; /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ compartmentOcid: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ deleteInProgress: boolean; /** * Description of the user */ description: string; /** * The displayName of the User's manager. OPTIONAL and READ-ONLY. */ displayName: string; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ domainOcid: string; /** * A complex attribute representing emails */ emails: outputs.Identity.GetDomainsUsersUserEmail[]; /** * A list of entitlements for the User that represent a thing the User has. */ entitlements: outputs.Identity.GetDomainsUsersUserEntitlement[]; /** * An identifier for the Resource as defined by the Service Consumer. READ-ONLY. */ externalId: string; forceDelete: boolean; /** * A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated */ groups: outputs.Identity.GetDomainsUsersUserGroup[]; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ id: string; /** * The User or App who created the Resource */ idcsCreatedBies: outputs.Identity.GetDomainsUsersUserIdcsCreatedBy[]; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * The User or App who modified the Resource */ idcsLastModifiedBies: outputs.Identity.GetDomainsUsersUserIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ idcsPreventedOperations: string[]; /** * User's instant messaging addresses */ ims: outputs.Identity.GetDomainsUsersUserIm[]; /** * Used to indicate the User's default location for purposes of localizing items such as currency, date and time format, numerical representations, and so on. */ locale: string; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ metas: outputs.Identity.GetDomainsUsersUserMeta[]; /** * Name of the account assigned to the User. */ names: outputs.Identity.GetDomainsUsersUserName[]; /** * Nick name */ nickName: string; /** * The OCID of the user's support account. */ ocid: string; /** * Password attribute. Max length for password is controlled via Password Policy. */ password: string; /** * Phone numbers */ phoneNumbers: outputs.Identity.GetDomainsUsersUserPhoneNumber[]; /** * URLs of photos for the User */ photos: outputs.Identity.GetDomainsUsersUserPhoto[]; /** * User's preferred written or spoken language used for localized user interfaces */ preferredLanguage: string; /** * A fully-qualified URL to a page representing the User's online profile */ profileUrl: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion: string; /** * A list of roles for the User that collectively represent who the User is; e.g., 'Student', 'Faculty'. */ roles: outputs.Identity.GetDomainsUsersUserRole[]; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ schemas: string[]; /** * A list of tags on this resource. */ tags: outputs.Identity.GetDomainsUsersUserTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ tenancyOcid: string; /** * User's timezone */ timezone: string; /** * Title */ title: string; /** * Enterprise User */ urnietfparamsscimschemasextensionenterprise20users: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasextensionenterprise20user[]; /** * Oracle Cloud Infrastructure Tags. */ urnietfparamsscimschemasoracleidcsextensionOciTags: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionOciTag[]; /** * This extension defines attributes to manage user's risk score. */ urnietfparamsscimschemasoracleidcsextensionadaptiveUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionadaptiveUser[]; /** * User's Capabilities */ urnietfparamsscimschemasoracleidcsextensioncapabilitiesUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensioncapabilitiesUser[]; /** * The database credentials user extension. */ urnietfparamsscimschemasoracleidcsextensiondbCredentialsUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensiondbCredentialsUser[]; /** * DB User extension */ urnietfparamsscimschemasoracleidcsextensiondbUserUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensiondbUserUser[]; /** * Kerberos User extension */ urnietfparamsscimschemasoracleidcsextensionkerberosUserUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionkerberosUserUser[]; /** * This extension defines attributes used to manage Multi-Factor Authentication within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use MFA. */ urnietfparamsscimschemasoracleidcsextensionmfaUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionmfaUser[]; /** * This extension defines attributes used to manage account passwords within a Service Provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use passwords. */ urnietfparamsscimschemasoracleidcsextensionpasswordStateUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionpasswordStateUser[]; /** * This extension defines attributes used to manage Passwordless-Factor Authentication within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use MFA. */ urnietfparamsscimschemasoracleidcsextensionpasswordlessUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionpasswordlessUser[]; /** * POSIX User extension */ urnietfparamsscimschemasoracleidcsextensionposixUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionposixUser[]; /** * This extension defines the attributes used to store the security questions of a user. */ urnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUser[]; /** * Controls whether a user can update themselves or not via User related APIs */ urnietfparamsscimschemasoracleidcsextensionselfChangeUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionselfChangeUser[]; /** * This extension defines attributes used to manage self registration profile linked to the user. */ urnietfparamsscimschemasoracleidcsextensionselfRegistrationUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionselfRegistrationUser[]; /** * SFF Auth Keys User extension */ urnietfparamsscimschemasoracleidcsextensionsffUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionsffUser[]; /** * Social User extension */ urnietfparamsscimschemasoracleidcsextensionsocialAccountUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionsocialAccountUser[]; /** * Terms Of Use extension */ urnietfparamsscimschemasoracleidcsextensiontermsOfUseUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensiontermsOfUseUser[]; /** * User's credentials */ urnietfparamsscimschemasoracleidcsextensionuserCredentialsUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUser[]; /** * This extension defines the attributes used to manage account passwords within a service provider. The extension is typically applied to a User resource, but MAY be applied to other resources that use passwords. */ urnietfparamsscimschemasoracleidcsextensionuserStateUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserStateUser[]; /** * Oracle Identity Cloud Service User */ urnietfparamsscimschemasoracleidcsextensionuserUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUser[]; /** * User name */ userName: string; /** * Used to identify the organization-to-user relationship */ userType: string; /** * A list of certificates issued to the User. */ x509certificates: outputs.Identity.GetDomainsUsersUserX509certificate[]; } interface GetDomainsUsersUserAddress { /** * The country name component. */ country: string; /** * Full name */ formatted: string; /** * The city or locality component. */ locality: string; /** * The zipcode or postal code component. */ postalCode: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * The state or region component. */ region: string; /** * The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. This attribute MAY contain newlines. */ streetAddress: string; /** * A label indicating the attribute's function. */ type: string; } interface GetDomainsUsersUserEmail { /** * Pending e-mail address verification */ pendingVerificationData: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A Boolean value that indicates whether the email address is the secondary email address. The secondary attribute value 'true' MUST appear no more than once. */ secondary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; /** * A Boolean value that indicates if the phone number is verified. */ verified: boolean; } interface GetDomainsUsersUserEntitlement { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserGroup { /** * Date when the member is Added to the group */ dateAdded: string; /** * A human readable name, primarily used for display purposes. */ display: string; /** * An identifier for the Resource as defined by the Service Consumer. READ-ONLY. */ externalId: string; /** * The membership OCID. */ membershipOcid: string; /** * A human readable name for Group as defined by the Service Consumer. READ-ONLY. */ nonUniqueDisplay: string; /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserIdcsCreatedBy { /** * A human readable name, primarily used for display purposes. */ display: string; /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserIdcsLastModifiedBy { /** * A human readable name, primarily used for display purposes. */ display: string; /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserIm { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserMeta { /** * The DateTime the Resource was added to the Service Provider */ created: string; /** * The most recent DateTime that the details of this Resource were updated at the Service Provider. If this Resource has never been modified since its initial creation, the value MUST be the same as the value of created. The attribute MUST be a DateTime. */ lastModified: string; /** * The URI of the Resource being returned. This value MUST be the same as the Location HTTP response header. */ location: string; /** * Name of the resource type of the resource--for example, Users or Groups */ resourceType: string; /** * The version of the Resource being returned. This value must be the same as the ETag HTTP response header. */ version: string; } interface GetDomainsUsersUserName { /** * Last name */ familyName: string; /** * Full name */ formatted: string; /** * First name */ givenName: string; /** * Prefix */ honorificPrefix: string; /** * Suffix */ honorificSuffix: string; /** * Middle name */ middleName: string; } interface GetDomainsUsersUserPhoneNumber { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; /** * A Boolean value that indicates if the phone number is verified. */ verified: boolean; } interface GetDomainsUsersUserPhoto { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserRole { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserTag { /** * The user's API key value. */ key: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasextensionenterprise20user { /** * Identifies the name of a cost center. */ costCenter: string; /** * Identifies the name of a department. */ department: string; /** * Identifies the name of a division. */ division: string; /** * Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization. */ employeeNumber: string; /** * The User's manager. A complex type that optionally allows Service Providers to represent organizational hierarchy by referencing the 'id' attribute of another User. */ managers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasextensionenterprise20userManager[]; /** * Identifies the name of an organization. */ organization: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasextensionenterprise20userManager { /** * The displayName of the User's manager. OPTIONAL and READ-ONLY. */ displayName: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionOciTag { /** * Oracle Cloud Infrastructure Defined Tags */ definedTags: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag[]; /** * Oracle Cloud Infrastructure Freeform Tags */ freeformTags: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag[]; /** * Oracle Cloud Infrastructure Tag slug */ tagSlug: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionOciTagDefinedTag { /** * The user's API key value. */ key: string; /** * Oracle Cloud Infrastructure Tag namespace */ namespace: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionOciTagFreeformTag { /** * The user's API key value. */ key: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionadaptiveUser { /** * Risk Level */ riskLevel: string; /** * The risk score pertaining to the user. */ riskScores: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionadaptiveUserRiskScore[]; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionadaptiveUserRiskScore { /** * Last update timestamp for the risk score */ lastUpdateTimestamp: string; /** * User Token URI */ ref: string; /** * Risk Level */ riskLevel: string; /** * Risk Score value */ score: number; /** * Risk Provider Profile Source */ source: string; /** * A supplemental status indicating the reason why a user is disabled */ status: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensioncapabilitiesUser { /** * Indicates whether a user can use API keys. */ canUseApiKeys: boolean; /** * Indicates whether a user can use Auth tokens. */ canUseAuthTokens: boolean; /** * Specifies whether user can access the Console. */ canUseConsole: boolean; /** * Indicates whether a user can use Console passwords. */ canUseConsolePassword: boolean; /** * Indicates whether a user can use customer secret keys. */ canUseCustomerSecretKeys: boolean; /** * Indicates whether a user can use database credentials. */ canUseDbCredentials: boolean; /** * Indicates whether a user can use OAuth2 client credentials. */ canUseOauth2clientCredentials: boolean; /** * Indicates whether a user can use SMTP credentials. */ canUseSmtpCredentials: boolean; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensiondbCredentialsUser { /** * The number of failed login attempts. The value is reset to 0 after a successful login. */ dbLoginAttempts: number; /** * The database username. */ dbUserName: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensiondbUserUser { /** * DB global roles to which the user is granted access. */ dbGlobalRoles: string[]; /** * DB domain level schema to which the user is granted access. */ domainLevelSchema: string; /** * DB instance level schema to which the user is granted access. */ instanceLevelSchema: string; /** * If true, indicates this is a database user. */ isDbUser: boolean; /** * Password Verifiers for DB User. */ passwordVerifiers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensiondbUserUserPasswordVerifier[]; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensiondbUserUserPasswordVerifier { /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionkerberosUserUser { /** * A list of kerberos realm users for an Oracle Identity Cloud Service User */ realmUsers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionkerberosUserUserRealmUser[]; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionkerberosUserUserRealmUser { /** * Principal Name of the KerberosRealmUser associated with the Oracle Identity Cloud Service User. */ principalName: string; /** * Realm Name for the KerberosRealmUser associated with the Oracle Identity Cloud Service User. */ realmName: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionmfaUser { /** * A list of bypass codes that belongs to the user. */ bypassCodes: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionmfaUserBypassCode[]; /** * A list of devices enrolled by the user. */ devices: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionmfaUserDevice[]; /** * The number of failed login attempts. The value is reset to 0 after a successful login. */ loginAttempts: number; /** * The date when the user enrolled in multi factor authentication. This will be set to null, when the user resets their factors. */ mfaEnabledOn: string; /** * User MFA Ignored Apps Identifiers */ mfaIgnoredApps: string[]; /** * The user opted for MFA. */ mfaStatus: string; /** * The preferred authentication factor type. */ preferredAuthenticationFactor: string; /** * The preferred authentication method. */ preferredAuthenticationMethod: string; /** * The user's preferred device. */ preferredDevices: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionmfaUserPreferredDevice[]; /** * The preferred third-party vendor name. */ preferredThirdPartyVendor: string; /** * A list of trusted User Agents owned by this user. Multi-Factored Authentication uses Trusted User Agents to authenticate users. A User Agent is software application that a user uses to issue requests. For example, a User Agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, oneof several executing on a particular mobile device). A User Agent is trusted once the Multi-Factor Authentication has verified it in some way. */ trustedUserAgents: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionmfaUserTrustedUserAgent[]; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionmfaUserBypassCode { /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionmfaUserDevice { /** * The authentication method. */ authenticationMethod: string; /** * A human readable name, primarily used for display purposes. */ display: string; /** * The device authentication factor status. */ factorStatus: string; /** * Authentication Factor Type */ factorType: string; /** * The last sync time for device. */ lastSyncTime: string; /** * User Token URI */ ref: string; /** * A supplemental status indicating the reason why a user is disabled */ status: string; /** * The third-party factor vendor name. */ thirdPartyVendorName: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionmfaUserPreferredDevice { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionmfaUserTrustedUserAgent { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionpasswordStateUser { /** * Applicable Password Policy */ applicablePasswordPolicies: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionpasswordStateUserApplicablePasswordPolicy[]; /** * Indicates that the current password MAY NOT be changed and all other password expiry settings SHALL be ignored */ cantChange: boolean; /** * Indicates that the password expiry policy will not be applied for the current Resource */ cantExpire: boolean; /** * Indicates whether the user password is expired. If this value is false, password expiry is still evaluated during user login. */ expired: boolean; /** * A DateTime that specifies the date and time when last failed password validation was set */ lastFailedValidationDate: string; /** * A DateTime that specifies the date and time when the current password was set */ lastSuccessfulSetDate: string; /** * A DateTime that specifies the date and time when last successful password validation was set */ lastSuccessfulValidationDate: string; /** * Indicates that the subject password value MUST change on next login. If not changed, typically the account is locked. The value may be set indirectly when the subject's current password expires or directly set by an administrator. */ mustChange: boolean; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionpasswordStateUserApplicablePasswordPolicy { /** * A human readable name, primarily used for display purposes. */ display: string; /** * PasswordPolicy priority */ priority: number; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionpasswordlessUser { /** * Factor Identifier ID */ factorIdentifiers: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionpasswordlessUserFactorIdentifier[]; /** * Authentication Factor Method */ factorMethod: string; /** * Authentication Factor Type */ factorType: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionpasswordlessUserFactorIdentifier { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionposixUser { /** * General information about the POSIX account such as their real name and phone number */ gecos: string; /** * Primary Group identifier of the POSIX user */ gidNumber: number; /** * The absolute path to the home directory of the POSIX account */ homeDirectory: string; /** * The path to the login shell of the POSIX account */ loginShell: string; /** * Integer uniquely identifying a user in a POSIX administrative domain */ uidNumber: number; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUser { /** * The schema used to mnage security question and answers provided by a user for account recovery and/or MFA. While setting up security questions, a user can also provide a hint for the answer. */ secQuestions: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUserSecQuestion[]; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionsecurityQuestionsUserSecQuestion { /** * The answer provided by a user for a security question. */ answer: string; /** * The hint for an answer that's given by user when setting up a security question. */ hintText: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionselfChangeUser { /** * If true, allows requesting user to update themselves. If false, requesting user can't update themself (default). */ allowSelfChange: boolean; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionselfRegistrationUser { /** * A boolean value that indicates whether the consent is granted. */ consentGranted: boolean; /** * Self registration profile used when user is self registered. */ selfRegistrationProfiles: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionselfRegistrationUserSelfRegistrationProfile[]; /** * User token returned if userFlowControlledByExternalClient is true */ userToken: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionselfRegistrationUserSelfRegistrationProfile { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionsffUser { /** * SFF auth keys clob */ sffAuthKeys: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionsocialAccountUser { /** * Description: */ socialAccounts: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionsocialAccountUserSocialAccount[]; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionsocialAccountUserSocialAccount { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensiontermsOfUseUser { /** * Description: */ termsOfUseConsents: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensiontermsOfUseUserTermsOfUseConsent[]; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensiontermsOfUseUserTermsOfUseConsent { /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUser { /** * A list of API keys corresponding to user. */ apiKeys: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserApiKey[]; /** * A list of Auth tokens corresponding to user. */ authTokens: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserAuthToken[]; /** * A list of customer secret keys corresponding to user. */ customerSecretKeys: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserCustomerSecretKey[]; /** * A list of database credentials corresponding to user. */ dbCredentials: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserDbCredential[]; /** * A list of OAuth2 client credentials corresponding to a user. */ oAuth2clientCredentials: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserOAuth2clientCredential[]; /** * A list of SMTP credentials corresponding to user. */ smtpCredentials: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserSmtpCredential[]; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserApiKey { /** * The user's API key value. */ key: string; /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserAuthToken { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserCustomerSecretKey { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserDbCredential { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserOAuth2clientCredential { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserCredentialsUserSmtpCredential { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserStateUser { /** * The last failed login date. */ lastFailedLoginDate: string; /** * The last successful login date. */ lastSuccessfulLoginDate: string; /** * A complex attribute that indicates an account is locked (blocking any new sessions). */ lockeds: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserLocked[]; /** * The number of failed login attempts. The value is reset to 0 after a successful login. */ loginAttempts: number; /** * The maximum number of concurrent sessions for a user. */ maxConcurrentSessions: number; /** * The previous successful login date. */ previousSuccessfulLoginDate: string; /** * The number of failed recovery attempts. The value is reset to 0 after a successful login. */ recoveryAttempts: number; /** * The number of failed account recovery enrollment attempts. */ recoveryEnrollAttempts: number; /** * A complex attribute that indicates a password recovery is locked (blocking any new sessions). */ recoveryLockeds: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserRecoveryLocked[]; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserLocked { /** * Indicates whether the user password is expired. If this value is false, password expiry is still evaluated during user login. */ expired: boolean; /** * The date and time that the current resource was locked. */ lockDate: string; /** * Indicates that the recovery is locked. */ on: boolean; /** * Indicates the reason for locking the account. Valid values are: 0 - failed password login attempts, 1 - admin lock, 2 - failed reset password attempts, 3 - failed MFA login attempts, 4 - failed MFA login attempts for federated user, 5 - failed Database login attempts */ reason: number; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserStateUserRecoveryLocked { /** * The date and time that the current resource was locked. */ lockDate: string; /** * Indicates that the recovery is locked. */ on: boolean; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUser { /** * Boolean value to prompt user to setup account recovery during login. */ accountRecoveryRequired: boolean; /** * Accounts assigned to this User. Each value of this attribute refers to an app-specific identity that is owned by this User. Therefore, this attribute is a convenience that allows one to see on each User the Apps to which that User has access. */ accounts: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserAccount[]; /** * A list of all AppRoles to which this User belongs directly, indirectly or implicitly. The User could belong directly because the User is a member of the AppRole, could belong indirectly because the User is a member of a Group that is a member of the AppRole, or could belong implicitly because the AppRole is public. */ appRoles: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserAppRole[]; /** * The app against which the user will authenticate. The value is not persisted but rather calculated. If the user's delegatedAuthenticationTargetApp is set, that value is returned. Otherwise, the app returned by evaluating the user's applicable Delegated Authentication Policy is returned. */ applicableAuthenticationTargetApps: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserApplicableAuthenticationTargetApp[]; /** * A Boolean value indicating whether or not to send email notification after creating the user. This attribute is not used in update/replace operations. */ bypassNotification: boolean; /** * User creation mechanism */ creationMechanism: string; /** * If set, indicates the user's preferred authentication target app. If not set and the user's \"syncedFromApp\" is set and is enabled for delegated authentication, it is used. Otherwise, the user authenticates locally to Oracle Identity Cloud Service. */ delegatedAuthenticationTargetApps: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserDelegatedAuthenticationTargetApp[]; /** * A Boolean value indicating whether or not to hide the getting started page */ doNotShowGettingStarted: boolean; /** * Grants to this User. Each value of this attribute refers to a Grant to this User of some App (and optionally of some entitlement). Therefore, this attribute is a convenience that allows one to see on each User all of the Grants to that User. */ grants: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserGrant[]; /** * Specifies date time when a User's group membership was last modified. */ groupMembershipLastModified: string; /** * Description: */ idcsAppRolesLimitedToGroups: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserIdcsAppRolesLimitedToGroup[]; /** * A Boolean value indicating whether or not a user is enrolled for account recovery */ isAccountRecoveryEnrolled: boolean; /** * A Boolean value indicating whether or not authentication request by this user should be delegated to a remote app. This value should be true only when the User was originally synced from an app which is enabled for delegated authentication */ isAuthenticationDelegated: boolean; /** * A Boolean value indicating whether or not the user is federated. */ isFederatedUser: boolean; /** * A Boolean value indicating whether or not group membership is normalized for this user. */ isGroupMembershipNormalized: boolean; /** * A Boolean value Indicates whether this User's group membership has been sync'ed from Group.members to UsersGroups. */ isGroupMembershipSyncedToUsersGroups: boolean; /** * Specifies the EmailTemplate to be used when sending notification to the user this request is for. If specified, it overrides the default EmailTemplate for this event. */ notificationEmailTemplateId: string; /** * User's preferred landing page following login, logout and reset password. */ preferredUiLandingPage: string; /** * Indicates if User is a Service User */ serviceUser: boolean; /** * A supplemental status indicating the reason why a user is disabled */ status: string; /** * A list of Support Accounts corresponding to user. */ supportAccounts: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserSupportAccount[]; /** * Managed App or an Identity Source from where the user is synced. If enabled, this Managed App or Identity Source can be used for performing delegated authentication. */ syncedFromApps: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserSyncedFromApp[]; /** * A Boolean value indicating whether to bypass notification and return user token to be used by an external client to control the user flow. */ userFlowControlledByExternalClient: boolean; /** * User Support Account Provider */ userProvider: string; /** * User token returned if userFlowControlledByExternalClient is true */ userTokens: outputs.Identity.GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserUserToken[]; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserAccount { /** * Status of the account */ active: boolean; /** * The ID of the App in this Grant. */ appId: string; /** * Name of the account assigned to the User. */ name: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserAppRole { /** * If true, then the role provides administrative access privileges. READ-ONLY. */ adminRole: boolean; /** * The ID of the App in this Grant. */ appId: string; /** * The name (Client ID) of the App that defines this AppRole. */ appName: string; /** * A human readable name, primarily used for display purposes. */ display: string; /** * The name (if any) under which this AppRole should appear in this User's group-memberships for reasons of backward compatibility. Oracle Identity Cloud Service distinguishes between Groups and AppRoles, but some services still expect AppRoles appear as if they were service-instance-specific Groups. */ legacyGroupName: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserApplicableAuthenticationTargetApp { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * Timeout interval for Synchronization TargetAction in milliseconds */ targetRequestTimeout: number; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserDelegatedAuthenticationTargetApp { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserGrant { /** * The ID of the App in this Grant. */ appId: string; /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ grantMechanism: string; /** * Grantor identifier */ grantorId: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserIdcsAppRolesLimitedToGroup { /** * A human readable name, primarily used for display purposes. */ display: string; /** * The id of the Oracle Identity Cloud Service AppRole grant limited to one or more Groups. */ idcsAppRoleId: string; /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserSupportAccount { /** * The OCID of the user's support account. */ ocid: string; /** * User Token URI */ ref: string; /** * User Support User Id */ userId: string; /** * User Support Account Provider */ userProvider: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserSyncedFromApp { /** * A human readable name, primarily used for display purposes. */ display: string; /** * User Token URI */ ref: string; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserUrnietfparamsscimschemasoracleidcsextensionuserUserUserToken { /** * User Token URI */ ref: string; /** * The value of a X509 certificate. */ value: string; } interface GetDomainsUsersUserX509certificate { /** * A human readable name, primarily used for display purposes. */ display: string; /** * A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once. */ primary: boolean; /** * A label indicating the attribute's function. */ type: string; /** * The value of a X509 certificate. */ value: string; } interface GetDynamicGroupsDynamicGroup { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the group. Does not have to be unique, and it's changeable. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the group. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; /** * A rule string that defines which instance certificates will be matched. For syntax, see [Managing Dynamic Groups](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingdynamicgroups.htm). */ matchingRule: string; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Date and time the group was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetDynamicGroupsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetFaultDomainsFaultDomain { /** * The name of the availibilityDomain. */ availabilityDomain: string; /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * The OCID of the Fault Domain. */ id: string; /** * The name of the Fault Domain. */ name: string; } interface GetFaultDomainsFilter { /** * The name of the Fault Domain. */ name: string; regex?: boolean; values: string[]; } interface GetGroupsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetGroupsGroup { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the group. Does not have to be unique, and it's changeable. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the group. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Date and time the group was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetIamWorkRequestErrorsFilter { name: string; regex?: boolean; values: string[]; } interface GetIamWorkRequestErrorsIamWorkRequestError { /** * A machine-usable code for the error that occured. */ code: string; /** * A human-readable error string. */ message: string; /** * The date and time the error occurred. */ timestamp: string; } interface GetIamWorkRequestLogsFilter { name: string; regex?: boolean; values: string[]; } interface GetIamWorkRequestLogsIamWorkRequestLog { /** * A human-readable error string. */ message: string; /** * Date and time the log was written, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timestamp: string; } interface GetIamWorkRequestResource { /** * The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. */ actionType: string; /** * The resource type the work request is affects. */ entityType: string; /** * The URI path that the user can do a GET on to access the resource metadata. */ entityUri: string; /** * An OCID of the resource that the work request affects. */ identifier: string; } interface GetIamWorkRequestsFilter { name: string; regex?: boolean; values: string[]; } interface GetIamWorkRequestsIamWorkRequest { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * The OCID of the work request. */ id: string; /** * The asynchronous operation tracked by this IAM work request. */ operationType: string; /** * How much progress the operation has made. */ percentComplete: number; /** * The resources this work request affects. */ resources: outputs.Identity.GetIamWorkRequestsIamWorkRequestResource[]; /** * Status of the work request */ status: string; /** * Date and time the work was accepted, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeAccepted: string; /** * Date and time the work completed, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeFinished: string; /** * Date and time the work started, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeStarted: string; } interface GetIamWorkRequestsIamWorkRequestResource { /** * The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. */ actionType: string; /** * The resource type the work request is affects. */ entityType: string; /** * The URI path that the user can do a GET on to access the resource metadata. */ entityUri: string; /** * An OCID of the resource that the work request affects. */ identifier: string; } interface GetIdentityProviderGroupsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetIdentityProviderGroupsIdentityProviderGroup { /** * Display name of the group */ displayName: string; /** * Identifier of the group in the identity provider */ externalIdentifier: string; /** * The OCID of the `IdentityProviderGroup`. */ id: string; /** * The OCID of the identity provider. */ identityProviderId: string; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * Date and time the `IdentityProviderGroup` was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Date and time the `IdentityProviderGroup` was last modified, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeModified: string; } interface GetIdentityProvidersFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetIdentityProvidersIdentityProvider { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the `IdentityProvider` during creation. Does not have to be unique, and it's changeable. */ description: string; /** * Extra name value pairs associated with this identity provider. Example: `{"clientId": "appSf3kdjf3"}` */ freeformAttributes: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the `IdentityProvider`. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; /** * The XML that contains the information required for federating Identity with SAML2 Identity Provider. */ metadata: string; /** * The URL for retrieving the identity provider's metadata, which contains information required for federating. */ metadataUrl: string; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). */ productType: string; /** * The protocol used for federation. */ protocol: string; /** * The URL to redirect federated users to for authentication with the identity provider. */ redirectUrl: string; /** * The identity provider's signing certificate used by the IAM Service to validate the SAML2 token. */ signingCertificate: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Date and time the `IdentityProvider` was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetIdpGroupMappingsFilter { name: string; regex?: boolean; values: string[]; } interface GetIdpGroupMappingsIdpGroupMapping { /** * The OCID of the tenancy containing the `IdentityProvider`. */ compartmentId: string; /** * The OCID of the IAM Service group that is mapped to the IdP group. */ groupId: string; /** * The OCID of the `IdpGroupMapping`. */ id: string; /** * The OCID of the identity provider. */ identityProviderId: string; /** * The name of the IdP group that is mapped to the IAM Service group. */ idpGroupName: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; /** * The mapping's current state. */ state: string; /** * Date and time the mapping was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetNetworkSourceVirtualSourceList { ipRanges: string[]; vcnId: string; } interface GetNetworkSourcesFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkSourcesNetworkSource { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the network source. Does not have to be unique, and it's changeable. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the network source. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * A list of allowed public IP addresses and CIDR ranges. */ publicSourceLists: string[]; /** * A list of services allowed to make on-behalf-of requests. These requests can have different source IPs than those specified in the network source. Currently, only `all` and `none` are supported. The default is `all`. */ services: string[]; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Date and time the group was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * A list of allowed VCN OCID and IP range pairs. Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]` */ virtualSourceLists: outputs.Identity.GetNetworkSourcesNetworkSourceVirtualSourceList[]; } interface GetNetworkSourcesNetworkSourceVirtualSourceList { ipRanges: string[]; vcnId: string; } interface GetPoliciesFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetPoliciesPolicy { /** * @deprecated The 'ETag' field has been deprecated and may be removed in a future version. Do not use this field. */ ETag: string; /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the policy. Does not have to be unique, and it's changeable. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the policy. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; /** * @deprecated The 'lastUpdateETag' field has been deprecated and may be removed in a future version. Do not use this field. */ lastUpdateETag: string; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * @deprecated The 'policyHash' field has been deprecated and may be removed in a future version. Do not use this field. */ policyHash: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * An array of one or more policy statements written in the policy language. */ statements: string[]; /** * Date and time the policy was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The version of the policy. If null or set to an empty string, when a request comes in for authorization, the policy will be evaluated according to the current behavior of the services at that moment. If set to a particular date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date. */ versionDate: string; } interface GetRegionSubscriptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetRegionSubscriptionsRegionSubscription { /** * Indicates if the region is the home region or not. */ isHomeRegion: boolean; /** * The region's key. See [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) for the full list of supported 3-letter region codes. Example: `PHX` */ regionKey: string; /** * The region's name. See [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) for the full list of supported region names. Example: `us-phoenix-1` */ regionName: string; state: string; /** * The OCID of the tenancy. */ tenancyId: string; } interface GetRegionsFilter { /** * The name of the region. See [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) for the full list of supported region names. Example: `us-phoenix-1` */ name: string; regex?: boolean; values: string[]; } interface GetRegionsRegion { /** * The key of the region. See [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) for the full list of supported 3-letter region codes. Example: `PHX` */ key: string; /** * The name of the region. See [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) for the full list of supported region names. Example: `us-phoenix-1` */ name: string; } interface GetSmtpCredentialsFilter { name: string; regex?: boolean; values: string[]; } interface GetSmtpCredentialsSmtpCredential { /** * The description you assign to the SMTP credential. Does not have to be unique, and it's changeable. */ description: string; /** * The OCID of the SMTP credential. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; password: string; /** * The credential's current state. */ state: string; /** * Date and time the `SmtpCredential` object was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires. Example: `2016-08-25T21:10:29.600Z` */ timeExpires: string; /** * The OCID of the user. */ userId: string; /** * The SMTP user name. */ username: string; } interface GetTagDefaultsFilter { name: string; regex?: boolean; values: string[]; } interface GetTagDefaultsTagDefault { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * A filter to only return resources that match the specified OCID exactly. */ id: string; /** * If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. * * If the `isRequired` flag is set to "true", the value is set during resource creation. * * If the `isRequired` flag is set to "false", the value you enter is set during resource creation. */ isRequired: boolean; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The OCID of the tag definition. */ tagDefinitionId: string; /** * The name used in the tag definition. This field is informational in the context of the tag default. */ tagDefinitionName: string; /** * The OCID of the tag namespace that contains the tag definition. */ tagNamespaceId: string; /** * Date and time the `TagDefault` object was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The default value for the tag definition. This will be applied to all new resources created in the compartment. */ value: string; } interface GetTagNamespacesFilter { /** * The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed. */ name: string; regex?: boolean; values: string[]; } interface GetTagNamespacesTagNamespace { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the tag namespace. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the tag namespace. */ id: string; /** * Whether the tag namespace is retired. For more information, see [Retiring Key Definitions and Namespace Definitions](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#Retiring). */ isRetired: boolean; /** * The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed. */ name: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Date and time the tag namespace was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetTagStandardTagNamespaceTemplateTagDefinitionTemplate { /** * The default description of the tag namespace that users can use to create the tag definition */ description: string; /** * The mutability of the possible values list for enum tags. This will default to IMMUTABLE for string value tags */ enumMutability: string; /** * Is the tag a cost tracking tag. Default will be false as cost tracking tags have been deprecated */ isCostTracking: boolean; /** * List of possible values. An optional parameter that will be present if the type of definition is enum. */ possibleValues: string[]; /** * The name of this standard tag definition */ tagDefinitionName: string; /** * The type of tag definition. Enum or string. */ type: string; } interface GetTagStandardTagNamespaceTemplatesFilter { name: string; regex?: boolean; values: string[]; } interface GetTagStandardTagNamespaceTemplatesStandardTagNamespaceTemplate { /** * The default description of the tag namespace that users can use to create the tag namespace */ description: string; /** * The reserved name of this standard tag namespace */ standardTagNamespaceName: string; /** * The status of the standard tag namespace */ status: string; } interface GetTagValidator { /** * Specifies the type of validation: a static value (no validation) or a list. */ validatorType: string; /** * The list of allowed values for a definedTag value. */ values: string[]; } interface GetTagsFilter { /** * The name assigned to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed. */ name: string; regex?: boolean; /** * The list of allowed values for a definedTag value. */ values: string[]; } interface GetTagsTag { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the tag. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the tag definition. */ id: string; /** * Indicates whether the tag is enabled for cost tracking. */ isCostTracking: boolean; /** * Indicates whether the tag is retired. See [Retiring Key Definitions and Namespace Definitions](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#Retiring). */ isRetired: boolean; /** * The name assigned to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed. */ name: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The OCID of the tag namespace. */ tagNamespaceId: string; /** * Date and time the tag was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Validates a definedTag value. Each validator performs validation steps in addition to the standard validation for definedTag values. For more information, see [Limits on Tags](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#Limits). */ validators: outputs.Identity.GetTagsTagValidator[]; } interface GetTagsTagValidator { /** * Specifies the type of validation: a static value (no validation) or a list. */ validatorType: string; /** * The list of allowed values for a definedTag value. */ values: string[]; } interface GetUserCapability { /** * Indicates if the user can use API keys. */ canUseApiKeys: boolean; /** * Indicates if the user can use SWIFT passwords / auth tokens. */ canUseAuthTokens: boolean; /** * Indicates if the user can log in to the console. */ canUseConsolePassword: boolean; /** * Indicates if the user can use SigV4 symmetric keys. */ canUseCustomerSecretKeys: boolean; /** * Indicates if the user can use DB passwords. */ canUseDbCredentials: boolean; /** * Indicates if the user can use OAuth2 credentials and tokens. */ canUseOauth2clientCredentials: boolean; /** * Indicates if the user can use SMTP passwords. */ canUseSmtpCredentials: boolean; } interface GetUserGroupMembershipsFilter { name: string; regex?: boolean; values: string[]; } interface GetUserGroupMembershipsMembership { /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * The OCID of the group. */ groupId: string; /** * The OCID of the membership. */ id: string; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState: string; /** * The membership's current state. */ state: string; /** * Date and time the membership was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The OCID of the user. */ userId: string; } interface GetUsersFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetUsersUser { /** * Properties indicating how the user is allowed to authenticate. */ capabilities: outputs.Identity.GetUsersUserCapability[]; /** * The OCID of the compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * DB username of the DB credential. Has to be unique across the tenancy. */ dbUserName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the user. Does not have to be unique, and it's changeable. */ description: string; /** * The email address you assign to the user. The email address must be unique across all users in the tenancy. */ email: string; /** * Whether the email address has been validated. */ emailVerified: boolean; /** * The id of a user in the identity provider. */ externalIdentifier: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the user. */ id: string; /** * The id of the identity provider. */ identityProviderId: string; /** * Returned only if the user's `lifecycleState` is INACTIVE. A 16-bit value showing the reason why the user is inactive: * * bit 0: SUSPENDED (reserved for future use) * * bit 1: DISABLED (reserved for future use) * * bit 2: BLOCKED (the user has exceeded the maximum number of failed login attempts for the Console) */ inactiveState: string; /** * The date and time of when the user most recently logged in the format defined by RFC3339 (ex. `2016-08-25T21:10:29.600Z`). If there is no login history, this field is null. */ lastSuccessfulLoginTime: string; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * The date and time of when the user most recently logged in the format defined by RFC3339 (ex. `2016-08-25T21:10:29.600Z`). If there is no login history, this field is null. */ previousSuccessfulLoginTime: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Date and time the user was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetUsersUserCapability { /** * Indicates if the user can use API keys. */ canUseApiKeys: boolean; /** * Indicates if the user can use SWIFT passwords / auth tokens. */ canUseAuthTokens: boolean; /** * Indicates if the user can log in to the console. */ canUseConsolePassword: boolean; /** * Indicates if the user can use SigV4 symmetric keys. */ canUseCustomerSecretKeys: boolean; /** * Indicates if the user can use DB passwords. */ canUseDbCredentials: boolean; /** * Indicates if the user can use OAuth2 credentials and tokens. */ canUseOauth2clientCredentials: boolean; /** * Indicates if the user can use SMTP passwords. */ canUseSmtpCredentials: boolean; } interface NetworkSourceVirtualSourceList { ipRanges: string[]; vcnId: string; } interface TagValidator { /** * (Updatable) Specifies the type of validation: a static value (no validation) or a list. */ validatorType: string; /** * (Updatable) The list of allowed values for a definedTag value. */ values: string[]; } interface UserCapability { /** * Indicates if the user can use API keys. */ canUseApiKeys: boolean; /** * Indicates if the user can use SWIFT passwords / auth tokens. */ canUseAuthTokens: boolean; /** * Indicates if the user can log in to the console. */ canUseConsolePassword: boolean; /** * Indicates if the user can use SigV4 symmetric keys. */ canUseCustomerSecretKeys: boolean; /** * Indicates if the user can use DB passwords. */ canUseDbCredentials: boolean; /** * Indicates if the user can use OAuth2 credentials and tokens. */ canUseOauth2clientCredentials: boolean; /** * Indicates if the user can use SMTP passwords. */ canUseSmtpCredentials: boolean; } } export declare namespace Integration { interface GetIntegrationInstanceAlternateCustomEndpoint { /** * When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata. */ alias: string; /** * Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified).* `dnsType` - Type of DNS. */ certificateSecretVersion: number; dnsType: string; /** * DNS Zone name */ dnsZoneName: string; /** * A custom hostname to be used for the integration instance URL, in FQDN format. */ hostname: string; /** * Indicates if custom endpoint is managed by oracle or customer. */ managedType: string; } interface GetIntegrationInstanceAttachment { /** * * If role == `PARENT`, the attached instance was created by this service instance * * If role == `CHILD`, this instance was created from attached instance on behalf of a user */ isImplicit: boolean; /** * The OCID of the target instance (which could be any other Oracle Cloud Infrastructure PaaS/SaaS resource), to which this instance is attached. */ targetId: string; /** * The dataplane instance URL of the attached instance */ targetInstanceUrl: string; /** * The role of the target attachment. * * `PARENT` - The target instance is the parent of this attachment. * * `CHILD` - The target instance is the child of this attachment. */ targetRole: string; /** * The type of the target instance, such as "FUSION". */ targetServiceType: string; } interface GetIntegrationInstanceCustomEndpoint { /** * When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata. */ alias: string; /** * Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified).* `dnsType` - Type of DNS. */ certificateSecretVersion: number; dnsType: string; /** * DNS Zone name */ dnsZoneName: string; /** * A custom hostname to be used for the integration instance URL, in FQDN format. */ hostname: string; /** * Indicates if custom endpoint is managed by oracle or customer. */ managedType: string; } interface GetIntegrationInstanceDisasterRecoveryDetail { /** * Details of integration instance created in cross region for disaster recovery. */ crossRegionIntegrationInstanceDetails: outputs.Integration.GetIntegrationInstanceDisasterRecoveryDetailCrossRegionIntegrationInstanceDetail[]; /** * Region specific instance url for the integration instance in the region */ regionalInstanceUrl: string; /** * Role of the integration instance in the region */ role: string; } interface GetIntegrationInstanceDisasterRecoveryDetailCrossRegionIntegrationInstanceDetail { /** * The Virtual Cloud Network OCID. */ id: string; /** * Cross region where integration instance is created */ region: string; /** * Role of the integration instance in the region */ role: string; /** * Time when cross region integration instance role was changed */ timeRoleChanged: string; } interface GetIntegrationInstanceIdcsInfo { /** * The IDCS application display name associated with the instance */ idcsAppDisplayName: string; /** * The IDCS application ID associated with the instance */ idcsAppId: string; /** * URL for the location of the IDCS Application (used by IDCS APIs) */ idcsAppLocationUrl: string; /** * The IDCS application name associated with the instance */ idcsAppName: string; /** * The URL used as the primary audience for integration flows in this instance type: string* `instanceDesignTimeUrl` - The Integration Instance Design Time URL */ instancePrimaryAudienceUrl: string; } interface GetIntegrationInstanceNetworkEndpointDetail { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.Integration.GetIntegrationInstanceNetworkEndpointDetailAllowlistedHttpVcn[]; /** * A collection of AllowListedIps and AllowListedVcns for a specific OIC component: global, RT, or DT */ designTimes: outputs.Integration.GetIntegrationInstanceNetworkEndpointDetailDesignTime[]; /** * The Integration service's VCN is allow-listed to allow integrations to call back into other integrations */ isIntegrationVcnAllowlisted: boolean; /** * The type of network endpoint. */ networkEndpointType: string; /** * A collection of AllowListedIps and AllowListedVcns for a specific OIC component: global, RT, or DT */ runtimes: outputs.Integration.GetIntegrationInstanceNetworkEndpointDetailRuntime[]; } interface GetIntegrationInstanceNetworkEndpointDetailAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIps: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface GetIntegrationInstanceNetworkEndpointDetailDesignTime { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.Integration.GetIntegrationInstanceNetworkEndpointDetailDesignTimeAllowlistedHttpVcn[]; } interface GetIntegrationInstanceNetworkEndpointDetailDesignTimeAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIps: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface GetIntegrationInstanceNetworkEndpointDetailRuntime { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.Integration.GetIntegrationInstanceNetworkEndpointDetailRuntimeAllowlistedHttpVcn[]; } interface GetIntegrationInstanceNetworkEndpointDetailRuntimeAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIps: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface GetIntegrationInstancePrivateEndpointOutboundConnection { /** * Indicates if all traffic should go through configured outbound connection */ isAllOutboundTrafficPrivate: boolean; /** * One or more Network security group Ids. This is an optional argument. */ nsgIds: string[]; /** * The type of Outbound Connection. */ outboundConnectionType: string; /** * Customer Private Network VCN Subnet OCID. This is a required argument. */ subnetId: string; } interface GetIntegrationInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetIntegrationInstancesIntegrationInstance { /** * A list of alternate custom endpoints used for the integration instance URL. */ alternateCustomEndpoints: outputs.Integration.GetIntegrationInstancesIntegrationInstanceAlternateCustomEndpoint[]; attachmentType: string; /** * A list of associated attachments to other services */ attachments: outputs.Integration.GetIntegrationInstancesIntegrationInstanceAttachment[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The entitlement used for billing purposes. */ consumptionModel: string; convertInstanceTrigger: number; /** * Details for a custom endpoint for the integration instance. */ customEndpoints: outputs.Integration.GetIntegrationInstancesIntegrationInstanceCustomEndpoint[]; /** * Data retention period set for given integration instance */ dataRetentionPeriod: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; disableProcessAutomationTrigger: number; /** * Disaster recovery details for the integration instance created in the region. */ disasterRecoveryDetails: outputs.Integration.GetIntegrationInstancesIntegrationInstanceDisasterRecoveryDetail[]; /** * A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; domainId: string; enableProcessAutomationTrigger: number; extendDataRetentionTrigger: number; failoverTrigger: number; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The Virtual Cloud Network OCID. */ id: string; idcsAt: string; /** * Information for IDCS access */ idcsInfos: outputs.Integration.GetIntegrationInstancesIntegrationInstanceIdcsInfo[]; instanceDesignTimeUrl: string; /** * The Integration Instance URL. */ instanceUrl: string; /** * Standard or Enterprise type, Oracle Integration Generation 2 uses ENTERPRISE and STANDARD, Oracle Integration 3 uses ENTERPRISEX, STANDARDX and HEALTHCARE */ integrationInstanceType: string; /** * Bring your own license. */ isByol: boolean; /** * Is Disaster Recovery enabled for the integrationInstance */ isDisasterRecoveryEnabled: boolean; /** * The file server is enabled or not. */ isFileServerEnabled: boolean; /** * Visual Builder is enabled or not. */ isVisualBuilderEnabled: boolean; /** * Additional details of lifecycleState or substates */ lifecycleDetails: string; /** * OCID of LogAnalytics LogGroup, enabled for given integration instance */ logGroupId: string; /** * The number of configured message packs (if any) */ messagePacks: number; /** * Base representation of a network endpoint. */ networkEndpointDetails: outputs.Integration.GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetail[]; /** * Base representation for Outbound Connection (Reverse Connection). */ privateEndpointOutboundConnections: outputs.Integration.GetIntegrationInstancesIntegrationInstancePrivateEndpointOutboundConnection[]; /** * OCID of LogAnalytics LogGroup, enabled for given Process Automation attached to integration instance. */ processAutomationLogGroupId: string; /** * 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.sensitivity.value" = "low" * "oracle-zpr.sensitivity.mode" = "enforce" * }` */ securityAttributes: { [key: string]: string; }; /** * Shape */ shape: string; /** * Life cycle state to query on. */ state: string; /** * An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ stateMessage: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the Integration Instance was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the IntegrationInstance was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetIntegrationInstancesIntegrationInstanceAlternateCustomEndpoint { /** * When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata. */ alias: string; /** * Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified).* `dnsType` - Type of DNS. */ certificateSecretVersion: number; dnsType: string; /** * DNS Zone name */ dnsZoneName: string; /** * A custom hostname to be used for the integration instance URL, in FQDN format. */ hostname: string; /** * Indicates if custom endpoint is managed by oracle or customer. */ managedType: string; } interface GetIntegrationInstancesIntegrationInstanceAttachment { /** * * If role == `PARENT`, the attached instance was created by this service instance * * If role == `CHILD`, this instance was created from attached instance on behalf of a user */ isImplicit: boolean; /** * The OCID of the target instance (which could be any other Oracle Cloud Infrastructure PaaS/SaaS resource), to which this instance is attached. */ targetId: string; /** * The dataplane instance URL of the attached instance */ targetInstanceUrl: string; /** * The role of the target attachment. * * `PARENT` - The target instance is the parent of this attachment. * * `CHILD` - The target instance is the child of this attachment. */ targetRole: string; /** * The type of the target instance, such as "FUSION". */ targetServiceType: string; } interface GetIntegrationInstancesIntegrationInstanceCustomEndpoint { /** * When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata. */ alias: string; /** * Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified).* `dnsType` - Type of DNS. */ certificateSecretVersion: number; dnsType: string; /** * DNS Zone name */ dnsZoneName: string; /** * A custom hostname to be used for the integration instance URL, in FQDN format. */ hostname: string; /** * Indicates if custom endpoint is managed by oracle or customer. */ managedType: string; } interface GetIntegrationInstancesIntegrationInstanceDisasterRecoveryDetail { /** * Details of integration instance created in cross region for disaster recovery. */ crossRegionIntegrationInstanceDetails: outputs.Integration.GetIntegrationInstancesIntegrationInstanceDisasterRecoveryDetailCrossRegionIntegrationInstanceDetail[]; /** * Region specific instance url for the integration instance in the region */ regionalInstanceUrl: string; /** * Role of the integration instance in the region */ role: string; } interface GetIntegrationInstancesIntegrationInstanceDisasterRecoveryDetailCrossRegionIntegrationInstanceDetail { /** * The Virtual Cloud Network OCID. */ id: string; /** * Cross region where integration instance is created */ region: string; /** * Role of the integration instance in the region */ role: string; /** * Time when cross region integration instance role was changed */ timeRoleChanged: string; } interface GetIntegrationInstancesIntegrationInstanceIdcsInfo { /** * The IDCS application display name associated with the instance */ idcsAppDisplayName: string; /** * The IDCS application ID associated with the instance */ idcsAppId: string; /** * URL for the location of the IDCS Application (used by IDCS APIs) */ idcsAppLocationUrl: string; /** * The IDCS application name associated with the instance */ idcsAppName: string; /** * The URL used as the primary audience for integration flows in this instance type: string* `instanceDesignTimeUrl` - The Integration Instance Design Time URL */ instancePrimaryAudienceUrl: string; } interface GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetail { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.Integration.GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetailAllowlistedHttpVcn[]; /** * A collection of AllowListedIps and AllowListedVcns for a specific OIC component: global, RT, or DT */ designTimes: outputs.Integration.GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetailDesignTime[]; /** * The Integration service's VCN is allow-listed to allow integrations to call back into other integrations */ isIntegrationVcnAllowlisted: boolean; /** * The type of network endpoint. */ networkEndpointType: string; /** * A collection of AllowListedIps and AllowListedVcns for a specific OIC component: global, RT, or DT */ runtimes: outputs.Integration.GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetailRuntime[]; } interface GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetailAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIps: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetailDesignTime { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.Integration.GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetailDesignTimeAllowlistedHttpVcn[]; } interface GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetailDesignTimeAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIps: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetailRuntime { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.Integration.GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetailRuntimeAllowlistedHttpVcn[]; } interface GetIntegrationInstancesIntegrationInstanceNetworkEndpointDetailRuntimeAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIps: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface GetIntegrationInstancesIntegrationInstancePrivateEndpointOutboundConnection { isAllOutboundTrafficPrivate: boolean; /** * One or more Network security group Ids. This is an optional argument. */ nsgIds: string[]; /** * The type of Outbound Connection. */ outboundConnectionType: string; /** * Customer Private Network VCN Subnet OCID. This is a required argument. */ subnetId: string; } interface IntegrationInstanceAlternateCustomEndpoint { /** * When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata. */ alias: string; /** * (Updatable) Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified). */ certificateSecretVersion: number; /** * Type of DNS. */ dnsType: string; /** * DNS Zone name */ dnsZoneName: string; /** * (Updatable) A custom hostname to be used for the integration instance URL, in FQDN format. */ hostname: string; /** * Indicates if custom endpoint is managed by oracle or customer. */ managedType: string; } interface IntegrationInstanceAttachment { /** * * If role == `PARENT`, the attached instance was created by this service instance * * If role == `CHILD`, this instance was created from attached instance on behalf of a user */ isImplicit: boolean; /** * The OCID of the target instance (which could be any other Oracle Cloud Infrastructure PaaS/SaaS resource), to which this instance is attached. */ targetId: string; /** * The dataplane instance URL of the attached instance */ targetInstanceUrl: string; /** * The role of the target attachment. * * `PARENT` - The target instance is the parent of this attachment. * * `CHILD` - The target instance is the child of this attachment. */ targetRole: string; /** * The type of the target instance, such as "FUSION". */ targetServiceType: string; } interface IntegrationInstanceCustomEndpoint { /** * When creating the DNS CNAME record for the custom hostname, this value must be specified in the rdata. */ alias: string; /** * (Updatable) Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified). */ certificateSecretVersion: number; /** * Type of DNS. */ dnsType?: string; /** * DNS Zone name */ dnsZoneName: string; /** * (Updatable) A custom hostname to be used for the integration instance URL, in FQDN format. */ hostname: string; /** * Indicates if custom endpoint is managed by oracle or customer. */ managedType: string; } interface IntegrationInstanceDisasterRecoveryDetail { /** * Details of integration instance created in cross region for disaster recovery. */ crossRegionIntegrationInstanceDetails: outputs.Integration.IntegrationInstanceDisasterRecoveryDetailCrossRegionIntegrationInstanceDetail[]; /** * Region specific instance url for the integration instance in the region */ regionalInstanceUrl: string; /** * Role of the integration instance in the region */ role: string; } interface IntegrationInstanceDisasterRecoveryDetailCrossRegionIntegrationInstanceDetail { /** * The Virtual Cloud Network OCID. */ id: string; /** * Cross region where integration instance is created */ region: string; /** * Role of the integration instance in the region */ role: string; /** * Time when cross region integration instance role was changed */ timeRoleChanged: string; } interface IntegrationInstanceIdcsInfo { /** * The IDCS application display name associated with the instance */ idcsAppDisplayName: string; /** * The IDCS application ID associated with the instance */ idcsAppId: string; /** * URL for the location of the IDCS Application (used by IDCS APIs) */ idcsAppLocationUrl: string; /** * The IDCS application name associated with the instance */ idcsAppName: string; /** * The URL used as the primary audience for integration flows in this instance type: string */ instancePrimaryAudienceUrl: string; } interface IntegrationInstanceNetworkEndpointDetails { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.Integration.IntegrationInstanceNetworkEndpointDetailsAllowlistedHttpVcn[]; /** * A collection of AllowListedIps and AllowListedVcns for a specific OIC component: global, RT, or DT */ designTime: outputs.Integration.IntegrationInstanceNetworkEndpointDetailsDesignTime; /** * The Integration service's VCN is allow-listed to allow integrations to call back into other integrations */ isIntegrationVcnAllowlisted: boolean; /** * The type of network endpoint. */ networkEndpointType: string; /** * A collection of AllowListedIps and AllowListedVcns for a specific OIC component: global, RT, or DT */ runtime: outputs.Integration.IntegrationInstanceNetworkEndpointDetailsRuntime; } interface IntegrationInstanceNetworkEndpointDetailsAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIps: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface IntegrationInstanceNetworkEndpointDetailsDesignTime { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.Integration.IntegrationInstanceNetworkEndpointDetailsDesignTimeAllowlistedHttpVcn[]; } interface IntegrationInstanceNetworkEndpointDetailsDesignTimeAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIps: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface IntegrationInstanceNetworkEndpointDetailsRuntime { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.Integration.IntegrationInstanceNetworkEndpointDetailsRuntimeAllowlistedHttpVcn[]; } interface IntegrationInstanceNetworkEndpointDetailsRuntimeAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIps: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface IntegrationInstancePrivateEndpointOutboundConnection { isAllOutboundTrafficPrivate: boolean; /** * One or more Network security group Ids. This is an optional argument. */ nsgIds: string[]; /** * The type of Outbound Connection. */ outboundConnectionType: string; /** * Customer Private Network VCN Subnet OCID. This is a required argument. */ subnetId: string; } } export declare namespace Jms { interface FleetAdvancedFeatureConfigurationAdvancedUsageTracking { /** * (Updatable) AdvancedUsageTracking flag to store enabled or disabled status. */ isEnabled: boolean; } interface FleetAdvancedFeatureConfigurationCryptoEventAnalysis { /** * (Updatable) CryptoEventAnalysis flag to store enabled or disabled status. */ isEnabled: boolean; /** * (Updatable) Summarized events log for advanced feature. */ summarizedEventsLog: outputs.Jms.FleetAdvancedFeatureConfigurationCryptoEventAnalysisSummarizedEventsLog; } interface FleetAdvancedFeatureConfigurationCryptoEventAnalysisSummarizedEventsLog { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface FleetAdvancedFeatureConfigurationJavaMigrationAnalysis { /** * (Updatable) JavaMigrationAnalysis flag to store enabled or disabled status. */ isEnabled: boolean; } interface FleetAdvancedFeatureConfigurationJfrRecording { /** * (Updatable) JfrRecording flag to store enabled or disabled status. */ isEnabled: boolean; } interface FleetAdvancedFeatureConfigurationLcm { /** * (Updatable) Lifecycle management flag to store enabled or disabled status. */ isEnabled: boolean; /** * (Updatable) List of available post actions you can execute after the successful Java installation. */ postInstallationActions: outputs.Jms.FleetAdvancedFeatureConfigurationLcmPostInstallationActions; } interface FleetAdvancedFeatureConfigurationLcmPostInstallationActions { /** * (Updatable) Sets FileHandler and ConsoleHandler as handlers in logging.properties file. */ addLoggingHandler: boolean; /** * (Updatable) The following post JRE installation actions are supported by the field: * * Disable TLS 1.0 , TLS 1.1 */ disabledTlsVersions: string[]; /** * (Updatable) Sets the logging level in logging.properties file. */ globalLoggingLevel: string; /** * (Updatable) test */ minimumKeySizeSettings: outputs.Jms.FleetAdvancedFeatureConfigurationLcmPostInstallationActionsMinimumKeySizeSettings; /** * (Updatable) List of proxy properties to be configured in net.properties file. */ proxies: outputs.Jms.FleetAdvancedFeatureConfigurationLcmPostInstallationActionsProxies; /** * (Updatable) Restores JDK root certificates with the certificates that are available in the operating system. The following action is supported by the field: * * Replace JDK root certificates with a list provided by the operating system. */ shouldReplaceCertificatesOperatingSystem: boolean; } interface FleetAdvancedFeatureConfigurationLcmPostInstallationActionsMinimumKeySizeSettings { /** * (Updatable) Updates the minimum key size for the specified encryption algorithm. The JDK property jdk.certpath.disabledAlgorithms will be updated with the following supported actions: * * Changing minimum key length for RSA signed jars * * Changing minimum key length for EC * * Changing minimum key length for DSA */ certpaths: outputs.Jms.FleetAdvancedFeatureConfigurationLcmPostInstallationActionsMinimumKeySizeSettingsCertpath[]; /** * (Updatable) Updates the minimum key size for the specified encryption algorithm. The JDK property jdk.jar.disabledAlgorithms will be updated with the following supported actions: * * Changing minimum key length for RSA signed jars * * Changing minimum key length for EC * * Changing minimum key length for DSA */ jars: outputs.Jms.FleetAdvancedFeatureConfigurationLcmPostInstallationActionsMinimumKeySizeSettingsJar[]; /** * (Updatable) Updates the minimum key size for the specified encryption algorithm. The JDK property jdk.tls.disabledAlgorithms will be updated with the following supported actions: * * Changing minimum key length for Diffie-Hellman */ tls: outputs.Jms.FleetAdvancedFeatureConfigurationLcmPostInstallationActionsMinimumKeySizeSettingsTl[]; } interface FleetAdvancedFeatureConfigurationLcmPostInstallationActionsMinimumKeySizeSettingsCertpath { /** * (Updatable) Key size for the encryption algorithm. Allowed values: 256 for EC, 2048 for DH/DSA/RSA */ keySize: number; /** * (Updatable) The algorithm name. */ name: string; } interface FleetAdvancedFeatureConfigurationLcmPostInstallationActionsMinimumKeySizeSettingsJar { /** * (Updatable) Key size for the encryption algorithm. Allowed values: 256 for EC, 2048 for DH/DSA/RSA */ keySize: number; /** * (Updatable) The algorithm name. */ name: string; } interface FleetAdvancedFeatureConfigurationLcmPostInstallationActionsMinimumKeySizeSettingsTl { /** * (Updatable) Key size for the encryption algorithm. Allowed values: 256 for EC, 2048 for DH/DSA/RSA */ keySize: number; /** * (Updatable) The algorithm name. */ name: string; } interface FleetAdvancedFeatureConfigurationLcmPostInstallationActionsProxies { /** * (Updatable) Ftp host to be set in net.properties file. */ ftpProxyHost: string; /** * (Updatable) Ftp port number to be set in net.properties file. */ ftpProxyPort: number; /** * (Updatable) Http host to be set in net.properties file. */ httpProxyHost: string; /** * (Updatable) Http port number to be set in net.properties file. */ httpProxyPort: number; /** * (Updatable) Https host to be set in net.properties file. */ httpsProxyHost: string; /** * (Updatable) Https port number to be set in net.properties file. */ httpsProxyPort: number; /** * (Updatable) Socks host to be set in net.properties file. */ socksProxyHost: string; /** * (Updatable) Socks port number to be set in net.properties file. */ socksProxyPort: number; /** * (Updatable) Sets "java.net.useSystemProxies=true" in net.properties when they exist. */ useSystemProxies: boolean; } interface FleetAdvancedFeatureConfigurationPerformanceTuningAnalysis { /** * (Updatable) PerformanceTuningAnalysis flag to store enabled or disabled status * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ isEnabled: boolean; } interface FleetAgentConfigurationLinuxConfiguration { /** * (Updatable) An array of file system paths (environment variables supported). */ excludePaths: string[]; /** * (Updatable) An array of file system paths (environment variables supported). */ includePaths: string[]; } interface FleetAgentConfigurationMacOsConfiguration { /** * (Updatable) An array of file system paths (environment variables supported). */ excludePaths: string[]; /** * (Updatable) An array of file system paths (environment variables supported). */ includePaths: string[]; } interface FleetAgentConfigurationWindowsConfiguration { /** * (Updatable) An array of file system paths (environment variables supported). */ excludePaths: string[]; /** * (Updatable) An array of file system paths (environment variables supported). */ includePaths: string[]; } interface FleetInventoryLog { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface FleetOperationLog { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ logId: string; } interface GetAgentInstallersAgentInstallerCollection { /** * A list of the agent installer summaries. */ items: outputs.Jms.GetAgentInstallersAgentInstallerCollectionItem[]; } interface GetAgentInstallersAgentInstallerCollectionItem { /** * Description of the agent installer artifact. The description typically includes the OS, architecture, and agent installer type. */ agentInstallerDescription: string; /** * Unique identifier for the agent installer. */ agentInstallerId: string; /** * Agent installer version. */ agentInstallerVersion: string; /** * Agent image version. */ agentVersion: string; /** * Approximate compressed file size in bytes. */ approximateFileSizeInBytes: string; /** * Java version. */ javaVersion: string; /** * The OS family for the agent installer. */ osFamily: string; /** * The package type (typically the file extension) of the agent software included in the installer. */ packageType: string; /** * The platform architecture for the agent installer. */ platformArchitecture: string; /** * SHA256 checksum of the agent installer. */ sha256: string; } interface GetAgentInstallersFilter { name: string; regex?: boolean; values: string[]; } interface GetAnnouncementsAnnouncementCollection { /** * List of AnnouncementSummary items */ items: outputs.Jms.GetAnnouncementsAnnouncementCollectionItem[]; } interface GetAnnouncementsAnnouncementCollectionItem { /** * Unique id of the announcement */ key: number; /** * Summary text of the announcement */ summary: string; /** * Date time on which the announcement was released */ timeReleased: string; /** * URL to the announcement web page */ url: string; } interface GetAnnouncementsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetAdvancedFeatureConfigurationAdvancedUsageTracking { /** * PerformanceTuningAnalysis flag to store enabled or disabled status */ isEnabled: boolean; } interface GetFleetAdvancedFeatureConfigurationCryptoEventAnalysis { /** * PerformanceTuningAnalysis flag to store enabled or disabled status */ isEnabled: boolean; /** * Summarized events log for advanced feature. */ summarizedEventsLogs: outputs.Jms.GetFleetAdvancedFeatureConfigurationCryptoEventAnalysisSummarizedEventsLog[]; } interface GetFleetAdvancedFeatureConfigurationCryptoEventAnalysisSummarizedEventsLog { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetFleetAdvancedFeatureConfigurationJavaMigrationAnalysis { /** * PerformanceTuningAnalysis flag to store enabled or disabled status */ isEnabled: boolean; } interface GetFleetAdvancedFeatureConfigurationJfrRecording { /** * PerformanceTuningAnalysis flag to store enabled or disabled status */ isEnabled: boolean; } interface GetFleetAdvancedFeatureConfigurationLcm { /** * PerformanceTuningAnalysis flag to store enabled or disabled status */ isEnabled: boolean; /** * List of available post actions you can execute after the successful Java installation. */ postInstallationActions: outputs.Jms.GetFleetAdvancedFeatureConfigurationLcmPostInstallationAction[]; } interface GetFleetAdvancedFeatureConfigurationLcmPostInstallationAction { /** * Sets FileHandler and ConsoleHandler as handlers in logging.properties file. */ addLoggingHandler: boolean; /** * The following post JRE installation actions are supported by the field: * * Disable TLS 1.0 , TLS 1.1 */ disabledTlsVersions: string[]; /** * Sets the logging level in logging.properties file. */ globalLoggingLevel: string; /** * test */ minimumKeySizeSettings: outputs.Jms.GetFleetAdvancedFeatureConfigurationLcmPostInstallationActionMinimumKeySizeSetting[]; /** * List of proxy properties to be configured in net.properties file. */ proxies: outputs.Jms.GetFleetAdvancedFeatureConfigurationLcmPostInstallationActionProxy[]; /** * Restores JDK root certificates with the certificates that are available in the operating system. The following action is supported by the field: * * Replace JDK root certificates with a list provided by the operating system. */ shouldReplaceCertificatesOperatingSystem: boolean; } interface GetFleetAdvancedFeatureConfigurationLcmPostInstallationActionMinimumKeySizeSetting { /** * Updates the minimum key size for the specified encryption algorithm. The JDK property jdk.certpath.disabledAlgorithms will be updated with the following supported actions: * * Changing minimum key length for RSA signed jars * * Changing minimum key length for EC * * Changing minimum key length for DSA */ certpaths: outputs.Jms.GetFleetAdvancedFeatureConfigurationLcmPostInstallationActionMinimumKeySizeSettingCertpath[]; /** * Updates the minimum key size for the specified encryption algorithm. The JDK property jdk.jar.disabledAlgorithms will be updated with the following supported actions: * * Changing minimum key length for RSA signed jars * * Changing minimum key length for EC * * Changing minimum key length for DSA */ jars: outputs.Jms.GetFleetAdvancedFeatureConfigurationLcmPostInstallationActionMinimumKeySizeSettingJar[]; /** * Updates the minimum key size for the specified encryption algorithm. The JDK property jdk.tls.disabledAlgorithms will be updated with the following supported actions: * * Changing minimum key length for Diffie-Hellman */ tls: outputs.Jms.GetFleetAdvancedFeatureConfigurationLcmPostInstallationActionMinimumKeySizeSettingTl[]; } interface GetFleetAdvancedFeatureConfigurationLcmPostInstallationActionMinimumKeySizeSettingCertpath { /** * Key size for the encryption algorithm. Allowed values: 256 for EC, 2048 for DH/DSA/RSA */ keySize: number; /** * The algorithm name. */ name: string; } interface GetFleetAdvancedFeatureConfigurationLcmPostInstallationActionMinimumKeySizeSettingJar { /** * Key size for the encryption algorithm. Allowed values: 256 for EC, 2048 for DH/DSA/RSA */ keySize: number; /** * The algorithm name. */ name: string; } interface GetFleetAdvancedFeatureConfigurationLcmPostInstallationActionMinimumKeySizeSettingTl { /** * Key size for the encryption algorithm. Allowed values: 256 for EC, 2048 for DH/DSA/RSA */ keySize: number; /** * The algorithm name. */ name: string; } interface GetFleetAdvancedFeatureConfigurationLcmPostInstallationActionProxy { /** * Ftp host to be set in net.properties file. */ ftpProxyHost: string; /** * Ftp port number to be set in net.properties file. */ ftpProxyPort: number; /** * Http host to be set in net.properties file. */ httpProxyHost: string; /** * Http port number to be set in net.properties file. */ httpProxyPort: number; /** * Https host to be set in net.properties file. */ httpsProxyHost: string; /** * Https port number to be set in net.properties file. */ httpsProxyPort: number; /** * Socks host to be set in net.properties file. */ socksProxyHost: string; /** * Socks port number to be set in net.properties file. */ socksProxyPort: number; /** * Sets "java.net.useSystemProxies=true" in net.properties when they exist. */ useSystemProxies: boolean; } interface GetFleetAdvancedFeatureConfigurationPerformanceTuningAnalysis { /** * PerformanceTuningAnalysis flag to store enabled or disabled status */ isEnabled: boolean; } interface GetFleetAgentConfigurationLinuxConfiguration { /** * An array of file system paths (environment variables supported). */ excludePaths: string[]; /** * An array of file system paths (environment variables supported). */ includePaths: string[]; } interface GetFleetAgentConfigurationMacOsConfiguration { /** * An array of file system paths (environment variables supported). */ excludePaths: string[]; /** * An array of file system paths (environment variables supported). */ includePaths: string[]; } interface GetFleetAgentConfigurationWindowsConfiguration { /** * An array of file system paths (environment variables supported). */ excludePaths: string[]; /** * An array of file system paths (environment variables supported). */ includePaths: string[]; } interface GetFleetBlocklistsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetBlocklistsItem { /** * The unique identifier of this blocklist record. */ key: string; /** * The operation type. */ operation: string; /** * The reason why the operation is blocklisted. */ reason: string; /** * A resource to blocklist for certain operation. */ targets: outputs.Jms.GetFleetBlocklistsItemTarget[]; } interface GetFleetBlocklistsItemTarget { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Fleet. */ fleetId: string; /** * The unique identifier for the installation of Java Runtime at a specific path on a specific operating system. */ installationKey: string; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; } interface GetFleetContainersContainerCollection { /** * A list of the container summaries. */ items: outputs.Jms.GetFleetContainersContainerCollectionItem[]; } interface GetFleetContainersContainerCollectionItem { /** * Unique key that identifies the application running in the container. */ applicationKey: string; /** * The name of the application. */ applicationName: string; /** * Unique identifier for the container. */ containerKey: string; /** * The display name. */ displayName: string; /** * The container image name. */ imageName: string; /** * The Java runtime used to run the application in the container. */ javaVersion: string; /** * Unique key that identifies the Java runtime used to run the application in the container. */ jreKey: string; /** * The security status of the Java Runtime. */ jreSecurityStatus: string; /** * The Fleet-unique identifier of the managed instance. */ managedInstanceId: string; /** * The namespace of the container. */ namespace: string; /** * The name of the node associated with the pod running this container. */ nodeName: string; /** * The name of the pod running this container. */ podName: string; /** * The start time of the container. */ timeStarted: string; } interface GetFleetContainersFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetCryptoAnalysisResultsCryptoAnalysisResultCollection { items: outputs.Jms.GetFleetCryptoAnalysisResultsCryptoAnalysisResultCollectionItem[]; } interface GetFleetCryptoAnalysisResultsCryptoAnalysisResultCollectionItem { /** * The aggregation mode of the crypto event analysis result. */ aggregationMode: string; /** * The Object Storage bucket name of this analysis result. */ bucket: string; /** * The Crypto Roadmap version used to perform the analysis. */ cryptoRoadmapVersion: string; /** * FindingCount of CryptoAnalysis Report. */ findingCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Fleet. */ fleetId: string; /** * The host [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. */ hostName: string; /** * The OCID to identify this analysis results. */ id: string; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; /** * The Object Storage namespace of this analysis result. */ namespace: string; /** * Non Compliant Finding Count of CryptoAnalysis Report. */ nonCompliantFindingCount: number; /** * The Object Storage object name of this analysis result. */ object: string; /** * Total number of summarized events. Summarized events are deduplicated events of interest. */ summarizedEventCount: number; /** * The time the result is compiled. */ timeCreated: string; /** * The time the JFR recording has finished. */ timeFinished: string; /** * Time of the first event in the analysis. */ timeFirstEvent: string; /** * Time of the last event in the analysis. */ timeLastEvent: string; /** * The time the JFR recording has started. */ timeStarted: string; /** * Total number of events in the analysis. */ totalEventCount: number; /** * The OCID of the work request to start the analysis. */ workRequestId: string; } interface GetFleetCryptoAnalysisResultsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetDiagnosesFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetDiagnosesFleetDiagnosisCollection { /** * A list of the fleet resource diagnosis. */ items: outputs.Jms.GetFleetDiagnosesFleetDiagnosisCollectionItem[]; } interface GetFleetDiagnosesFleetDiagnosisCollectionItem { /** * The diagnosis message. */ resourceDiagnosis: string; /** * The OCID of the external resouce needed by the fleet. */ resourceId: string; /** * The state of the resource. The resource state is ACTIVE when it works properly for the fleet. In case it would cause an issue for the fleet function, the state is INACTIVE. When JMS can't locate the resource, the state is NOT_FOUND. OTHER covers other cases, such as a temporarily network issue that prevents JMS from detecting the resource. Check the resourceDiagnosis for details. */ resourceState: string; /** * The type of the resource needed by the fleet. This is the role of a resource in the fleet. Use the OCID to determine the actual Oracle Cloud Infrastructure resource type such as log group or log. */ resourceType: string; } interface GetFleetDrsFilesDrsFileCollection { items: outputs.Jms.GetFleetDrsFilesDrsFileCollectionItem[]; } interface GetFleetDrsFilesDrsFileCollectionItem { /** * The Object Storage bucket name where the DRS file is located. */ bucket: string; /** * The checksum type for the DRS file in Object Storage. */ checksumType: string; /** * The checksum value for the DRS file in Object Storage. */ checksumValue: string; /** * The unique identifier of the DRS file in Object Storage. */ drsFileKey: string; /** * The name of the DRS file in Object Store. */ drsFileName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Fleet. */ fleetId: string; /** * To check if the DRS file is the detfault ones. */ isDefault: boolean; /** * The namespace for Object Storage. */ namespace: string; } interface GetFleetDrsFilesFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetErrorAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetErrorAnalyticsFleetErrorAggregationCollection { /** * A list of FleetErrorAggregationSummary. */ items: outputs.Jms.GetFleetErrorAnalyticsFleetErrorAggregationCollectionItem[]; } interface GetFleetErrorAnalyticsFleetErrorAggregationCollectionItem { /** * List of fleet error aggregations. */ fleetErrorAggregations: outputs.Jms.GetFleetErrorAnalyticsFleetErrorAggregationCollectionItemFleetErrorAggregation[]; /** * Count of fleets with no problems. */ healthyFleetCount: number; } interface GetFleetErrorAnalyticsFleetErrorAggregationCollectionItemFleetErrorAggregation { /** * Number of FleetErrors encountered for the specific reason. */ fleetErrorAnalyticCount: number; /** * Enum that uniquely identifies the fleet error. */ reason: string; } interface GetFleetErrorsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetErrorsFleetErrorCollection { /** * A list of FleetErrorSummary. */ items: outputs.Jms.GetFleetErrorsFleetErrorCollectionItem[]; } interface GetFleetErrorsFleetErrorCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * List of fleet error details. */ errors: outputs.Jms.GetFleetErrorsFleetErrorCollectionItemError[]; /** * The ID of the Fleet. */ fleetId: string; /** * The display name of the Fleet. */ fleetName: string; /** * The timestamp of the first time an error was detected. */ timeFirstSeen: string; /** * The timestamp of the last time an error was detected. */ timeLastSeen: string; } interface GetFleetErrorsFleetErrorCollectionItemError { /** * Optional string containing additional details. */ details: string; /** * The fleet error reason. */ reason: string; /** * The timestamp of the last time an error was detected. */ timeLastSeen: string; } interface GetFleetExportSettingExportDataFilter { /** * List of application names to filter by partial match */ applicationNameContains: string[]; /** * List of application names to filter by exact match */ applicationNameEqualTos: string[]; /** * List of Java major versions to filter by */ javaMajorVersions: string[]; /** * List of Java vendors to filter by */ javaVendors: string[]; /** * List of Java versions to filter by */ javaVersions: string[]; /** * The security statuses of the Java Runtime */ securityStatuses: string[]; } interface GetFleetInventoryLog { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetFleetJavaMigrationAnalysisResultsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetJavaMigrationAnalysisResultsJavaMigrationAnalysisResultCollection { items: outputs.Jms.GetFleetJavaMigrationAnalysisResultsJavaMigrationAnalysisResultCollectionItem[]; } interface GetFleetJavaMigrationAnalysisResultsJavaMigrationAnalysisResultCollectionItem { /** * Execution type of the application for an application type, such as WAR and EAR, that is deployed or installed. */ applicationExecutionType: string; /** * The unique key that identifies the application. */ applicationKey: string; /** * The name of the application. */ applicationName: string; /** * The installation path of the application for which the Java migration analysis was performed. */ applicationPath: string; /** * The name of the object storage bucket that contains the results of the migration analysis. */ bucket: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Fleet. */ fleetId: string; /** * The host [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. */ hostName: string; /** * The OCID of the migration analysis report. */ id: string; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; /** * Additional info reserved for future use. */ metadata: string; /** * The object storage namespace that contains the results of the migration analysis. */ namespace: string; /** * The names of the object storage objects that contain the results of the migration analysis. */ objectLists: string[]; /** * The directory path of the object storage bucket that contains the results of the migration analysis. */ objectStorageUploadDirPath: string; /** * The source JDK version of the application that's currently running. */ sourceJdkVersion: string; /** * The target JDK version of the application to be migrated. */ targetJdkVersion: string; /** * The time the result is compiled. */ timeCreated: string; /** * The OCID of the work request of this analysis. */ workRequestId: string; } interface GetFleetLibraryApplicationsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetLibraryApplicationsLibraryApplicationUsageCollection { /** * A list of LibraryApplicationUsageSummaries. */ items: outputs.Jms.GetFleetLibraryApplicationsLibraryApplicationUsageCollectionItem[]; } interface GetFleetLibraryApplicationsLibraryApplicationUsageCollectionItem { /** * The internal identifier of a Java application. */ applicationKey: string; /** * The name of the application. */ applicationName: string; /** * The timestamp of the first time the specified library was detected in classpath. */ firstSeenInClasspath: string; /** * The date and time a library or Java package was _last_ detected in a dynamic library scan. */ lastDetectedDynamically: string; /** * The timestamp of the last time the specified library was detected in classpath. */ lastSeenInClasspath: string; /** * The count of managed instances wherein the specified library was detected. */ managedInstanceCount: number; } interface GetFleetLibraryManagedInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetLibraryManagedInstancesLibraryManagedInstanceUsageCollection { /** * A list of LibraryManagedInstanceUsageSummaries. */ items: outputs.Jms.GetFleetLibraryManagedInstancesLibraryManagedInstanceUsageCollectionItem[]; } interface GetFleetLibraryManagedInstancesLibraryManagedInstanceUsageCollectionItem { /** * The count of applications where the specified library was detected. */ applicationCount: number; /** * The timestamp of the first time the specified library was detected in classpath. */ firstSeenInClasspath: string; /** * The hostname of the managed instance. */ hostname: string; /** * The date and time a library or Java package was _last_ detected in a dynamic library scan. */ lastDetectedDynamically: string; /** * The timestamp of the last time the specified library was detected in classpath. */ lastSeenInClasspath: string; /** * The Fleet-unique identifier of the managed instance. */ managedInstanceId: string; } interface GetFleetOperationLog { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetFleetPerformanceTuningAnalysisResultsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetPerformanceTuningAnalysisResultsPerformanceTuningAnalysisResultCollection { items: outputs.Jms.GetFleetPerformanceTuningAnalysisResultsPerformanceTuningAnalysisResultCollectionItem[]; } interface GetFleetPerformanceTuningAnalysisResultsPerformanceTuningAnalysisResultCollectionItem { /** * The Fleet-unique identifier of the related application. */ applicationId: string; /** * The internal identifier of the application installation for which the report has been generated. */ applicationInstallationId: string; /** * The installation path of the application for which the report has been generated. */ applicationInstallationPath: string; /** * The name of the application. */ applicationName: string; /** * The Object Storage bucket name of this analysis result. */ bucket: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Fleet. */ fleetId: string; /** * The host [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. */ hostName: string; /** * The OCID to identify this analysis results. */ id: string; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; /** * The Object Storage namespace of this analysis result. */ namespace: string; /** * The Object Storage object name of this analysis result. */ object: string; /** * Result of the analysis based on whether warnings have been found or not. */ result: string; /** * The time the result is compiled. */ timeCreated: string; /** * The time the JFR recording has finished. */ timeFinished: string; /** * The time the JFR recording has started. */ timeStarted: string; /** * Total number of warnings reported by the analysis. */ warningCount: number; /** * The OCID of the work request to start the analysis. */ workRequestId: string; } interface GetFleetUncorrelatedPackageApplicationsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetUncorrelatedPackageApplicationsUncorrelatedPackageApplicationUsageCollection { /** * A list of UncorrelatedPackageApplicationUsageSummaries. */ items: outputs.Jms.GetFleetUncorrelatedPackageApplicationsUncorrelatedPackageApplicationUsageCollectionItem[]; } interface GetFleetUncorrelatedPackageApplicationsUncorrelatedPackageApplicationUsageCollectionItem { /** * The internal identifier of a Java application. */ applicationKey: string; /** * The displayed name of the Java application. */ applicationName: string; /** * The date and time a library or Java package was _last_ detected in a dynamic library scan. */ lastDetectedDynamically: string; /** * The count of managed instances wherein the specified library was detected. */ managedInstanceCount: number; } interface GetFleetUncorrelatedPackageManagedInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetUncorrelatedPackageManagedInstancesUncorrelatedPackageManagedInstanceUsageCollection { /** * A list of UncorrelatedPackageManagedInstanceUsageSummaries. */ items: outputs.Jms.GetFleetUncorrelatedPackageManagedInstancesUncorrelatedPackageManagedInstanceUsageCollectionItem[]; } interface GetFleetUncorrelatedPackageManagedInstancesUncorrelatedPackageManagedInstanceUsageCollectionItem { /** * The count of applications wherein the specified library was detected. */ applicationCount: number; /** * The hostname of the managed instance. */ hostname: string; /** * The date and time a library or Java package was _last_ detected in a dynamic library scan. */ lastDetectedDynamically: string; /** * The Fleet-unique identifier of the managed instance. */ managedInstanceId: string; } interface GetFleetUncorrelatedPackagesFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetUncorrelatedPackagesUncorrelatedPackageUsageCollection { /** * A list of uncorrelated package summaries. */ items: outputs.Jms.GetFleetUncorrelatedPackagesUncorrelatedPackageUsageCollectionItem[]; } interface GetFleetUncorrelatedPackagesUncorrelatedPackageUsageCollectionItem { /** * The count of applications wherein the specified package was detected. */ applicationCount: number; /** * The date and time a library or Java package was _last_ detected in a dynamic library scan. */ lastDetectedDynamically: string; /** * The count of managed instances wherein the specified package was detected. */ managedInstanceCount: number; /** * The unique identifier of a Java package. */ packageName: string; } interface GetFleetsFilter { name: string; regex?: boolean; values: string[]; } interface GetFleetsFleetCollection { items: outputs.Jms.GetFleetsFleetCollectionItem[]; } interface GetFleetsFleetCollectionItem { /** * The approximate count of all unique applications in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag. */ approximateApplicationCount: number; /** * The approximate count of all unique Java installations in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag. */ approximateInstallationCount: number; /** * The approximate count of all unique Java servers in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag. */ approximateJavaServerCount: number; /** * The approximate count of all unique Java Runtimes in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag. */ approximateJreCount: number; /** * The approximate count of all unique libraries in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag. */ approximateLibraryCount: number; /** * The approximate count of all unique library vulnerabilities in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag. */ approximateLibraryVulnerabilityCount: number; /** * The approximate count of all unique managed instances in the Fleet in the past seven days. This metric is provided on a best-effort manner, and isn't taken into account when computing the resource ETag. */ approximateManagedInstanceCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. (See [Understanding Free-form Tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)). */ definedTags: { [key: string]: string; }; /** * The Fleet's description. */ description: string; /** * The display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm).) */ freeformTags: { [key: string]: string; }; /** * The ID. */ id: string; /** * Custom Log for inventory or operation log. */ inventoryLogs: outputs.Jms.GetFleetsFleetCollectionItemInventoryLog[]; /** * Whether or not advanced features are enabled in this Fleet. Deprecated, use `/fleets/{fleetId}/advanceFeatureConfiguration` API instead. */ isAdvancedFeaturesEnabled: boolean; /** * Whether or not export setting is enabled in this Fleet. */ isExportSettingEnabled: boolean; /** * Custom Log for inventory or operation log. */ operationLogs: outputs.Jms.GetFleetsFleetCollectionItemOperationLog[]; /** * The state of the lifecycle. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The creation date and time of the Fleet (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeCreated: string; } interface GetFleetsFleetCollectionItemInventoryLog { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetFleetsFleetCollectionItemOperationLog { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetInstallationSiteItem { /** * The approximate count of applications running on this installation */ approximateApplicationCount: number; /** * The list of operations that are blocklisted. */ blocklists: outputs.Jms.GetInstallationSiteItemBlocklist[]; /** * The unique identifier for the installation of Java Runtime at a specific path on a specific operating system. */ installationKey: string; /** * The essential properties to identify a Java Runtime. */ jres: outputs.Jms.GetInstallationSiteItemJre[]; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; /** * Operating System of the platform on which the Java Runtime was reported. */ operatingSystems: outputs.Jms.GetInstallationSiteItemOperatingSystem[]; /** * The file system path of the installation. */ path: string; /** * The security status of the Java Runtime. */ securityStatus: string; /** * The lifecycle state of the installation site. */ state: string; /** * The date and time the resource was _last_ reported to JMS. This is potentially _after_ the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period. */ timeLastSeen: string; } interface GetInstallationSiteItemBlocklist { /** * The operation type. */ operation: string; /** * The reason why the operation is blocklisted. */ reason: string; } interface GetInstallationSiteItemJre { /** * The distribution of a Java Runtime is the name of the lineage of product to which it belongs, for example _Java(TM) SE Runtime Environment_. */ distribution: string; /** * The unique identifier for a Java Runtime. */ jreKey: string; /** * The vendor of the Java Runtime. */ vendor: string; /** * The version of the operating system as provided by the Java system property os.version. */ version: string; } interface GetInstallationSiteItemOperatingSystem { /** * The architecture of the operating system as provided by the Java system property os.arch. */ architecture: string; /** * The operating system type, such as Windows or Linux */ family: string; /** * Number of instances running the operating system */ managedInstanceCount: number; /** * The name of the operating system as provided by the Java system property os.name. */ name: string; /** * The version of the operating system as provided by the Java system property os.version. */ version: string; } interface GetInstallationSitesFilter { /** * The name of the operating system as provided by the Java system property os.name. */ name: string; regex?: boolean; values: string[]; } interface GetInstallationSitesInstallationSiteCollection { /** * A list of Java installation sites. */ items: outputs.Jms.GetInstallationSitesInstallationSiteCollectionItem[]; } interface GetInstallationSitesInstallationSiteCollectionItem { /** * The approximate count of applications running on this installation */ approximateApplicationCount: number; /** * The list of operations that are blocklisted. */ blocklists: outputs.Jms.GetInstallationSitesInstallationSiteCollectionItemBlocklist[]; /** * The unique identifier for the installation of Java Runtime at a specific path on a specific operating system. */ installationKey: string; /** * The essential properties to identify a Java Runtime. */ jres: outputs.Jms.GetInstallationSitesInstallationSiteCollectionItemJre[]; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; /** * Operating System of the platform on which the Java Runtime was reported. */ operatingSystems: outputs.Jms.GetInstallationSitesInstallationSiteCollectionItemOperatingSystem[]; /** * The file system path of the installation. */ path: string; /** * The security status of the Java Runtime. */ securityStatus: string; /** * The lifecycle state of the installation site. */ state: string; /** * The date and time the resource was _last_ reported to JMS. This is potentially _after_ the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period. */ timeLastSeen: string; } interface GetInstallationSitesInstallationSiteCollectionItemBlocklist { /** * The operation type. */ operation: string; /** * The reason why the operation is blocklisted. */ reason: string; } interface GetInstallationSitesInstallationSiteCollectionItemJre { /** * The name of the Operating System distribution, such as Oracle Linux 9, Windows 10, or macOS X. */ distribution: string; /** * The unique identifier for a Java Runtime. */ jreKey: string; /** * The vendor of the Java Runtime. */ vendor: string; /** * The version of the operating system as provided by the Java system property os.version. */ version: string; } interface GetInstallationSitesInstallationSiteCollectionItemOperatingSystem { /** * The architecture of the operating system as provided by the Java system property os.arch. */ architecture: string; /** * The name of the Operating System distribution, such as Oracle Linux 9, Windows 10, or macOS X. */ distribution: string; /** * The operating system type, such as Windows, Linux or macOS */ family: string; /** * Number of instances running the operating system. */ managedInstanceCount: number; /** * The name of the operating system as provided by the Java system property os.name. */ name: string; /** * The version of the operating system as provided by the Java system property os.version. */ version: string; } interface GetJavaDownloadsJavaDownloadRecordsFilter { name: string; regex?: boolean; values: string[]; } interface GetJavaDownloadsJavaDownloadRecordsJavaDownloadRecordCollection { /** * A list of Java download records in a tenancy. */ items: outputs.Jms.GetJavaDownloadsJavaDownloadRecordsJavaDownloadRecordCollectionItem[]; } interface GetJavaDownloadsJavaDownloadRecordsJavaDownloadRecordCollectionItem { /** * Target Operating System architecture of the artifact. */ architecture: string; /** * Identifier of the source that downloaded the artifact. */ downloadSourceId: string; /** * Type of download. */ downloadType: string; /** * The Java family display name. */ familyDisplayName: string; /** * Unique Java family version identifier. */ familyVersion: string; /** * Target Operating System family of the artifact. */ osFamily: string; /** * The package type (typically the file extension) of the artifact. */ packageType: string; /** * Packaging type detail of the artifact. */ packageTypeDetail: string; /** * Unique Java release version identifier. */ releaseVersion: string; /** * Timestamp of download. */ timeDownloaded: string; } interface GetJavaDownloadsJavaDownloadReportCreatedBy { /** * Display name for the Java download report. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Java download report. */ id: string; } interface GetJavaDownloadsJavaDownloadReportsFilter { name: string; regex?: boolean; values: string[]; } interface GetJavaDownloadsJavaDownloadReportsJavaDownloadReportCollection { items: outputs.Jms.GetJavaDownloadsJavaDownloadReportsJavaDownloadReportCollectionItem[]; } interface GetJavaDownloadsJavaDownloadReportsJavaDownloadReportCollectionItem { /** * The algorithm used for calculating the checksum. */ checksumType: string; /** * The checksum value of the Java download report file. */ checksumValue: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenancy. */ compartmentId: string; /** * An authorized principal. */ createdBies: outputs.Jms.GetJavaDownloadsJavaDownloadReportsJavaDownloadReportCollectionItemCreatedBy[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. (See [Understanding Free-form Tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)). */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the display name. */ displayName: string; /** * Approximate size of the Java download report file in bytes. */ fileSizeInBytes: string; /** * The file format of the Java download report. */ format: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm).) */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Java download report. */ id: string; sortBy: string; sortOrder: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The time the Java download report was created, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * The end time until when the download records are included (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeEnd: string; /** * The start time from when the download records are included (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeStart: string; } interface GetJavaDownloadsJavaDownloadReportsJavaDownloadReportCollectionItemCreatedBy { /** * A filter to return only resources that match the display name. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Java download report. */ id: string; } interface GetJavaDownloadsJavaDownloadTokenCreatedBy { /** * The name of the principal. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the principal. */ id: string; } interface GetJavaDownloadsJavaDownloadTokenLastUpdatedBy { /** * The name of the principal. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the principal. */ id: string; } interface GetJavaDownloadsJavaDownloadTokensFilter { name: string; regex?: boolean; values: string[]; } interface GetJavaDownloadsJavaDownloadTokensJavaDownloadTokenCollection { items: outputs.Jms.GetJavaDownloadsJavaDownloadTokensJavaDownloadTokenCollectionItem[]; } interface GetJavaDownloadsJavaDownloadTokensJavaDownloadTokenCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenancy. */ compartmentId: string; /** * An authorized principal. */ createdBies: outputs.Jms.GetJavaDownloadsJavaDownloadTokensJavaDownloadTokenCollectionItemCreatedBy[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. (See [Understanding Free-form Tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)). */ definedTags: { [key: string]: string; }; /** * User provided description of the JavaDownloadToken. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm).) */ freeformTags: { [key: string]: string; }; /** * Unique JavaDownloadToken identifier. */ id: string; /** * A flag to indicate if the token is default. */ isDefault: boolean; /** * The associated Java version of the JavaDownloadToken. */ javaVersion: string; /** * An authorized principal. */ lastUpdatedBies: outputs.Jms.GetJavaDownloadsJavaDownloadTokensJavaDownloadTokenCollectionItemLastUpdatedBy[]; /** * The license type(s) associated with the JavaDownloadToken. */ licenseTypes: string[]; /** * Possible lifecycle substates. */ lifecycleDetails: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The time the JavaDownloadToken was created, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * The expiry time of the JavaDownloadToken, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeExpires: string; /** * The time the JavaDownloadToken was last used for download, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeLastUsed: string; /** * The time the JavaDownloadToken was updated, displayed as an [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeUpdated: string; /** * Unique JavaDownloadToken value. */ value: string; } interface GetJavaDownloadsJavaDownloadTokensJavaDownloadTokenCollectionItemCreatedBy { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The email of the principal. */ email: string; /** * Unique JavaDownloadToken identifier. */ id: string; } interface GetJavaDownloadsJavaDownloadTokensJavaDownloadTokenCollectionItemLastUpdatedBy { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The email of the principal. */ email: string; /** * Unique JavaDownloadToken identifier. */ id: string; } interface GetJavaDownloadsJavaLicenseAcceptanceRecordCreatedBy { /** * The name of the principal. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the principal. */ id: string; } interface GetJavaDownloadsJavaLicenseAcceptanceRecordLastUpdatedBy { /** * The name of the principal. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the principal. */ id: string; } interface GetJavaDownloadsJavaLicenseAcceptanceRecordsFilter { name: string; regex?: boolean; values: string[]; } interface GetJavaDownloadsJavaLicenseAcceptanceRecordsJavaLicenseAcceptanceRecordCollection { items: outputs.Jms.GetJavaDownloadsJavaLicenseAcceptanceRecordsJavaLicenseAcceptanceRecordCollectionItem[]; } interface GetJavaDownloadsJavaLicenseAcceptanceRecordsJavaLicenseAcceptanceRecordCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenancy. */ compartmentId: string; /** * An authorized principal. */ createdBies: outputs.Jms.GetJavaDownloadsJavaLicenseAcceptanceRecordsJavaLicenseAcceptanceRecordCollectionItemCreatedBy[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. (See [Understanding Free-form Tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)). */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm).) */ freeformTags: { [key: string]: string; }; /** * Unique Java license acceptance record identifier. */ id: string; /** * An authorized principal. */ lastUpdatedBies: outputs.Jms.GetJavaDownloadsJavaLicenseAcceptanceRecordsJavaLicenseAcceptanceRecordCollectionItemLastUpdatedBy[]; /** * Status of license acceptance. */ licenseAcceptanceStatus: string; /** * Unique Java license type. */ licenseType: string; /** * The current state of the JavaLicenseAcceptanceRecord. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time of license acceptance (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeAccepted: string; /** * The date and time of last update (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeLastUpdated: string; } interface GetJavaDownloadsJavaLicenseAcceptanceRecordsJavaLicenseAcceptanceRecordCollectionItemCreatedBy { /** * The name of the principal. */ displayName: string; /** * The email of the principal. */ email: string; /** * Unique Java license acceptance record identifier. */ id: string; } interface GetJavaDownloadsJavaLicenseAcceptanceRecordsJavaLicenseAcceptanceRecordCollectionItemLastUpdatedBy { /** * The name of the principal. */ displayName: string; /** * The email of the principal. */ email: string; /** * Unique Java license acceptance record identifier. */ id: string; } interface GetJavaDownloadsJavaLicensesFilter { name: string; regex?: boolean; values: string[]; } interface GetJavaDownloadsJavaLicensesJavaLicenseCollection { items: outputs.Jms.GetJavaDownloadsJavaLicensesJavaLicenseCollectionItem[]; } interface GetJavaDownloadsJavaLicensesJavaLicenseCollectionItem { /** * A filter to return only resources that match the display name. */ displayName: string; /** * Unique Java license type. */ licenseType: string; /** * Publicly accessible license URL containing the detailed terms and conditions. */ licenseUrl: string; } interface GetJavaFamiliesFilter { name: string; regex?: boolean; values: string[]; } interface GetJavaFamiliesJavaFamilyCollection { items: outputs.Jms.GetJavaFamiliesJavaFamilyCollectionItem[]; } interface GetJavaFamiliesJavaFamilyCollectionItem { /** * The display name for the Java family. */ displayName: string; /** * Link to access the documentation for the release. */ docUrl: string; /** * The End of Support Life (EOSL) date of the Java release family (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ endOfSupportLifeDate: string; /** * The version identifier for the Java family. */ familyVersion: string; /** * Filter the Java Release Family versions by support status. */ isSupportedVersion: boolean; /** * List of artifacts for the latest Java release version in this family. The script URLs in the response can be used from a command line, or in scripts and dockerfiles to always get the artifacts corresponding to the latest update release version. */ latestReleaseArtifacts: outputs.Jms.GetJavaFamiliesJavaFamilyCollectionItemLatestReleaseArtifact[]; /** * Latest Java release version in the family. */ latestReleaseVersion: string; /** * The license type(s) associated with the Java family. */ licenseTypes: string[]; /** * The date on which the Java release family was first made available (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ releaseDate: string; /** * This indicates the support category for the Java release family. */ supportType: string; } interface GetJavaFamiliesJavaFamilyCollectionItemLatestReleaseArtifact { /** * Approximate compressed file size in bytes. */ approximateFileSizeInBytes: string; /** * The target Operating System architecture for the artifact. */ architecture: string; /** * Product content type of this artifact. */ artifactContentType: string; /** * Description of the binary artifact. Typically includes the OS, architecture, and installer type. */ artifactDescription: string; /** * The file name of the artifact. */ artifactFileName: string; /** * Unique identifier for the artifact. */ artifactId: string; /** * The endpoint that returns a short-lived artifact download URL in the response payload. This download url can then be used for downloading the artifact. See this [API](https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/DownloadUrl/GenerateArtifactDownloadUrl) for more details. */ downloadUrl: string; /** * The target Operating System family for the artifact. */ osFamily: string; /** * The package type(typically the file extension) of the artifact. */ packageType: string; /** * Additional information about the package type. */ packageTypeDetail: string; /** * The URL for retrieving the checksum for the artifact. Depending on the context, this can point to the checksum of the archive or latest update release version artifact. */ scriptChecksumUrl: string; /** * The endpoint for downloading this artifact from command line, automatically in scripts and dockerfiles. Depending on the context, this can point to the archive or latest update release version artifact in the specified family. */ scriptDownloadUrl: string; /** * SHA256 checksum of the artifact. */ sha256: string; } interface GetJavaFamilyLatestReleaseArtifact { /** * Approximate compressed file size in bytes. */ approximateFileSizeInBytes: string; /** * The target Operating System architecture for the artifact. */ architecture: string; /** * Product content type of this artifact. */ artifactContentType: string; /** * Description of the binary artifact. Typically includes the OS, architecture, and installer type. */ artifactDescription: string; /** * The file name of the artifact. */ artifactFileName: string; /** * Unique identifier for the artifact. */ artifactId: string; /** * The endpoint that returns a short-lived artifact download URL in the response payload. This download url can then be used for downloading the artifact. See this [API](https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/DownloadUrl/GenerateArtifactDownloadUrl) for more details. */ downloadUrl: string; /** * The target Operating System family for the artifact. */ osFamily: string; /** * The package type(typically the file extension) of the artifact. */ packageType: string; /** * Additional information about the package type. */ packageTypeDetail: string; /** * The URL for retrieving the checksum for the artifact. Depending on the context, this can point to the checksum of the archive or latest update release version artifact. */ scriptChecksumUrl: string; /** * The endpoint for downloading this artifact from command line, automatically in scripts and dockerfiles. Depending on the context, this can point to the archive or latest update release version artifact in the specified family. */ scriptDownloadUrl: string; /** * SHA256 checksum of the artifact. */ sha256: string; } interface GetJavaReleaseArtifact { /** * Approximate compressed file size in bytes. */ approximateFileSizeInBytes: string; /** * The target Operating System architecture for the artifact. */ architecture: string; /** * Product content type of this artifact. */ artifactContentType: string; /** * Description of the binary artifact. Typically includes the OS, architecture, and installer type. */ artifactDescription: string; /** * The file name of the artifact. */ artifactFileName: string; /** * Unique identifier for the artifact. */ artifactId: string; /** * The endpoint that returns a short-lived artifact download URL in the response payload. This download url can then be used for downloading the artifact. See this [API](https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/DownloadUrl/GenerateArtifactDownloadUrl) for more details. */ downloadUrl: string; /** * The target Operating System family for the artifact. */ osFamily: string; /** * The package type(typically the file extension) of the artifact. */ packageType: string; /** * Additional information about the package type. */ packageTypeDetail: string; /** * The URL for retrieving the checksum for the artifact. Depending on the context, this can point to the checksum of the archive or latest update release version artifact. */ scriptChecksumUrl: string; /** * The endpoint for downloading this artifact from command line, automatically in scripts and dockerfiles. Depending on the context, this can point to the archive or latest update release version artifact in the specified family. */ scriptDownloadUrl: string; /** * SHA256 checksum of the artifact. */ sha256: string; } interface GetJavaReleaseFamilyDetail { /** * Commonly used name for the MoS release. */ displayName: string; /** * Link to access the documentation for the release. */ docUrl: string; /** * The End of Support Life (EOSL) date of the Java release family (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ endOfSupportLifeDate: string; /** * Java release family identifier. */ familyVersion: string; /** * Whether or not this Java release family is under active support. Refer [Java Support Roadmap](https://www.oracle.com/java/technologies/java-se-support-roadmap.html) for more details. */ isSupportedVersion: boolean; /** * List of artifacts for the latest Java release version in this family. The script URLs in the response can be used from a command line, or in scripts and dockerfiles to always get the artifacts corresponding to the latest update release version. */ latestReleaseArtifacts: outputs.Jms.GetJavaReleaseFamilyDetailLatestReleaseArtifact[]; /** * Latest Java release version in the family. */ latestReleaseVersion: string; /** * The license type(s) associated with the Java family. */ licenseTypes: string[]; /** * The release date of the Java version (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ releaseDate: string; /** * This indicates the support category for the Java release family. */ supportType: string; } interface GetJavaReleaseFamilyDetailLatestReleaseArtifact { /** * Approximate compressed file size in bytes. */ approximateFileSizeInBytes: string; /** * The target Operating System architecture for the artifact. */ architecture: string; /** * Product content type of this artifact. */ artifactContentType: string; /** * Description of the binary artifact. Typically includes the OS, architecture, and installer type. */ artifactDescription: string; /** * The file name of the artifact. */ artifactFileName: string; /** * Unique identifier for the artifact. */ artifactId: string; /** * The endpoint that returns a short-lived artifact download URL in the response payload. This download url can then be used for downloading the artifact. See this [API](https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/DownloadUrl/GenerateArtifactDownloadUrl) for more details. */ downloadUrl: string; /** * The target Operating System family for the artifact. */ osFamily: string; /** * The package type(typically the file extension) of the artifact. */ packageType: string; /** * Additional information about the package type. */ packageTypeDetail: string; /** * The URL for retrieving the checksum for the artifact. Depending on the context, this can point to the checksum of the archive or latest update release version artifact. */ scriptChecksumUrl: string; /** * The endpoint for downloading this artifact from command line, automatically in scripts and dockerfiles. Depending on the context, this can point to the archive or latest update release version artifact in the specified family. */ scriptDownloadUrl: string; /** * SHA256 checksum of the artifact. */ sha256: string; } interface GetJavaReleaseLicenseDetail { /** * Commonly used name for the MoS release. */ displayName: string; /** * License type for the Java version. */ licenseType: string; /** * Publicly accessible license URL containing the detailed terms and conditions. */ licenseUrl: string; } interface GetJavaReleaseMosPatch { /** * Commonly used name for the MoS release. */ displayName: string; /** * MoS URL to access the artifacts for the Java release. */ patchUrl: string; } interface GetJavaReleasesFilter { name: string; regex?: boolean; values: string[]; } interface GetJavaReleasesJavaReleaseCollection { items: outputs.Jms.GetJavaReleasesJavaReleaseCollectionItem[]; } interface GetJavaReleasesJavaReleaseCollectionItem { /** * Artifact content types for the Java version. */ artifactContentTypes: string[]; /** * List of Java artifacts. */ artifacts: outputs.Jms.GetJavaReleasesJavaReleaseCollectionItemArtifact[]; /** * The number of days since this release has been under the security baseline. */ daysUnderSecurityBaseline: number; /** * Metadata associated with a specific Java release family. A Java release family is typically a major version in the Java version identifier. */ familyDetails: outputs.Jms.GetJavaReleasesJavaReleaseCollectionItemFamilyDetail[]; /** * The version identifier for the Java family. */ familyVersion: string; /** * Information about a license type for Java. */ licenseDetails: outputs.Jms.GetJavaReleasesJavaReleaseCollectionItemLicenseDetail[]; /** * Java license type. */ licenseType: string; /** * List of My Oracle Support(MoS) patches available for this release. This information is only available for `BPR` release type. */ mosPatches: outputs.Jms.GetJavaReleasesJavaReleaseCollectionItemMosPatch[]; /** * Parent Java release version identifier. This is applicable for BPR releases. */ parentReleaseVersion: string; /** * The release date of the Java version (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ releaseDate: string; /** * Release notes associated with the Java version. */ releaseNotesUrl: string; /** * Java release type. */ releaseType: string; /** * Unique Java release version identifier */ releaseVersion: string; /** * The security status of the Java version. */ securityStatus: string; } interface GetJavaReleasesJavaReleaseCollectionItemArtifact { /** * Approximate compressed file size in bytes. */ approximateFileSizeInBytes: string; /** * The target Operating System architecture for the artifact. */ architecture: string; /** * Product content type of this artifact. */ artifactContentType: string; /** * Description of the binary artifact. Typically includes the OS, architecture, and installer type. */ artifactDescription: string; /** * The file name of the artifact. */ artifactFileName: string; /** * Unique identifier for the artifact. */ artifactId: string; /** * The endpoint that returns a short-lived artifact download URL in the response payload. This download url can then be used for downloading the artifact. See this [API](https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/DownloadUrl/GenerateArtifactDownloadUrl) for more details. */ downloadUrl: string; /** * The target Operating System family for the artifact. */ osFamily: string; /** * The package type(typically the file extension) of the artifact. */ packageType: string; /** * Additional information about the package type. */ packageTypeDetail: string; /** * The URL for retrieving the checksum for the artifact. Depending on the context, this can point to the checksum of the archive or latest update release version artifact. */ scriptChecksumUrl: string; /** * The endpoint for downloading this artifact from command line, automatically in scripts and dockerfiles. Depending on the context, this can point to the archive or latest update release version artifact in the specified family. */ scriptDownloadUrl: string; /** * SHA256 checksum of the artifact. */ sha256: string; } interface GetJavaReleasesJavaReleaseCollectionItemFamilyDetail { /** * Commonly used name for the MoS release. */ displayName: string; /** * Link to access the documentation for the release. */ docUrl: string; /** * The End of Support Life (EOSL) date of the Java release family (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ endOfSupportLifeDate: string; /** * The version identifier for the Java family. */ familyVersion: string; /** * Whether or not this Java release family is under active support. Refer [Java Support Roadmap](https://www.oracle.com/java/technologies/java-se-support-roadmap.html) for more details. */ isSupportedVersion: boolean; /** * List of artifacts for the latest Java release version in this family. The script URLs in the response can be used from a command line, or in scripts and dockerfiles to always get the artifacts corresponding to the latest update release version. */ latestReleaseArtifacts: outputs.Jms.GetJavaReleasesJavaReleaseCollectionItemFamilyDetailLatestReleaseArtifact[]; /** * Latest Java release version in the family. */ latestReleaseVersion: string; /** * The license type(s) associated with the Java family. */ licenseTypes: string[]; /** * The release date of the Java version (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ releaseDate: string; /** * This indicates the support category for the Java release family. */ supportType: string; } interface GetJavaReleasesJavaReleaseCollectionItemFamilyDetailLatestReleaseArtifact { /** * Approximate compressed file size in bytes. */ approximateFileSizeInBytes: string; /** * The target Operating System architecture for the artifact. */ architecture: string; /** * Product content type of this artifact. */ artifactContentType: string; /** * Description of the binary artifact. Typically includes the OS, architecture, and installer type. */ artifactDescription: string; /** * The file name of the artifact. */ artifactFileName: string; /** * Unique identifier for the artifact. */ artifactId: string; /** * The endpoint that returns a short-lived artifact download URL in the response payload. This download url can then be used for downloading the artifact. See this [API](https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/DownloadUrl/GenerateArtifactDownloadUrl) for more details. */ downloadUrl: string; /** * The target Operating System family for the artifact. */ osFamily: string; /** * The package type(typically the file extension) of the artifact. */ packageType: string; /** * Additional information about the package type. */ packageTypeDetail: string; /** * The URL for retrieving the checksum for the artifact. Depending on the context, this can point to the checksum of the archive or latest update release version artifact. */ scriptChecksumUrl: string; /** * The endpoint for downloading this artifact from command line, automatically in scripts and dockerfiles. Depending on the context, this can point to the archive or latest update release version artifact in the specified family. */ scriptDownloadUrl: string; /** * SHA256 checksum of the artifact. */ sha256: string; } interface GetJavaReleasesJavaReleaseCollectionItemLicenseDetail { /** * Commonly used name for the MoS release. */ displayName: string; /** * Java license type. */ licenseType: string; /** * Publicly accessible license URL containing the detailed terms and conditions. */ licenseUrl: string; } interface GetJavaReleasesJavaReleaseCollectionItemMosPatch { /** * Commonly used name for the MoS release. */ displayName: string; /** * MoS URL to access the artifacts for the Java release. */ patchUrl: string; } interface GetJmsPluginsFilter { name: string; regex?: boolean; values: string[]; } interface GetJmsPluginsJmsPluginCollection { items: outputs.Jms.GetJmsPluginsJmsPluginCollectionItem[]; } interface GetJmsPluginsJmsPluginCollectionItem { /** * The ManagementAgent (OMA), Oracle Cloud Agent (OCA), or the Oracle Container Management Agent (OCMA) [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that identifies the Agent. */ agentId: string; /** * Filter JmsPlugin with agent type. */ agentType: string; /** * Filter JmsPlugin with its availability status. */ availabilityStatus: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. (See [Understanding Free-form Tags](https://docs.cloud.oracle.com/iaas/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)). */ definedTags: { [key: string]: string; }; /** * The ID of the Fleet. */ fleetId: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`. (See [Managing Tags and Tag Namespaces](https://docs.cloud.oracle.com/iaas/Content/Tagging/Concepts/understandingfreeformtags.htm).) */ freeformTags: { [key: string]: string; }; /** * The hostname of the agent. */ hostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the JmsPlugin. */ id: string; /** * The architecture of the operating system of the plugin. */ osArchitecture: string; /** * The distribution of the operating system of the plugin. */ osDistribution: string; /** * The operating system family for the plugin. */ osFamily: string; /** * The version of the plugin. */ pluginVersion: string; /** * Filter JmsPlugin with its lifecycle state. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the resource was _last_ reported to JMS. This is potentially _after_ the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period. */ timeLastSeen: string; /** * The date and time the plugin was registered. */ timeRegistered: string; } interface GetListJreUsageItem { /** * The approximate count of the applications running on this Java Runtime. */ approximateApplicationCount: number; /** * The approximate count of installations that are installations of this Java Runtime. */ approximateInstallationCount: number; /** * The approximate count of the managed instances that report this Java Runtime. */ approximateManagedInstanceCount: number; /** * The approximate count of work requests working on this Java Runtime. */ approximatePendingWorkRequestCount: number; /** * The number of days since this release has been under the security baseline. */ daysUnderSecurityBaseline: number; /** * The distribution of a Java Runtime is the name of the lineage of product to which it belongs, for example _Java(TM) SE Runtime Environment_. */ distribution: string; /** * The End of Support Life (EOSL) date of the Java Runtime (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ endOfSupportLifeDate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related fleet. */ fleetId: string; /** * The internal identifier of the Java Runtime. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related managed instance. This property value is present only for /listJreUsage. */ managedInstanceId: string; /** * The operating systems that have this Java Runtime installed. */ operatingSystems: outputs.Jms.GetListJreUsageItemOperatingSystem[]; /** * The release date of the Java Runtime (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ releaseDate: string; /** * The security status of the Java Runtime. */ securityStatus: string; /** * The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeEnd: string; /** * The date and time the resource was _first_ reported to JMS. This is potentially _before_ the specified time period provided by the filters. For example, a resource can be first reported to JMS before the start of a specified time period, if it is also reported during the time period. */ timeFirstSeen: string; /** * The date and time the resource was _last_ reported to JMS. This is potentially _after_ the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period. */ timeLastSeen: string; /** * The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeStart: string; /** * The vendor of the Java Runtime. */ vendor: string; /** * The version of the Java Runtime. */ version: string; } interface GetListJreUsageItemOperatingSystem { /** * The architecture of the operating system as provided by the Java system property os.arch. */ architecture: string; /** * The operating system type, such as Windows or Linux */ family: string; /** * Number of instances running the operating system */ managedInstanceCount: number; /** * The name of the operating system as provided by the Java system property os.name. */ name: string; /** * The version of the Java Runtime. */ version: string; } interface GetPluginErrorAnalyticsFilter { name: string; regex?: boolean; values: string[]; } interface GetPluginErrorAnalyticsPluginErrorAggregationCollection { /** * A list of PluginErrorAggregationSummary. */ items: outputs.Jms.GetPluginErrorAnalyticsPluginErrorAggregationCollectionItem[]; } interface GetPluginErrorAnalyticsPluginErrorAggregationCollectionItem { /** * Count of plugins with no problems. */ healthyPluginCount: number; /** * List of plugin aggregation errors. */ pluginErrorAggregations: outputs.Jms.GetPluginErrorAnalyticsPluginErrorAggregationCollectionItemPluginErrorAggregation[]; } interface GetPluginErrorAnalyticsPluginErrorAggregationCollectionItemPluginErrorAggregation { /** * Number of FleetErrors encountered for the specific reason. */ pluginErrorAnalyticCount: number; /** * Enum that uniquely identifies the plugin error. */ reason: string; } interface GetPluginErrorsFilter { name: string; regex?: boolean; values: string[]; } interface GetPluginErrorsPluginErrorCollection { /** * A list of PluginErrorSummary. */ items: outputs.Jms.GetPluginErrorsPluginErrorCollectionItem[]; } interface GetPluginErrorsPluginErrorCollectionItem { /** * The agent type. */ agentType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * List of plugin error details. */ errors: outputs.Jms.GetPluginErrorsPluginErrorCollectionItemError[]; /** * The HostName or Compute Instance name of the Managed Instance running the plugin. */ hostName: string; /** * The Fleet-unique identifier of the managed instance. */ managedInstanceId: string; /** * The timestamp of the first time an error was detected. */ timeFirstSeen: string; /** * The timestamp of the last time an error was detected. */ timeLastSeen: string; } interface GetPluginErrorsPluginErrorCollectionItemError { /** * Optional string containing additional details. */ details: string; /** * The plugin error reason. */ reason: string; /** * The timestamp of the last time an error was detected. */ timeLastSeen: string; } interface GetTaskScheduleTaskDetail { /** * The list of Java installation sites to add. */ addInstallationSiteTaskRequests: outputs.Jms.GetTaskScheduleTaskDetailAddInstallationSiteTaskRequest[]; /** * Details of the request to start a JFR crypto event analysis. When the targets aren't specified, then all managed instances currently in the fleet are selected. */ cryptoTaskRequests: outputs.Jms.GetTaskScheduleTaskDetailCryptoTaskRequest[]; /** * Details of the request to start a Java migration analyses. The analyses requires the managed instance OCID, deployed application key, source JDK version, and target JDK version of each selected application. */ deployedApplicationMigrationTaskRequests: outputs.Jms.GetTaskScheduleTaskDetailDeployedApplicationMigrationTaskRequest[]; /** * Details of the request to start a Java migration analysis. The analysis requires the managed instance OCID, application installation key, source JDK version, and target JDK version of each selected application. */ javaMigrationTaskRequests: outputs.Jms.GetTaskScheduleTaskDetailJavaMigrationTaskRequest[]; /** * Details of the request to start JFR recordings. When the targets aren't specified, then all managed instances currently in the Fleet are selected. */ jfrTaskRequests: outputs.Jms.GetTaskScheduleTaskDetailJfrTaskRequest[]; /** * Details of the request to start a JFR performance tuning analysis. */ performanceTuningTaskRequests: outputs.Jms.GetTaskScheduleTaskDetailPerformanceTuningTaskRequest[]; /** * The list of Java installation sites to remove. */ removeInstallationSiteTaskRequests: outputs.Jms.GetTaskScheduleTaskDetailRemoveInstallationSiteTaskRequest[]; /** * The list of managed instances to scan. */ scanJavaServerTaskRequests: outputs.Jms.GetTaskScheduleTaskDetailScanJavaServerTaskRequest[]; /** * The list of managed instances to scan. */ scanLibraryTaskRequests: outputs.Jms.GetTaskScheduleTaskDetailScanLibraryTaskRequest[]; /** * Type of task. */ taskType: string; } interface GetTaskScheduleTaskDetailAddInstallationSiteTaskRequest { /** * The list of installation sites to remove. */ installationSites: outputs.Jms.GetTaskScheduleTaskDetailAddInstallationSiteTaskRequestInstallationSite[]; /** * Optional list of post java installation actions */ postInstallationActions: string[]; } interface GetTaskScheduleTaskDetailAddInstallationSiteTaskRequestInstallationSite { /** * Artifact content type for the Java version. */ artifactContentType: string; /** * Forces the installation request even if a more recent release is already present in the host. */ forceInstall: boolean; /** * Flag to install headless or headful Java installation. Only valid for Oracle Linux in OCI. */ headlessMode: boolean; /** * Custom path to install new Java installation site. */ installationPath: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related managed instance. */ managedInstanceId: string; /** * The release version of the Java Runtime. */ releaseVersion: string; } interface GetTaskScheduleTaskDetailCryptoTaskRequest { /** * Duration of the JFR recording in minutes. */ recordingDurationInMinutes: number; /** * The attachment targets to start JFR. */ targets: outputs.Jms.GetTaskScheduleTaskDetailCryptoTaskRequestTarget[]; /** * Period to looking for JVMs. In addition to attach to running JVMs when given the command, JVM started within the waiting period will also be attached for JFR. The value should be larger than the agent polling interval setting for the fleet to ensure agent can get the instructions. If not specified, the agent polling interval for the fleet is used. */ waitingPeriodInMinutes: number; } interface GetTaskScheduleTaskDetailCryptoTaskRequestTarget { /** * Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * Unique key that identifies the application for JFR data collection. */ applicationKey: string; /** * Unique key that identifies the container for JFR data collection. */ containerKey: string; /** * Unique key that identify the JVM for JFR data collection. */ jreKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related managed instance. */ managedInstanceId: string; } interface GetTaskScheduleTaskDetailDeployedApplicationMigrationTaskRequest { /** * The attachment targets to start JFR. */ targets: outputs.Jms.GetTaskScheduleTaskDetailDeployedApplicationMigrationTaskRequestTarget[]; } interface GetTaskScheduleTaskDetailDeployedApplicationMigrationTaskRequestTarget { /** * The unique key that identifies the deployed application's installation path that is to be used for the Java migration analyses. */ deployedApplicationInstallationKey: string; /** * Excludes the packages that starts with the prefix from the migration analysis result. Either this or includePackagePrefixes can be specified. */ excludePackagePrefixes: string[]; /** * includes the packages that starts with the prefix from the migration analysis result. Either this or excludePackagePrefixes can be specified. */ includePackagePrefixes: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related managed instance. */ managedInstanceId: string; /** * The JDK version the application is currently running on. */ sourceJdkVersion: string; /** * The JDK version against which the migration analysis was performed to identify effort required to move from source JDK. */ targetJdkVersion: string; } interface GetTaskScheduleTaskDetailJavaMigrationTaskRequest { /** * The attachment targets to start JFR. */ targets: outputs.Jms.GetTaskScheduleTaskDetailJavaMigrationTaskRequestTarget[]; } interface GetTaskScheduleTaskDetailJavaMigrationTaskRequestTarget { /** * Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * Excludes the packages that starts with the prefix from the migration analysis result. Either this or includePackagePrefixes can be specified. */ excludePackagePrefixes: string[]; /** * includes the packages that starts with the prefix from the migration analysis result. Either this or excludePackagePrefixes can be specified. */ includePackagePrefixes: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related managed instance. */ managedInstanceId: string; /** * The JDK version the application is currently running on. */ sourceJdkVersion: string; /** * The JDK version against which the migration analysis was performed to identify effort required to move from source JDK. */ targetJdkVersion: string; } interface GetTaskScheduleTaskDetailJfrTaskRequest { /** * The profile used for JFR events selection. If the name isn't recognized, the settings from jfcV1 or jfcV2 will be used depending on the JVM version. Both jfcV2 and jfcV1 should be provided to ensure JFR collection on different JVM versions. */ jfcProfileName: string; /** * The BASE64 encoded string of JFR settings XML with schema used by JDK 8. */ jfcV1: string; /** * The BASE64 encoded string of JFR settings XML with [schema used by JDK 9 and after](https://raw.githubusercontent.com/openjdk/jdk/master/src/jdk.jfr/share/classes/jdk/jfr/internal/jfc/jfc.xsd). */ jfcV2: string; /** * Duration of the JFR recording in minutes. */ recordingDurationInMinutes: number; /** * The maximum size limit for the JFR file collected. */ recordingSizeInMb: number; /** * The attachment targets to start JFR. */ targets: outputs.Jms.GetTaskScheduleTaskDetailJfrTaskRequestTarget[]; /** * Period to looking for JVMs. In addition to attach to running JVMs when given the command, JVM started within the waiting period will also be attached for JFR. The value should be larger than the agent polling interval setting for the fleet to ensure agent can get the instructions. If not specified, the agent polling interval for the fleet is used. */ waitingPeriodInMinutes: number; } interface GetTaskScheduleTaskDetailJfrTaskRequestTarget { /** * Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * Unique key that identifies the application for JFR data collection. */ applicationKey: string; /** * Unique key that identifies the container for JFR data collection. */ containerKey: string; /** * Unique key that identify the JVM for JFR data collection. */ jreKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related managed instance. */ managedInstanceId: string; } interface GetTaskScheduleTaskDetailPerformanceTuningTaskRequest { /** * Duration of the JFR recording in minutes. */ recordingDurationInMinutes: number; /** * The attachment targets to start JFR. */ targets: outputs.Jms.GetTaskScheduleTaskDetailPerformanceTuningTaskRequestTarget[]; /** * Period to looking for JVMs. In addition to attach to running JVMs when given the command, JVM started within the waiting period will also be attached for JFR. The value should be larger than the agent polling interval setting for the fleet to ensure agent can get the instructions. If not specified, the agent polling interval for the fleet is used. */ waitingPeriodInMinutes: number; } interface GetTaskScheduleTaskDetailPerformanceTuningTaskRequestTarget { /** * Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * Unique key that identifies the application for JFR data collection. */ applicationKey: string; /** * Unique key that identifies the container for JFR data collection. */ containerKey: string; /** * Unique key that identify the JVM for JFR data collection. */ jreKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related managed instance. */ managedInstanceId: string; } interface GetTaskScheduleTaskDetailRemoveInstallationSiteTaskRequest { /** * The list of installation sites to remove. */ installationSites: outputs.Jms.GetTaskScheduleTaskDetailRemoveInstallationSiteTaskRequestInstallationSite[]; } interface GetTaskScheduleTaskDetailRemoveInstallationSiteTaskRequestInstallationSite { /** * The unique identifier for the installation of a Java Runtime at a specific path on a specific operating system. */ installationKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related managed instance. */ managedInstanceId: string; } interface GetTaskScheduleTaskDetailScanJavaServerTaskRequest { /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of managed instances to scan. */ managedInstanceIds: string[]; } interface GetTaskScheduleTaskDetailScanLibraryTaskRequest { /** * The duration of the dynamic scan in minutes. */ dynamicScanDurationInMinutes: number; /** * Indicates whether the scan is dynamic or static. */ isDynamicScan: boolean; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of managed instances to scan. */ managedInstanceIds: string[]; } interface GetTaskSchedulesFilter { /** * The task name. */ name: string; regex?: boolean; values: string[]; } interface GetTaskSchedulesTaskScheduleCollection { items: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItem[]; } interface GetTaskSchedulesTaskScheduleCollectionItem { /** * Name of the task creator. */ createdBy: string; /** * Recurrence specification for the task schedule execution (formatted according to [RFC-5545](https://icalendar.org/RFC-Specifications/iCalendar-RFC-5545/)). To run daily for 10 occurrences starts on September 2, 2024 09:00 UTC, it should be 'DTSTART=20240902T090000Z; RRULE:FREQ=DAILY;COUNT=10'. To run every 3 hours from 9:00 AM to 5:00 PM on August 5, 2024 UTC, it should be 'DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z'. */ executionRecurrences: string; /** * The ID of the Fleet. */ fleetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) to identify this task schedule. */ id: string; /** * The task name. */ name: string; /** * All possible status of task schedule. */ state: string; /** * The minimum details of a task. */ taskDetails: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetail[]; /** * The date and time the task schedule was created (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeCreated: string; /** * The date and time the task schedule ran last (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeLastRun: string; /** * The date and time the task schedule was last updated (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeLastUpdated: string; /** * The date and time the task schedule will run next (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)). */ timeNextRun: string; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetail { /** * The list of Java installation sites to add. */ addInstallationSiteTaskRequests: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailAddInstallationSiteTaskRequest[]; /** * Details of the request to start a JFR crypto event analysis. When the targets aren't specified, then all managed instances currently in the fleet are selected. */ cryptoTaskRequests: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailCryptoTaskRequest[]; /** * Details of the request to start a Java migration analyses. The analyses requires the managed instance OCID, deployed application key, source JDK version, and target JDK version of each selected application. */ deployedApplicationMigrationTaskRequests: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailDeployedApplicationMigrationTaskRequest[]; /** * Details of the request to start a Java migration analysis. The analysis requires the managed instance OCID, application installation key, source JDK version, and target JDK version of each selected application. */ javaMigrationTaskRequests: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailJavaMigrationTaskRequest[]; /** * Details of the request to start JFR recordings. When the targets aren't specified, then all managed instances currently in the Fleet are selected. */ jfrTaskRequests: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailJfrTaskRequest[]; /** * Details of the request to start a JFR performance tuning analysis. */ performanceTuningTaskRequests: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailPerformanceTuningTaskRequest[]; /** * The list of Java installation sites to remove. */ removeInstallationSiteTaskRequests: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailRemoveInstallationSiteTaskRequest[]; /** * The list of managed instances to scan. */ scanJavaServerTaskRequests: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailScanJavaServerTaskRequest[]; /** * The list of managed instances to scan. */ scanLibraryTaskRequests: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailScanLibraryTaskRequest[]; /** * Type of task. */ taskType: string; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailAddInstallationSiteTaskRequest { /** * The list of installation sites to remove. */ installationSites: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailAddInstallationSiteTaskRequestInstallationSite[]; /** * Optional list of post java installation actions */ postInstallationActions: string[]; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailAddInstallationSiteTaskRequestInstallationSite { /** * Artifact content type for the Java version. */ artifactContentType: string; /** * Forces the installation request even if a more recent release is already present in the host. */ forceInstall: boolean; /** * Flag to install headless or headful Java installation. Only valid for Oracle Linux in OCI. */ headlessMode: boolean; /** * Custom path to install new Java installation site. */ installationPath: string; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; /** * The release version of the Java Runtime. */ releaseVersion: string; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailCryptoTaskRequest { /** * Duration of the JFR recording in minutes. */ recordingDurationInMinutes: number; /** * The attachment targets to start JFR. */ targets: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailCryptoTaskRequestTarget[]; /** * Period to looking for JVMs. In addition to attach to running JVMs when given the command, JVM started within the waiting period will also be attached for JFR. The value should be larger than the agent polling interval setting for the fleet to ensure agent can get the instructions. If not specified, the agent polling interval for the fleet is used. */ waitingPeriodInMinutes: number; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailCryptoTaskRequestTarget { /** * Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * Unique key that identifies the application for JFR data collection. */ applicationKey: string; /** * Unique key that identifies the container for JFR data collection. */ containerKey: string; /** * Unique key that identify the JVM for JFR data collection. */ jreKey: string; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailDeployedApplicationMigrationTaskRequest { /** * The attachment targets to start JFR. */ targets: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailDeployedApplicationMigrationTaskRequestTarget[]; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailDeployedApplicationMigrationTaskRequestTarget { /** * The unique key that identifies the deployed application's installation path that is to be used for the Java migration analyses. */ deployedApplicationInstallationKey: string; /** * Excludes the packages that starts with the prefix from the migration analysis result. Either this or includePackagePrefixes can be specified. */ excludePackagePrefixes: string[]; /** * includes the packages that starts with the prefix from the migration analysis result. Either this or excludePackagePrefixes can be specified. */ includePackagePrefixes: string[]; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; /** * The JDK version the application is currently running on. */ sourceJdkVersion: string; /** * The JDK version against which the migration analysis was performed to identify effort required to move from source JDK. */ targetJdkVersion: string; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailJavaMigrationTaskRequest { /** * The attachment targets to start JFR. */ targets: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailJavaMigrationTaskRequestTarget[]; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailJavaMigrationTaskRequestTarget { /** * Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * Excludes the packages that starts with the prefix from the migration analysis result. Either this or includePackagePrefixes can be specified. */ excludePackagePrefixes: string[]; /** * includes the packages that starts with the prefix from the migration analysis result. Either this or excludePackagePrefixes can be specified. */ includePackagePrefixes: string[]; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; /** * The JDK version the application is currently running on. */ sourceJdkVersion: string; /** * The JDK version against which the migration analysis was performed to identify effort required to move from source JDK. */ targetJdkVersion: string; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailJfrTaskRequest { /** * The profile used for JFR events selection. If the name isn't recognized, the settings from jfcV1 or jfcV2 will be used depending on the JVM version. Both jfcV2 and jfcV1 should be provided to ensure JFR collection on different JVM versions. */ jfcProfileName: string; /** * The BASE64 encoded string of JFR settings XML with schema used by JDK 8. */ jfcV1: string; /** * The BASE64 encoded string of JFR settings XML with [schema used by JDK 9 and after](https://raw.githubusercontent.com/openjdk/jdk/master/src/jdk.jfr/share/classes/jdk/jfr/internal/jfc/jfc.xsd). */ jfcV2: string; /** * Duration of the JFR recording in minutes. */ recordingDurationInMinutes: number; /** * The maximum size limit for the JFR file collected. */ recordingSizeInMb: number; /** * The attachment targets to start JFR. */ targets: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailJfrTaskRequestTarget[]; /** * Period to looking for JVMs. In addition to attach to running JVMs when given the command, JVM started within the waiting period will also be attached for JFR. The value should be larger than the agent polling interval setting for the fleet to ensure agent can get the instructions. If not specified, the agent polling interval for the fleet is used. */ waitingPeriodInMinutes: number; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailJfrTaskRequestTarget { /** * Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * Unique key that identifies the application for JFR data collection. */ applicationKey: string; /** * Unique key that identifies the container for JFR data collection. */ containerKey: string; /** * Unique key that identify the JVM for JFR data collection. */ jreKey: string; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailPerformanceTuningTaskRequest { /** * Duration of the JFR recording in minutes. */ recordingDurationInMinutes: number; /** * The attachment targets to start JFR. */ targets: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailPerformanceTuningTaskRequestTarget[]; /** * Period to looking for JVMs. In addition to attach to running JVMs when given the command, JVM started within the waiting period will also be attached for JFR. The value should be larger than the agent polling interval setting for the fleet to ensure agent can get the instructions. If not specified, the agent polling interval for the fleet is used. */ waitingPeriodInMinutes: number; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailPerformanceTuningTaskRequestTarget { /** * Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * Unique key that identifies the application for JFR data collection. */ applicationKey: string; /** * Unique key that identifies the container for JFR data collection. */ containerKey: string; /** * Unique key that identify the JVM for JFR data collection. */ jreKey: string; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailRemoveInstallationSiteTaskRequest { /** * The list of installation sites to remove. */ installationSites: outputs.Jms.GetTaskSchedulesTaskScheduleCollectionItemTaskDetailRemoveInstallationSiteTaskRequestInstallationSite[]; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailRemoveInstallationSiteTaskRequestInstallationSite { /** * The unique identifier for the installation of a Java Runtime at a specific path on a specific operating system. */ installationKey: string; /** * The Fleet-unique identifier of the related managed instance. */ managedInstanceId: string; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailScanJavaServerTaskRequest { /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of managed instances to scan. */ managedInstanceIds: string[]; } interface GetTaskSchedulesTaskScheduleCollectionItemTaskDetailScanLibraryTaskRequest { /** * The duration of the dynamic scan in minutes. */ dynamicScanDurationInMinutes: number; /** * Indicates whether the scan is dynamic or static. */ isDynamicScan: boolean; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of managed instances to scan. */ managedInstanceIds: string[]; } interface GetUtilsJavaMigrationAnalysiCreatedBy { /** * The name of the principal. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Java Migration Analysis. */ id: string; } interface GetUtilsJavaMigrationAnalysisFilter { name: string; regex?: boolean; values: string[]; } interface GetUtilsJavaMigrationAnalysisJavaMigrationAnalysisCollection { items: outputs.Jms.GetUtilsJavaMigrationAnalysisJavaMigrationAnalysisCollectionItem[]; } interface GetUtilsJavaMigrationAnalysisJavaMigrationAnalysisCollectionItem { /** * The project name of the Performance Tuning Analysis to query for. */ analysisProjectName: string; /** * The analysis application file names result in the Object Storage. */ analysisResultFiles: string[]; /** * Path to the Object Storage analysis application result. */ analysisResultObjectStoragePath: string; /** * Object storage bucket name. */ bucket: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * An authorized principal. */ createdBies: outputs.Jms.GetUtilsJavaMigrationAnalysisJavaMigrationAnalysisCollectionItemCreatedBy[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Java Migration Analysis. */ id: string; /** * Object storage paths to the input files applications to be analysed. */ inputApplicationsObjectStoragePaths: string[]; /** * Additional info reserved for future use. */ metadata: string; /** * Object storage namespace. */ namespace: string; /** * Jdk Version of the Java Migration Analysis target. */ targetJdkVersion: string; /** * The date and time the Java Migration Analysis was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Java Migration Analysis was finished, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeFinished: string; /** * The date and time the Java Migration Analysis was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeStarted: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Work Request. */ workRequestId: string; } interface GetUtilsJavaMigrationAnalysisJavaMigrationAnalysisCollectionItemCreatedBy { /** * The name of the principal. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Java Migration Analysis. */ id: string; } interface GetUtilsPerformanceTuningAnalysiCreatedBy { /** * The name of the principal. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Performance Tuning Analysis. */ id: string; } interface GetUtilsPerformanceTuningAnalysisFilter { name: string; regex?: boolean; values: string[]; } interface GetUtilsPerformanceTuningAnalysisPerformanceTuningAnalysisCollection { items: outputs.Jms.GetUtilsPerformanceTuningAnalysisPerformanceTuningAnalysisCollectionItem[]; } interface GetUtilsPerformanceTuningAnalysisPerformanceTuningAnalysisCollectionItem { /** * The project name of the Performance Tuning Analysis to query for. */ analysisProjectName: string; /** * Object storage path to the artifact. */ artifactObjectStoragePath: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * An authorized principal. */ createdBies: outputs.Jms.GetUtilsPerformanceTuningAnalysisPerformanceTuningAnalysisCollectionItemCreatedBy[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Performance Tuning Analysis. */ id: string; /** * Possible Performance Tuning Result statuses. */ result: string; /** * Object storage path to the analysis. */ resultObjectStoragePath: string; /** * The date and time the Performance Tuning Analysis was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Performance Tuning Analysis was finished, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeFinished: string; /** * The date and time the Performance Tuning Analysis was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeStarted: string; /** * Number of warnings in the Performance Tuning Analysis. */ warningCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Work Request. */ workRequestId: string; } interface GetUtilsPerformanceTuningAnalysisPerformanceTuningAnalysisCollectionItemCreatedBy { /** * The name of the principal. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Performance Tuning Analysis. */ id: string; } interface JavaDownloadsJavaDownloadReportCreatedBy { /** * Display name for the Java download report. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Java download report. */ id: string; } interface JavaDownloadsJavaDownloadTokenCreatedBy { /** * (Updatable) User provided display name of the JavaDownloadToken. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the principal. */ id: string; } interface JavaDownloadsJavaDownloadTokenLastUpdatedBy { /** * (Updatable) User provided display name of the JavaDownloadToken. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the principal. */ id: string; } interface JavaDownloadsJavaLicenseAcceptanceRecordCreatedBy { /** * The name of the principal. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the principal. */ id: string; } interface JavaDownloadsJavaLicenseAcceptanceRecordLastUpdatedBy { /** * The name of the principal. */ displayName: string; /** * The email of the principal. */ email: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the principal. */ id: string; } interface TaskScheduleTaskDetails { /** * (Updatable) The list of Java installation sites to add. */ addInstallationSiteTaskRequest: outputs.Jms.TaskScheduleTaskDetailsAddInstallationSiteTaskRequest; /** * (Updatable) Details of the request to start a JFR crypto event analysis. When the targets aren't specified, then all managed instances currently in the fleet are selected. */ cryptoTaskRequest: outputs.Jms.TaskScheduleTaskDetailsCryptoTaskRequest; /** * (Updatable) Details of the request to start a Java migration analyses. The analyses requires the managed instance OCID, deployed application key, source JDK version, and target JDK version of each selected application. */ deployedApplicationMigrationTaskRequest: outputs.Jms.TaskScheduleTaskDetailsDeployedApplicationMigrationTaskRequest; /** * (Updatable) Details of the request to start a Java migration analysis. The analysis requires the managed instance OCID, application installation key, source JDK version, and target JDK version of each selected application. */ javaMigrationTaskRequest: outputs.Jms.TaskScheduleTaskDetailsJavaMigrationTaskRequest; /** * (Updatable) Details of the request to start JFR recordings. When the targets aren't specified, then all managed instances currently in the Fleet are selected. */ jfrTaskRequest: outputs.Jms.TaskScheduleTaskDetailsJfrTaskRequest; /** * (Updatable) Details of the request to start a JFR performance tuning analysis. */ performanceTuningTaskRequest: outputs.Jms.TaskScheduleTaskDetailsPerformanceTuningTaskRequest; /** * (Updatable) The list of Java installation sites to remove. */ removeInstallationSiteTaskRequest: outputs.Jms.TaskScheduleTaskDetailsRemoveInstallationSiteTaskRequest; /** * (Updatable) The list of managed instances to scan. */ scanJavaServerTaskRequest: outputs.Jms.TaskScheduleTaskDetailsScanJavaServerTaskRequest; /** * (Updatable) The list of managed instances to scan. */ scanLibraryTaskRequest: outputs.Jms.TaskScheduleTaskDetailsScanLibraryTaskRequest; /** * (Updatable) Type of task. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ taskType: string; } interface TaskScheduleTaskDetailsAddInstallationSiteTaskRequest { /** * (Updatable) The list of installation sites to add. */ installationSites: outputs.Jms.TaskScheduleTaskDetailsAddInstallationSiteTaskRequestInstallationSite[]; /** * (Updatable) Optional list of post java installation actions */ postInstallationActions: string[]; } interface TaskScheduleTaskDetailsAddInstallationSiteTaskRequestInstallationSite { /** * (Updatable) Artifact content type for the Java version. */ artifactContentType: string; /** * (Updatable) Forces the installation request even if a more recent release is already present in the host. */ forceInstall: boolean; /** * (Updatable) Flag to install headless or headful Java installation. Only valid for Oracle Linux in OCI. */ headlessMode: boolean; /** * (Updatable) Custom path to install new Java installation site. */ installationPath: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related managed instance. */ managedInstanceId: string; /** * (Updatable) The release version of the Java Runtime. */ releaseVersion: string; } interface TaskScheduleTaskDetailsCryptoTaskRequest { /** * (Updatable) Duration of the JFR recording in minutes. */ recordingDurationInMinutes: number; /** * (Updatable) The attachment targets to start JFR. */ targets: outputs.Jms.TaskScheduleTaskDetailsCryptoTaskRequestTarget[]; /** * (Updatable) Period to looking for JVMs. In addition to attach to running JVMs when given the command, JVM started within the waiting period will also be attached for JFR. The value should be larger than the agent polling interval setting for the fleet to ensure agent can get the instructions. If not specified, the agent polling interval for the fleet is used. */ waitingPeriodInMinutes: number; } interface TaskScheduleTaskDetailsCryptoTaskRequestTarget { /** * (Updatable) Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * (Updatable) Unique key that identifies the application for JFR data collection. */ applicationKey: string; /** * (Updatable) Unique key that identifies the container for JFR data collection. */ containerKey: string; /** * (Updatable) Unique key that identify the JVM for JFR data collection. */ jreKey: string; /** * (Updatable) OCID of the Managed Instance to collect JFR data. */ managedInstanceId: string; } interface TaskScheduleTaskDetailsDeployedApplicationMigrationTaskRequest { /** * (Updatable) An array of migration analyses requests. */ targets: outputs.Jms.TaskScheduleTaskDetailsDeployedApplicationMigrationTaskRequestTarget[]; } interface TaskScheduleTaskDetailsDeployedApplicationMigrationTaskRequestTarget { /** * (Updatable) The unique key that identifies the deployed application's installation path that is to be used for the Java migration analyses. */ deployedApplicationInstallationKey: string; /** * (Updatable) Excludes the packages that starts with the prefix from the migration analyses result. Either this or includePackagePrefixes can be specified. */ excludePackagePrefixes: string[]; /** * (Updatable) Includes the packages that starts with the prefix from the migration analyses result. Either this or excludePackagePrefixes can be specified. */ includePackagePrefixes: string[]; /** * (Updatable) The OCID of the managed instance that hosts the application for which the Java migration analyses was performed. */ managedInstanceId: string; /** * (Updatable) The JDK version the application is currently running on. */ sourceJdkVersion: string; /** * (Updatable) The JDK version against which the migration analyses was performed to identify effort required to move from source JDK. */ targetJdkVersion: string; } interface TaskScheduleTaskDetailsJavaMigrationTaskRequest { /** * (Updatable) An array of migration analysis requests. */ targets: outputs.Jms.TaskScheduleTaskDetailsJavaMigrationTaskRequestTarget[]; } interface TaskScheduleTaskDetailsJavaMigrationTaskRequestTarget { /** * (Updatable) The unique key that identifies the application's installation path that is to be used for the Java migration analysis. */ applicationInstallationKey: string; /** * (Updatable) Excludes the packages that starts with the prefix from the migration analysis result. Either this or includePackagePrefixes can be specified. */ excludePackagePrefixes: string[]; /** * (Updatable) includes the packages that starts with the prefix from the migration analysis result. Either this or excludePackagePrefixes can be specified. */ includePackagePrefixes: string[]; /** * (Updatable) The OCID of the managed instance that hosts the application for which the Java migration analysis was performed. */ managedInstanceId: string; /** * (Updatable) The JDK version the application is currently running on. */ sourceJdkVersion: string; /** * (Updatable) The JDK version against which the migration analysis was performed to identify effort required to move from source JDK. */ targetJdkVersion: string; } interface TaskScheduleTaskDetailsJfrTaskRequest { /** * (Updatable) The profile used for JFR events selection. If the name isn't recognized, the settings from jfcV1 or jfcV2 will be used depending on the JVM version. Both jfcV2 and jfcV1 should be provided to ensure JFR collection on different JVM versions. */ jfcProfileName: string; /** * (Updatable) The BASE64 encoded string of JFR settings XML with schema used by JDK 8. */ jfcV1: string; /** * (Updatable) The BASE64 encoded string of JFR settings XML with [schema used by JDK 9 and after](https://raw.githubusercontent.com/openjdk/jdk/master/src/jdk.jfr/share/classes/jdk/jfr/internal/jfc/jfc.xsd). */ jfcV2: string; /** * (Updatable) Duration of the JFR recording in minutes. */ recordingDurationInMinutes: number; /** * (Updatable) The maximum size limit for the JFR file collected. */ recordingSizeInMb: number; /** * (Updatable) The attachment targets to start JFR. */ targets: outputs.Jms.TaskScheduleTaskDetailsJfrTaskRequestTarget[]; /** * (Updatable) Period to looking for JVMs. In addition to attach to running JVMs when given the command, JVM started within the waiting period will also be attached for JFR. The value should be larger than the agent polling interval setting for the fleet to ensure agent can get the instructions. If not specified, the agent polling interval for the fleet is used. */ waitingPeriodInMinutes: number; } interface TaskScheduleTaskDetailsJfrTaskRequestTarget { /** * (Updatable) Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * (Updatable) Unique key that identifies the application for JFR data collection. */ applicationKey: string; /** * (Updatable) Unique key that identifies the container for JFR data collection. */ containerKey: string; /** * (Updatable) Unique key that identify the JVM for JFR data collection. */ jreKey: string; /** * (Updatable) OCID of the Managed Instance to collect JFR data. */ managedInstanceId: string; } interface TaskScheduleTaskDetailsPerformanceTuningTaskRequest { /** * (Updatable) Duration of the JFR recording in minutes. */ recordingDurationInMinutes: number; /** * (Updatable) The attachment targets to start JFR. */ targets: outputs.Jms.TaskScheduleTaskDetailsPerformanceTuningTaskRequestTarget[]; /** * (Updatable) Period to looking for JVMs. In addition to attach to running JVMs when given the command, JVM started within the waiting period will also be attached for JFR. The value should be larger than the agent polling interval setting for the fleet to ensure agent can get the instructions. If not specified, the agent polling interval for the fleet is used. */ waitingPeriodInMinutes: number; } interface TaskScheduleTaskDetailsPerformanceTuningTaskRequestTarget { /** * (Updatable) Unique key that identifies the application installation for JFR data collection. */ applicationInstallationKey: string; /** * (Updatable) Unique key that identifies the application for JFR data collection. */ applicationKey: string; /** * (Updatable) Unique key that identifies the container for JFR data collection. */ containerKey: string; /** * (Updatable) Unique key that identify the JVM for JFR data collection. */ jreKey: string; /** * (Updatable) OCID of the Managed Instance to collect JFR data. */ managedInstanceId: string; } interface TaskScheduleTaskDetailsRemoveInstallationSiteTaskRequest { /** * (Updatable) The list of installation sites to remove. */ installationSites: outputs.Jms.TaskScheduleTaskDetailsRemoveInstallationSiteTaskRequestInstallationSite[]; } interface TaskScheduleTaskDetailsRemoveInstallationSiteTaskRequestInstallationSite { /** * (Updatable) The unique identifier for the installation of a Java Runtime at a specific path on a specific operating system. */ installationKey: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the related managed instance. */ managedInstanceId: string; } interface TaskScheduleTaskDetailsScanJavaServerTaskRequest { /** * (Updatable) The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of managed instances to scan. */ managedInstanceIds: string[]; } interface TaskScheduleTaskDetailsScanLibraryTaskRequest { /** * (Updatable) The duration of the dynamic scan in minutes. */ dynamicScanDurationInMinutes: number; /** * (Updatable) Indicates whether the scan is dynamic or static. */ isDynamicScan: boolean; /** * (Updatable) The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of managed instances to scan. */ managedInstanceIds: string[]; } } export declare namespace Kms { interface GeneratedKeyKeyShape { /** * The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for `External` keys. */ algorithm: string; /** * Supported curve IDs for ECDSA keys. */ curveId: string; /** * The length of the key in bytes, expressed as an integer. Supported values include the following: * * AES: 16, 24, or 32 * * RSA: 256, 384, or 512 * * ECDSA: 32, 48, or 66 */ length: number; } interface GetEkmsPrivateEndpointsEkmsPrivateEndpoint { /** * CABundle to validate TLS certificate of the external key manager system in PEM format */ caBundle: string; /** * The OCID of the compartment. */ compartmentId: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Mutable name of the EKMS private endpoint */ displayName: string; /** * Private IP of the external key manager system to connect to from the EKMS private endpoint */ externalKeyManagerIp: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state. */ lifecycleDetails: string; /** * The port of the external key manager system */ port: number; /** * The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet */ privateEndpointIp: string; /** * The current state of the EKMS private endpoint resource. */ state: string; /** * Subnet Identifier */ subnetId: string; /** * The time the EKMS private endpoint was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * The time the EKMS private endpoint was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string. */ timeUpdated: string; } interface GetEkmsPrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetKeyAutoKeyRotationDetail { /** * The last execution status message of auto key rotation. */ lastRotationMessage: string; /** * The status of last execution of auto key rotation. */ lastRotationStatus: string; /** * The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule. */ rotationIntervalInDays: number; /** * A property indicating Last rotation Date. Example: `2023-04-04T00:00:00Z`. */ timeOfLastRotation: string; /** * A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z`. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z. */ timeOfNextRotation: string; /** * A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer. */ timeOfScheduleStart: string; } interface GetKeyExternalKeyReference { /** * ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM. */ externalKeyId: string; } interface GetKeyExternalKeyReferenceDetail { /** * ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM. */ externalKeyId: string; /** * Key version ID associated with the external key. */ externalKeyVersionId: string; } interface GetKeyKeyShape { /** * The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for `External` keys. */ algorithm: string; /** * Supported curve IDs for ECDSA keys. */ curveId: string; /** * The length of the key in bytes, expressed as an integer. Supported values include the following: * * AES: 16, 24, or 32 * * RSA: 256, 384, or 512 * * ECDSA: 32, 48, or 66 */ length: number; } interface GetKeyReplicaDetail { /** * ReplicationId associated with a key operation */ replicationId: string; } interface GetKeyRestoreFromFile { /** * content length of key's backup binary file */ contentLength: string; /** * content md5 hashed value of key's backup file */ contentMd5: string; /** * Key backup file content */ restoreKeyFromFileDetails: string; } interface GetKeyRestoreFromObjectStore { /** * Name of the bucket where key was backed up */ bucket: string; /** * Type of backup to restore from. Values of "BUCKET", "PRE_AUTHENTICATED_REQUEST_URI" are supported */ destination: string; /** * Namespace of the bucket where key was backed up */ namespace: string; /** * Object containing the backup */ object: string; /** * Pre-authenticated-request-uri of the backup */ uri: string; } interface GetKeyVersionExternalKeyReferenceDetail { /** * ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM. */ externalKeyId: string; /** * Key version ID associated with the external key. */ externalKeyVersionId: string; } interface GetKeyVersionReplicaDetail { /** * ReplicationId associated with a key version operation */ replicationId: string; } interface GetKeyVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetKeyVersionsKeyVersion { /** * The OCID of the compartment that contains this key version. */ compartmentId: string; /** * Key reference data to be returned to the customer as a response. */ externalKeyReferenceDetails: outputs.Kms.GetKeyVersionsKeyVersionExternalKeyReferenceDetail[]; /** * Key version ID associated with the external key. */ externalKeyVersionId: string; /** * The OCID of the key version. */ id: string; /** * An optional property indicating whether this keyversion is generated from auto rotatation. */ isAutoRotated: boolean; /** * A Boolean value that indicates whether the KeyVersion belongs to primary Vault or replica Vault. */ isPrimary: boolean; /** * The OCID of the key. */ keyId: string; /** * The OCID of the key version. */ keyVersionId: string; /** * The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint. */ managementEndpoint: string; /** * The public key in PEM format. (This value pertains only to RSA and ECDSA keys.) */ publicKey: string; /** * KeyVersion replica details */ replicaDetails: outputs.Kms.GetKeyVersionsKeyVersionReplicaDetail[]; restoredFromKeyId: string; /** * The OCID of the key version from which this key version was restored. */ restoredFromKeyVersionId: string; /** * The key version's current lifecycle state. Example: `ENABLED` */ state: string; /** * The date and time this key version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: "2018-04-03T21:10:29.600Z" */ timeCreated: string; /** * An optional property to indicate when to delete the key version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` */ timeOfDeletion: string; /** * The OCID of the vault that contains this key version. */ vaultId: string; } interface GetKeyVersionsKeyVersionExternalKeyReferenceDetail { /** * ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM. */ externalKeyId: string; /** * Key version ID associated with the external key. */ externalKeyVersionId: string; } interface GetKeyVersionsKeyVersionReplicaDetail { /** * ReplicationId associated with a key version operation */ replicationId: string; } interface GetKeysFilter { name: string; regex?: boolean; values: string[]; } interface GetKeysKey { /** * The details of auto rotation schedule for the Key being create updated or imported. */ autoKeyRotationDetails: outputs.Kms.GetKeysKeyAutoKeyRotationDetail[]; /** * The OCID of the compartment. */ compartmentId: string; /** * The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The `currentKeyVersion` property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations. */ currentKeyVersion: string; /** * 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"}` */ definedTags: { [key: string]: string; }; desiredState: string; /** * A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information. */ displayName: string; /** * Key reference data to be returned to the customer as a response. */ externalKeyReferenceDetails: outputs.Kms.GetKeysKeyExternalKeyReferenceDetail[]; externalKeyReferences: outputs.Kms.GetKeysKeyExternalKeyReference[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the key. */ id: string; /** * A parameter specifying whether the auto key rotation is enabled or not. */ isAutoRotationEnabled: boolean; /** * A Boolean value that indicates whether the Key belongs to primary Vault or replica vault. */ isPrimary: boolean; /** * The cryptographic properties of a key. */ keyShapes: outputs.Kms.GetKeysKeyKeyShape[]; /** * The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint. */ managementEndpoint: string; /** * A key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager. */ protectionMode: string; /** * Key replica details */ replicaDetails: outputs.Kms.GetKeysKeyReplicaDetail[]; restoreFromFiles: outputs.Kms.GetKeysKeyRestoreFromFile[]; restoreFromObjectStores: outputs.Kms.GetKeysKeyRestoreFromObjectStore[]; restoreTrigger: boolean; restoredFromKeyId: string; /** * The key's current lifecycle state. Example: `ENABLED` */ state: string; /** * The date and time the key was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeCreated: string; /** * An optional property indicating when to delete the key, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` */ timeOfDeletion: string; /** * The OCID of the vault that contains this key. */ vaultId: string; } interface GetKeysKeyAutoKeyRotationDetail { /** * The last execution status message of auto key rotation. */ lastRotationMessage: string; /** * The status of last execution of auto key rotation. */ lastRotationStatus: string; /** * The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule. */ rotationIntervalInDays: number; /** * A property indicating Last rotation Date. Example: `2023-04-04T00:00:00Z`. */ timeOfLastRotation: string; /** * A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z`. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z. */ timeOfNextRotation: string; /** * A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer. */ timeOfScheduleStart: string; } interface GetKeysKeyExternalKeyReference { /** * ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM. */ externalKeyId: string; } interface GetKeysKeyExternalKeyReferenceDetail { /** * ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM. */ externalKeyId: string; /** * Key version ID associated with the external key. */ externalKeyVersionId: string; } interface GetKeysKeyKeyShape { /** * The algorithm used by a key's key versions to encrypt or decrypt data. Currently, support includes AES, RSA, and ECDSA algorithms. */ algorithm: string; /** * The curve ID of the keys. (This pertains only to ECDSA keys.) */ curveId: string; /** * The length of the key in bytes, expressed as an integer. Supported values include 16, 24, or 32. */ length: number; } interface GetKeysKeyReplicaDetail { /** * ReplicationId associated with a key operation */ replicationId: string; } interface GetKeysKeyRestoreFromFile { contentLength: string; contentMd5: string; restoreKeyFromFileDetails: string; } interface GetKeysKeyRestoreFromObjectStore { bucket: string; destination: string; namespace: string; object: string; uri: string; } interface GetReplicationStatusReplicaDetail { /** * The replica region */ region: string; /** * Replication status associated with a replicationId */ status: string; } interface GetVaultExternalKeyManagerMetadata { /** * URL of the vault on external key manager. */ externalVaultEndpointUrl: string; oauthMetadatas: outputs.Kms.GetVaultExternalKeyManagerMetadataOauthMetadata[]; /** * OCID of the private endpoint. */ privateEndpointId: string; } interface GetVaultExternalKeyManagerMetadataOauthMetadata { /** * ID of the client app created in IDP. */ clientAppId: string; clientAppSecret: string; /** * Base URL of the IDCS account where confidential client app is created. */ idcsAccountNameUrl: string; } interface GetVaultExternalKeyManagerMetadataSummary { /** * URL of the vault on external key manager. */ externalVaultEndpointUrl: string; /** * Summary about authorization to be returned to the customer as a response. */ oauthMetadataSummaries: outputs.Kms.GetVaultExternalKeyManagerMetadataSummaryOauthMetadataSummary[]; /** * OCID of the private endpoint. */ privateEndpointId: string; /** * Vendor of the external key manager. */ vendor: string; } interface GetVaultExternalKeyManagerMetadataSummaryOauthMetadataSummary { /** * ID of the client app created in IDP. */ clientAppId: string; /** * Base URL of the IDCS account where confidential client app is created. */ idcsAccountNameUrl: string; } interface GetVaultReplicaDetail { /** * ReplicationId associated with a vault operation */ replicationId: string; } interface GetVaultReplicasFilter { name: string; regex?: boolean; values: string[]; } interface GetVaultReplicasVaultReplica { /** * The vault replica's crypto endpoint */ cryptoEndpoint: string; /** * The vault replica's management endpoint */ managementEndpoint: string; /** * Region to which vault is replicated to */ region: string; /** * Status of the Vault */ status: string; } interface GetVaultRestoreFromFile { /** * content length of vault's backup binary file */ contentLength: string; /** * content md5 hashed value of vault's backup file */ contentMd5: string; /** * Vault backup file content */ restoreVaultFromFileDetails: string; } interface GetVaultRestoreFromObjectStore { /** * Name of the bucket where vault was backed up */ bucket: string; /** * Type of backup to restore from. Values of "BUCKET", "PRE_AUTHENTICATED_REQUEST_URI" are supported */ destination: string; /** * Namespace of the bucket where vault was backed up */ namespace: string; /** * Object containing the backup */ object: string; /** * Pre-authenticated-request-uri of the backup */ uri: string; } interface GetVaultsFilter { name: string; regex?: boolean; values: string[]; } interface GetVaultsVault { /** * The OCID of the compartment. */ compartmentId: string; /** * The service endpoint to perform cryptographic operations against. Cryptographic operations include [Encrypt](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/EncryptedData/Encrypt), [Decrypt](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/DecryptedData/Decrypt), and [GenerateDataEncryptionKey](https://docs.cloud.oracle.com/iaas/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations. */ cryptoEndpoint: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information. */ displayName: string; /** * Summary about metadata of external key manager to be returned to the customer as a response. */ externalKeyManagerMetadataSummaries: outputs.Kms.GetVaultsVaultExternalKeyManagerMetadataSummary[]; externalKeyManagerMetadatas: outputs.Kms.GetVaultsVaultExternalKeyManagerMetadata[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the vault. */ id: string; /** * A Boolean value that indicates whether the Vault is primary Vault or replica Vault. */ isPrimary: boolean; /** * A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults. */ isVaultReplicable: boolean; /** * The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations. */ managementEndpoint: string; /** * Vault replica details */ replicaDetails: outputs.Kms.GetVaultsVaultReplicaDetail[]; restoreFromFiles: outputs.Kms.GetVaultsVaultRestoreFromFile[]; restoreFromObjectStores: outputs.Kms.GetVaultsVaultRestoreFromObjectStore[]; restoreTrigger: boolean; /** * The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault. */ restoredFromVaultId: string; /** * The vault's current lifecycle state. Example: `DELETED` */ state: string; /** * The date and time this vault was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeCreated: string; /** * An optional property to indicate when to delete the vault, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` */ timeOfDeletion: string; /** * The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing. */ vaultType: string; } interface GetVaultsVaultExternalKeyManagerMetadata { /** * URL of the vault on external key manager. */ externalVaultEndpointUrl: string; oauthMetadatas: outputs.Kms.GetVaultsVaultExternalKeyManagerMetadataOauthMetadata[]; /** * OCID of the private endpoint. */ privateEndpointId: string; } interface GetVaultsVaultExternalKeyManagerMetadataOauthMetadata { /** * ID of the client app created in IDP. */ clientAppId: string; clientAppSecret: string; /** * Base URL of the IDCS account where confidential client app is created. */ idcsAccountNameUrl: string; } interface GetVaultsVaultExternalKeyManagerMetadataSummary { /** * URL of the vault on external key manager. */ externalVaultEndpointUrl: string; /** * Summary about authorization to be returned to the customer as a response. */ oauthMetadataSummaries: outputs.Kms.GetVaultsVaultExternalKeyManagerMetadataSummaryOauthMetadataSummary[]; /** * OCID of the private endpoint. */ privateEndpointId: string; /** * Vendor of the external key manager. */ vendor: string; } interface GetVaultsVaultExternalKeyManagerMetadataSummaryOauthMetadataSummary { /** * ID of the client app created in IDP. */ clientAppId: string; /** * Base URL of the IDCS account where confidential client app is created. */ idcsAccountNameUrl: string; } interface GetVaultsVaultReplicaDetail { /** * ReplicationId associated with a vault operation */ replicationId: string; } interface GetVaultsVaultRestoreFromFile { contentLength: string; contentMd5: string; restoreVaultFromFileDetails: string; } interface GetVaultsVaultRestoreFromObjectStore { bucket: string; destination: string; namespace: string; object: string; uri: string; } interface KeyAutoKeyRotationDetails { /** * (Updatable) The last execution status message of auto key rotation. */ lastRotationMessage: string; /** * (Updatable) The status of last execution of auto key rotation. */ lastRotationStatus: string; /** * (Updatable) The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule. */ rotationIntervalInDays: number; /** * (Updatable) A property indicating Last rotation Date. Example: `2023-04-04T00:00:00Z`. */ timeOfLastRotation: string; /** * (Updatable) A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z`. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z. */ timeOfNextRotation: string; /** * (Updatable) A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer. */ timeOfScheduleStart: string; } interface KeyExternalKeyReference { /** * ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM */ externalKeyId: string; } interface KeyExternalKeyReferenceDetail { /** * ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM. */ externalKeyId: string; /** * Key version ID associated with the external key. */ externalKeyVersionId: string; } interface KeyKeyShape { /** * The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for `External` keys. */ algorithm: string; /** * Supported curve IDs for ECDSA keys. */ curveId: string; /** * The length of the key in bytes, expressed as an integer. Supported values include the following: * * AES: 16, 24, or 32 * * RSA: 256, 384, or 512 * * ECDSA: 32, 48, or 66 */ length: number; } interface KeyReplicaDetail { /** * ReplicationId associated with a key operation */ replicationId: string; } interface KeyRestoreFromFile { /** * (Updatable) content length of key's backup binary file */ contentLength: string; /** * (Updatable) content md5 hashed value of key's backup file */ contentMd5?: string; /** * Key backup file content. */ restoreKeyFromFileDetails: string; } interface KeyRestoreFromObjectStore { /** * (Updatable) Name of the bucket where key was backed up */ bucket?: string; /** * (Updatable) Type of backup to restore from. Values of "BUCKET", "PRE_AUTHENTICATED_REQUEST_URI" are supported */ destination: string; /** * (Updatable) Namespace of the bucket where key was backed up */ namespace?: string; /** * (Updatable) Object containing the backup */ object?: string; /** * (Updatable) Pre-authenticated-request-uri of the backup */ uri?: string; } interface KeyVersionExternalKeyReferenceDetail { /** * ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM. */ externalKeyId: string; /** * Key version ID associated with the external key. */ externalKeyVersionId: string; } interface KeyVersionReplicaDetail { /** * ReplicationId associated with a key version operation */ replicationId: string; } interface VaultExternalKeyManagerMetadata { /** * URI of the vault on external key manager. */ externalVaultEndpointUrl: string; /** * Authorization details required to get access token from IDP for accessing protected resources. */ oauthMetadata: outputs.Kms.VaultExternalKeyManagerMetadataOauthMetadata; /** * OCID of private endpoint created by customer. */ privateEndpointId: string; } interface VaultExternalKeyManagerMetadataOauthMetadata { /** * ID of the client app created in IDP. */ clientAppId: string; /** * Secret of the client app created in IDP. */ clientAppSecret: string; /** * Base URL of the IDCS account where confidential client app is created. */ idcsAccountNameUrl: string; } interface VaultExternalKeyManagerMetadataSummary { /** * URL of the vault on external key manager. */ externalVaultEndpointUrl: string; /** * Summary about authorization to be returned to the customer as a response. */ oauthMetadataSummaries: outputs.Kms.VaultExternalKeyManagerMetadataSummaryOauthMetadataSummary[]; /** * OCID of the private endpoint. */ privateEndpointId: string; /** * Vendor of the external key manager. */ vendor: string; } interface VaultExternalKeyManagerMetadataSummaryOauthMetadataSummary { /** * ID of the client app created in IDP. */ clientAppId: string; /** * Base URL of the IDCS account where confidential client app is created. */ idcsAccountNameUrl: string; } interface VaultReplicaDetail { /** * ReplicationId associated with a vault operation */ replicationId: string; } interface VaultRestoreFromFile { /** * content length of vault's backup binary file */ contentLength: string; /** * (Updatable) content md5 hashed value of vault's backup file */ contentMd5?: string; /** * Vault backup file content */ restoreVaultFromFileDetails: string; } interface VaultRestoreFromObjectStore { /** * (Updatable) Name of the bucket where vault was backed up */ bucket?: string; /** * (Updatable) Type of backup to restore from. Values of "BUCKET", "PRE_AUTHENTICATED_REQUEST_URI" are supported */ destination: string; /** * (Updatable) Namespace of the bucket where vault was backed up */ namespace?: string; /** * (Updatable) Object containing the backup */ object?: string; /** * (Updatable) Pre-authenticated-request-uri of the backup* `restoreTrigger` - (Optional) (Updatable) An optional property when flipped triggers restore from restore option provided in config file. */ uri?: string; } interface VaultVerificationReplicaVaultMetadata { idcsAccountNameUrl: string; privateEndpointId: string; vaultType: string; } } export declare namespace LicenseManager { interface GetLicenseRecordsFilter { name: string; regex?: boolean; values: string[]; } interface GetLicenseRecordsLicenseRecordCollection { items: outputs.LicenseManager.GetLicenseRecordsLicenseRecordCollectionItem[]; } interface GetLicenseRecordsLicenseRecordCollectionItem { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) where the license record is created. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The license record display name. Avoid entering confidential information. */ displayName: string; /** * The license record end date in [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. Example: `2018-09-12` */ expirationDate: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The license record [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * Specifies if the license record term is perpertual. */ isPerpetual: boolean; /** * Specifies if the license count is unlimited. */ isUnlimited: boolean; /** * The number of license units added by the user for the given license record. Default 1 */ licenseCount: number; /** * The product license unit. */ licenseUnit: string; /** * The license record product ID. */ productId: string; /** * The product license name with which the license record is associated. */ productLicense: string; /** * Unique product license identifier. */ productLicenseId: string; /** * The current license record state. */ state: string; /** * The license record support end date in [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. Example: `2018-09-12` */ supportEndDate: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the license record was created. An [RFC 3339](https://tools.ietf.org/html/rfc3339)-formatted datetime string. */ timeCreated: string; /** * The time the license record was updated. An [RFC 3339](https://tools.ietf.org/html/rfc3339)-formatted datetime string. */ timeUpdated: string; } interface GetProductLicenseConsumersItem { /** * Specifies if all options are available. */ areAllOptionsAvailable: boolean; /** * Specifies if the base license is available. */ isBaseLicenseAvailable: boolean; /** * The product license unit. */ licenseUnitType: string; /** * Number of license units consumed by the resource. */ licenseUnitsConsumed: number; /** * Collection of missing product licenses. */ missingProducts: outputs.LicenseManager.GetProductLicenseConsumersItemMissingProduct[]; /** * The resource product name. */ productName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the resource. */ resourceCompartmentId: string; /** * The display name of the compartment that contains the resource. */ resourceCompartmentName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ resourceId: string; /** * The display name of the resource. */ resourceName: string; /** * Number of units of the resource */ resourceUnitCount: number; /** * The unit type for the resource. */ resourceUnitType: string; } interface GetProductLicenseConsumersItemMissingProduct { /** * Product category base or option. */ category: string; /** * Units required for the missing product. */ count: number; /** * Name of the product. */ name: string; } interface GetProductLicenseImage { /** * The image ID associated with the product license. */ id: string; /** * The image listing ID. */ listingId: string; /** * The listing name associated with the product license. */ listingName: string; /** * The image package version. */ packageVersion: string; /** * The image publisher. */ publisher: string; } interface GetProductLicensesFilter { name: string; regex?: boolean; values: string[]; } interface GetProductLicensesProductLicenseCollection { items: outputs.LicenseManager.GetProductLicensesProductLicenseCollectionItem[]; } interface GetProductLicensesProductLicenseCollectionItem { /** * The number of active license records associated with the product license. */ activeLicenseRecordCount: number; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) used for the license record, product license, and configuration. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * License record name */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The image ID associated with the product license. */ id: string; /** * The images associated with the product license. */ images: outputs.LicenseManager.GetProductLicensesProductLicenseCollectionItemImage[]; /** * Specifies whether or not the product license is oversubscribed. */ isOverSubscribed: boolean; /** * Specifies if the license unit count is unlimited. */ isUnlimited: boolean; /** * Specifies whether the vendor is Oracle or a third party. */ isVendorOracle: boolean; /** * The product license unit. */ licenseUnit: string; /** * The current product license state. */ state: string; /** * The current product license status. */ status: string; /** * Status description for the current product license status. */ statusDescription: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the product license was created. An [RFC 3339](https://tools.ietf.org/html/rfc3339)-formatted datetime string. */ timeCreated: string; /** * The time the product license was updated. An [RFC 3339](https://tools.ietf.org/html/rfc3339)-formatted datetime string. */ timeUpdated: string; /** * The total number of licenses available for the product license, calculated by adding up all the license counts for active license records associated with the product license. */ totalActiveLicenseUnitCount: number; /** * The number of license records associated with the product license. */ totalLicenseRecordCount: number; /** * The number of license units consumed. Updated after each allocation run. */ totalLicenseUnitsConsumed: number; /** * The vendor of the ProductLicense */ vendorName: string; } interface GetProductLicensesProductLicenseCollectionItemImage { /** * The image ID associated with the product license. */ id: string; /** * The image listing ID. */ listingId: string; /** * The listing name associated with the product license. */ listingName: string; /** * The image package version. */ packageVersion: string; /** * The image publisher. */ publisher: string; } interface GetTopUtilizedProductLicensesItem { /** * Specifies if the license unit count is unlimited. */ isUnlimited: boolean; /** * The product license [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ productLicenseId: string; /** * The product type. */ productType: string; /** * The current product license status. */ status: string; /** * Total number of license units in the product license provided by the user. */ totalLicenseUnitCount: number; /** * Number of license units consumed. */ totalUnitsConsumed: number; /** * The product license unit. */ unitType: string; } interface GetTopUtilizedResourcesItem { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that contains the resource. */ resourceCompartmentId: string; /** * The display name of the compartment that contains the resource. */ resourceCompartmentName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ resourceId: string; /** * Resource canonical name. */ resourceName: string; /** * Number of license units consumed by the resource. */ totalUnits: number; /** * The resource unit. */ unitType: string; } interface ProductLicenseImage { /** * The image ID associated with the product license. */ id: string; /** * (Updatable) Marketplace image listing ID. */ listingId: string; /** * The listing name associated with the product license. */ listingName: string; /** * (Updatable) Image package version. */ packageVersion: string; /** * The image publisher. */ publisher: string; } } export declare namespace Limits { interface GetLimitDefinitionsFilter { /** * Optional field, filter for a specific resource limit. */ name: string; regex?: boolean; values: string[]; } interface GetLimitDefinitionsLimitDefinition { /** * If true, quota policies can be created on top of this resource limit. */ areQuotasSupported: boolean; /** * The limit description. */ description: string; /** * An array of subscription types that support ExternalLocations. */ externalLocationSupportedSubscriptions: string[]; /** * Indicates if the limit has been deprecated. */ isDeprecated: boolean; /** * The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services. */ isDynamic: boolean; /** * Indicates if the customer can request a limit increase for this resource. */ isEligibleForLimitIncrease: boolean; /** * Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response. */ isResourceAvailabilitySupported: boolean; /** * Optional field, filter for a specific resource limit. */ name: string; /** * Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific. */ scopeType: string; /** * The target service name. */ serviceName: string; /** * Supported quota family names for creation of quota policy. */ supportedQuotaFamilies: string[]; /** * An array of subscription types supported by the limit. For example, the type of subscription, such as SAAS, ERP, or CRM. */ supportedSubscriptions: string[]; } interface GetLimitValuesFilter { /** * Optional field, can be used to see a specific resource limit value. */ name: string; regex?: boolean; values: string[]; } interface GetLimitValuesLimitValue { /** * Filter entries by availability domain. This implies that only AD-specific values are returned. */ availabilityDomain: string; /** * Optional field, can be used to see a specific resource limit value. */ name: string; /** * Filter entries by scope type. */ scopeType: string; /** * The resource limit value. */ value: string; } interface GetQuotaLock { /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * Date and time the quota was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface GetQuotasFilter { /** * name */ name: string; regex?: boolean; values: string[]; } interface GetQuotasQuota { /** * The OCID of the parent compartment (remember that the tenancy is simply the root compartment). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the quota. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the quota. */ id: string; isLockOverride: boolean; /** * Locks associated with this resource. */ locks: outputs.Limits.GetQuotasQuotaLock[]; /** * name */ name: string; /** * Filters returned quotas based on the given state. */ state: string; /** * An array of one or more quota statements written in the declarative quota statement language. */ statements: string[]; /** * Date and time the quota was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetQuotasQuotaLock { /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * Date and time the quota was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Lock type. */ type: string; } interface GetServicesFilter { /** * The service name. Use this when calling other APIs. */ name: string; regex?: boolean; values: string[]; } interface GetServicesService { /** * The friendly service name. */ description: string; /** * The service name. Use this when calling other APIs. */ name: string; /** * An array of subscription types supported by the service. For example, the type of subscription, such as SAAS, ERP, or CRM. */ supportedSubscriptions: string[]; } interface QuotaLock { /** * A message added by the lock creator. The message typically gives an indication of why the resource is locked. */ message: string; /** * The resource ID that is locking this resource. Indicates that deleting this resource removes the lock. */ relatedResourceId: string; /** * Date and time the quota was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Lock type. */ type: string; } } export declare namespace LoadBalancer { interface BackendSetBackend { /** * (Updatable) Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. * * **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. * * Example: `false` */ backup?: boolean; /** * (Updatable) Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: `false` */ drain?: boolean; /** * (Updatable) The IP address of the backend server. Example: `10.0.0.3` */ ipAddress: string; /** * (Updatable) The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. * * If setting maxConnections to some value other than 0 then that value must be greater or equal to 256. * * Example: `300` */ maxConnections: number; /** * A friendly name for the backend set. It must be unique and it cannot be changed. * * Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information. * * Example: `exampleBackendSet` */ name: string; /** * (Updatable) Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ offline?: boolean; /** * (Updatable) The communication port for the backend server. Example: `8080` */ port: number; /** * (Updatable) The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see [How Load Balancing Policies Work](https://docs.cloud.oracle.com/iaas/Content/Balance/Reference/lbpolicies.htm). Example: `3` */ weight: number; } interface BackendSetHealthChecker { /** * (Updatable) The interval between health checks, in milliseconds. Example: `10000` */ intervalMs?: number; /** * (Updatable) Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL. * * If "true", health checks will be done using plain text even if the associated backend set is configured to use SSL. * * If "false", health checks will be done using SSL encryption if the associated backend set is configured to use SSL. If the backend set is not so configured the health checks will be done using plain text. * * Example: `false` */ isForcePlainText: boolean; /** * (Updatable) The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the `Backend` object. Example: `8080` */ port?: number; /** * (Updatable) The protocol the health check must use; either HTTP or TCP. Example: `HTTP` */ protocol: string; /** * (Updatable) A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` */ responseBodyRegex: string; /** * (Updatable) The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. Example: `3` */ retries?: number; /** * (Updatable) The status code a healthy backend server should return. Example: `200` */ returnCode: number; /** * (Updatable) The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. Example: `3000` */ timeoutInMillis?: number; /** * (Updatable) The path against which to run the health check. Example: `/healthcheck` */ urlPath: string; } interface BackendSetLbCookieSessionPersistenceConfiguration { /** * (Updatable) The name of the cookie inserted by the load balancer. If this field is not configured, the cookie name defaults to "X-Oracle-BMC-LBS-Route". Example: `exampleCookie` * * **Notes:** * * Ensure that the cookie name used at the backend application servers is different from the cookie name used at the load balancer. To minimize the chance of name collision, Oracle recommends that you use a prefix such as "X-Oracle-OCI-" for this field. * * If a backend server and the load balancer both insert cookies with the same name, the client or browser behavior can vary depending on the domain and path values associated with the cookie. If the name, domain, and path values of the `Set-cookie` generated by a backend server and the `Set-cookie` generated by the load balancer are all the same, the client or browser treats them as one cookie and returns only one of the cookie values in subsequent requests. If both `Set-cookie` names are the same, but the domain and path names are different, the client or browser treats them as two different cookies. */ cookieName: string; /** * (Updatable) Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: `false` */ disableFallback: boolean; /** * (Updatable) The domain in which the cookie is valid. The `Set-cookie` header inserted by the load balancer contains a domain attribute with the specified value. * * This attribute has no default value. If you do not specify a value, the load balancer does not insert the domain attribute into the `Set-cookie` header. * * **Notes:** * * [RFC 6265 - HTTP State Management Mechanism](https://www.ietf.org/rfc/rfc6265.txt) describes client and browser behavior when the domain attribute is present or not present in the `Set-cookie` header. * * If the value of the `Domain` attribute is `example.com` in the `Set-cookie` header, the client includes the same cookie in the `Cookie` header when making HTTP requests to `example.com`, `www.example.com`, and `www.abc.example.com`. If the `Domain` attribute is not present, the client returns the cookie only for the domain to which the original request was made. * * Ensure that this attribute specifies the correct domain value. If the `Domain` attribute in the `Set-cookie` header does not include the domain to which the original request was made, the client or browser might reject the cookie. As specified in RFC 6265, the client accepts a cookie with the `Domain` attribute value `example.com` or `www.example.com` sent from `www.example.com`. It does not accept a cookie with the `Domain` attribute `abc.example.com` or `www.abc.example.com` sent from `www.example.com`. * * Example: `example.com` */ domain: string; /** * (Updatable) Whether the `Set-cookie` header should contain the `HttpOnly` attribute. If `true`, the `Set-cookie` header inserted by the load balancer contains the `HttpOnly` attribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example: `true` */ isHttpOnly: boolean; /** * (Updatable) Whether the `Set-cookie` header should contain the `Secure` attribute. If `true`, the `Set-cookie` header inserted by the load balancer contains the `Secure` attribute, which directs the client or browser to send the cookie only using a secure protocol. * * **Note:** If you set this field to `true`, you cannot associate the corresponding backend set with an HTTP listener. * * Example: `true` */ isSecure: boolean; /** * (Updatable) The amount of time the cookie remains valid. The `Set-cookie` header inserted by the load balancer contains a `Max-Age` attribute with the specified value. * * The specified value must be at least one second. There is no default value for this attribute. If you do not specify a value, the load balancer does not include the `Max-Age` attribute in the `Set-cookie` header. In most cases, the client or browser retains the cookie until the current session ends, as defined by the client. * * Example: `3600` */ maxAgeInSeconds: number; /** * (Updatable) The path in which the cookie is valid. The `Set-cookie header` inserted by the load balancer contains a `Path` attribute with the specified value. * * Clients include the cookie in an HTTP request only if the path portion of the request-uri matches, or is a subdirectory of, the cookie's `Path` attribute. * * The default value is `/`. * * Example: `/example` */ path: string; } interface BackendSetSessionPersistenceConfiguration { /** * (Updatable) The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: `exampleCookie` */ cookieName: string; /** * (Updatable) Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: `false` */ disableFallback?: boolean; } interface BackendSetSslConfiguration { /** * (Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]` */ certificateIds?: string[]; /** * (Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: `exampleCertificateBundle` */ certificateName?: string; /** * (Updatable) The name of the cipher suite to use for HTTPS or SSL connections. * * If this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`. * * **Notes:** * * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher suite. Clients cannot perform an SSL handshake if there is an incompatible configuration. * * You must ensure compatibility between the ciphers configured in the cipher suite and the configured certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA certificates. * * If the cipher configuration is not modified after load balancer creation, the `GET` operation returns `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners that predate this feature. * * If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET` operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for existing listeners that predate this feature. * * The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing backend sets that predate this feature. * * If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field, you must specify an appropriate predefined or custom cipher suite name when updating the resource. * * The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for this field. * * example: `exampleCipherSuite` */ cipherSuiteName: string; /** * (Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections. * * The load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure connection ensures that all data passed between the client and the server is private. * * The Load Balancing service supports the following protocols: * * TLSv1 * * TLSv1.1 * * TLSv1.2 * * TLSv1.3 * * If this field is not specified, TLSv1.2 is the default. * * **Warning:** All SSL listeners created on a given port must use the same set of SSL protocols. * * **Notes:** * * The handshake to establish an SSL connection fails if the client supports none of the specified protocols. * * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher suite. * * For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation displays a list of SSL protocols currently used by those resources. * * example: `["TLSv1.1", "TLSv1.2"]` */ protocols: string[]; /** * (Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers. * * **Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This field is ignored when the `SSLConfiguration` object is associated with a backend set. */ serverOrderPreference: string; /** * (Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]` */ trustedCertificateAuthorityIds?: string[]; /** * (Updatable) The maximum depth for peer certificate chain verification. Example: `3` */ verifyDepth?: number; /** * (Updatable) Whether the load balancer listener should verify peer certificates. Example: `true` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ verifyPeerCertificate?: boolean; } interface GetBackendHealthHealthCheckResult { /** * The result of the most recent health check. */ healthCheckStatus: string; /** * The IP address of the health check status report provider. This identifier helps you differentiate same-subnet load balancers that report health check status. Example: `10.0.0.7` */ sourceIpAddress: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet hosting the load balancer that reported this health check status. */ subnetId: string; /** * The date and time the data was retrieved, in the format defined by RFC3339. Example: `2017-06-02T18:28:11+00:00` */ timestamp: string; } interface GetBackendSetsBackendset { /** * The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set or set to 0 then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. Example: `300` */ backendMaxConnections: number; backends: outputs.LoadBalancer.GetBackendSetsBackendsetBackend[]; /** * The health check policy configuration. For more information, see [Editing Health Check Policies](https://docs.cloud.oracle.com/iaas/Content/Balance/Tasks/editinghealthcheck.htm). */ healthCheckers: outputs.LoadBalancer.GetBackendSetsBackendsetHealthChecker[]; id: string; /** * The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness). */ lbCookieSessionPersistenceConfigurations: outputs.LoadBalancer.GetBackendSetsBackendsetLbCookieSessionPersistenceConfiguration[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend sets to retrieve. */ loadBalancerId: string; /** * A friendly name for the backend set. It must be unique and it cannot be changed. */ name: string; /** * The load balancer policy for the backend set. To get a list of available policies, use the [ListPolicies](https://docs.cloud.oracle.com/iaas/api/#/en/loadbalancer/20170115/LoadBalancerPolicy/ListPolicies) operation. Example: `LEAST_CONNECTIONS` */ policy: string; /** * The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness). */ sessionPersistenceConfigurations: outputs.LoadBalancer.GetBackendSetsBackendsetSessionPersistenceConfiguration[]; /** * A listener's SSL handling configuration. */ sslConfigurations: outputs.LoadBalancer.GetBackendSetsBackendsetSslConfiguration[]; state: string; } interface GetBackendSetsBackendsetBackend { /** * Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. */ backup: boolean; /** * Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: `false` */ drain: boolean; /** * The IP address of the backend server. Example: `10.0.0.3` */ ipAddress: string; /** * The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. Example: `300` */ maxConnections: number; /** * A friendly name for the backend set. It must be unique and it cannot be changed. */ name: string; /** * Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ offline: boolean; /** * The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the `Backend` object. Example: `8080` */ port: number; /** * The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see [How Load Balancing Policies Work](https://docs.cloud.oracle.com/iaas/Content/Balance/Reference/lbpolicies.htm). Example: `3` */ weight: number; } interface GetBackendSetsBackendsetHealthChecker { /** * The interval between health checks, in milliseconds. The default is 10000 (10 seconds). Example: `10000` */ intervalMs: number; /** * Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL. */ isForcePlainText: boolean; /** * The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the `Backend` object. Example: `8080` */ port: number; /** * The protocol the health check must use; either HTTP or TCP. Example: `HTTP` */ protocol: string; /** * A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` */ responseBodyRegex: string; /** * The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. Defaults to 3. Example: `3` */ retries: number; /** * The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, you can use common HTTP status codes such as "200". Example: `200` */ returnCode: number; /** * The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. Defaults to 3000 (3 seconds). Example: `3000` */ timeoutInMillis: number; /** * The path against which to run the health check. Example: `/healthcheck` */ urlPath: string; } interface GetBackendSetsBackendsetLbCookieSessionPersistenceConfiguration { /** * The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: `exampleCookie` */ cookieName: string; /** * Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: `false` */ disableFallback: boolean; /** * The domain in which the cookie is valid. The `Set-cookie` header inserted by the load balancer contains a domain attribute with the specified value. */ domain: string; /** * Whether the `Set-cookie` header should contain the `HttpOnly` attribute. If `true`, the `Set-cookie` header inserted by the load balancer contains the `HttpOnly` attribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels. Example: `true` */ isHttpOnly: boolean; /** * Whether the `Set-cookie` header should contain the `Secure` attribute. If `true`, the `Set-cookie` header inserted by the load balancer contains the `Secure` attribute, which directs the client or browser to send the cookie only using a secure protocol. */ isSecure: boolean; /** * The amount of time the cookie remains valid. The `Set-cookie` header inserted by the load balancer contains a `Max-Age` attribute with the specified value. */ maxAgeInSeconds: number; /** * The path in which the cookie is valid. The `Set-cookie header` inserted by the load balancer contains a `Path` attribute with the specified value. */ path: string; } interface GetBackendSetsBackendsetSessionPersistenceConfiguration { /** * The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify that any cookie set by the backend causes the session to persist. Example: `exampleCookie` */ cookieName: string; /** * Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false. Example: `false` */ disableFallback: boolean; } interface GetBackendSetsBackendsetSslConfiguration { /** * Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]` */ certificateIds: string[]; /** * A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: `exampleCertificateBundle` */ certificateName: string; /** * The name of the cipher suite to use for HTTPS or SSL connections. */ cipherSuiteName: string; /** * A list of SSL protocols the load balancer must support for HTTPS or SSL connections. */ protocols: string[]; /** * When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers. */ serverOrderPreference: string; /** * Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]` */ trustedCertificateAuthorityIds: string[]; /** * The maximum depth for peer certificate chain verification. Example: `3` */ verifyDepth: number; /** * Whether the load balancer listener should verify peer certificates. Example: `true` */ verifyPeerCertificate: boolean; } interface GetBackendSetsFilter { /** * A friendly name for the backend set. It must be unique and it cannot be changed. */ name: string; regex?: boolean; values: string[]; } interface GetBackendsBackend { /** * The name of the backend set associated with the backend servers. Example: `exampleBackendSet` */ backendsetName: string; /** * Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. */ backup?: boolean; /** * Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: `false` */ drain: boolean; /** * The IP address of the backend server. Example: `10.0.0.3` */ ipAddress: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and servers. */ loadBalancerId: string; /** * The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. Example: `300` */ maxConnections: number; /** * A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080` */ name: string; /** * Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ offline: boolean; /** * The communication port for the backend server. Example: `8080` */ port: number; state: string; /** * The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see [How Load Balancing Policies Work](https://docs.cloud.oracle.com/iaas/Content/Balance/Reference/lbpolicies.htm). Example: `3` */ weight: number; } interface GetBackendsFilter { /** * A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080` */ name: string; regex?: boolean; values: string[]; } interface GetCertificatesCertificate { /** * The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider. */ caCertificate: string; /** * A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: `exampleCertificateBundle` */ certificateName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer associated with the certificate bundles to be listed. */ loadBalancerId: string; passphrase?: string; privateKey: string; /** * The public certificate, in PEM format, that you received from your SSL certificate provider. */ publicCertificate: string; state: string; } interface GetCertificatesFilter { name: string; regex?: boolean; values: string[]; } interface GetHostnamesFilter { /** * A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `exampleHostname001` */ name: string; regex?: boolean; values: string[]; } interface GetHostnamesHostname { /** * A virtual hostname. For more information about virtual hostname string construction, see [Managing Request Routing](https://docs.cloud.oracle.com/iaas/Content/Balance/Tasks/managingrequest.htm#routing). Example: `app.example.com` */ hostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer associated with the hostnames to retrieve. */ loadBalancerId: string; /** * A friendly name for the hostname resource. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `exampleHostname001` */ name: string; state: string; } interface GetListenerRulesFilter { /** * The name of the rule set that the rule belongs to. */ name: string; regex?: boolean; values: string[]; } interface GetListenerRulesListenerRule { /** * The name of the rule set that the rule belongs to. */ name: string; /** * A rule object that applies to the listener. */ rules: outputs.LoadBalancer.GetListenerRulesListenerRuleRule[]; state: string; } interface GetListenerRulesListenerRuleRule { /** * The action can be one of these values: `ADD_HTTP_REQUEST_HEADER`, `ADD_HTTP_RESPONSE_HEADER`, `ALLOW`, `CONTROL_ACCESS_USING_HTTP_METHODS`, `EXTEND_HTTP_REQUEST_HEADER_VALUE`, `EXTEND_HTTP_RESPONSE_HEADER_VALUE`, `HTTP_HEADER`, `IP_BASED_MAX_CONNECTIONS`, `REDIRECT`, `REMOVE_HTTP_REQUEST_HEADER`, `REMOVE_HTTP_RESPONSE_HEADER` */ action: string; /** * The list of HTTP methods allowed for this listener. */ allowedMethods: string[]; /** * Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header */ areInvalidCharactersAllowed: boolean; conditions: outputs.LoadBalancer.GetListenerRulesListenerRuleRuleCondition[]; /** * The maximum number of connections that the any IP can make to a listener unless the IP is mentioned in maxConnections. If no defaultMaxConnections is specified the default is unlimited. */ defaultMaxConnections: number; /** * A brief description of the access control rule. Avoid entering confidential information. */ description: string; /** * A header name that conforms to RFC 7230. Example: `exampleHeaderName` */ header: string; /** * The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64. */ httpLargeHeaderSizeInKb: number; /** * An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is */ ipMaxConnections: outputs.LoadBalancer.GetListenerRulesListenerRuleRuleIpMaxConnection[]; /** * A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. */ prefix: string; /** * An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI. */ redirectUris: outputs.LoadBalancer.GetListenerRulesListenerRuleRuleRedirectUri[]; /** * The HTTP status code to return when the incoming request is redirected. */ responseCode: number; /** * The HTTP status code to return when the requested HTTP method is not in the list of allowed methods. The associated status line returned with the code is mapped from the standard HTTP specification. The default value is `405 (Method Not Allowed)`. Example: 403 */ statusCode: number; /** * A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. */ suffix: string; /** * A header value that conforms to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. */ value: string; } interface GetListenerRulesListenerRuleRuleCondition { /** * The attributeName can be one of these values: `PATH`, `SOURCE_IP_ADDRESS`, `SOURCE_VCN_ID`, `SOURCE_VCN_IP_ADDRESS` */ attributeName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the originating VCN that an incoming packet must match. */ attributeValue: string; /** * A string that specifies how to compare the PathMatchCondition object's `attributeValue` string to the incoming URI. * * **EXACT_MATCH** - The incoming URI path must exactly and completely match the `attributeValue` string. * * **FORCE_LONGEST_PREFIX_MATCH** - The system looks for the `attributeValue` string with the best, longest match of the beginning portion of the incoming URI path. * * **PREFIX_MATCH** - The beginning portion of the incoming URI path must exactly match the `attributeValue` string. * * **SUFFIX_MATCH** - The ending portion of the incoming URI path must exactly match the `attributeValue` string. */ operator: string; } interface GetListenerRulesListenerRuleRuleIpMaxConnection { /** * Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]' */ ipAddresses: string[]; /** * The maximum number of simultaneous connections that the specified IPs can make to the Listener. IPs without a maxConnections setting can make either defaultMaxConnections simultaneous connections to a listener or, if no defaultMaxConnections is specified, an unlimited number of simultaneous connections to a listener. */ maxConnections: number; } interface GetListenerRulesListenerRuleRuleRedirectUri { /** * The valid domain name (hostname) or IP address to use in the redirect URI. */ host: string; /** * The HTTP URI path to use in the redirect URI. */ path: string; /** * The communication port to use in the redirect URI. */ port: number; /** * The HTTP protocol to use in the redirect URI. */ protocol: string; /** * The query string to use in the redirect URI. */ query: string; } interface GetLoadBalancerRoutingPoliciesFilter { /** * A unique name for the routing policy rule. Avoid entering confidential information. */ name: string; regex?: boolean; values: string[]; } interface GetLoadBalancerRoutingPoliciesRoutingPolicy { /** * The version of the language in which `condition` of `rules` are composed. */ conditionLanguageVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer associated with the routing policies. */ loadBalancerId: string; /** * A unique name for the routing policy rule. Avoid entering confidential information. */ name: string; /** * The ordered list of routing rules. */ rules: outputs.LoadBalancer.GetLoadBalancerRoutingPoliciesRoutingPolicyRule[]; state: string; } interface GetLoadBalancerRoutingPoliciesRoutingPolicyRule { /** * A list of actions to be applied when conditions of the routing rule are met. */ actions: outputs.LoadBalancer.GetLoadBalancerRoutingPoliciesRoutingPolicyRuleAction[]; /** * A routing rule to evaluate defined conditions against the incoming HTTP request and perform an action. */ condition: string; /** * A unique name for the routing policy rule. Avoid entering confidential information. */ name: string; } interface GetLoadBalancerRoutingPoliciesRoutingPolicyRuleAction { /** * Name of the backend set the listener will forward the traffic to. Example: `backendSetForImages` */ backendSetName: string; /** * A unique name for the routing policy rule. Avoid entering confidential information. */ name: string; } interface GetLoadBalancerRoutingPolicyRule { /** * A list of actions to be applied when conditions of the routing rule are met. */ actions: outputs.LoadBalancer.GetLoadBalancerRoutingPolicyRuleAction[]; /** * A routing rule to evaluate defined conditions against the incoming HTTP request and perform an action. */ condition: string; /** * A unique name for the routing policy rule. Avoid entering confidential information. */ name: string; } interface GetLoadBalancerRoutingPolicyRuleAction { /** * Name of the backend set the listener will forward the traffic to. Example: `backendSetForImages` */ backendSetName: string; /** * A unique name for the routing policy rule. Avoid entering confidential information. */ name: string; } interface GetLoadBalancersFilter { /** * A friendly name for the SSL cipher suite. It must be unique and it cannot be changed. */ name: string; regex?: boolean; values: string[]; } interface GetLoadBalancersLoadBalancer { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to list. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. Example: `exampleLoadBalancer` */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Ocid of the Reserved IP/Public Ip created with VCN. */ id: string; /** * An array of IP addresses. */ ipAddressDetails: outputs.LoadBalancer.GetLoadBalancersLoadBalancerIpAddressDetail[]; /** * An array of IP addresses. Deprecated: use ipAddressDetails instead. * * @deprecated The 'ip_addresses' field has been deprecated. Please use 'ip_address_details' instead. */ ipAddresses: string[]; ipMode: string; ipv6subnetCidr: string; /** * Whether or not the load balancer has delete protection enabled. */ isDeleteProtectionEnabled: boolean; /** * Whether the load balancer has a VCN-local (private) IP address. */ isPrivate: boolean; /** * Whether or not the load balancer has the Request Id feature enabled for HTTP listeners. */ isRequestIdEnabled: boolean; /** * An array of NSG [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the load balancer. */ networkSecurityGroupIds: string[]; /** * If isRequestIdEnabled is true then this field contains the name of the header field that contains the unique request id that is attached to every request from the load balancer to the load balancer backends and to every response from the load balancer. */ requestIdHeader: string; reservedIps: outputs.LoadBalancer.GetLoadBalancersLoadBalancerReservedIp[]; /** * Extended Defined tags for ZPR for this resource. Each key is predefined and scoped to a namespace. Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit", "usagetype" : "zpr"}}}` */ securityAttributes: { [key: string]: string; }; /** * A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/loadbalancer/20170115/LoadBalancerShape/ListShapes) operation. Example: `100Mbps` */ shape: string; /** * The configuration details to update load balancer to a different shape. */ shapeDetails: outputs.LoadBalancer.GetLoadBalancersLoadBalancerShapeDetail[]; /** * A filter to return only resources that match the given lifecycle state. Example: `SUCCEEDED` */ state: string; /** * An array of subnet [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ subnetIds: string[]; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The date and time the load balancer was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetLoadBalancersLoadBalancerIpAddressDetail { /** * An IP address. Example: `192.168.0.3` */ ipAddress: string; /** * Whether the IP address is public or private. */ isPublic: boolean; reservedIps: outputs.LoadBalancer.GetLoadBalancersLoadBalancerIpAddressDetailReservedIp[]; } interface GetLoadBalancersLoadBalancerIpAddressDetailReservedIp { /** * Ocid of the Reserved IP/Public Ip created with VCN. */ id: string; } interface GetLoadBalancersLoadBalancerReservedIp { /** * Ocid of the Reserved IP/Public Ip created with VCN. */ id: string; } interface GetLoadBalancersLoadBalancerShapeDetail { /** * Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps parameter. */ maximumBandwidthInMbps: number; /** * Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 0 and the maximumBandwidthInMbps in multiples of 10. The current allowed maximum value is defined in [Service Limits](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/servicelimits.htm). Example: `150` */ minimumBandwidthInMbps: number; } interface GetPathRouteSetsFilter { /** * The unique name for this set of path route rules. Avoid entering confidential information. Example: `examplePathRouteSet` */ name: string; regex?: boolean; values: string[]; } interface GetPathRouteSetsPathRouteSet { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer associated with the path route sets to retrieve. */ loadBalancerId: string; /** * The unique name for this set of path route rules. Avoid entering confidential information. Example: `examplePathRouteSet` */ name: string; /** * The set of path route rules. */ pathRoutes: outputs.LoadBalancer.GetPathRouteSetsPathRouteSetPathRoute[]; state: string; } interface GetPathRouteSetsPathRouteSetPathRoute { /** * The name of the target backend set for requests where the incoming URI matches the specified path. Example: `exampleBackendSet` */ backendSetName: string; /** * The path string to match against the incoming URI path. * * Path strings are case-insensitive. * * Asterisk (*) wildcards are not supported. * * Regular expressions are not supported. */ path: string; /** * The type of matching to apply to incoming URIs. */ pathMatchType: outputs.LoadBalancer.GetPathRouteSetsPathRouteSetPathRoutePathMatchType; } interface GetPathRouteSetsPathRouteSetPathRoutePathMatchType { /** * Specifies how the load balancing service compares a [PathRoute](https://docs.cloud.oracle.com/iaas/api/#/en/loadbalancer/20170115/requests/PathRoute) object's `path` string against the incoming URI. * * **EXACT_MATCH** - Looks for a `path` string that exactly matches the incoming URI path. * * **FORCE_LONGEST_PREFIX_MATCH** - Looks for the `path` string with the best, longest match of the beginning portion of the incoming URI path. * * **PREFIX_MATCH** - Looks for a `path` string that matches the beginning portion of the incoming URI path. * * **SUFFIX_MATCH** - Looks for a `path` string that matches the ending portion of the incoming URI path. */ matchType: string; } interface GetPoliciesFilter { /** * The name of a load balancing policy. Example: 'LEAST_CONNECTIONS' */ name: string; regex?: boolean; values: string[]; } interface GetPoliciesPolicy { /** * The name of a load balancing policy. Example: 'LEAST_CONNECTIONS' */ name: string; } interface GetProtocolsFilter { /** * The name of a protocol. Example: 'HTTP' */ name: string; regex?: boolean; values: string[]; } interface GetProtocolsProtocol { /** * The name of a protocol. Example: 'HTTP' */ name: string; } interface GetRuleSetItem { /** * The action can be one of these values: `ADD_HTTP_REQUEST_HEADER`, `ADD_HTTP_RESPONSE_HEADER`, `ALLOW`, `CONTROL_ACCESS_USING_HTTP_METHODS`, `EXTEND_HTTP_REQUEST_HEADER_VALUE`, `EXTEND_HTTP_RESPONSE_HEADER_VALUE`, `HTTP_HEADER`, `IP_BASED_MAX_CONNECTIONS`, `REDIRECT`, `REMOVE_HTTP_REQUEST_HEADER`, `REMOVE_HTTP_RESPONSE_HEADER` */ action: string; /** * The list of HTTP methods allowed for this listener. */ allowedMethods: string[]; /** * Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header */ areInvalidCharactersAllowed: boolean; conditions: outputs.LoadBalancer.GetRuleSetItemCondition[]; /** * The maximum number of connections that the any IP can make to a listener unless the IP is mentioned in maxConnections. If no defaultMaxConnections is specified the default is unlimited. */ defaultMaxConnections: number; /** * A brief description of the access control rule. Avoid entering confidential information. */ description: string; /** * A header name that conforms to RFC 7230. Example: `exampleHeaderName` */ header: string; /** * The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64. */ httpLargeHeaderSizeInKb: number; /** * An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is */ ipMaxConnections: outputs.LoadBalancer.GetRuleSetItemIpMaxConnection[]; /** * A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. */ prefix: string; /** * An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI. */ redirectUris: outputs.LoadBalancer.GetRuleSetItemRedirectUri[]; /** * The HTTP status code to return when the incoming request is redirected. */ responseCode: number; /** * The HTTP status code to return when the requested HTTP method is not in the list of allowed methods. The associated status line returned with the code is mapped from the standard HTTP specification. The default value is `405 (Method Not Allowed)`. Example: 403 */ statusCode: number; /** * A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. */ suffix: string; /** * A header value that conforms to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. */ value: string; } interface GetRuleSetItemCondition { /** * (Required) (Updatable) The attributeName can be one of these values: `PATH`, `SOURCE_IP_ADDRESS`, `SOURCE_VCN_ID`, `SOURCE_VCN_IP_ADDRESS` */ attributeName: string; /** * (Required) (Updatable) Depends on `attributeName`: * - when `attributeName` = `SOURCE_IP_ADDRESS` | IPv4 or IPv6 address range to which the source IP address of incoming packet would be matched against * - when `attributeName` = `SOURCE_VCN_IP_ADDRESS` | IPv4 address range to which the original client IP address (in customer VCN) of incoming packet would be matched against * - when `attributeName` = `SOURCE_VCN_ID` | OCID of the customer VCN to which the service gateway embedded VCN ID of incoming packet would be matched against */ attributeValue: string; /** * A string that specifies how to compare the PathMatchCondition object's `attributeValue` string to the incoming URI. * * **EXACT_MATCH** - The incoming URI path must exactly and completely match the `attributeValue` string. * * **FORCE_LONGEST_PREFIX_MATCH** - The system looks for the `attributeValue` string with the best, longest match of the beginning portion of the incoming URI path. * * **PREFIX_MATCH** - The beginning portion of the incoming URI path must exactly match the `attributeValue` string. * * **SUFFIX_MATCH** - The ending portion of the incoming URI path must exactly match the `attributeValue` string. */ operator: string; } interface GetRuleSetItemIpMaxConnection { /** * Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]' */ ipAddresses: string[]; /** * The maximum number of simultaneous connections that the specified IPs can make to the Listener. IPs without a maxConnections setting can make either defaultMaxConnections simultaneous connections to a listener or, if no defaultMaxConnections is specified, an unlimited number of simultaneous connections to a listener. */ maxConnections: number; } interface GetRuleSetItemRedirectUri { /** * The valid domain name (hostname) or IP address to use in the redirect URI. */ host: string; /** * The HTTP URI path to use in the redirect URI. */ path: string; /** * The communication port to use in the redirect URI. */ port: number; /** * The HTTP protocol to use in the redirect URI. */ protocol: string; /** * The query string to use in the redirect URI. */ query: string; } interface GetRuleSetsFilter { /** * The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `exampleRuleSet` */ name: string; regex?: boolean; values: string[]; } interface GetRuleSetsRuleSet { id: string; /** * An array of rules that compose the rule set. */ items: outputs.LoadBalancer.GetRuleSetsRuleSetItem[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the specified load balancer. */ loadBalancerId: string; /** * The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: `exampleRuleSet` */ name: string; state: string; } interface GetRuleSetsRuleSetItem { /** * The action can be one of these values: `ADD_HTTP_REQUEST_HEADER`, `ADD_HTTP_RESPONSE_HEADER`, `ALLOW`, `CONTROL_ACCESS_USING_HTTP_METHODS`, `EXTEND_HTTP_REQUEST_HEADER_VALUE`, `EXTEND_HTTP_RESPONSE_HEADER_VALUE`, `HTTP_HEADER`, `IP_BASED_MAX_CONNECTIONS`, `REDIRECT`, `REMOVE_HTTP_REQUEST_HEADER`, `REMOVE_HTTP_RESPONSE_HEADER` */ action: string; /** * The list of HTTP methods allowed for this listener. */ allowedMethods: string[]; /** * Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header */ areInvalidCharactersAllowed: boolean; conditions: outputs.LoadBalancer.GetRuleSetsRuleSetItemCondition[]; /** * The maximum number of connections that the any IP can make to a listener unless the IP is mentioned in maxConnections. If no defaultMaxConnections is specified the default is unlimited. */ defaultMaxConnections: number; /** * A brief description of the access control rule. Avoid entering confidential information. */ description: string; /** * A header name that conforms to RFC 7230. Example: `exampleHeaderName` */ header: string; /** * The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64. */ httpLargeHeaderSizeInKb: number; /** * An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is */ ipMaxConnections: outputs.LoadBalancer.GetRuleSetsRuleSetItemIpMaxConnection[]; /** * A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. */ prefix: string; /** * An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI. */ redirectUris: outputs.LoadBalancer.GetRuleSetsRuleSetItemRedirectUri[]; /** * The HTTP status code to return when the incoming request is redirected. */ responseCode: number; /** * The HTTP status code to return when the requested HTTP method is not in the list of allowed methods. The associated status line returned with the code is mapped from the standard HTTP specification. The default value is `405 (Method Not Allowed)`. Example: 403 */ statusCode: number; /** * A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. */ suffix: string; /** * A header value that conforms to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. */ value: string; } interface GetRuleSetsRuleSetItemCondition { /** * (Required) (Updatable) The attributeName can be one of these values: `PATH`, `SOURCE_IP_ADDRESS`, `SOURCE_VCN_ID`, `SOURCE_VCN_IP_ADDRESS` */ attributeName: string; /** * (Required) (Updatable) Depends on `attributeName`: * - when `attributeName` = `SOURCE_IP_ADDRESS` | IPv4 or IPv6 address range to which the source IP address of incoming packet would be matched against * - when `attributeName` = `SOURCE_VCN_IP_ADDRESS` | IPv4 address range to which the original client IP address (in customer VCN) of incoming packet would be matched against * - when `attributeName` = `SOURCE_VCN_ID` | OCID of the customer VCN to which the service gateway embedded VCN ID of incoming packet would be matched against */ attributeValue: string; /** * A string that specifies how to compare the PathMatchCondition object's `attributeValue` string to the incoming URI. * * **EXACT_MATCH** - The incoming URI path must exactly and completely match the `attributeValue` string. * * **FORCE_LONGEST_PREFIX_MATCH** - The system looks for the `attributeValue` string with the best, longest match of the beginning portion of the incoming URI path. * * **PREFIX_MATCH** - The beginning portion of the incoming URI path must exactly match the `attributeValue` string. * * **SUFFIX_MATCH** - The ending portion of the incoming URI path must exactly match the `attributeValue` string. */ operator: string; } interface GetRuleSetsRuleSetItemIpMaxConnection { /** * Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]' */ ipAddresses: string[]; /** * The maximum number of simultaneous connections that the specified IPs can make to the Listener. IPs without a maxConnections setting can make either defaultMaxConnections simultaneous connections to a listener or, if no defaultMaxConnections is specified, an unlimited number of simultaneous connections to a listener. */ maxConnections: number; } interface GetRuleSetsRuleSetItemRedirectUri { /** * The valid domain name (hostname) or IP address to use in the redirect URI. */ host: string; /** * The HTTP URI path to use in the redirect URI. */ path: string; /** * The communication port to use in the redirect URI. */ port: number; /** * The HTTP protocol to use in the redirect URI. */ protocol: string; /** * The query string to use in the redirect URI. */ query: string; } interface GetShapesFilter { /** * The name of the shape. Example: `100Mbps` */ name: string; regex?: boolean; values: string[]; } interface GetShapesShape { /** * The name of the shape. Example: `100Mbps` */ name: string; } interface GetSslCipherSuitesFilter { /** * A friendly name for the SSL cipher suite. It must be unique and it cannot be changed. */ name: string; regex?: boolean; values: string[]; } interface GetSslCipherSuitesSslCipherSuite { /** * A list of SSL ciphers the load balancer must support for HTTPS or SSL connections. */ ciphers: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated load balancer. */ loadBalancerId: string; /** * A friendly name for the SSL cipher suite. It must be unique and it cannot be changed. */ name: string; state: string; } interface ListenerConnectionConfiguration { /** * (Updatable) An array that represents the PPV2 Options that can be enabled on TCP Listeners. Example: ["PP2_TYPE_AUTHORITY"] */ backendTcpProxyProtocolOptions: string[]; /** * (Updatable) The backend TCP Proxy Protocol version. Example: `1` */ backendTcpProxyProtocolVersion?: number; /** * (Updatable) The maximum idle time, in seconds, allowed between two successive receive or two successive send operations between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations. * * For more information, see [Connection Configuration](https://docs.cloud.oracle.com/iaas/Content/Balance/Reference/connectionreuse.htm#ConnectionConfiguration). * * Example: `1200` */ idleTimeoutInSeconds: string; } interface ListenerSslConfiguration { /** * (Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]` */ certificateIds?: string[]; /** * (Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: `exampleCertificateBundle` */ certificateName?: string; /** * (Updatable) The name of the cipher suite to use for HTTPS or SSL connections. * * If this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`. * * **Notes:** * * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher suite. Clients cannot perform an SSL handshake if there is an incompatible configuration. * * You must ensure compatibility between the ciphers configured in the cipher suite and the configured certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA certificates. * * If the cipher configuration is not modified after load balancer creation, the `GET` operation returns `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners that predate this feature. * * If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET` operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for existing listeners that predate this feature. * * The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing backend sets that predate this feature. * * If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field, you must specify an appropriate predefined or custom cipher suite name when updating the resource. * * The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for this field. * * example: `exampleCipherSuite` */ cipherSuiteName: string; /** * (Updatable) Whether the load balancer listener should resume an encrypted session by reusing the cryptographic parameters of a previous TLS session, without having to perform a full handshake again. If "true", the service resumes the previous TLS encrypted session. If "false", the service starts a new TLS encrypted session. Enabling session resumption improves performance but provides a lower level of security. Disabling session resumption improves security but reduces performance. Example: `true` */ hasSessionResumption: boolean; /** * (Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections. * * The load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure connection ensures that all data passed between the client and the server is private. * * The Load Balancing service supports the following protocols: * * TLSv1 * * TLSv1.1 * * TLSv1.2 * * TLSv1.3 * * If this field is not specified, TLSv1.2 is the default. * * **Warning:** All SSL listeners created on a given port must use the same set of SSL protocols. * * **Notes:** * * The handshake to establish an SSL connection fails if the client supports none of the specified protocols. * * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher suite. * * For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation displays a list of SSL protocols currently used by those resources. * * example: `["TLSv1.1", "TLSv1.2"]` */ protocols: string[]; /** * (Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers. * * **Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This field is ignored when the `SSLConfiguration` object is associated with a backend set. */ serverOrderPreference: string; /** * (Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]` */ trustedCertificateAuthorityIds?: string[]; /** * (Updatable) The maximum depth for peer certificate chain verification. Example: `3` */ verifyDepth?: number; /** * (Updatable) Whether the load balancer listener should verify peer certificates. Example: `true` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ verifyPeerCertificate?: boolean; } interface LoadBalancerIpAddressDetail { /** * An IP address. Example: `192.168.0.3` */ ipAddress: string; /** * Whether the IP address is public or private. */ isPublic: boolean; reservedIps: outputs.LoadBalancer.LoadBalancerIpAddressDetailReservedIp[]; } interface LoadBalancerIpAddressDetailReservedIp { /** * Ocid of the Reserved IP/Public Ip created with VCN. */ id: string; } interface LoadBalancerReservedIp { /** * (Updatable) Ocid of the Reserved IP/Public Ip created with VCN. * * Reserved IPs are IPs which already registered using VCN API. * * Create a reserved Public IP and then while creating the load balancer pass the ocid of the reserved IP in this field reservedIp to attach the Ip to Load balancer. Load balancer will be configured to listen to traffic on this IP. * * Reserved IPs will not be deleted when the Load balancer is deleted. They will be unattached from the Load balancer. * * Example: "ocid1.publicip.oc1.phx.unique_ID" * * IPV6 example: "ocid1.ipv6.oc1.phx.unique_ID" Ocid of the pre-created public IP that should be attached to this load balancer. The public IP will be attached to a private IP. **Note** If public IP resource is present in the config, the pulumi preview will throw `After applying this step and refreshing, the plan was not empty` error, and `privateIpId` needs to be added as an input argument to the public IP resource block or ignore from its lifecycle as shown in examples to resolve this error. */ id: string; } interface LoadBalancerRoutingPolicyRule { /** * (Updatable) A list of actions to be applied when conditions of the routing rule are met. */ actions: outputs.LoadBalancer.LoadBalancerRoutingPolicyRuleAction[]; /** * (Updatable) A routing rule to evaluate defined conditions against the incoming HTTP request and perform an action. */ condition: string; /** * (Updatable) A unique name for the routing policy rule. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ name: string; } interface LoadBalancerRoutingPolicyRuleAction { /** * (Updatable) Name of the backend set the listener will forward the traffic to. Example: `backendSetForImages` */ backendSetName: string; /** * (Updatable) The name can be one of these values: `FORWARD_TO_BACKENDSET` */ name: string; } interface LoadBalancerShapeDetails { /** * (Updatable) Bandwidth in Mbps that determines the maximum bandwidth (ingress plus egress) that the load balancer can achieve. This bandwidth cannot be always guaranteed. For a guaranteed bandwidth use the minimumBandwidthInMbps parameter. * * The values must be between minimumBandwidthInMbps and 8000 (8Gbps). * * Example: `1500` */ maximumBandwidthInMbps: number; /** * (Updatable) Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress). The values must be between 10 and the maximumBandwidthInMbps. Example: `150` */ minimumBandwidthInMbps: number; } interface PathRouteSetPathRoute { /** * (Updatable) The name of the target backend set for requests where the incoming URI matches the specified path. Example: `exampleBackendSet` */ backendSetName: string; /** * (Updatable) The path string to match against the incoming URI path. * * Path strings are case-insensitive. * * Asterisk (*) wildcards are not supported. * * Regular expressions are not supported. * * Example: `/example/video/123` */ path: string; /** * (Updatable) The type of matching to apply to incoming URIs. */ pathMatchType: outputs.LoadBalancer.PathRouteSetPathRoutePathMatchType; } interface PathRouteSetPathRoutePathMatchType { /** * (Updatable) Specifies how the load balancing service compares a [PathRoute](https://docs.cloud.oracle.com/iaas/api/#/en/loadbalancer/20170115/requests/PathRoute) object's `path` string against the incoming URI. * * **EXACT_MATCH** - Looks for a `path` string that exactly matches the incoming URI path. * * **FORCE_LONGEST_PREFIX_MATCH** - Looks for the `path` string with the best, longest match of the beginning portion of the incoming URI path. * * **PREFIX_MATCH** - Looks for a `path` string that matches the beginning portion of the incoming URI path. * * **SUFFIX_MATCH** - Looks for a `path` string that matches the ending portion of the incoming URI path. * * For a full description of how the system handles `matchType` in a path route set containing multiple rules, see [Managing Request Routing](https://docs.cloud.oracle.com/iaas/Content/Balance/Tasks/managingrequest.htm). * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ matchType: string; } interface RuleSetItem { /** * (Updatable) The action can be one of these values: `ADD_HTTP_REQUEST_HEADER`, `ADD_HTTP_RESPONSE_HEADER`, `ALLOW`, `CONTROL_ACCESS_USING_HTTP_METHODS`, `EXTEND_HTTP_REQUEST_HEADER_VALUE`, `EXTEND_HTTP_RESPONSE_HEADER_VALUE`, `HTTP_HEADER`, `IP_BASED_MAX_CONNECTIONS`, `REDIRECT`, `REMOVE_HTTP_REQUEST_HEADER`, `REMOVE_HTTP_RESPONSE_HEADER` */ action: string; /** * (Updatable) The list of HTTP methods allowed for this listener. * * By default, you can specify only the standard HTTP methods defined in the [HTTP Method Registry](http://www.iana.org/assignments/http-methods/http-methods.xhtml). You can also see a list of supported standard HTTP methods in the Load Balancing service documentation at [Managing Rule Sets](https://docs.cloud.oracle.com/iaas/Content/Balance/Tasks/managingrulesets.htm). * * Your backend application must be able to handle the methods specified in this list. * * The list of HTTP methods is extensible. If you need to configure custom HTTP methods, contact [My Oracle Support](http://support.oracle.com/) to remove the restriction for your tenancy. * * Example: ["GET", "PUT", "POST", "PROPFIND"] */ allowedMethods: string[]; /** * (Updatable) Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header */ areInvalidCharactersAllowed: boolean; /** * (Updatable) */ conditions: outputs.LoadBalancer.RuleSetItemCondition[]; /** * (Updatable) The maximum number of connections that the any IP can make to a listener unless the IP is mentioned in maxConnections. If no defaultMaxConnections is specified the default is unlimited. */ defaultMaxConnections: number; /** * (Updatable) A brief description of the access control rule. Avoid entering confidential information. * * example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.` */ description: string; /** * (Updatable) A header name that conforms to RFC 7230. Example: `exampleHeaderName` */ header: string; /** * (Updatable) The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64. */ httpLargeHeaderSizeInKb: number; /** * (Updatable) An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is */ ipMaxConnections: outputs.LoadBalancer.RuleSetItemIpMaxConnection[]; /** * (Updatable) A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. * * Example: `examplePrefixValue` */ prefix: string; /** * (Updatable) An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI. * * **NOTE:** The Load Balancing service cannot automatically detect or avoid infinite redirects. Be sure to provide meaningful, complete, and correct field values. If any component field of this object has no value, the system retains the value from the incoming HTTP request URI. * * For example, if you specify only the protocol field `https`, and the incoming request URI is `http://example.com:8080`, the resulting runtime redirect URI is `https://example.com:8080`. The system retains the host and port from the incoming URI and does not automatically change the port setting from `8080` to `443`. * * Be sure to configure valid percent-encoding (URL encoding) when needed. * * In addition to static string values, you can use the following tokens to construct the redirect URI. These tokens extract values from the incoming HTTP request URI. * * {protocol} : The protocol from the incoming HTTP request URI. * * {host} : The domain name from the incoming HTTP request URI. * * {port} : The port from the incoming HTTP request URI. * * {path} : The path from the incoming HTTP request URI. * * {query} : The query string from the incoming HTTP request URI. * * The tokens are case sensitive. For example, `{host}` is a valid token, but `{HOST}` is not. * * You can retain the literal characters of a token when you specify values for the path and query properties of the redirect URI. Use a backslash (\\) as the escape character for the \\, {, and } characters. For example, if the incoming HTTP request URI is `/video`, the path property value: * * `/example{path}123\{path\}` * * appears in the constructed redirect URI as: * * `/example/video123{path}` */ redirectUri: outputs.LoadBalancer.RuleSetItemRedirectUri; /** * (Updatable) The HTTP status code to return when the incoming request is redirected. * * The status line returned with the code is mapped from the standard HTTP specification. Valid response codes for redirection are: * * 301 * * 302 * * 303 * * 307 * * 308 * * The default value is `302` (Found). * * Example: `301` */ responseCode: number; /** * (Updatable) The HTTP status code to return when the requested HTTP method is not in the list of allowed methods. The associated status line returned with the code is mapped from the standard HTTP specification. The default value is `405 (Method Not Allowed)`. Example: 403 */ statusCode: number; /** * (Updatable) A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. * * Example: `exampleSuffixValue` */ suffix: string; /** * (Updatable) A header value that conforms to RFC 7230. With the following exceptions: * * value cannot contain `$` * * value cannot contain patterns like `{variable_name}`. They are reserved for future extensions. Currently, such values are invalid. * * Example: `exampleValue` */ value: string; } interface RuleSetItemCondition { /** * (Updatable) The attributeName can be one of these values: `PATH`, `SOURCE_IP_ADDRESS`, `SOURCE_VCN_ID`, `SOURCE_VCN_IP_ADDRESS` */ attributeName: string; /** * (Updatable) Depends on `attributeName`: * - when `attributeName` = `SOURCE_IP_ADDRESS` | IPv4 or IPv6 address range to which the source IP address of incoming packet would be matched against * - when `attributeName` = `SOURCE_VCN_IP_ADDRESS` | IPv4 address range to which the original client IP address (in customer VCN) of incoming packet would be matched against * - when `attributeName` = `SOURCE_VCN_ID` | OCID of the customer VCN to which the service gateway embedded VCN ID of incoming packet would be matched against */ attributeValue: string; /** * (Updatable) A string that specifies how to compare the PathMatchCondition object's `attributeValue` string to the incoming URI. * * **EXACT_MATCH** - The incoming URI path must exactly and completely match the `attributeValue` string. * * **FORCE_LONGEST_PREFIX_MATCH** - The system looks for the `attributeValue` string with the best, longest match of the beginning portion of the incoming URI path. * * **PREFIX_MATCH** - The beginning portion of the incoming URI path must exactly match the `attributeValue` string. * * **SUFFIX_MATCH** - The ending portion of the incoming URI path must exactly match the `attributeValue` string. */ operator: string; } interface RuleSetItemIpMaxConnection { /** * (Updatable) Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]' */ ipAddresses: string[]; /** * (Updatable) The maximum number of simultaneous connections that the specified IPs can make to the Listener. IPs without a maxConnections setting can make either defaultMaxConnections simultaneous connections to a listener or, if no defaultMaxConnections is specified, an unlimited number of simultaneous connections to a listener. */ maxConnections: number; } interface RuleSetItemRedirectUri { /** * (Updatable) The valid domain name (hostname) or IP address to use in the redirect URI. * * When this value is null, not set, or set to `{host}`, the service preserves the original domain name from the incoming HTTP request URI. * * All RedirectUri tokens are valid for this property. You can use any token more than once. * * Curly braces are valid in this property only to surround tokens, such as `{host}` * * Examples: * * **example.com** appears as `example.com` in the redirect URI. * * **in{host}** appears as `inexample.com` in the redirect URI if `example.com` is the hostname in the incoming HTTP request URI. * * **{port}{host}** appears as `8081example.com` in the redirect URI if `example.com` is the hostname and the port is `8081` in the incoming HTTP request URI. */ host: string; /** * (Updatable) The HTTP URI path to use in the redirect URI. * * When this value is null, not set, or set to `{path}`, the service preserves the original path from the incoming HTTP request URI. To omit the path from the redirect URI, set this value to an empty string, "". * * All RedirectUri tokens are valid for this property. You can use any token more than once. * * The path string must begin with `/` if it does not begin with the `{path}` token. * * Examples: * * __/example/video/123__ appears as `/example/video/123` in the redirect URI. * * __/example{path}__ appears as `/example/video/123` in the redirect URI if `/video/123` is the path in the incoming HTTP request URI. * * __{path}/123__ appears as `/example/video/123` in the redirect URI if `/example/video` is the path in the incoming HTTP request URI. * * __{path}123__ appears as `/example/video123` in the redirect URI if `/example/video` is the path in the incoming HTTP request URI. * * __/{host}/123__ appears as `/example.com/123` in the redirect URI if `example.com` is the hostname in the incoming HTTP request URI. * * __/{host}/{port}__ appears as `/example.com/123` in the redirect URI if `example.com` is the hostname and `123` is the port in the incoming HTTP request URI. * * __/{query}__ appears as `/lang=en` in the redirect URI if the query is `lang=en` in the incoming HTTP request URI. */ path: string; /** * (Updatable) The communication port to use in the redirect URI. * * Valid values include integers from 1 to 65535. * * When this value is null, the service preserves the original port from the incoming HTTP request URI. * * Example: `8081` */ port: number; /** * (Updatable) The HTTP protocol to use in the redirect URI. * * When this value is null, not set, or set to `{protocol}`, the service preserves the original protocol from the incoming HTTP request URI. Allowed values are: * * HTTP * * HTTPS * * {protocol} * * `{protocol}` is the only valid token for this property. It can appear only once in the value string. * * Example: `HTTPS` */ protocol: string; /** * (Updatable) The query string to use in the redirect URI. * * When this value is null, not set, or set to `{query}`, the service preserves the original query parameters from the incoming HTTP request URI. * * All `RedirectUri` tokens are valid for this property. You can use any token more than once. * * If the query string does not begin with the `{query}` token, it must begin with the question mark (?) character. * * You can specify multiple query parameters as a single string. Separate each query parameter with an ampersand (&) character. To omit all incoming query parameters from the redirect URI, set this value to an empty string, "". * * If the specified query string results in a redirect URI ending with `?` or `&`, the last character is truncated. For example, if the incoming URI is `http://host.com:8080/documents` and the query property value is `?lang=en&{query}`, the redirect URI is `http://host.com:8080/documents?lang=en`. The system truncates the final ampersand (&) because the incoming URI included no value to replace the {query} token. * * Examples: * * **lang=en&time_zone=PST** appears as `lang=en&time_zone=PST` in the redirect URI. * * **{query}** appears as `lang=en&time_zone=PST` in the redirect URI if `lang=en&time_zone=PST` is the query string in the incoming HTTP request. If the incoming HTTP request has no query parameters, the `{query}` token renders as an empty string. * * **lang=en&{query}&time_zone=PST** appears as `lang=en&country=us&time_zone=PST` in the redirect URI if `country=us` is the query string in the incoming HTTP request. If the incoming HTTP request has no query parameters, this value renders as `lang=en&time_zone=PST`. * * **protocol={protocol}&hostname={host}** appears as `protocol=http&hostname=example.com` in the redirect URI if the protocol is `HTTP` and the hostname is `example.com` in the incoming HTTP request. * * **port={port}&hostname={host}** appears as `port=8080&hostname=example.com` in the redirect URI if the port is `8080` and the hostname is `example.com` in the incoming HTTP request URI. */ query?: string; } } export declare namespace LogAnalytics { interface GetLogAnalyticsCategoriesListItem { /** * The category description. */ description: string; /** * The category display name. */ displayName: string; /** * The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category. */ isSystem: boolean; /** * A filter to return only log analytics category whose name matches the entire name given. The match is case-insensitive. */ name: string; /** * The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC". */ type: string; } interface GetLogAnalyticsEntitiesFilter { /** * A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive. */ name: string; regex?: boolean; values: string[]; } interface GetLogAnalyticsEntitiesLogAnalyticsEntityCollection { /** * An array of entity metadata. */ items: outputs.LogAnalytics.GetLogAnalyticsEntitiesLogAnalyticsEntityCollectionItem[]; } interface GetLogAnalyticsEntitiesLogAnalyticsEntityCollectionItem { /** * The Boolean flag to indicate if logs are collected for an entity for log analytics usage. */ areLogsCollected: boolean; /** * The count of associated log sources for a given log analytics entity. */ associatedSourcesCount: number; /** * A filter to return only log analytics entities whose cloudResourceId matches the cloudResourceId given. */ cloudResourceId: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Internal name for the log analytics entity type. */ entityTypeInternalName: string; /** * A filter to return only log analytics entities whose entityTypeName matches the entire log analytics entity type name of one of the entityTypeNames given in the list. The match is case-insensitive. */ entityTypeName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only log analytics entities whose hostname matches the entire hostname given. */ hostname: string; /** * The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. */ id: string; /** * lifecycleDetails has additional information regarding substeps such as management agent plugin deployment. */ lifecycleDetails: string; /** * Management agent (management-agents resource kind) compartment OCID */ managementAgentCompartmentId: string; /** * Management agent (management-agents resource kind) display name */ managementAgentDisplayName: string; /** * The OCID of the Management Agent. */ managementAgentId: string; /** * Details of entity metadata information. */ metadatas: outputs.LogAnalytics.GetLogAnalyticsEntitiesLogAnalyticsEntityCollectionItemMetadata[]; /** * A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive. */ name: string; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: string; /** * The name/value pairs for parameter values to be used in file patterns specified in log sources. */ properties: { [key: string]: string; }; /** * A filter to return only log analytics entities whose sourceId matches the sourceId given. */ sourceId: string; /** * A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the resource was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the resource was last discovered, in the format defined by RFC3339. */ timeLastDiscovered: string; /** * The date and time the resource was last updated, in the format defined by RFC3339. */ timeUpdated: string; /** * The timezone region of the log analytics entity. */ timezoneRegion: string; } interface GetLogAnalyticsEntitiesLogAnalyticsEntityCollectionItemMetadata { /** * An array of entity metadata. */ items: outputs.LogAnalytics.GetLogAnalyticsEntitiesLogAnalyticsEntityCollectionItemMetadataItem[]; } interface GetLogAnalyticsEntitiesLogAnalyticsEntityCollectionItemMetadataItem { /** * A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive. */ name: string; /** * The metadata type. */ type: string; /** * The metadata value. */ value: string; } interface GetLogAnalyticsEntityAssociationsListFilter { /** * Log analytics entity name. */ name: string; regex?: boolean; values: string[]; } interface GetLogAnalyticsEntityAssociationsListLogAnalyticsEntityCollection { /** * An array of entity metadata. */ items: outputs.LogAnalytics.GetLogAnalyticsEntityAssociationsListLogAnalyticsEntityCollectionItem[]; } interface GetLogAnalyticsEntityAssociationsListLogAnalyticsEntityCollectionItem { /** * The Boolean flag to indicate if logs are collected for an entity for log analytics usage. */ areLogsCollected: boolean; /** * The count of associated log sources for a given log analytics entity. */ associatedSourcesCount: number; /** * The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity represents a non-cloud resource that the customer may have on their premises. */ cloudResourceId: string; /** * Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Internal name for the log analytics entity type. */ entityTypeInternalName: string; /** * Log analytics entity type name. */ entityTypeName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. */ id: string; /** * lifecycleDetails has additional information regarding substeps such as management agent plugin deployment. */ lifecycleDetails: string; /** * The OCID of the Management Agent. */ managementAgentId: string; /** * A collection of entity metadata information. */ metadatas: outputs.LogAnalytics.GetLogAnalyticsEntityAssociationsListLogAnalyticsEntityCollectionItemMetadata[]; /** * Log analytics entity name. */ name: string; /** * This indicates the type of source. It is primarily for Enterprise Manager Repository ID. */ sourceId: string; /** * The current state of the log analytics entity. */ state: string; /** * The date and time the resource was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the resource was last discovered, in the format defined by RFC3339. */ timeLastDiscovered: string; /** * The date and time the resource was last updated, in the format defined by RFC3339. */ timeUpdated: string; /** * The timezone region of the log analytics entity. */ timezoneRegion: string; } interface GetLogAnalyticsEntityAssociationsListLogAnalyticsEntityCollectionItemMetadata { /** * An array of entity metadata. */ items: outputs.LogAnalytics.GetLogAnalyticsEntityAssociationsListLogAnalyticsEntityCollectionItemMetadataItem[]; } interface GetLogAnalyticsEntityAssociationsListLogAnalyticsEntityCollectionItemMetadataItem { /** * Log analytics entity name. */ name: string; /** * The metadata type. */ type: string; /** * The metadata value. */ value: string; } interface GetLogAnalyticsEntityMetadata { /** * An array of entity metadata. */ items: outputs.LogAnalytics.GetLogAnalyticsEntityMetadataItem[]; } interface GetLogAnalyticsEntityMetadataItem { /** * Log analytics entity name. */ name: string; /** * The metadata type. */ type: string; /** * The metadata value. */ value: string; } interface GetLogAnalyticsEntityTopologyFilter { /** * Log analytics entity name. */ name: string; regex?: boolean; values: string[]; } interface GetLogAnalyticsEntityTopologyItem { /** * Collection of log analytics entity relationship links. */ links: outputs.LogAnalytics.GetLogAnalyticsEntityTopologyItemLink[]; /** * Collection of log analytics entities. */ nodes: outputs.LogAnalytics.GetLogAnalyticsEntityTopologyItemNode[]; } interface GetLogAnalyticsEntityTopologyItemLink { /** * An array of entity metadata. */ items: outputs.LogAnalytics.GetLogAnalyticsEntityTopologyItemLinkItem[]; } interface GetLogAnalyticsEntityTopologyItemLinkItem { /** * The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. */ destinationEntityId: string; /** * The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. */ sourceEntityId: string; } interface GetLogAnalyticsEntityTopologyItemNode { /** * An array of entity metadata. */ items: outputs.LogAnalytics.GetLogAnalyticsEntityTopologyItemNodeItem[]; } interface GetLogAnalyticsEntityTopologyItemNodeItem { /** * The Boolean flag to indicate if logs are collected for an entity for log analytics usage. */ areLogsCollected: boolean; /** * The OCID of the Cloud resource which this entity is a representation of. This may be blank when the entity represents a non-cloud resource that the customer may have on their premises. */ cloudResourceId: string; /** * Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Internal name for the log analytics entity type. */ entityTypeInternalName: string; /** * Log analytics entity type name. */ entityTypeName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. */ id: string; /** * lifecycleDetails has additional information regarding substeps such as management agent plugin deployment. */ lifecycleDetails: string; /** * The OCID of the Management Agent. */ managementAgentId: string; /** * Log analytics entity name. */ name: string; /** * This indicates the type of source. It is primarily for Enterprise Manager Repository ID. */ sourceId: string; /** * A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the resource was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the resource was last updated, in the format defined by RFC3339. */ timeUpdated: string; /** * The timezone region of the log analytics entity. */ timezoneRegion: string; } interface GetLogAnalyticsEntityTypeProperty { /** * Description for the log analytics entity type property. */ description: string; /** * Log analytics entity type property name. */ name: string; } interface GetLogAnalyticsEntityTypesFilter { /** * A filter to return only log analytics entity types whose name matches the entire name given. The match is case-insensitive. */ name: string; regex?: boolean; values: string[]; } interface GetLogAnalyticsEntityTypesLogAnalyticsEntityTypeCollection { /** * Array of log analytics entity type summary. */ items: outputs.LogAnalytics.GetLogAnalyticsEntityTypesLogAnalyticsEntityTypeCollectionItem[]; } interface GetLogAnalyticsEntityTypesLogAnalyticsEntityTypeCollectionItem { /** * Log analytics entity type category. Category will be used for grouping and filtering. */ category: string; /** * A filter to return CLOUD or NON_CLOUD entity types. */ cloudType: string; /** * Internal name for the log analytics entity type. */ internalName: string; managementAgentEligibilityStatus: string; /** * A filter to return only log analytics entity types whose name matches the entire name given. The match is case-insensitive. */ name: string; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: string; properties: outputs.LogAnalytics.GetLogAnalyticsEntityTypesLogAnalyticsEntityTypeCollectionItemProperty[]; /** * A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive. */ state: string; /** * Time the log analytics entity type was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Time the log analytics entity type was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetLogAnalyticsEntityTypesLogAnalyticsEntityTypeCollectionItemProperty { description: string; /** * A filter to return only log analytics entity types whose name matches the entire name given. The match is case-insensitive. */ name: string; } interface GetLogAnalyticsLogGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetLogAnalyticsLogGroupsLogAnalyticsLogGroupSummaryCollection { items: outputs.LogAnalytics.GetLogAnalyticsLogGroupsLogAnalyticsLogGroupSummaryCollectionItem[]; } interface GetLogAnalyticsLogGroupsLogAnalyticsLogGroupSummaryCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description for this resource. */ description: string; /** * A filter to return only log analytics log groups whose displayName matches the entire display name given. The match is case-insensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. */ id: string; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: string; /** * The date and time the resource was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the resource was last updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetLogAnalyticsObjectCollectionRuleOverride { matchType: string; matchValue: string; propertyName: string; propertyValue: string; } interface GetLogAnalyticsObjectCollectionRulesFilter { /** * A filter to return rules only matching with this name. */ name: string; regex?: boolean; values: string[]; } interface GetLogAnalyticsObjectCollectionRulesLogAnalyticsObjectCollectionRuleCollection { items: outputs.LogAnalytics.GetLogAnalyticsObjectCollectionRulesLogAnalyticsObjectCollectionRuleCollectionItem[]; } interface GetLogAnalyticsObjectCollectionRulesLogAnalyticsObjectCollectionRuleCollectionItem { /** * An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing. It is recommended to set this value as ISO_8589_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs. */ charEncoding: string; /** * The type of collection. Supported collection types: LIVE, HISTORIC, HISTORIC_LIVE */ collectionType: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A string that describes the details of the rule. It does not have to be unique, and can be changed. Avoid entering confidential information. */ description: string; /** * Log Analytics entity OCID to associate the processed logs with. */ entityId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. */ id: string; /** * Whether or not this rule is currently enabled. */ isEnabled: boolean; /** * Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule */ isForceHistoricCollection: boolean; /** * Last Collected Object for the rule */ lastCollectedObject: string; /** * A detailed status of the life cycle state. */ lifecycleDetails: string; /** * Log Analytics Log group OCID to associate the processed logs with. */ logGroupId: string; /** * The logSet to be associated with the processed logs. The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex. */ logSet: string; /** * The regex to be applied against given logSetKey. Regex has to be in string escaped format. */ logSetExtRegex: string; /** * An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex. Default value is OBJECT_PATH (e.g. /n//b//o/). */ logSetKey: string; /** * Name of the Log Analytics Source to use for the processing. */ logSourceName: string; /** * Type of files/objects in this object collection rule. */ logType: string; /** * A filter to return rules only matching with this name. */ name: string; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: string; /** * When the filters are provided, only the objects matching the filters are picked up for processing. The matchType supported is exact match and accommodates wildcard "*". For more information on filters, see [Event Filters](https://docs.oracle.com/en-us/iaas/Content/Events/Concepts/filterevents.htm). */ objectNameFilters: string[]; /** * Name of the Object Storage bucket. */ osBucketName: string; /** * Object Storage namespace. */ osNamespace: string; /** * Use this to override some property values which are defined at bucket level to the scope of object. Supported propeties for override are, logSourceName, charEncoding. Supported matchType for override are "contains". */ overrides: outputs.LogAnalytics.GetLogAnalyticsObjectCollectionRulesLogAnalyticsObjectCollectionRuleCollectionItemOverride[]; /** * The oldest time of the file in the bucket to consider for collection. Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error. */ pollSince: string; /** * The oldest time of the file in the bucket to consider for collection. Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. When collectionType is LIVE, specifying pollTill will result in error. */ pollTill: string; /** * Lifecycle state filter. */ state: string; /** * The time from which to consume the objects, if streamCursorType is AT_TIME. */ streamCursorTime: string; /** * Cursor type used to fetch messages from stream. When the streamCursorType is set to DEFAULT, the existing cursor position will be used if already set by any previous objection collection rule(s) using the same stream. Otherwise, the behaviour is to consume from the oldest available message in the stream. When the streamCursorType is set to TRIM_HORIZON, the behaviour is to start consuming from the oldest available message in the stream. When the streamCursorType is set to LATEST, the behavior is to start consuming messages that were published after the creation of this rule. When the streamCursorType is set to AT_TIME, the behavior is to start consuming from a given time. For more information on cursor types, see [Stream Consumer Groups](https://docs.oracle.com/en-us/iaas/Content/Streaming/Tasks/using_consumer_groups.htm). */ streamCursorType: string; /** * A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Log Analytics while creating Event Rule and consume the event notifications created by the Object Storage. */ streamId: string; /** * The time when this rule was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when this rule was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Timezone to be used when processing log entries whose timestamps do not include an explicit timezone. When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used. */ timezone: string; } interface GetLogAnalyticsObjectCollectionRulesLogAnalyticsObjectCollectionRuleCollectionItemOverride { matchType: string; matchValue: string; propertyName: string; propertyValue: string; } interface GetLogAnalyticsPreferenceItem { /** * The preference name. */ name: string; /** * The preference value. */ value: string; } interface GetLogAnalyticsResourceCategoriesListCategory { /** * The category description. */ description: string; /** * The category display name. */ displayName: string; /** * The system flag. A value of false denotes a user-created category assignment. A value of true denotes an Oracle-defined category assignment. */ isSystem: boolean; /** * The unique name that identifies the category. */ name: string; /** * The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC". */ type: string; } interface GetLogAnalyticsResourceCategoriesListItem { /** * The category name to which this resource belongs. */ categoryName: string; /** * The compartment id in which to list resources. */ compartmentId: string; /** * The system flag. A value of false denotes a user-created category assignment. A value of true denotes an Oracle-defined category assignment. */ isSystem: boolean; /** * The resource display name. */ resourceDisplayName: string; /** * The unique identifier of the resource, usually a name or ocid. */ resourceId: string; /** * The resource type. */ resourceType: string; } interface GetNamespaceEffectivePropertiesEffectivePropertyCollection { /** * A list of properties and their effective values. */ items: outputs.LogAnalytics.GetNamespaceEffectivePropertiesEffectivePropertyCollectionItem[]; } interface GetNamespaceEffectivePropertiesEffectivePropertyCollectionItem { /** * The effective level of the property value. */ effectiveLevel: string; /** * The property name used for filtering. */ name: string; /** * A list of pattern level override values for the property. */ patterns: outputs.LogAnalytics.GetNamespaceEffectivePropertiesEffectivePropertyCollectionItemPattern[]; /** * The effective value of the property. This is determined by considering the value set at the most effective level. */ value: string; } interface GetNamespaceEffectivePropertiesEffectivePropertyCollectionItemPattern { /** * The effective level of the property value. */ effectiveLevel: string; /** * The pattern id. */ id: string; /** * The effective value of the property. This is determined by considering the value set at the most effective level. */ value: string; } interface GetNamespaceEffectivePropertiesFilter { /** * The property name used for filtering. */ name: string; regex?: boolean; values: string[]; } interface GetNamespaceFieldUsageDependentParser { /** * The list of dependencies defined by the source. */ dependencies: outputs.LogAnalytics.GetNamespaceFieldUsageDependentParserDependency[]; /** * The system flag. A value of false denotes a custom, or user defined object. A value of true denotes a built in object. */ isSystem: boolean; /** * The parser display name. */ parserDisplayName: string; /** * The parser unique identifier. */ parserId: string; /** * The parser name. */ parserName: string; /** * The parser type */ parserType: string; } interface GetNamespaceFieldUsageDependentParserDependency { /** * The display name of the dependency object */ referenceDisplayName: string; /** * The unique identifier of the reference, if available. */ referenceId: string; /** * The name of the dependency object */ referenceName: string; /** * The type of reference that defines the dependency. */ referenceType: string; /** * The dependency type. */ type: string; } interface GetNamespaceFieldUsageDependentSource { /** * The list of dependencies defined by the source. */ dependencies: outputs.LogAnalytics.GetNamespaceFieldUsageDependentSourceDependency[]; /** * The entity types. */ entityTypes: outputs.LogAnalytics.GetNamespaceFieldUsageDependentSourceEntityType[]; /** * A flag indicating whether or not the source is marked for auto association. */ isAutoAssociationEnabled: boolean; /** * The system flag. A value of false denotes a custom, or user defined object. A value of true denotes a built in object. */ isSystem: boolean; /** * The source display name. */ sourceDisplayName: string; /** * The source unique identifier. */ sourceId: string; /** * The source name. */ sourceName: string; /** * The source type. */ sourceType: string; } interface GetNamespaceFieldUsageDependentSourceDependency { /** * The display name of the dependency object */ referenceDisplayName: string; /** * The unique identifier of the reference, if available. */ referenceId: string; /** * The name of the dependency object */ referenceName: string; /** * The type of reference that defines the dependency. */ referenceType: string; /** * The dependency type. */ type: string; } interface GetNamespaceFieldUsageDependentSourceEntityType { /** * The entity type. */ entityType: string; /** * The type category. */ entityTypeCategory: string; /** * The entity type display name. */ entityTypeDisplayName: string; /** * The source unique identifier. */ sourceId: string; } interface GetNamespaceIngestTimeRuleAction { /** * Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Additional dimensions to publish for the extracted metric. A valid list contains the source field names whose values are to be published as dimensions. The source name itself is specified using a special macro SOURCE_NAME */ dimensions: string[]; /** * The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ metricName: string; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: string; /** * The resourceGroup of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ resourceGroup: string; /** * Discriminator. */ type: string; } interface GetNamespaceIngestTimeRuleCondition { /** * Optional additional condition(s) to be evaluated. */ additionalConditions: outputs.LogAnalytics.GetNamespaceIngestTimeRuleConditionAdditionalCondition[]; /** * The field name to be evaluated. */ fieldName: string; /** * The operator to be used for evaluating the field. */ fieldOperator: string; /** * The field value to be evaluated. */ fieldValue: string; /** * Discriminator. */ kind: string; } interface GetNamespaceIngestTimeRuleConditionAdditionalCondition { /** * The additional field name to be evaluated. */ conditionField: string; /** * The operator to be used for evaluating the additional field. */ conditionOperator: string; /** * The additional field value to be evaluated. */ conditionValue: string; } interface GetNamespaceIngestTimeRulesFilter { name: string; regex?: boolean; values: string[]; } interface GetNamespaceIngestTimeRulesIngestTimeRuleSummaryCollection { items: outputs.LogAnalytics.GetNamespaceIngestTimeRulesIngestTimeRuleSummaryCollectionItem[]; } interface GetNamespaceIngestTimeRulesIngestTimeRuleSummaryCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The ingest time rule condition kind used for filtering. Only rules with conditions of the specified kind will be returned. */ conditionKind: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description for this resource. */ description: string; /** * A filter to return rules whose displayName matches in whole or in part the specified value. The match is case-insensitive. */ displayName: string; /** * The field name used for filtering. Only rules using the specified field name will be returned. */ fieldName: string; /** * The field value used for filtering. Only rules using the specified field value will be returned. */ fieldValue: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. */ id: string; /** * A flag indicating whether or not the ingest time rule is enabled. */ isEnabled: boolean; /** * The rule lifecycle state used for filtering. Currently supported values are ACTIVE and DELETED. */ state: string; /** * The date and time the resource was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the resource was last updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetNamespaceLookupCategory { /** * The lookup description. */ description: string; /** * The field display name. */ displayName: string; /** * The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category. */ isSystem: boolean; /** * The field name. */ name: string; /** * The lookup type. Valid values are Lookup, Dictionary or Module. */ type: string; } interface GetNamespaceLookupField { /** * The common field name. */ commonFieldName: string; /** * The default match value. */ defaultMatchValue: string; /** * The field display name. */ displayName: string; /** * A flag indicating whether or not the lookup field is a common field. */ isCommonField: boolean; /** * The match operator. */ matchOperator: string; /** * The field name. */ name: string; /** * THe field position. */ position: string; } interface GetNamespaceLookupReferringSource { /** * The canonical link. */ canonicalLink: string; /** * The total count. */ totalCount: string; } interface GetNamespaceLookupStatusSummary { /** * The number of chunks processed. */ chunksProcessed: string; /** * The failure details, if any. */ failureDetails: string; /** * The filename. */ filename: string; /** * The status. */ status: string; /** * The total number of chunks. */ totalChunks: string; } interface GetNamespaceParserActionsFilter { /** * The parser action name used for filtering. */ name: string; regex?: boolean; values: string[]; } interface GetNamespaceParserActionsParserActionSummaryCollection { /** * An array of parser action summary objects. */ items: outputs.LogAnalytics.GetNamespaceParserActionsParserActionSummaryCollectionItem[]; } interface GetNamespaceParserActionsParserActionSummaryCollectionItem { /** * The parser action description. */ description: string; /** * The parser action display name. */ displayName: string; /** * The parser action name used for filtering. */ name: string; } interface GetNamespacePropertiesMetadataFilter { /** * The property name used for filtering. */ name: string; regex?: boolean; values: string[]; } interface GetNamespacePropertiesMetadataPropertyMetadataSummaryCollection { /** * An array of properties along with their metadata summary. */ items: outputs.LogAnalytics.GetNamespacePropertiesMetadataPropertyMetadataSummaryCollectionItem[]; } interface GetNamespacePropertiesMetadataPropertyMetadataSummaryCollectionItem { /** * The default property value. */ defaultValue: string; /** * The property description. */ description: string; /** * The property display name. */ displayName: string; /** * A list of levels at which the property could be defined. */ levels: outputs.LogAnalytics.GetNamespacePropertiesMetadataPropertyMetadataSummaryCollectionItemLevel[]; /** * The property name used for filtering. */ name: string; } interface GetNamespacePropertiesMetadataPropertyMetadataSummaryCollectionItemLevel { /** * The constraints that apply to the properties at a certain level. */ constraints: string; /** * The property name used for filtering. */ name: string; } interface GetNamespaceRulesFilter { name: string; regex?: boolean; values: string[]; } interface GetNamespaceRulesRuleSummaryCollection { /** * An array of rule summary objects. */ items: outputs.LogAnalytics.GetNamespaceRulesRuleSummaryCollectionItem[]; } interface GetNamespaceRulesRuleSummaryCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description for this resource. */ description: string; /** * A filter to return rules whose displayName matches in whole or in part the specified value. The match is case-insensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. */ id: string; /** * A flag indicating whether or not the ingest time rule or scheduled task is enabled. */ isEnabled: boolean; /** * The rule kind used for filtering. Only rules of the specified kind will be returned. */ kind: string; /** * The most recent task execution status. */ lastExecutionStatus: string; /** * The rule lifecycle state used for filtering. Currently supported values are ACTIVE and DELETED. */ state: string; /** * The target service to use for filtering. */ targetService: string; /** * The task status of the rule. */ taskStatus: string; /** * The date and time the resource was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the scheduled task last executed, in the format defined by RFC3339. */ timeLastExecuted: string; /** * The date and time the resource was last updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetNamespaceScheduledTaskAction { /** * if true, purge child compartments data */ compartmentIdInSubtree: boolean; /** * the type of the log data to be purged */ dataType: string; /** * Specify metric extraction for SAVED_SEARCH scheduled task execution to post to Oracle Cloud Infrastructure Monitoring. */ metricExtractions: outputs.LogAnalytics.GetNamespaceScheduledTaskActionMetricExtraction[]; /** * the compartment OCID under which the data will be purged */ purgeCompartmentId: string; /** * The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W). */ purgeDuration: string; /** * Purge query string. */ queryString: string; /** * The ManagementSavedSearch id [OCID] utilized in the action. */ savedSearchId: string; /** * details for scheduled task using template */ templateDetails: outputs.LogAnalytics.GetNamespaceScheduledTaskActionTemplateDetail[]; /** * Schedule type discriminator. */ type: string; } interface GetNamespaceScheduledTaskActionMetricExtraction { /** * Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Details for the metrics to be collected. */ metricCollections: outputs.LogAnalytics.GetNamespaceScheduledTaskActionMetricExtractionMetricCollection[]; /** * The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ metricName: string; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: string; /** * The resource group of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ resourceGroup: string; } interface GetNamespaceScheduledTaskActionMetricExtractionMetricCollection { /** * Selected dimension fields for the metric collection. */ dimensions: outputs.LogAnalytics.GetNamespaceScheduledTaskActionMetricExtractionMetricCollectionDimension[]; /** * The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ metricName: string; /** * Output field in the query to be used as the metric value. */ metricQueryFieldName: string; /** * Output table in the query. */ queryTableName: string; } interface GetNamespaceScheduledTaskActionMetricExtractionMetricCollectionDimension { /** * Dimension name to be stored with the metric. */ dimensionName: string; /** * Output field in the query to be used as the source for the metric dimension. */ queryFieldName: string; } interface GetNamespaceScheduledTaskActionTemplateDetail { /** * The Config template Id of a particular template. */ templateId: string; /** * To store macro params. */ templateParams: outputs.LogAnalytics.GetNamespaceScheduledTaskActionTemplateDetailTemplateParam[]; } interface GetNamespaceScheduledTaskActionTemplateDetailTemplateParam { /** * Contains macro parameter's names. */ keyField: string; /** * Contains macro parameter's value. */ valueField: string; } interface GetNamespaceScheduledTaskSchedule { schedules: outputs.LogAnalytics.GetNamespaceScheduledTaskScheduleSchedule[]; } interface GetNamespaceScheduledTaskScheduleSchedule { /** * Value in cron format. */ expression: string; /** * Schedule misfire retry policy. */ misfirePolicy: string; /** * Number of seconds to offset the query time window by to accommodate capture late arriving data. For example, a schedule run at 12:00 with a 10 minute interval and queryOffsetSecs=120 will use the query time window of 11:48-11:58 rather than 11:50-12:00 without queryOffsetSecs. */ queryOffsetSecs: number; /** * Recurring interval in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M). */ recurringInterval: string; /** * Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once. */ repeatCount: number; /** * End time for the schedule, even if the schedule would otherwise have remaining executions. */ timeEnd: string; /** * Time zone, by default UTC. */ timeZone: string; /** * Schedule type discriminator. */ type: string; } interface GetNamespaceScheduledTasksFilter { name: string; regex?: boolean; values: string[]; } interface GetNamespaceScheduledTasksScheduledTaskCollection { items: outputs.LogAnalytics.GetNamespaceScheduledTasksScheduledTaskCollectionItem[]; } interface GetNamespaceScheduledTasksScheduledTaskCollectionItem { /** * Action for scheduled task. */ actions: outputs.LogAnalytics.GetNamespaceScheduledTasksScheduledTaskCollectionItemAction[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description for this resource. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the data plane resource. */ id: string; kind: string; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: string; /** * Number of execution occurrences. */ numOccurrences: string; /** * The ManagementSavedSearch id [OCID] utilized in the action. */ savedSearchId: string; scheduledTaskId: string; /** * Schedules. */ schedules: outputs.LogAnalytics.GetNamespaceScheduledTasksScheduledTaskCollectionItemSchedule[]; /** * The current state of the scheduled task. */ state: string; /** * Status of the scheduled task. - PURGE_RESOURCE_NOT_FOUND - LIMIT_EXCEEDED */ taskStatus: string; /** * Required parameter to specify schedule task type. */ taskType: string; /** * The date and time the scheduled task was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the scheduled task was last updated, in the format defined by RFC3339. */ timeUpdated: string; /** * most recent Work Request Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request. */ workRequestId: string; } interface GetNamespaceScheduledTasksScheduledTaskCollectionItemAction { /** * if true, purge child compartments data */ compartmentIdInSubtree: boolean; /** * the type of the log data to be purged */ dataType: string; /** * Specify metric extraction for SAVED_SEARCH scheduled task execution to post to Oracle Cloud Infrastructure Monitoring. */ metricExtractions: outputs.LogAnalytics.GetNamespaceScheduledTasksScheduledTaskCollectionItemActionMetricExtraction[]; /** * the compartment OCID under which the data will be purged */ purgeCompartmentId: string; /** * The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W). */ purgeDuration: string; /** * Purge query string. */ queryString: string; /** * The ManagementSavedSearch id [OCID] utilized in the action. */ savedSearchId: string; /** * details for scheduled task using template */ templateDetails: outputs.LogAnalytics.GetNamespaceScheduledTasksScheduledTaskCollectionItemActionTemplateDetail[]; /** * Schedule type discriminator. */ type: string; } interface GetNamespaceScheduledTasksScheduledTaskCollectionItemActionMetricExtraction { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Details for the metrics to be collected. */ metricCollections: outputs.LogAnalytics.GetNamespaceScheduledTasksScheduledTaskCollectionItemActionMetricExtractionMetricCollection[]; /** * The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ metricName: string; /** * The Log Analytics namespace used for the request. The namespace can be obtained by running 'oci os ns get' */ namespace: string; /** * The resourceGroup of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ resourceGroup: string; } interface GetNamespaceScheduledTasksScheduledTaskCollectionItemActionMetricExtractionMetricCollection { /** * Selected dimension fields for the metric collection. */ dimensions: outputs.LogAnalytics.GetNamespaceScheduledTasksScheduledTaskCollectionItemActionMetricExtractionMetricCollectionDimension[]; /** * The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ metricName: string; /** * Output field in the query to be used as the metric value. */ metricQueryFieldName: string; /** * Output table in the query. */ queryTableName: string; } interface GetNamespaceScheduledTasksScheduledTaskCollectionItemActionMetricExtractionMetricCollectionDimension { /** * Dimension name to be stored with the metric. */ dimensionName: string; /** * Output field in the query to be used as the source for the metric dimension. */ queryFieldName: string; } interface GetNamespaceScheduledTasksScheduledTaskCollectionItemActionTemplateDetail { /** * A filter to return only scheduled tasks whose stream action templateId matches the given id exactly. */ templateId: string; /** * To store macro params. */ templateParams: outputs.LogAnalytics.GetNamespaceScheduledTasksScheduledTaskCollectionItemActionTemplateDetailTemplateParam[]; } interface GetNamespaceScheduledTasksScheduledTaskCollectionItemActionTemplateDetailTemplateParam { /** * Contains macro parameter's names. */ keyField: string; /** * Contains macro parameter's value. */ valueField: string; } interface GetNamespaceScheduledTasksScheduledTaskCollectionItemSchedule { schedules: outputs.LogAnalytics.GetNamespaceScheduledTasksScheduledTaskCollectionItemScheduleSchedule[]; } interface GetNamespaceScheduledTasksScheduledTaskCollectionItemScheduleSchedule { /** * Value in cron format. */ expression: string; /** * Schedule misfire retry policy. */ misfirePolicy: string; /** * Number of seconds to offset the query time window by to accommodate capture late arriving data. For example, a schedule run at 12:00 with a 10 minute interval and queryOffsetSecs=120 will use the query time window of 11:48-11:58 rather than 11:50-12:00 without queryOffsetSecs. */ queryOffsetSecs: number; /** * Recurring interval in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M). */ recurringInterval: string; /** * Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once. */ repeatCount: number; /** * End time for the schedule, even if the schedule would otherwise have remaining executions. */ timeEnd: string; /** * Time zone, by default UTC. */ timeZone: string; /** * Schedule type discriminator. */ type: string; } interface GetNamespaceStorageArchivalConfigArchivingConfiguration { /** * This is the duration data in active storage before data is archived, as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P365D (not P1Y) or P14D (not P2W). */ activeStorageDuration: string; /** * This is the duration before archived data is deleted from object storage, as described in https://en.wikipedia.org/wiki/ISO_8601#Durations The largest supported unit is D, e.g. P365D (not P1Y) or P14D (not P2W). */ archivalStorageDuration: string; /** * end time of the oldest active CoreGroup */ timeOldestActiveBucketEnded: string; } interface GetNamespaceStorageEncryptionKeyInfoItem { /** * This is the key OCID of the encryption key (null if Oracle-managed). */ keyId: string; /** * This is the source of the encryption key. */ keySource: string; /** * This is the type of data to be encrypted. It can be either active or archival. */ keyType: string; } interface GetNamespaceStorageOverlappingRecallsFilter { name: string; regex?: boolean; values: string[]; } interface GetNamespaceStorageOverlappingRecallsOverlappingRecallCollection { /** * This is the array of overlapping recall requests */ items: outputs.LogAnalytics.GetNamespaceStorageOverlappingRecallsOverlappingRecallCollectionItem[]; } interface GetNamespaceStorageOverlappingRecallsOverlappingRecallCollectionItem { /** * This is the id of the associated recalled data collection */ collectionId: string; /** * This is the user who initiated the recall request */ createdBy: string; /** * This is the list of logsets associated with this recall */ logSets: string; /** * This is the purpose of the recall */ purpose: string; /** * This is the query associated with the recall */ queryString: string; /** * This is the id for the recall request */ recallId: string; /** * This is the status of the recall */ status: string; /** * This is the end of the time range for recalled data */ timeDataEnded: string; /** * This is the start of the time range for recalled data */ timeDataStarted: string; /** * This is the time when the recall operation was started for this recall request */ timeStarted: string; } interface GetNamespaceTemplateFacet { /** * The template name. */ name: string; /** * The facet value. */ value: string; } interface GetNamespaceTemplatesFilter { /** * The template name used for filtering. */ name: string; regex?: boolean; values: string[]; } interface GetNamespaceTemplatesLogAnalyticsTemplateCollection { items: outputs.LogAnalytics.GetNamespaceTemplatesLogAnalyticsTemplateCollectionItem[]; } interface GetNamespaceTemplatesLogAnalyticsTemplateCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Base64 encoded template content. */ content: string; /** * Content format. For example - XML. */ contentFormat: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description for this resource. */ description: string; /** * Facets of the template */ facets: outputs.LogAnalytics.GetNamespaceTemplatesLogAnalyticsTemplateCollectionItemFacet[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud. */ id: string; /** * The system flag. A value of false denotes a custom, or user defined object. A value of true denotes a built in object. */ isSystem: boolean; /** * The template name used for filtering. */ name: string; /** * Base64 encoded template parameters. */ parameters: string; /** * Parameters format. For example - NAME_VALUE_PAIR. */ parametersFormat: string; /** * Base64 encoded parameters metadata definition. */ parametersMetadata: string; /** * The template lifecycle state used for filtering. Currently supported values are ACTIVE and DELETED. */ state: string; /** * The date and time the resource was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the resource was last updated, in the format defined by RFC3339. */ timeUpdated: string; /** * The template type used for filtering. Only templates of the specified type will be returned. */ type: string; } interface GetNamespaceTemplatesLogAnalyticsTemplateCollectionItemFacet { /** * The template name used for filtering. */ name: string; /** * The facet value. */ value: string; } interface GetNamespacesFilter { name: string; regex?: boolean; values: string[]; } interface GetNamespacesNamespaceCollection { items: outputs.LogAnalytics.GetNamespacesNamespaceCollectionItem[]; } interface GetNamespacesNamespaceCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * This indicates if old data can be archived for a tenancy */ isArchivingEnabled: boolean; /** * This indicates if the tenancy is data ever ingested */ isDataEverIngested: boolean; isLogsetEnabled: boolean; /** * This indicates if the tenancy is onboarded to Log Analytics */ isOnboarded: boolean; /** * This is the namespace name of a tenancy */ namespace: string; /** * The current state of the compartment. * * `is_logSet_enabled` - This indicates if the tenancy is logSet enable */ state: string; } interface LogAnalyticsEntityMetadata { /** * (Updatable) An array of entity metadata details. */ items: outputs.LogAnalytics.LogAnalyticsEntityMetadataItem[]; } interface LogAnalyticsEntityMetadataItem { /** * (Updatable) The metadata name. */ name: string; /** * (Updatable) The metadata type. */ type: string; /** * (Updatable) The metadata value. */ value: string; } interface LogAnalyticsEntityTypeProperty { /** * Description for the log analytics entity type property. */ description: string; /** * Log analytics entity type property name. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ name: string; } interface LogAnalyticsImportCustomContentChangeList { /** * A list of field display names with conflicts. */ conflictFieldDisplayNames: string[]; /** * A list of parser names with conflicts. */ conflictParserNames: string[]; /** * A list of source names with conflicts. */ conflictSourceNames: string[]; /** * An array of created field display names. */ createdFieldDisplayNames: string[]; /** * An array of created parser names. */ createdParserNames: string[]; /** * An array of created source names. */ createdSourceNames: string[]; /** * An array of updated field display names. */ updatedFieldDisplayNames: string[]; /** * An array of updated parser names. */ updatedParserNames: string[]; /** * An array of updated source names. */ updatedSourceNames: string[]; } interface LogAnalyticsObjectCollectionRuleOverride { matchType: string; matchValue: string; propertyName: string; propertyValue: string; } interface LogAnalyticsPreferencesManagementItem { /** * The preference name. */ name?: string; /** * The preference value. */ value?: string; } interface NamespaceAssociationAssociationProperty { /** * The name of the association property. */ name: string; /** * A list of pattern level overrides for this property. */ patterns?: outputs.LogAnalytics.NamespaceAssociationAssociationPropertyPattern[]; /** * The value of the association property. */ value?: string; } interface NamespaceAssociationAssociationPropertyPattern { effectiveLevel: string; /** * The pattern id. */ id: string; /** * (Updatable) The value of the property. */ value: string; } interface NamespaceIngestTimeRuleAction { /** * (Updatable) The compartment OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the extracted metric. */ compartmentId: string; /** * (Updatable) Additional dimensions to publish for the extracted metric. A valid list contains the source field names whose values are to be published as dimensions. The source name itself is specified using a special macro SOURCE_NAME */ dimensions: string[]; /** * (Updatable) The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ metricName: string; /** * (Updatable) The namespace of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters and underscores (_). */ namespace: string; /** * (Updatable) The resourceGroup of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ resourceGroup: string; /** * (Updatable) Discriminator. */ type: string; } interface NamespaceIngestTimeRuleConditions { /** * (Updatable) Optional additional condition(s) to be evaluated. */ additionalConditions: outputs.LogAnalytics.NamespaceIngestTimeRuleConditionsAdditionalCondition[]; /** * (Updatable) The field name to be evaluated. */ fieldName: string; /** * (Updatable) The operator to be used for evaluating the field. */ fieldOperator: string; /** * (Updatable) The field value to be evaluated. */ fieldValue: string; /** * (Updatable) Discriminator. */ kind: string; } interface NamespaceIngestTimeRuleConditionsAdditionalCondition { /** * (Updatable) The additional field name to be evaluated. */ conditionField: string; /** * (Updatable) The operator to be used for evaluating the additional field. */ conditionOperator: string; /** * (Updatable) The additional field value to be evaluated. */ conditionValue: string; } interface NamespaceLookupCategory { /** * (Updatable) The category description. */ description: string; /** * (Updatable) The category display name. */ displayName: string; /** * (Updatable) The system flag. A value of false denotes a user-created category. A value of true denotes an Oracle-defined category. */ isSystem: boolean; /** * (Updatable) The unique name that identifies the category. */ name: string; /** * (Updatable) The category type. Values include "PRODUCT", "TIER", "VENDOR" and "GENERIC". */ type: string; } interface NamespaceLookupField { /** * (Updatable) The common field name. */ commonFieldName: string; /** * (Updatable) The default match value. */ defaultMatchValue: string; /** * (Updatable) The display name. */ displayName: string; /** * (Updatable) A flag indicating whether or not the field is a common field. */ isCommonField: boolean; /** * (Updatable) The match operator. */ matchOperator: string; /** * (Updatable) The field name. */ name: string; /** * (Updatable) The position. */ position: string; } interface NamespaceLookupReferringSource { /** * The canonical link. */ canonicalLink: string; /** * The total count. */ totalCount: string; } interface NamespaceLookupStatusSummary { /** * The number of chunks processed. */ chunksProcessed: string; /** * The failure details, if any. */ failureDetails: string; /** * The filename. */ filename: string; /** * The status. */ status: string; /** * The total number of chunks. */ totalChunks: string; } interface NamespaceScheduledTaskAction { /** * if true, purge child compartments data */ compartmentIdInSubtree: boolean; /** * the type of the log data to be purged */ dataType: string; /** * Specify metric extraction for SAVED_SEARCH scheduled task execution to post to Oracle Cloud Infrastructure Monitoring. */ metricExtraction: outputs.LogAnalytics.NamespaceScheduledTaskActionMetricExtraction; /** * the compartment OCID under which the data will be purged */ purgeCompartmentId: string; /** * The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W). */ purgeDuration: string; /** * Purge query string. */ queryString: string; /** * The ManagementSavedSearch id [OCID] utilized in the action. Should not be provided when a template ID is present. */ savedSearchId: string; /** * details for scheduled task using template */ templateDetails: outputs.LogAnalytics.NamespaceScheduledTaskActionTemplateDetails; /** * Action type discriminator. */ type: string; } interface NamespaceScheduledTaskActionMetricExtraction { /** * (Updatable) The compartment OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the extracted metric. */ compartmentId: string; /** * Details for the metrics to be collected. */ metricCollections: outputs.LogAnalytics.NamespaceScheduledTaskActionMetricExtractionMetricCollection[]; /** * The metric name of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ metricName: string; /** * The namespace of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters and underscores (_). */ namespace: string; /** * The resource group of the extracted metric. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ resourceGroup: string; } interface NamespaceScheduledTaskActionMetricExtractionMetricCollection { /** * Selected dimension fields for the metric collection. */ dimensions: outputs.LogAnalytics.NamespaceScheduledTaskActionMetricExtractionMetricCollectionDimension[]; /** * The metric name for this metric collection. A valid value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). */ metricName: string; /** * Output field in the query to be used as the metric value. */ metricQueryFieldName: string; /** * Output table in the query. */ queryTableName: string; } interface NamespaceScheduledTaskActionMetricExtractionMetricCollectionDimension { /** * Dimension name to be stored with the metric. */ dimensionName: string; /** * Output field in the query to be used as the source for the metric dimension. */ queryFieldName: string; } interface NamespaceScheduledTaskActionTemplateDetails { /** * The template Id of a particular template. Should not be provided when a saved search ID is present. */ templateId: string; /** * To store macro params. */ templateParams: outputs.LogAnalytics.NamespaceScheduledTaskActionTemplateDetailsTemplateParam[]; } interface NamespaceScheduledTaskActionTemplateDetailsTemplateParam { /** * Contains a template parameter's name. */ keyField: string; /** * Contains the desired value for a given parameter. */ valueField: string; } interface NamespaceScheduledTaskSchedules { schedules: outputs.LogAnalytics.NamespaceScheduledTaskSchedulesSchedule[]; } interface NamespaceScheduledTaskSchedulesSchedule { /** * Value in cron format. */ expression: string; /** * Schedule misfire retry policy. */ misfirePolicy: string; /** * Number of seconds to offset the query time window by to accommodate capture late arriving data. For example, a schedule run at 12:00 with a 10 minute interval and queryOffsetSecs=120 will use the query time window of 11:48-11:58 rather than 11:50-12:00 without queryOffsetSecs. */ queryOffsetSecs: number; /** * Recurring interval in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M). */ recurringInterval: string; /** * Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once. */ repeatCount: number; /** * End time for the schedule, even if the schedule would otherwise have remaining executions. */ timeEnd: string; /** * Time zone, by default UTC. */ timeZone: string; /** * Schedule type discriminator. */ type: string; } interface NamespaceStorageArchivalConfigArchivingConfiguration { /** * (Updatable) This is the duration data in active storage before data is archived, as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P365D (not P1Y) or P14D (not P2W). */ activeStorageDuration: string; /** * (Updatable) This is the duration before archived data is deleted from object storage, as described in https://en.wikipedia.org/wiki/ISO_8601#Durations The largest supported unit is D, e.g. P365D (not P1Y) or P14D (not P2W). */ archivalStorageDuration: string; /** * (Updatable) end time of the oldest active CoreGroup */ timeOldestActiveBucketEnded: string; } } export declare namespace Logging { interface GetLogConfiguration { /** * The OCID of the compartment that the resource belongs to. */ compartmentId: string; /** * The source the log object comes from. */ sources: outputs.Logging.GetLogConfigurationSource[]; } interface GetLogConfigurationSource { /** * Log object category. */ category: string; /** * Log category parameters are stored here. The resource for a service log can't be updated. */ parameters: { [key: string]: string; }; /** * The unique identifier of the resource emitting the log. The resource can be updated, and the resource value can vary depending on the Oracle Cloud Infrastructure service to which the resource belongs to. */ resource: string; /** * Service generating log. */ service: string; /** * The log source. * * **OCISERVICE:** Oracle Service. */ sourceType: string; } interface GetLogGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetLogGroupsLogGroup { /** * Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description for this resource. */ description: string; /** * Resource name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the resource. */ id: string; /** * The log group object state. */ state: string; /** * Time the resource was created. */ timeCreated: string; /** * Time the resource was last modified. */ timeLastModified: string; } interface GetLogSavedSearchesFilter { /** * Resource name. */ name: string; regex?: boolean; values: string[]; } interface GetLogSavedSearchesLogSavedSearchSummaryCollection { items: outputs.Logging.GetLogSavedSearchesLogSavedSearchSummaryCollectionItem[]; } interface GetLogSavedSearchesLogSavedSearchSummaryCollectionItem { /** * Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description for this resource. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the resource. */ id: string; /** * Resource name. */ name: string; /** * The search query that is saved. */ query: string; /** * The state of the LogSavedSearch */ state: string; /** * Time the resource was created. */ timeCreated: string; /** * Time the resource was last modified. */ timeLastModified: string; } interface GetLogsFilter { name: string; regex?: boolean; values: string[]; } interface GetLogsLog { /** * The OCID of the compartment that the resource belongs to. */ compartmentId: string; /** * Log object configuration. */ configurations: outputs.Logging.GetLogsLogConfiguration[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Resource name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the resource. */ id: string; /** * Whether or not this resource is currently enabled. */ isEnabled: boolean; /** * OCID of a log group to work with. */ logGroupId: string; /** * The logType that the log object is for, whether custom or service. */ logType: string; /** * Log retention duration in 30-day increments (30, 60, 90 and so on until 180). */ retentionDuration: number; /** * Lifecycle state of the log object */ state: string; /** * The OCID of the tenancy. */ tenancyId: string; /** * Time the resource was created. */ timeCreated: string; /** * Time the resource was last modified. */ timeLastModified: string; } interface GetLogsLogConfiguration { /** * The OCID of the compartment that the resource belongs to. */ compartmentId: string; /** * The source the log object comes from. */ sources: outputs.Logging.GetLogsLogConfigurationSource[]; } interface GetLogsLogConfigurationSource { /** * Log object category. */ category: string; /** * Log category parameters are stored here. The resource for a service log can't be updated. */ parameters: { [key: string]: string; }; /** * The unique identifier of the resource emitting the log. The resource can be updated, and the resource value can vary depending on the Oracle Cloud Infrastructure service to which the resource belongs to. */ resource: string; /** * Service generating log. */ service: string; /** * The log source. * * **OCISERVICE:** Oracle Service. */ sourceType: string; } interface GetUnifiedAgentConfigurationGroupAssociation { /** * list of group/dynamic group ids associated with this configuration. */ groupLists: string[]; } interface GetUnifiedAgentConfigurationServiceConfiguration { /** * Unified Agent monitoring application configuration details. */ applicationConfigurations: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationApplicationConfiguration[]; /** * Type of Unified Agent service configuration. */ configurationType: string; /** * Unified monitoring agent operational metrics destination object. */ destinations: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationDestination[]; /** * Logging source object. */ sources: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationSource[]; /** * Logging filter object. */ unifiedAgentConfigurationFilters: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilter[]; } interface GetUnifiedAgentConfigurationServiceConfigurationApplicationConfiguration { /** * Unified monitoring agent operational metrics destination object. */ destinations: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationDestination[]; /** * Unified monitoring agent operational metrics source object. */ source: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource[]; /** * Unified schema logging source type. */ sourceType: string; /** * Logging source object. */ sources: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource[]; /** * Logging filter object. */ unifiedAgentConfigurationFilters: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationUnifiedAgentConfigurationFilter[]; } interface GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationDestination { /** * The OCID of the compartment that the resource belongs to. */ compartmentId: string; /** * Namespace to which metrics will be emitted. */ metricsNamespace: string; } interface GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource { /** * Advanced options for logging configuration */ advancedOptions: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceAdvancedOption[]; /** * The name key to tag this Grok pattern. */ name: string; /** * Source parser object. */ parsers: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParser[]; /** * Absolute paths for log source files. Wildcards can be used. */ paths: string[]; /** * Unified schema logging source type. */ sourceType: string; } interface GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceAdvancedOption { /** * Starts to read the logs from the head of the file or the last read position recorded in pos_file, not tail. */ isReadFromHead: boolean; } interface GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParser { /** * CSV delimiter. */ delimiter: string; /** * Regex pattern. */ expression: string; /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * First line pattern format. */ formatFirstline: string; /** * Mutiline pattern format. */ formats: string[]; /** * Grok failure key. */ grokFailureKey: string; /** * Grok name key. */ grokNameKey: string; /** * If true, use Fluent::EventTime.now(current time) as a timestamp when the timeKey is specified. */ isEstimateCurrentEvent: boolean; /** * If true, keep the time field in the record. */ isKeepTimeKey: boolean; /** * If you don't need stream or logtag fields, set this to false. */ isMergeCriFields: boolean; /** * If true, an empty string field is replaced with a null value. */ isNullEmptyString: boolean; /** * Specifies whether or not to support colonless ident. Corresponds to the Fluentd supportColonlessIdent parameter. */ isSupportColonlessIdent: boolean; /** * Specifies with priority or not. Corresponds to the Fluentd withPriority parameter. */ isWithPriority: boolean; /** * CSV keys. */ keys: string[]; /** * Syslog message format. */ messageFormat: string; /** * Specifies the field name to contain logs. */ messageKey: string; /** * Multiline start regexp pattern. */ multiLineStartRegexp: string; /** * Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey. */ nestedParsers: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserNestedParser[]; /** * Specify the null value pattern. */ nullValuePattern: string; /** * If true, a separator parameter can be further defined. */ parseNested: boolean; /** * Type of fluent parser. */ parserType: string; /** * Grok pattern object. */ patterns: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserPattern[]; /** * record section of openmetrics parser. */ recordInputs: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserRecordInput[]; /** * RFC 5424 time format. */ rfc5424timeFormat: string; /** * Keys of adjacent levels are joined by the separator. */ separator: string; /** * Syslog parser type. */ syslogParserType: string; /** * Process time value using the specified format. */ timeFormat: string; /** * JSON parser time type. */ timeType: string; /** * Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. */ timeoutInMilliseconds: number; /** * Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user timeKey time */ types: { [key: string]: string; }; } interface GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserNestedParser { /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * If true, keep the time field in the record. */ isKeepTimeKey: boolean; /** * If true, a separator parameter can be further defined. */ parseNested: boolean; /** * Keys of adjacent levels are joined by the separator. */ separator: string; /** * Process time value using the specified format. */ timeFormat: string; /** * JSON parser time type. */ timeType: string; } interface GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserPattern { /** * Process value using the specified format. This is available only when timeType is a string. */ fieldTimeFormat: string; /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * Use the specified time zone. The time value can be parsed or formatted in the specified time zone. */ fieldTimeZone: string; /** * The name key to tag this Grok pattern. */ name: string; /** * The Grok pattern. */ pattern: string; } interface GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserRecordInput { /** * Dimensions to be added for metrics. */ dimensions: { [key: string]: string; }; /** * Namespace to emit metrics. */ namespace: string; /** * Resource group to emit metrics. */ resourceGroup: string; } interface GetUnifiedAgentConfigurationServiceConfigurationApplicationConfigurationUnifiedAgentConfigurationFilter { /** * A list of filtering rules to include logs */ allowLists: string[]; /** * A list of filtering rules to reject logs */ denyLists: string[]; /** * Unified schema logging filter type. */ filterType: string; /** * The name key to tag this Grok pattern. */ name: string; } interface GetUnifiedAgentConfigurationServiceConfigurationDestination { /** * The OCID of the resource. */ logObjectId: string; /** * Unified monitoring agent operational metrics configuration object. */ operationalMetricsConfigurations: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfiguration[]; } interface GetUnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfiguration { /** * Unified monitoring agent operational metrics destination object. */ destinations: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationDestination[]; /** * Unified monitoring agent operational metrics source object. */ sources: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSource[]; } interface GetUnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationDestination { /** * The OCID of the compartment that the resource belongs to. */ compartmentId: string; } interface GetUnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSource { /** * List of unified monitoring agent operational metrics. */ metrics: string[]; /** * record section of openmetrics parser. */ recordInputs: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSourceRecordInput[]; /** * Type of the unified monitoring agent operational metrics source object. */ type: string; } interface GetUnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSourceRecordInput { /** * Namespace to emit metrics. */ namespace: string; /** * Resource group to emit metrics. */ resourceGroup: string; } interface GetUnifiedAgentConfigurationServiceConfigurationSource { /** * Advanced options for logging configuration */ advancedOptions: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationSourceAdvancedOption[]; /** * Windows event log channels. */ channels: string[]; /** * User customized source plugin. */ customPlugin: string; /** * The name key to tag this Grok pattern. */ name: string; /** * Source parser object. */ parsers: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationSourceParser[]; /** * Absolute paths for log source files. Wildcards can be used. */ paths: string[]; /** * Unified schema logging source type. */ sourceType: string; } interface GetUnifiedAgentConfigurationServiceConfigurationSourceAdvancedOption { /** * Starts to read the logs from the head of the file or the last read position recorded in pos_file, not tail. */ isReadFromHead: boolean; } interface GetUnifiedAgentConfigurationServiceConfigurationSourceParser { /** * CSV delimiter. */ delimiter: string; /** * Regex pattern. */ expression: string; /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * First line pattern format. */ formatFirstline: string; /** * Mutiline pattern format. */ formats: string[]; /** * Grok failure key. */ grokFailureKey: string; /** * Grok name key. */ grokNameKey: string; /** * If true, use Fluent::EventTime.now(current time) as a timestamp when the timeKey is specified. */ isEstimateCurrentEvent: boolean; /** * If true, keep the time field in the record. */ isKeepTimeKey: boolean; /** * If you don't need stream or logtag fields, set this to false. */ isMergeCriFields: boolean; /** * If true, an empty string field is replaced with a null value. */ isNullEmptyString: boolean; /** * Specifies whether or not to support colonless ident. Corresponds to the Fluentd supportColonlessIdent parameter. */ isSupportColonlessIdent: boolean; /** * Specifies with priority or not. Corresponds to the Fluentd withPriority parameter. */ isWithPriority: boolean; /** * CSV keys. */ keys: string[]; /** * Syslog message format. */ messageFormat: string; /** * Specifies the field name to contain logs. */ messageKey: string; /** * Multiline start regexp pattern. */ multiLineStartRegexp: string; /** * Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey. */ nestedParsers: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationSourceParserNestedParser[]; /** * Specify the null value pattern. */ nullValuePattern: string; /** * If true, a separator parameter can be further defined. */ parseNested: boolean; /** * Type of fluent parser. */ parserType: string; /** * Grok pattern object. */ patterns: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationSourceParserPattern[]; /** * record section of openmetrics parser. */ recordInputs: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationSourceParserRecordInput[]; /** * RFC 5424 time format. */ rfc5424timeFormat: string; /** * Keys of adjacent levels are joined by the separator. */ separator: string; /** * Syslog parser type. */ syslogParserType: string; /** * Process time value using the specified format. */ timeFormat: string; /** * JSON parser time type. */ timeType: string; /** * Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. */ timeoutInMilliseconds: number; /** * Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user timeKey time */ types: { [key: string]: string; }; } interface GetUnifiedAgentConfigurationServiceConfigurationSourceParserNestedParser { /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * If true, keep the time field in the record. */ isKeepTimeKey: boolean; /** * If true, a separator parameter can be further defined. */ parseNested: boolean; /** * Keys of adjacent levels are joined by the separator. */ separator: string; /** * Process time value using the specified format. */ timeFormat: string; /** * JSON parser time type. */ timeType: string; } interface GetUnifiedAgentConfigurationServiceConfigurationSourceParserPattern { /** * Process value using the specified format. This is available only when timeType is a string. */ fieldTimeFormat: string; /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * Use the specified time zone. The time value can be parsed or formatted in the specified time zone. */ fieldTimeZone: string; /** * The name key to tag this Grok pattern. */ name: string; /** * The Grok pattern. */ pattern: string; } interface GetUnifiedAgentConfigurationServiceConfigurationSourceParserRecordInput { /** * Dimensions to be added for metrics. */ dimensions: { [key: string]: string; }; /** * Namespace to emit metrics. */ namespace: string; /** * Resource group to emit metrics. */ resourceGroup: string; } interface GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilter { /** * A list of filtering rules to include logs */ allowLists: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterAllowList[]; /** * Type of the custom filter */ customFilterType: string; /** * List of custom sections in custom filter */ customSections: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterCustomSection[]; /** * A list of filtering rules to reject logs */ denyLists: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterDenyList[]; /** * If true, emit invalid record to @ERROR label. Invalid cases are: 1) key does not exist; 2) the format does not match; or 3) an unexpected error. You can rescue unexpected format logs in the @ERROR lable. If you want to ignore these errors, set this to false. */ emitInvalidRecordToError: boolean; /** * Unified schema logging filter type. */ filterType: string; /** * Store the parsed values as a hash value in a field. */ hashValueField: string; /** * Store the parsed values with the specified key name prefix. */ injectKeyPrefix: string; /** * If true, automatically casts the field types. */ isAutoTypecastEnabled: boolean; /** * If true, it modifies a new empty hash */ isRenewRecordEnabled: boolean; /** * When set to true, the full Ruby syntax is enabled in the ${} expression. */ isRubyEnabled: boolean; /** * A list of keys to keep. Only relevant if isRenewRecordEnabled is set to true */ keepKeys: string[]; /** * The field name in the record to parse. */ keyName: string; /** * The name key to tag this Grok pattern. */ name: string; /** * Parameters of the custom filter */ params: { [key: string]: string; }; /** * Source parser object. */ parsers: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParser[]; /** * Add new key-value pairs in logs */ recordLists: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterRecordList[]; /** * If true, remove the keyName field when parsing is succeeded. */ removeKeyNameField: boolean; /** * A list of keys to delete */ removeKeys: string[]; /** * Overwrites the time of logs with this value, this value must be a Unix timestamp. */ renewTimeKey: string; /** * If true, the invalid string is replaced with safe characters and is re-parsed. */ replaceInvalidSequence: boolean; /** * If true, keep the original key-value pair in the parsed result. */ reserveData: boolean; /** * If true, keep the original event time in the parsed result. */ reserveTime: boolean; } interface GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterAllowList { /** * A new key */ key: string; /** * The Grok pattern. */ pattern: string; } interface GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterCustomSection { /** * The name key to tag this Grok pattern. */ name: string; /** * Parameters of the custom filter */ params: { [key: string]: string; }; } interface GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterDenyList { /** * A new key */ key: string; /** * The Grok pattern. */ pattern: string; } interface GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParser { /** * CSV delimiter. */ delimiter: string; /** * Regex pattern. */ expression: string; /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * First line pattern format. */ formatFirstline: string; /** * Mutiline pattern format. */ formats: string[]; /** * Grok failure key. */ grokFailureKey: string; /** * Grok name key. */ grokNameKey: string; /** * If true, use Fluent::EventTime.now(current time) as a timestamp when the timeKey is specified. */ isEstimateCurrentEvent: boolean; /** * If true, keep the time field in the record. */ isKeepTimeKey: boolean; /** * If you don't need stream or logtag fields, set this to false. */ isMergeCriFields: boolean; /** * If true, an empty string field is replaced with a null value. */ isNullEmptyString: boolean; /** * Specifies whether or not to support colonless ident. Corresponds to the Fluentd supportColonlessIdent parameter. */ isSupportColonlessIdent: boolean; /** * Specifies with priority or not. Corresponds to the Fluentd withPriority parameter. */ isWithPriority: boolean; /** * CSV keys. */ keys: string[]; /** * Syslog message format. */ messageFormat: string; /** * Specifies the field name to contain logs. */ messageKey: string; /** * Multiline start regexp pattern. */ multiLineStartRegexp: string; /** * Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey. */ nestedParsers: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserNestedParser[]; /** * Specify the null value pattern. */ nullValuePattern: string; /** * If true, a separator parameter can be further defined. */ parseNested: boolean; /** * Type of fluent parser. */ parserType: string; /** * Grok pattern object. */ patterns: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserPattern[]; /** * record section of openmetrics parser. */ recordInputs: outputs.Logging.GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserRecordInput[]; /** * RFC 5424 time format. */ rfc5424timeFormat: string; /** * Keys of adjacent levels are joined by the separator. */ separator: string; /** * Syslog parser type. */ syslogParserType: string; /** * Process time value using the specified format. */ timeFormat: string; /** * JSON parser time type. */ timeType: string; /** * Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. */ timeoutInMilliseconds: number; /** * Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user timeKey time */ types: { [key: string]: string; }; } interface GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserNestedParser { /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * If true, keep the time field in the record. */ isKeepTimeKey: boolean; /** * If true, a separator parameter can be further defined. */ parseNested: boolean; /** * Keys of adjacent levels are joined by the separator. */ separator: string; /** * Process time value using the specified format. */ timeFormat: string; /** * JSON parser time type. */ timeType: string; } interface GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserPattern { /** * Process value using the specified format. This is available only when timeType is a string. */ fieldTimeFormat: string; /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * Use the specified time zone. The time value can be parsed or formatted in the specified time zone. */ fieldTimeZone: string; /** * The name key to tag this Grok pattern. */ name: string; /** * The Grok pattern. */ pattern: string; } interface GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserRecordInput { /** * Dimensions to be added for metrics. */ dimensions: { [key: string]: string; }; /** * Namespace to emit metrics. */ namespace: string; /** * Resource group to emit metrics. */ resourceGroup: string; } interface GetUnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterRecordList { /** * A new key */ key: string; /** * A new value */ value: string; } interface GetUnifiedAgentConfigurationsFilter { /** * The name key to tag this Grok pattern. */ name: string; regex?: boolean; values: string[]; } interface GetUnifiedAgentConfigurationsUnifiedAgentConfigurationCollection { items: outputs.Logging.GetUnifiedAgentConfigurationsUnifiedAgentConfigurationCollectionItem[]; } interface GetUnifiedAgentConfigurationsUnifiedAgentConfigurationCollectionItem { /** * Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal. */ compartmentId: string; /** * State of unified agent service configuration. */ configurationState: string; /** * Type of Unified Agent service configuration. */ configurationType: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description for this resource. */ description: string; /** * Resource name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the resource. */ id: string; /** * Whether or not this resource is currently enabled. */ isEnabled: boolean; /** * Lifecycle state of the log object */ state: string; /** * Time the resource was created. */ timeCreated: string; /** * Time the resource was last modified. */ timeLastModified: string; } interface LogConfiguration { /** * The OCID of the compartment that the resource belongs to. */ compartmentId: string; /** * The source the log object comes from. */ source: outputs.Logging.LogConfigurationSource; } interface LogConfigurationSource { /** * Log object category. */ category: string; /** * (Updatable) Log category parameters are stored here. The resource for a service log can't be updated. */ parameters: { [key: string]: string; }; /** * The unique identifier of the resource emitting the log. The resource can be updated, and the resource value can vary depending on the Oracle Cloud Infrastructure service to which the resource belongs to. */ resource: string; /** * Service generating log. */ service: string; /** * The log source. * * **OCISERVICE:** Oracle Service. */ sourceType: string; } interface UnifiedAgentConfigurationGroupAssociation { /** * (Updatable) list of group/dynamic group ids associated with this configuration. */ groupLists: string[]; } interface UnifiedAgentConfigurationServiceConfiguration { /** * (Updatable) Unified Agent monitoring application configuration details. */ applicationConfigurations: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationApplicationConfiguration[]; /** * (Updatable) Type of Unified Agent service configuration. */ configurationType: string; /** * (Updatable) Logging destination object. */ destination?: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationDestination; /** * (Updatable) Logging source object. */ sources?: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationSource[]; /** * (Updatable) Logging filter object. */ unifiedAgentConfigurationFilters: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilter[]; } interface UnifiedAgentConfigurationServiceConfigurationApplicationConfiguration { /** * (Updatable) Kubernetes destination object. */ destination: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationDestination; /** * (Updatable) Kubernetes source object. */ source: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource; /** * (Updatable) Type of source of metrics */ sourceType: string; /** * (Updatable) Tail log source objects. */ sources: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource[]; /** * (Updatable) Kubernetes filter object */ unifiedAgentConfigurationFilter: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationUnifiedAgentConfigurationFilter; } interface UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationDestination { /** * (Updatable) The OCID of the compartment that the resource belongs to. */ compartmentId: string; /** * (Updatable) Namespace to which metrics will be emitted. */ metricsNamespace: string; } interface UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSource { /** * (Updatable) Advanced options for logging configuration */ advancedOptions: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceAdvancedOptions; /** * (Updatable) Unique name for the source. */ name: string; /** * (Updatable) Source parser object. */ parser: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParser; /** * (Updatable) Absolute paths for log source files. Wildcards can be used. */ paths: string[]; /** * (Updatable) Unified schema logging source type. */ sourceType: string; } interface UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceAdvancedOptions { /** * (Updatable) Starts to read the logs from the head of the file or the last read position recorded in pos_file, not tail. */ isReadFromHead: boolean; } interface UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParser { /** * (Updatable) CSV delimiter. */ delimiter: string; /** * (Updatable) Regex pattern. */ expression: string; /** * (Updatable) Specifies the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * (Updatable) First line pattern format. */ formatFirstline: string; /** * (Updatable) Mutiline pattern format. */ formats: string[]; /** * (Updatable) Grok failure key. */ grokFailureKey: string; /** * (Updatable) Grok name key. */ grokNameKey: string; /** * (Updatable) If true, use Fluent::EventTime.now(current time) as a timestamp when the timeKey is specified. */ isEstimateCurrentEvent?: boolean; /** * (Updatable) If true, keep the time field in the record. */ isKeepTimeKey?: boolean; /** * (Updatable) If you don't need stream or logtag fields, set this to false. */ isMergeCriFields: boolean; /** * (Updatable) If true, an empty string field is replaced with a null value. */ isNullEmptyString?: boolean; /** * (Updatable) Specifies whether or not to support colonless ident. Corresponds to the Fluentd supportColonlessIdent parameter. */ isSupportColonlessIdent: boolean; /** * (Updatable) Specifies with priority or not. Corresponds to the Fluentd withPriority parameter. */ isWithPriority: boolean; /** * (Updatable) CSV keys. */ keys: string[]; /** * (Updatable) Syslog message format. */ messageFormat: string; /** * (Updatable) Specifies the field name to contain logs. */ messageKey: string; /** * (Updatable) Multiline start regexp pattern. */ multiLineStartRegexp: string; /** * (Updatable) Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey. */ nestedParser: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserNestedParser; /** * (Updatable) Specify the null value pattern. */ nullValuePattern: string; /** * (Updatable) If true, a separator parameter can be further defined. */ parseNested: boolean; /** * (Updatable) Type of fluent parser. */ parserType: string; /** * (Updatable) Grok pattern object. */ patterns: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserPattern[]; /** * (Updatable) record section of openmetrics parser. */ recordInput: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserRecordInput; /** * (Updatable) RFC 5424 time format. */ rfc5424timeFormat: string; /** * (Updatable) Keys of adjacent levels are joined by the separator. */ separator: string; /** * (Updatable) Syslog parser type. */ syslogParserType: string; /** * (Updatable) Process time value using the specified format. */ timeFormat: string; /** * (Updatable) JSON parser time type. */ timeType: string; /** * (Updatable) Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. */ timeoutInMilliseconds: number; /** * (Updatable) Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user timeKey time * * This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" * * is parsed as: 1362020400 (2013/02/28/ 12:00:00) * * record: { "host" : "192.168.0.1", "reqId" : "111", "user" : "-" } */ types: { [key: string]: string; }; } interface UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserNestedParser { /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * If true, keep the time field in the record. */ isKeepTimeKey: boolean; /** * (Updatable) If true, a separator parameter can be further defined. */ parseNested: boolean; /** * (Updatable) Keys of adjacent levels are joined by the separator. */ separator: string; /** * (Updatable) Process time value using the specified format. */ timeFormat: string; /** * (Updatable) JSON parser time type. */ timeType: string; } interface UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserPattern { /** * (Updatable) Process value using the specified format. This is available only when timeType is a string. */ fieldTimeFormat: string; /** * (Updatable) Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * (Updatable) Use the specified time zone. The time value can be parsed or formatted in the specified time zone. */ fieldTimeZone: string; /** * (Updatable) The name key to tag this Grok pattern. */ name: string; /** * (Updatable) The Grok pattern. */ pattern: string; } interface UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationSourceParserRecordInput { /** * (Updatable) Dimensions to be added for metrics. */ dimensions: { [key: string]: string; }; /** * (Updatable) Namespace to emit metrics. */ namespace: string; /** * (Updatable) Resource group to emit metrics. */ resourceGroup: string; } interface UnifiedAgentConfigurationServiceConfigurationApplicationConfigurationUnifiedAgentConfigurationFilter { /** * (Updatable) List of metrics regex to be allowed. */ allowLists: string[]; /** * (Updatable) List of metrics regex to be denied. */ denyLists: string[]; /** * (Updatable) Unified schema logging filter type. */ filterType: string; /** * (Updatable) Unique name for the filter. */ name: string; } interface UnifiedAgentConfigurationServiceConfigurationDestination { /** * (Updatable) The OCID of the resource. */ logObjectId: string; /** * (Updatable) Unified monitoring agent operational metrics configuration object. */ operationalMetricsConfiguration: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfiguration; } interface UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfiguration { /** * (Updatable) Unified monitoring agent operational metrics destination object. */ destination: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationDestination; /** * (Updatable) Unified monitoring agent operational metrics source object. */ source: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSource; } interface UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationDestination { /** * (Updatable) The OCID of the compartment that the resource belongs to. */ compartmentId: string; } interface UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSource { /** * (Updatable) List of unified monitoring agent operational metrics. */ metrics: string[]; /** * (Updatable) Record section of OperationalMetricsSource object. */ recordInput: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSourceRecordInput; /** * (Updatable) Type of the unified monitoring agent operational metrics source object. */ type: string; } interface UnifiedAgentConfigurationServiceConfigurationDestinationOperationalMetricsConfigurationSourceRecordInput { /** * (Updatable) Namespace to emit the operational metrics. */ namespace: string; /** * (Updatable) Resource group to emit the operational metrics. */ resourceGroup: string; } interface UnifiedAgentConfigurationServiceConfigurationSource { /** * (Updatable) Advanced options for logging configuration */ advancedOptions: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationSourceAdvancedOptions; /** * (Updatable) Windows event log channels. */ channels: string[]; /** * (Updatable) User customized source plugin. */ customPlugin: string; /** * (Updatable) Unique name for the source. */ name: string; /** * (Updatable) Source parser object. */ parser: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationSourceParser; /** * (Updatable) Absolute paths for log source files. Wildcards can be used. */ paths: string[]; /** * (Updatable) Unified schema logging source type. */ sourceType: string; } interface UnifiedAgentConfigurationServiceConfigurationSourceAdvancedOptions { /** * (Updatable) Starts to read the logs from the head of the file or the last read position recorded in pos_file, not tail. */ isReadFromHead: boolean; } interface UnifiedAgentConfigurationServiceConfigurationSourceParser { /** * (Updatable) CSV delimiter. */ delimiter: string; /** * (Updatable) Regex pattern. */ expression: string; /** * (Updatable) Specifies the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * (Updatable) First line pattern format. */ formatFirstline: string; /** * (Updatable) Mutiline pattern format. */ formats: string[]; /** * (Updatable) Grok failure key. */ grokFailureKey: string; /** * (Updatable) Grok name key. */ grokNameKey: string; /** * (Updatable) If true, use Fluent::EventTime.now(current time) as a timestamp when the timeKey is specified. */ isEstimateCurrentEvent?: boolean; /** * (Updatable) If true, keep the time field in the record. */ isKeepTimeKey?: boolean; /** * (Updatable) If you don't need stream or logtag fields, set this to false. */ isMergeCriFields: boolean; /** * (Updatable) If true, an empty string field is replaced with a null value. */ isNullEmptyString?: boolean; /** * (Updatable) Specifies whether or not to support colonless ident. Corresponds to the Fluentd supportColonlessIdent parameter. */ isSupportColonlessIdent: boolean; /** * (Updatable) Specifies with priority or not. Corresponds to the Fluentd withPriority parameter. */ isWithPriority: boolean; /** * (Updatable) CSV keys. */ keys: string[]; /** * (Updatable) Syslog message format. */ messageFormat: string; /** * (Updatable) Specifies the field name to contain logs. */ messageKey: string; /** * (Updatable) Multiline start regexp pattern. */ multiLineStartRegexp: string; /** * (Updatable) Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey. */ nestedParser: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationSourceParserNestedParser; /** * (Updatable) Specify the null value pattern. */ nullValuePattern: string; /** * (Updatable) If true, a separator parameter can be further defined. */ parseNested: boolean; /** * (Updatable) Type of fluent parser. */ parserType: string; /** * (Updatable) Grok pattern object. */ patterns: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationSourceParserPattern[]; /** * (Updatable) record section of openmetrics parser. */ recordInput: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationSourceParserRecordInput; /** * (Updatable) RFC 5424 time format. */ rfc5424timeFormat: string; /** * (Updatable) Keys of adjacent levels are joined by the separator. */ separator: string; /** * (Updatable) Syslog parser type. */ syslogParserType: string; /** * (Updatable) Process time value using the specified format. */ timeFormat: string; /** * (Updatable) JSON parser time type. */ timeType: string; /** * (Updatable) Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. */ timeoutInMilliseconds: number; /** * (Updatable) Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user timeKey time * * This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" * * is parsed as: 1362020400 (2013/02/28/ 12:00:00) * * record: { "host" : "192.168.0.1", "reqId" : "111", "user" : "-" } */ types: { [key: string]: string; }; } interface UnifiedAgentConfigurationServiceConfigurationSourceParserNestedParser { /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * If true, keep the time field in the record. */ isKeepTimeKey: boolean; /** * (Updatable) If true, a separator parameter can be further defined. */ parseNested: boolean; /** * (Updatable) Keys of adjacent levels are joined by the separator. */ separator: string; /** * (Updatable) Process time value using the specified format. */ timeFormat: string; /** * (Updatable) JSON parser time type. */ timeType: string; } interface UnifiedAgentConfigurationServiceConfigurationSourceParserPattern { /** * (Updatable) Process value using the specified format. This is available only when timeType is a string. */ fieldTimeFormat: string; /** * (Updatable) Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * (Updatable) Use the specified time zone. The time value can be parsed or formatted in the specified time zone. */ fieldTimeZone: string; /** * (Updatable) The name key to tag this Grok pattern. */ name: string; /** * (Updatable) The Grok pattern. */ pattern: string; } interface UnifiedAgentConfigurationServiceConfigurationSourceParserRecordInput { /** * (Updatable) Dimensions to be added for metrics. */ dimensions: { [key: string]: string; }; /** * (Updatable) Namespace to emit metrics. */ namespace: string; /** * (Updatable) Resource group to emit metrics. */ resourceGroup: string; } interface UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilter { /** * (Updatable) A list of filtering rules to include logs */ allowLists: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterAllowList[]; /** * (Updatable) Type of the custom filter */ customFilterType: string; /** * (Updatable) List of custom sections in custom filter */ customSections: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterCustomSection[]; /** * (Updatable) A list of filtering rules to reject logs */ denyLists: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterDenyList[]; /** * (Updatable) If true, emit invalid record to @ERROR label. Invalid cases are: 1) key does not exist; 2) the format does not match; or 3) an unexpected error. You can rescue unexpected format logs in the @ERROR lable. If you want to ignore these errors, set this to false. */ emitInvalidRecordToError: boolean; /** * (Updatable) Unified schema logging filter type. */ filterType: string; /** * (Updatable) Store the parsed values as a hash value in a field. */ hashValueField: string; /** * (Updatable) Store the parsed values with the specified key name prefix. */ injectKeyPrefix: string; /** * (Updatable) If true, automatically casts the field types. */ isAutoTypecastEnabled: boolean; /** * (Updatable) If true, it modifies a new empty hash */ isRenewRecordEnabled: boolean; /** * (Updatable) When set to true, the full Ruby syntax is enabled in the ${} expression. */ isRubyEnabled: boolean; /** * (Updatable) A list of keys to keep. Only relevant if isRenewRecordEnabled is set to true */ keepKeys: string[]; /** * (Updatable) The field name in the record to parse. */ keyName: string; /** * (Updatable) Unique name for the filter. */ name: string; /** * (Updatable) Parameters of the custom filter */ params: { [key: string]: string; }; /** * (Updatable) Source parser object. */ parser: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParser; /** * (Updatable) Add new key-value pairs in logs */ recordLists: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterRecordList[]; /** * (Updatable) If true, remove the keyName field when parsing is succeeded. */ removeKeyNameField: boolean; /** * (Updatable) A list of keys to delete */ removeKeys: string[]; /** * (Updatable) Overwrites the time of logs with this value, this value must be a Unix timestamp. */ renewTimeKey: string; /** * (Updatable) If true, the invalid string is replaced with safe characters and is re-parsed. */ replaceInvalidSequence: boolean; /** * (Updatable) If true, keep the original key-value pair in the parsed result. */ reserveData: boolean; /** * (Updatable) If true, keep the original event time in the parsed result. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ reserveTime: boolean; } interface UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterAllowList { /** * (Updatable) The field name to which the regular expression is applied */ key: string; /** * (Updatable) The regular expression */ pattern: string; } interface UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterCustomSection { /** * (Updatable) The name of the custom section */ name: string; /** * (Updatable) Parameters in the custom section */ params: { [key: string]: string; }; } interface UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterDenyList { /** * (Updatable) The field name to which the regular expression is applied */ key: string; /** * (Updatable) The regular expression */ pattern: string; } interface UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParser { /** * (Updatable) CSV delimiter. */ delimiter: string; /** * (Updatable) Regex pattern. */ expression: string; /** * (Updatable) Specifies the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * (Updatable) First line pattern format. */ formatFirstline: string; /** * (Updatable) Mutiline pattern format. */ formats: string[]; /** * (Updatable) Grok failure key. */ grokFailureKey: string; /** * (Updatable) Grok name key. */ grokNameKey: string; /** * (Updatable) If true, use Fluent::EventTime.now(current time) as a timestamp when the timeKey is specified. */ isEstimateCurrentEvent?: boolean; /** * (Updatable) If true, keep the time field in the record. */ isKeepTimeKey?: boolean; /** * (Updatable) If you don't need stream or logtag fields, set this to false. */ isMergeCriFields: boolean; /** * (Updatable) If true, an empty string field is replaced with a null value. */ isNullEmptyString?: boolean; /** * (Updatable) Specifies whether or not to support colonless ident. Corresponds to the Fluentd supportColonlessIdent parameter. */ isSupportColonlessIdent: boolean; /** * (Updatable) Specifies with priority or not. Corresponds to the Fluentd withPriority parameter. */ isWithPriority: boolean; /** * (Updatable) CSV keys. */ keys: string[]; /** * (Updatable) Syslog message format. */ messageFormat: string; /** * (Updatable) Specifies the field name to contain logs. */ messageKey: string; /** * (Updatable) Multiline start regexp pattern. */ multiLineStartRegexp: string; /** * (Updatable) Optional nested JSON Parser for CRI. Supported fields are fieldTimeKey, timeFormat, and isKeepTimeKey. */ nestedParser: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserNestedParser; /** * (Updatable) Specify the null value pattern. */ nullValuePattern: string; /** * (Updatable) If true, a separator parameter can be further defined. */ parseNested: boolean; /** * (Updatable) Type of fluent parser. */ parserType: string; /** * (Updatable) Grok pattern object. */ patterns: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserPattern[]; /** * (Updatable) record section of openmetrics parser. */ recordInput: outputs.Logging.UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserRecordInput; /** * (Updatable) RFC 5424 time format. */ rfc5424timeFormat: string; /** * (Updatable) Keys of adjacent levels are joined by the separator. */ separator: string; /** * (Updatable) Syslog parser type. */ syslogParserType: string; /** * (Updatable) Process time value using the specified format. */ timeFormat: string; /** * (Updatable) JSON parser time type. */ timeType: string; /** * (Updatable) Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. */ timeoutInMilliseconds: number; /** * (Updatable) Specify types for converting a field into another type. For example, With this configuration: @type csv keys time,host,req_id,user timeKey time * * This incoming event: "2013/02/28 12:00:00,192.168.0.1,111,-" * * is parsed as: 1362020400 (2013/02/28/ 12:00:00) * * record: { "host" : "192.168.0.1", "reqId" : "111", "user" : "-" } */ types: { [key: string]: string; }; } interface UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserNestedParser { /** * Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * If true, keep the time field in the record. */ isKeepTimeKey: boolean; /** * (Updatable) If true, a separator parameter can be further defined. */ parseNested: boolean; /** * (Updatable) Keys of adjacent levels are joined by the separator. */ separator: string; /** * (Updatable) Process time value using the specified format. */ timeFormat: string; /** * (Updatable) JSON parser time type. */ timeType: string; } interface UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserPattern { /** * (Updatable) Process value using the specified format. This is available only when timeType is a string. */ fieldTimeFormat: string; /** * (Updatable) Specify the time field for the event time. If the event doesn't have this field, the current time is used. */ fieldTimeKey: string; /** * (Updatable) Use the specified time zone. The time value can be parsed or formatted in the specified time zone. */ fieldTimeZone: string; /** * (Updatable) The name key to tag this Grok pattern. */ name: string; /** * (Updatable) The Grok pattern. */ pattern: string; } interface UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterParserRecordInput { /** * (Updatable) Dimensions to be added for metrics. */ dimensions: { [key: string]: string; }; /** * (Updatable) Namespace to emit metrics. */ namespace: string; /** * (Updatable) Resource group to emit metrics. */ resourceGroup: string; } interface UnifiedAgentConfigurationServiceConfigurationUnifiedAgentConfigurationFilterRecordList { /** * (Updatable) A new key */ key: string; /** * (Updatable) A new value */ value: string; } } export declare namespace Lustre { interface FileStorageLustreFileSystemDateTimeDetails { /** * A user-friendly date. Example: `2025-04-25` */ date: string; /** * A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ time: string; } interface FileStorageLustreFileSystemMaintenanceWindow { /** * (Updatable) Day of the week when the maintainence window starts. */ dayOfWeek: string; /** * (Updatable) The time to start the maintenance window. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ timeStart: string; } interface FileStorageLustreFileSystemMaintenanceWindowMetadata { /** * A generic object to show date and time in the below specified format */ activeOrNextPlannedMaintenances: outputs.Lustre.FileStorageLustreFileSystemMaintenanceWindowMetadataActiveOrNextPlannedMaintenance[]; /** * A generic object to show date and time in the below specified format */ finishedMaintenances: outputs.Lustre.FileStorageLustreFileSystemMaintenanceWindowMetadataFinishedMaintenance[]; /** * whether or not an active maintenance is going on for the LustreFileSystem */ isMaintenanceInProgress: boolean; } interface FileStorageLustreFileSystemMaintenanceWindowMetadataActiveOrNextPlannedMaintenance { /** * A user-friendly date. Example: `2025-04-25` */ date: string; /** * A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ time: string; } interface FileStorageLustreFileSystemMaintenanceWindowMetadataFinishedMaintenance { /** * A user-friendly date. Example: `2025-04-25` */ date: string; /** * A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ time: string; } interface FileStorageLustreFileSystemRootSquashConfiguration { /** * (Updatable) A list of NIDs allowed with this lustre file system not to be squashed. A maximum of 10 is allowed. */ clientExceptions: string[]; /** * (Updatable) Used when clients accessing the Lustre file system have their UID and GID remapped to `squashUid` and `squashGid`. If `ROOT`, only the root user and group (UID/GID 0) are remapped; if `NONE`, no remapping is done. If unspecified, defaults to `NONE`. */ identitySquash: string; /** * (Updatable) The GID value to remap to when squashing a client GID. See `identitySquash` for more details. If unspecified, defaults to `65534`. */ squashGid: string; /** * (Updatable) The UID value to remap to when squashing a client UID. See `identitySquash` for more details. If unspecified, defaults to `65534`. */ squashUid: string; } interface GetFileStorageAvailableMaintenanceScheduleStartTimesAvailableMaintenanceScheduleStartTimeCollection { /** * List of available start times on every day of the week */ items: outputs.Lustre.GetFileStorageAvailableMaintenanceScheduleStartTimesAvailableMaintenanceScheduleStartTimeCollectionItem[]; } interface GetFileStorageAvailableMaintenanceScheduleStartTimesAvailableMaintenanceScheduleStartTimeCollectionItem { /** * Day of the week filter */ dayOfWeek: string; /** * List of available start times. Each array item is of the format `HH:mm` */ startTimes: string[]; } interface GetFileStorageAvailableMaintenanceScheduleStartTimesFilter { name: string; regex?: boolean; values: string[]; } interface GetFileStorageAvailableOverrideMaintenanceStartTimesAvailableOverrideMaintenanceStartTimeCollection { /** * List of available start times on every day of the week */ items: outputs.Lustre.GetFileStorageAvailableOverrideMaintenanceStartTimesAvailableOverrideMaintenanceStartTimeCollectionItem[]; } interface GetFileStorageAvailableOverrideMaintenanceStartTimesAvailableOverrideMaintenanceStartTimeCollectionItem { /** * List of available start times. Each array item is of the format `HH:mm` */ startTimes: string[]; /** * The date corresponding to the list of start times available. Example: `2024-04-25T00:00:00.000Z` */ timeDateAvailable: string; } interface GetFileStorageAvailableOverrideMaintenanceStartTimesFilter { name: string; regex?: boolean; values: string[]; } interface GetFileStorageLustreFileSystemDateTimeDetail { /** * A user-friendly date. Example: `2025-04-25` */ date: string; /** * A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ time: string; } interface GetFileStorageLustreFileSystemMaintenanceWindow { /** * Day of the week when the maintainence window starts. */ dayOfWeek: string; /** * The time to start the maintenance window. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ timeStart: string; } interface GetFileStorageLustreFileSystemMaintenanceWindowMetadata { /** * A generic object to show date and time in the below specified format */ activeOrNextPlannedMaintenances: outputs.Lustre.GetFileStorageLustreFileSystemMaintenanceWindowMetadataActiveOrNextPlannedMaintenance[]; /** * A generic object to show date and time in the below specified format */ finishedMaintenances: outputs.Lustre.GetFileStorageLustreFileSystemMaintenanceWindowMetadataFinishedMaintenance[]; /** * whether or not an active maintenance is going on for the LustreFileSystem */ isMaintenanceInProgress: boolean; } interface GetFileStorageLustreFileSystemMaintenanceWindowMetadataActiveOrNextPlannedMaintenance { /** * A user-friendly date. Example: `2025-04-25` */ date: string; /** * A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ time: string; } interface GetFileStorageLustreFileSystemMaintenanceWindowMetadataFinishedMaintenance { /** * A user-friendly date. Example: `2025-04-25` */ date: string; /** * A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ time: string; } interface GetFileStorageLustreFileSystemRootSquashConfiguration { /** * A list of NIDs allowed with this lustre file system not to be squashed. A maximum of 10 is allowed. */ clientExceptions: string[]; /** * Used when clients accessing the Lustre file system have their UID and GID remapped to `squashUid` and `squashGid`. If `ROOT`, only the root user and group (UID/GID 0) are remapped; if `NONE`, no remapping is done. If unspecified, defaults to `NONE`. */ identitySquash: string; /** * The GID value to remap to when squashing a client GID. See `identitySquash` for more details. If unspecified, defaults to `65534`. */ squashGid: string; /** * The UID value to remap to when squashing a client UID. See `identitySquash` for more details. If unspecified, defaults to `65534`. */ squashUid: string; } interface GetFileStorageLustreFileSystemsFilter { name: string; regex?: boolean; values: string[]; } interface GetFileStorageLustreFileSystemsLustreFileSystemCollection { items: outputs.Lustre.GetFileStorageLustreFileSystemsLustreFileSystemCollectionItem[]; } interface GetFileStorageLustreFileSystemsLustreFileSystemCollectionItem { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * Capacity of the Lustre file system in GB. */ capacityInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group in which the Lustre file system exists. */ clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; dateTimeDetails: outputs.Lustre.GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemDateTimeDetail[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * Short description of the Lustre file system. Avoid entering confidential information. */ fileSystemDescription: string; /** * The Lustre file system name. This is used in mount commands and other aspects of the client command line interface. The default file system name is 'lustre'. The file system name is limited to 8 characters. Allowed characters are lower and upper case English letters, numbers, and '_'. */ fileSystemName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system. */ kmsKeyId: string; /** * A message that describes the current state of the Lustre file system in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Type of network used by clients to mount the file system. Example: `tcp` */ lnet: string; /** * The meta-data for maintenance window. */ maintenanceWindowMetadatas: outputs.Lustre.GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemMaintenanceWindowMetadata[]; /** * The preferred day and time to perform maintenance. */ maintenanceWindows: outputs.Lustre.GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemMaintenanceWindow[]; /** * Major version of Lustre running in the Lustre file system. Example: `2.15` */ majorVersion: string; /** * The IPv4 address of MGS (Lustre Management Service) used by clients to mount the file system. For example '10.0.0.4'. */ managementServiceAddress: string; /** * A list of Network Security Group [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this lustre file system. A maximum of 5 is allowed. Setting this to an empty array after the list is created removes the lustre file system from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; overrideMaintenanceTrigger: number; /** * The Lustre file system performance tier. A value of `MBPS_PER_TB_125` represents 125 megabytes per second per terabyte. */ performanceTier: string; /** * An administrative feature that allows you to restrict root level access from clients that try to access your Lustre file system as root. */ rootSquashConfigurations: outputs.Lustre.GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemRootSquashConfiguration[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the Lustre file system is in. */ subnetId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time that the current billing cycle for the file system will end, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. After the current cycle ends, this date is updated automatically to the next timestamp, which is 30 days later. File systems deleted earlier than this time will still incur charges until the billing cycle ends. Example: `2016-08-25T21:10:29.600Z` */ timeBillingCycleEnd: string; /** * The date and time the Lustre file system was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2024-04-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Lustre file system was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2024-04-25T21:10:29.600Z` */ timeUpdated: string; } interface GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemDateTimeDetail { /** * A user-friendly date. Example: `2025-04-25` */ date: string; /** * A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ time: string; } interface GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemMaintenanceWindow { /** * Day of the week when the maintainence window starts. */ dayOfWeek: string; /** * The time to start the maintenance window. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ timeStart: string; } interface GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemMaintenanceWindowMetadata { /** * A generic object to show date and time in the below specified format */ activeOrNextPlannedMaintenances: outputs.Lustre.GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemMaintenanceWindowMetadataActiveOrNextPlannedMaintenance[]; /** * A generic object to show date and time in the below specified format */ finishedMaintenances: outputs.Lustre.GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemMaintenanceWindowMetadataFinishedMaintenance[]; /** * whether or not an active maintenance is going on for the LustreFileSystem */ isMaintenanceInProgress: boolean; } interface GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemMaintenanceWindowMetadataActiveOrNextPlannedMaintenance { /** * A user-friendly date. Example: `2025-04-25` */ date: string; /** * A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ time: string; } interface GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemMaintenanceWindowMetadataFinishedMaintenance { /** * A user-friendly date. Example: `2025-04-25` */ date: string; /** * A user-friendly time. The format is 'HH:MM', 'HH:MM' represents the time in UTC. Example: `22:00` */ time: string; } interface GetFileStorageLustreFileSystemsLustreFileSystemCollectionItemRootSquashConfiguration { /** * A list of NIDs allowed with this lustre file system not to be squashed. A maximum of 10 is allowed. */ clientExceptions: string[]; /** * Used when clients accessing the Lustre file system have their UID and GID remapped to `squashUid` and `squashGid`. If `ROOT`, only the root user and group (UID/GID 0) are remapped; if `NONE`, no remapping is done. If unspecified, defaults to `NONE`. */ identitySquash: string; /** * The GID value to remap to when squashing a client GID. See `identitySquash` for more details. If unspecified, defaults to `65534`. */ squashGid: string; /** * The UID value to remap to when squashing a client UID. See `identitySquash` for more details. If unspecified, defaults to `65534`. */ squashUid: string; } interface GetFileStorageObjectStorageLinkSyncJobsFilter { name: string; regex?: boolean; values: string[]; } interface GetFileStorageObjectStorageLinkSyncJobsSyncJobCollection { items: outputs.Lustre.GetFileStorageObjectStorageLinkSyncJobsSyncJobCollectionItem[]; } interface GetFileStorageObjectStorageLinkSyncJobsSyncJobCollectionItem { /** * Bytes transferred during the sync. This value changes while the sync is still in progress. */ bytesTransferred: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the sync job. */ id: string; /** * The flag is an identifier to tell whether this specific job run has overwrite enabled. If `isOverwrite` is false, the file to be imported or exported will be skipped if it already exists. If `isOverwrite` is true, the file to be imported or exported will be overwritten if it already exists. */ isOverwrite: boolean; /** * The type of the sync job. */ jobType: string; /** * A message that describes the current state of the sync job in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * The path in the Lustre file system used for this Object Storage link. Example: `myFileSystem/mount/myDirectory` */ lustreFileSystemPath: string; /** * The Object Storage namespace and bucket name, including optional object prefix string, to use as the source for imports or destination for exports. Example: `objectStorageNamespace:/bucketName/optionalFolder/optionalPrefix` */ objectStoragePath: string; /** * Count of total files that transferred successfully. */ objectsTransferred: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link. */ parentId: string; /** * Count of files or objects that failed to export or import due to errors. */ skippedErrorCount: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the job finished, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2020-07-25T21:10:29.600Z` */ timeFinished: string; /** * The date and time the job was started, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2020-07-25T21:10:29.600Z` */ timeStarted: string; /** * Total object count for scanned files for import or export as part of this sync job. */ totalObjectsScanned: string; } interface GetFileStorageObjectStorageLinksFilter { name: string; regex?: boolean; values: string[]; } interface GetFileStorageObjectStorageLinksObjectStorageLinkCollection { items: outputs.Lustre.GetFileStorageObjectStorageLinksObjectStorageLinkCollectionItem[]; } interface GetFileStorageObjectStorageLinksObjectStorageLinkCollectionItem { /** * The name of the availability domain. Example: `Uocm:PHX-AD-1` */ availabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of currently running sync job. If no sync job is running, then this will be empty. */ currentJobId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The path in the Lustre file system used for this Object Storage link. Example: `myFileSystem/mount/myDirectory` */ fileSystemPath: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Object Storage link. */ id: string; /** * The flag is an identifier to tell whether the job run has overwrite enabled. If `isOverwrite` is false, the file to be imported or exported will be skipped if it already exists. If `isOverwrite` is true, the file to be imported or exported will be overwritten if it already exists. */ isOverwrite: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of last succeeded sync job. If no sync job has previously run, then this will be empty. */ lastJobId: string; /** * A message that describes the current state of the Object Storage link in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Lustre file system. */ lustreFileSystemId: string; /** * The Object Storage namespace and bucket name, including optional object prefix string, to use as the source for imports or destination for exports. Example: `objectStorageNamespace:/bucketName/optionalFolder/optionalPrefix` */ objectStoragePrefix: string; startExportToObjectTrigger: number; startImportFromObjectTrigger: number; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; stopExportToObjectTrigger: number; stopImportFromObjectTrigger: number; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Lustre file system was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2024-04-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Object Storage link was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2024-04-25T21:10:29.600Z` */ timeUpdated: string; } } export declare namespace ManagementAgent { interface GetManagementAgentAvailableHistoriesAvailabilityHistory { /** * The availability status of managementAgent */ availabilityStatus: string; /** * Unique Management Agent identifier */ managementAgentId: string; /** * The time till which the Management Agent was known to be in the availability status. An RFC3339 formatted datetime string */ timeAvailabilityStatusEnded: string; /** * The time at which the Management Agent moved to the availability status. An RFC3339 formatted datetime string */ timeAvailabilityStatusStarted: string; } interface GetManagementAgentAvailableHistoriesFilter { name: string; regex?: boolean; values: string[]; } interface GetManagementAgentCountItem { /** * The number of Management Agents in this group */ count: number; /** * The Aggregation of Management Agent Dimensions */ dimensions: outputs.ManagementAgent.GetManagementAgentCountItemDimension[]; } interface GetManagementAgentCountItemDimension { /** * The availability status of managementAgent */ availabilityStatus: string; /** * When set to true then agents that have at least one plugin deployed will be returned. When set to false only agents that have no plugins deployed will be returned. */ hasPlugins: boolean; /** * A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned. */ installType: string; /** * Platform Type */ platformType: string; /** * Agent image version */ version: string; } interface GetManagementAgentDataSourceList { /** * Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required. */ allowMetrics: string; /** * Compartment owning this DataSource. */ compartmentId: string; /** * Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint. */ connectionTimeout: number; /** * If the Kubernetes cluster type is Daemon set then this will be set to true. */ isDaemonSet: boolean; /** * Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent. */ key: string; /** * The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint. */ metricDimensions: outputs.ManagementAgent.GetManagementAgentDataSourceListMetricDimension[]; /** * Name of the property */ name: string; /** * The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded. */ namespace: string; /** * The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property). */ proxyUrl: string; /** * Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB). */ readDataLimit: number; /** * Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint. */ readTimeout: number; /** * Oracle Cloud Infrastructure monitoring resource group to assign the metric to. */ resourceGroup: string; /** * Number in minutes. The scraping occurs at the specified interval. */ scheduleMins: number; /** * The current state of managementAgent */ state: string; /** * The time the Management Agent was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Management Agent was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The type of the DataSource. */ type: string; /** * The url through which the Prometheus Exporter publishes its metrics. (http only) */ url: string; } interface GetManagementAgentDataSourceListMetricDimension { /** * Name of the property */ name: string; /** * Value of the metric dimension */ value: string; } interface GetManagementAgentDataSourceMetricDimension { /** * Unique name of the DataSource. */ name: string; /** * Value of the metric dimension */ value: string; } interface GetManagementAgentDataSourceSummaryList { /** * If the Kubernetes cluster type is Daemon set then this will be set to true. */ isDaemonSet: boolean; /** * Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent. */ key: string; /** * Name of the property */ name: string; /** * The type of the DataSource. */ type: string; } interface GetManagementAgentDataSourcesDataSource { /** * Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent. */ dataSourceKey: string; /** * Unique name of the dataSource. */ name?: string; /** * The type of the DataSource. */ type: string; } interface GetManagementAgentDataSourcesFilter { /** * Unique name of the dataSource. */ name: string; regex?: boolean; values: string[]; } interface GetManagementAgentImagesFilter { /** * A filter to return only resources that match the entire platform name given. */ name: string; regex?: boolean; values: string[]; } interface GetManagementAgentImagesManagementAgentImage { /** * Object content SHA256 Hash */ checksum: string; /** * Agent image resource id */ id: string; /** * Details of the Objectstorage object */ imageObjectStorageDetails: outputs.ManagementAgent.GetManagementAgentImagesManagementAgentImageImageObjectStorageDetail[]; /** * Object storage URL for download */ objectUrl: string; /** * The installation package target architecture type */ packageArchitectureType: string; /** * The installation package type */ packageType: string; /** * Agent image platform display name */ platformName: string; /** * Agent image platform type */ platformType: string; /** * Agent image size in bytes */ size: number; /** * Filter to return only Management Agents in the particular lifecycle state. */ state: string; /** * Agent image version */ version: string; } interface GetManagementAgentImagesManagementAgentImageImageObjectStorageDetail { /** * Object content SHA256 Hash */ checksum: string; /** * Objectstorage object name reference providing the original location of this object */ object: string; /** * Objectstorage bucket reference providing the original location of this object */ objectBucket: string; /** * Objectstorage namespace reference providing the original location of this object */ objectNamespace: string; /** * Object storage URL for download */ objectUrl: string; } interface GetManagementAgentInstallKeysFilter { name: string; regex?: boolean; values: string[]; } interface GetManagementAgentInstallKeysManagementAgentInstallKey { /** * Total number of install for this keys */ allowedKeyInstallCount: number; /** * The OCID of the compartment to which a request will be scoped. */ compartmentId: string; /** * Principal id of user who created the Agent Install key */ createdByPrincipalId: string; /** * Total number of install for this keys */ currentKeyInstallCount: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The display name for which the Key needs to be listed. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Agent install Key identifier */ id: string; /** * If set to true, the install key has no expiration date or usage limit. Properties allowedKeyInstallCount and timeExpires are ignored if set to true. Defaults to false. */ isUnlimited: boolean; /** * Management Agent Install Key */ key: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Filter to return only Management Agents in the particular lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when Management Agent install Key was created. An RFC3339 formatted date time string */ timeCreated: string; /** * date after which key would expire after creation */ timeExpires: string; /** * The time when Management Agent install Key was updated. An RFC3339 formatted date time string */ timeUpdated: string; } interface GetManagementAgentManagementAgentProperty { /** * Name of the property */ name: string; /** * Unit for the property */ units: string; /** * Values of the property */ values: string[]; } interface GetManagementAgentNamedCredentialsMetadataMetadata { /** * The field display name */ displayName: string; /** * This Named Credential type is supported on management agents at this version or above. */ minimumAgentVersion: string; /** * The property definitions for this named credential metadata */ properties: outputs.ManagementAgent.GetManagementAgentNamedCredentialsMetadataMetadataProperty[]; /** * The type of the Named Credential. */ type: string; } interface GetManagementAgentNamedCredentialsMetadataMetadataProperty { /** * List of values which can be applied to the value when valueCategory is ALLOWED_VALUES */ allowedValues: string[]; /** * The default value which will be used if no value is set. If defaultValue is empty, then no default will be set. */ defaultValue: string; /** * The field display name */ displayName: string; /** * Set to true if the field must be defined */ isRequired: boolean; /** * The field name */ name: string; /** * Optional regular expression definition which will be applied to the value when valueCategory is CLEAR_TEXT */ regex: string; /** * List of value categories of field allowed for this property */ valueCategories: string[]; } interface GetManagementAgentPluginCountItem { /** * The number of Management Agent Plugins in this group */ count: number; /** * The Aggregation of Management Agent Plugin Dimensions */ dimensions: outputs.ManagementAgent.GetManagementAgentPluginCountItemDimension[]; } interface GetManagementAgentPluginCountItemDimension { /** * Management Agent Plugin Display Name */ pluginDisplayName: string; /** * Management Agent Plugin Name */ pluginName: string; } interface GetManagementAgentPluginList { /** * flag indicating whether the plugin is in enabled mode or disabled mode. */ isEnabled: boolean; /** * Management Agent Plugin Identifier, can be renamed */ pluginDisplayName: string; /** * Plugin Id */ pluginId: string; /** * Management Agent Plugin Name */ pluginName: string; /** * Plugin Status */ pluginStatus: string; /** * Status message of the Plugin */ pluginStatusMessage: string; /** * Plugin Version */ pluginVersion: string; } interface GetManagementAgentPluginsFilter { /** * Management Agent Plugin Name */ name: string; regex?: boolean; values: string[]; } interface GetManagementAgentPluginsManagementAgentPlugin { /** * Management Agent Plugin description */ description: string; /** * Filter to return only Management Agent Plugins having the particular display name. */ displayName: string; /** * Management Agent Plugin Id */ id: string; /** * A flag to indicate whether a given plugin can be deployed from Agent Console UI or not. */ isConsoleDeployable: boolean; /** * Management Agent Plugin Name */ name: string; /** * Filter to return only Management Agents in the particular lifecycle state. */ state: string; /** * Supported Platform Types */ supportedPlatformTypes: string[]; /** * Management Agent Plugin Version */ version: number; } interface GetManagementAgentsFilter { /** * Name of the property */ name: string; regex?: boolean; /** * Values of the property */ values: string[]; } interface GetManagementAgentsManagementAgent { /** * Filter to return only Management Agents in the particular availability status. */ availabilityStatus: string; /** * The OCID of the compartment to which a request will be scoped. */ compartmentId: string; dataSourceLists: outputs.ManagementAgent.GetManagementAgentsManagementAgentDataSourceList[]; /** * list of dataSources associated with the agent */ dataSourceSummaryLists: outputs.ManagementAgent.GetManagementAgentsManagementAgentDataSourceSummaryList[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; deployPluginsIds: string[]; /** * Filter to return only Management Agents having the particular display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Management Agent host machine name */ host: string; /** * Filter to return only Management Agents having the particular agent host id. */ hostId: string; /** * agent identifier */ id: string; /** * agent install key identifier */ installKeyId: string; /** * Path where Management Agent is installed */ installPath: string; /** * A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned. */ installType: string; /** * true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference. */ isAgentAutoUpgradable: boolean; /** * true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent. */ isCustomerDeployed: boolean; latestSupportedVersion: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; managedAgentId: string; /** * Additional properties for this Management Agent */ managementAgentProperties: outputs.ManagementAgent.GetManagementAgentsManagementAgentManagementAgentProperty[]; /** * Platform Name */ platformName: string; /** * Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"] */ platformType: string; /** * Platform Version */ platformVersion: string; /** * list of managementAgentPlugins associated with the agent */ pluginLists: outputs.ManagementAgent.GetManagementAgentsManagementAgentPluginList[]; /** * Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999 */ resourceArtifactVersion: string; /** * Filter to return only Management Agents in the particular lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Management Agent was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string */ timeLastHeartbeat: string; /** * The time the Management Agent was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"] */ version: string; } interface GetManagementAgentsManagementAgentDataSourceList { allowMetrics: string; /** * The OCID of the compartment to which a request will be scoped. */ compartmentId: string; connectionTimeout: number; /** * If the Kubernetes cluster type is Daemon set then this will be set to true. */ isDaemonSet: boolean; /** * Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent. */ key: string; metricDimensions: outputs.ManagementAgent.GetManagementAgentsManagementAgentDataSourceListMetricDimension[]; /** * Name of the property */ name: string; namespace: string; proxyUrl: string; readDataLimit: number; readTimeout: number; resourceGroup: string; scheduleMins: number; /** * Filter to return only Management Agents in the particular lifecycle state. */ state: string; /** * The time the Management Agent was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Management Agent was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The type of the DataSource. */ type: string; url: string; } interface GetManagementAgentsManagementAgentDataSourceListMetricDimension { /** * Name of the property */ name: string; value: string; } interface GetManagementAgentsManagementAgentDataSourceSummaryList { /** * If the Kubernetes cluster type is Daemon set then this will be set to true. */ isDaemonSet: boolean; /** * Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent. */ key: string; /** * Name of the property */ name: string; /** * The type of the DataSource. */ type: string; } interface GetManagementAgentsManagementAgentManagementAgentProperty { /** * Name of the property */ name: string; /** * Unit for the property */ units: string; /** * Values of the property */ values: string[]; } interface GetManagementAgentsManagementAgentPluginList { /** * flag indicating whether the plugin is in enabled mode or disabled mode. */ isEnabled: boolean; /** * Management Agent Plugin Identifier, can be renamed */ pluginDisplayName: string; /** * Plugin Id */ pluginId: string; /** * Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"] */ pluginName: string; /** * Plugin Status */ pluginStatus: string; /** * Status message of the Plugin */ pluginStatusMessage: string; /** * Plugin Version */ pluginVersion: string; } interface GetNamedCredentialProperty { /** * Name of the property */ name: string; /** * Value of the property */ value: string; /** * The category of the Named credential property value. CLEAR_TEXT indicates the value field contains a clear text value. SECRET_IDENTIFIER indicates the value field contains a vault secret ocid identifier. ADB_IDENTIFIER indicates the value field contains an Autonomous database ocid identifier. ALLOWED_VALUE indicates the value should be selected from the options in the allowedValues field. */ valueCategory: string; } interface GetNamedCredentialsFilter { /** * Filter list for these name items. */ name: string; regex?: boolean; values: string[]; } interface GetNamedCredentialsNamedCredentialCollection { items: outputs.ManagementAgent.GetNamedCredentialsNamedCredentialCollectionItem[]; } interface GetNamedCredentialsNamedCredentialCollectionItem { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of the Named Credential. */ description: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Filter list for these Named credentials identifiers (ocid) values. */ id: string; /** * The ManagementAgentID of the agent from which the named credentials are associated. */ managementAgentId: string; /** * Filter list for these name items. */ name: string; /** * Properties for the named credential */ properties: outputs.ManagementAgent.GetNamedCredentialsNamedCredentialCollectionItemProperty[]; /** * Filter list to return only Management Agents in the particular lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Named Credential was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Named Credential data was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * Filter list for these type values. */ type: string; } interface GetNamedCredentialsNamedCredentialCollectionItemProperty { /** * Filter list for these name items. */ name: string; /** * Value of the property */ value: string; /** * The category of the Named credential property value. CLEAR_TEXT indicates the value field contains a clear text value. SECRET_IDENTIFIER indicates the value field contains a vault secret ocid identifier. ADB_IDENTIFIER indicates the value field contains an Autonomous database ocid identifier. ALLOWED_VALUE indicates the value should be selected from the options in the allowedValues field. */ valueCategory: string; } interface ManagementAgentDataSourceList { /** * Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required. */ allowMetrics: string; /** * Compartment owning this DataSource. */ compartmentId: string; /** * Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint. */ connectionTimeout: number; /** * If the Kubernetes cluster type is Daemon set then this will be set to true. */ isDaemonSet: boolean; /** * Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent. */ key: string; /** * The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint. */ metricDimensions: outputs.ManagementAgent.ManagementAgentDataSourceListMetricDimension[]; /** * Name of the property */ name: string; /** * The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded. */ namespace: string; /** * The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property). */ proxyUrl: string; /** * Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB). */ readDataLimit: number; /** * Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint. */ readTimeout: number; /** * Oracle Cloud Infrastructure monitoring resource group to assign the metric to. */ resourceGroup: string; /** * Number in minutes. The scraping occurs at the specified interval. */ scheduleMins: number; /** * The current state of managementAgent */ state: string; /** * The time the Management Agent was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Management Agent was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The type of the DataSource. */ type: string; /** * The url through which the Prometheus Exporter publishes its metrics. (http only) */ url: string; } interface ManagementAgentDataSourceListMetricDimension { /** * Name of the property */ name: string; /** * Value of the metric dimension */ value: string; } interface ManagementAgentDataSourceMetricDimension { /** * (Updatable) Name of the metric dimension */ name: string; /** * (Updatable) Value of the metric dimension */ value: string; } interface ManagementAgentDataSourceSummaryList { /** * If the Kubernetes cluster type is Daemon set then this will be set to true. */ isDaemonSet: boolean; /** * Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent. */ key: string; /** * Name of the property */ name: string; /** * The type of the DataSource. */ type: string; } interface ManagementAgentManagementAgentProperty { /** * Name of the property */ name: string; /** * Unit for the property */ units: string; /** * Values of the property */ values: string[]; } interface ManagementAgentPluginList { /** * flag indicating whether the plugin is in enabled mode or disabled mode. */ isEnabled: boolean; /** * Management Agent Plugin Identifier, can be renamed */ pluginDisplayName: string; /** * Plugin Id */ pluginId: string; /** * Management Agent Plugin Name */ pluginName: string; /** * Plugin Status */ pluginStatus: string; /** * Status message of the Plugin */ pluginStatusMessage: string; /** * Plugin Version */ pluginVersion: string; } interface NamedCredentialProperty { /** * (Updatable) Name of the property */ name: string; /** * (Updatable) Value of the property */ value: string; /** * (Updatable) The category of the Named credential property value. CLEAR_TEXT indicates the value field contains a clear text value. SECRET_IDENTIFIER indicates the value field contains a vault secret ocid identifier. ADB_IDENTIFIER indicates the value field contains an Autonomous database ocid identifier. ALLOWED_VALUE indicates the value should be selected from the options in the allowedValues field. */ valueCategory: string; } } export declare namespace ManagementDashboard { interface GetManagementSavedSearchesFilter { name: string; regex?: boolean; values: string[]; } interface GetManagementSavedSearchesManagementSavedSearchCollection { items: outputs.ManagementDashboard.GetManagementSavedSearchesManagementSavedSearchCollectionItem[]; } interface GetManagementSavedSearchesManagementSavedSearchCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The principle id of the user that created this saved search. This is automatically managed by the system. In Oracle Cloud Infrastructure the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value. */ createdBy: string; /** * It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. */ dataConfig: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of the saved search. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Drill-down configuration to define the destination of a drill-down action. */ drilldownConfig: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * ID of the saved search. */ id: string; /** * Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified. */ isOobSavedSearch: boolean; /** * The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. */ metadataVersion: string; /** * JSON that contains internationalization options. */ nls: string; /** * Defines parameters for the saved search. */ parametersConfig: string; /** * ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID. */ providerId: string; /** * Name of the service (for example, Logging Analytics) that owns the saved search. */ providerName: string; /** * Version of the service that owns this saved search. */ providerVersion: string; /** * Screen image of the saved search. */ screenImage: string; /** * Oracle Cloud Infrastructure lifecycle status. This is automatically managed by the system. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Date and time the saved search was created. */ timeCreated: string; /** * Date and time the saved search was updated. */ timeUpdated: string; /** * Determines how the saved search is displayed in a dashboard. */ type: string; /** * It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. */ uiConfig: string; /** * The principle id of the user that updated this saved search. */ updatedBy: string; /** * The UI template that the saved search uses to render itself. */ widgetTemplate: string; /** * The View Model that the saved search uses to render itself. */ widgetVm: string; } } export declare namespace Marketplace { interface GetAcceptedAgreementsAcceptedAgreement { /** * The unique identifier for the terms of use agreement itself. */ agreementId: string; /** * The unique identifier for the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The display name of the resource. */ displayName: string; /** * The freeform tags associated with this resource, if any. 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"}` */ freeformTags: { [key: string]: string; }; /** * The unique identifier for the acceptance of the agreement within a specific compartment. */ id: string; /** * The unique identifier for the listing. */ listingId: string; /** * The version of the package. Package versions are unique within a listing. */ packageVersion: string; signature: string; /** * The time the agreement was accepted. */ timeAccepted: string; } interface GetAcceptedAgreementsFilter { name: string; regex?: boolean; values: string[]; } interface GetCategoriesCategory { /** * Name of the product category. */ name: string; } interface GetCategoriesFilter { /** * Name of the product category. */ name: string; regex?: boolean; values: string[]; } interface GetListingBanner { /** * The content URL of the screenshot. */ contentUrl: string; /** * The file extension of the screenshot. */ fileExtension: string; /** * The MIME type of the screenshot. */ mimeType: string; /** * Text that describes the resource. */ name: string; } interface GetListingDocumentationLink { /** * The category that the document belongs to. */ documentCategory: string; /** * Text that describes the resource. */ name: string; /** * The URL of the resource. */ url: string; } interface GetListingIcon { /** * The content URL of the screenshot. */ contentUrl: string; /** * The file extension of the screenshot. */ fileExtension: string; /** * The MIME type of the screenshot. */ mimeType: string; /** * Text that describes the resource. */ name: string; } interface GetListingLanguage { /** * A code assigned to the item. */ code: string; /** * Text that describes the resource. */ name: string; } interface GetListingLink { /** * The anchor tag. */ href: string; /** * Reference links to the previous page, next page, and other pages. */ rel: string; } interface GetListingPackageAgreementsAgreement { /** * Who authored the agreement. */ author: string; /** * The content URL of the agreement. */ contentUrl: string; /** * The unique identifier for the agreement. */ id: string; /** * Textual prompt to read and accept the agreement. */ prompt: string; } interface GetListingPackageAgreementsFilter { name: string; regex?: boolean; values: string[]; } interface GetListingPackageOperatingSystem { /** * The name of the variable. */ name: string; } interface GetListingPackagePricing { /** * The currency of the pricing model. */ currency: string; /** * The model for international market pricing. */ internationalMarketPrices: outputs.Marketplace.GetListingPackagePricingInternationalMarketPrice[]; /** * The type of pricing for a PAYGO model, eg PER_OCPU_LINEAR, PER_OCPU_MIN_BILLING, PER_INSTANCE. Null if type is not PAYGO. */ payGoStrategy: string; /** * The pricing rate. */ rate: number; /** * The type of the pricing model. */ type: string; } interface GetListingPackagePricingInternationalMarketPrice { /** * The currency of the pricing model. */ currencyCode: string; /** * The symbol of the currency */ currencySymbol: string; /** * The pricing rate. */ rate: number; } interface GetListingPackageRegion { /** * A code assigned to the item. */ code: string; /** * Countries in the region. */ countries: outputs.Marketplace.GetListingPackageRegionCountry[]; /** * The name of the variable. */ name: string; } interface GetListingPackageRegionCountry { /** * A code assigned to the item. */ code: string; /** * The name of the variable. */ name: string; } interface GetListingPackageVariable { /** * The data type of the variable. */ dataType: string; /** * The variable's default value. */ defaultValue: string; /** * A description of the variable. */ description: string; /** * A brief textual description that helps to explain the variable. */ hintMessage: string; /** * Whether the variable is mandatory. */ isMandatory: boolean; /** * The name of the variable. */ name: string; } interface GetListingPackagesFilter { /** * The name of the variable. */ name: string; regex?: boolean; values: string[]; } interface GetListingPackagesListingPackage { /** * The unique identifier for the listing. */ listingId: string; /** * The operating system used by the listing. */ operatingSystems: outputs.Marketplace.GetListingPackagesListingPackageOperatingSystem[]; /** * A filter to return only packages that match the given package type exactly. */ packageType: string; /** * The version of the package. Package versions are unique within a listing. */ packageVersion: string; /** * The model for pricing. */ pricings: outputs.Marketplace.GetListingPackagesListingPackagePricing[]; /** * The regions where you can deploy the listing package. (Some packages have restrictions that limit their deployment to United States regions only.) */ regions: outputs.Marketplace.GetListingPackagesListingPackageRegion[]; /** * The unique identifier for the package resource. */ resourceId: string; /** * The date and time this listing package was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetListingPackagesListingPackageOperatingSystem { /** * The name of the variable. */ name: string; } interface GetListingPackagesListingPackagePricing { /** * The currency of the pricing model. */ currency: string; /** * The model for international market pricing. */ internationalMarketPrices: outputs.Marketplace.GetListingPackagesListingPackagePricingInternationalMarketPrice[]; /** * The type of pricing for a PAYGO model, eg PER_OCPU_LINEAR, PER_OCPU_MIN_BILLING, PER_INSTANCE. Null if type is not PAYGO. */ payGoStrategy: string; /** * The pricing rate. */ rate: number; /** * The type of the pricing model. */ type: string; } interface GetListingPackagesListingPackagePricingInternationalMarketPrice { /** * The currency of the pricing model. */ currencyCode: string; /** * The symbol of the currency */ currencySymbol: string; /** * The pricing rate. */ rate: number; } interface GetListingPackagesListingPackageRegion { /** * A code assigned to the item. */ code: string; /** * Countries in the region. */ countries: outputs.Marketplace.GetListingPackagesListingPackageRegionCountry[]; /** * The name of the variable. */ name: string; } interface GetListingPackagesListingPackageRegionCountry { /** * A code assigned to the item. */ code: string; /** * The name of the variable. */ name: string; } interface GetListingPublisher { /** * The email address of the publisher. */ contactEmail: string; /** * The phone number of the publisher. */ contactPhone: string; /** * A description of the screenshot. */ description: string; /** * The address of the publisher's headquarters. */ hqAddress: string; /** * The unique identifier for the publisher. */ id: string; /** * Reference links. */ links: outputs.Marketplace.GetListingPublisherLink[]; /** * The model for upload data for images and icons. */ logos: outputs.Marketplace.GetListingPublisherLogo[]; /** * Text that describes the resource. */ name: string; /** * The publisher's website. */ websiteUrl: string; /** * The year the publisher's company or organization was founded. */ yearFounded: string; } interface GetListingPublisherLink { /** * The anchor tag. */ href: string; /** * Reference links to the previous page, next page, and other pages. */ rel: string; } interface GetListingPublisherLogo { /** * The content URL of the screenshot. */ contentUrl: string; /** * The file extension of the screenshot. */ fileExtension: string; /** * The MIME type of the screenshot. */ mimeType: string; /** * Text that describes the resource. */ name: string; } interface GetListingRegion { /** * A code assigned to the item. */ code: string; /** * Countries in the region. */ countries: outputs.Marketplace.GetListingRegionCountry[]; /** * Text that describes the resource. */ name: string; } interface GetListingRegionCountry { /** * A code assigned to the item. */ code: string; /** * Text that describes the resource. */ name: string; } interface GetListingScreenshot { /** * The content URL of the screenshot. */ contentUrl: string; /** * A description of the screenshot. */ description: string; /** * The file extension of the screenshot. */ fileExtension: string; /** * The MIME type of the screenshot. */ mimeType: string; /** * Text that describes the resource. */ name: string; } interface GetListingSupportContact { /** * The email of the contact. */ email: string; /** * Text that describes the resource. */ name: string; /** * The phone number of the contact. */ phone: string; /** * The email subject line to use when contacting support. */ subject: string; } interface GetListingSupportLink { /** * Text that describes the resource. */ name: string; /** * The URL of the resource. */ url: string; } interface GetListingSupportedOperatingSystem { /** * Text that describes the resource. */ name: string; } interface GetListingTaxesFilter { /** * Name of the tax code. */ name: string; regex?: boolean; values: string[]; } interface GetListingTaxesTax { /** * Unique code for the tax. */ code: string; /** * Country, which imposes the tax. */ country: string; /** * Name of the tax code. */ name: string; /** * The URL with more details about this tax. */ url: string; } interface GetListingVideo { /** * Text that describes the resource. */ name: string; /** * The URL of the resource. */ url: string; } interface GetListingsFilter { /** * The name of the listing. */ name: string; regex?: boolean; values: string[]; } interface GetListingsListing { /** * The model for upload data for images and icons. */ banners: outputs.Marketplace.GetListingsListingBanner[]; /** * Product categories that the listing belongs to. */ categories: string[]; /** * The list of compatible architectures supported by the listing */ compatibleArchitectures: string[]; /** * The default package version. */ defaultPackageVersion: string; /** * Links to additional documentation provided by the publisher specifically for the listing. */ documentationLinks: outputs.Marketplace.GetListingsListingDocumentationLink[]; /** * The model for upload data for images and icons. */ icons: outputs.Marketplace.GetListingsListingIcon[]; /** * The unique identifier for the publisher. */ id: string; /** * Indicates whether to show only featured listings. If this is set to `false` or is omitted, then all listings will be returned. */ isFeatured: boolean; /** * The publisher category to which the listing belongs. The publisher category informs where the listing appears for use. */ listingType: string; /** * The name of the listing. */ name: string; /** * A filter to return only packages that match the given package type exactly. */ packageType: string; pricingTypes: string[]; /** * Summary details about the publisher of the listing. */ publishers: outputs.Marketplace.GetListingsListingPublisher[]; /** * The regions where the listing is eligible to be deployed. */ regions: outputs.Marketplace.GetListingsListingRegion[]; /** * A short description of the listing. */ shortDescription: string; /** * The list of operating systems supported by the listing. */ supportedOperatingSystems: outputs.Marketplace.GetListingsListingSupportedOperatingSystem[]; } interface GetListingsListingBanner { /** * The content URL of the screenshot. */ contentUrl: string; /** * The file extension of the screenshot. */ fileExtension: string; /** * The MIME type of the screenshot. */ mimeType: string; /** * The name of the listing. */ name: string; } interface GetListingsListingDocumentationLink { /** * The category that the document belongs to. */ documentCategory: string; /** * The name of the listing. */ name: string; /** * The URL of the resource. */ url: string; } interface GetListingsListingIcon { /** * The content URL of the screenshot. */ contentUrl: string; /** * The file extension of the screenshot. */ fileExtension: string; /** * The MIME type of the screenshot. */ mimeType: string; /** * The name of the listing. */ name: string; } interface GetListingsListingPublisher { /** * A description of the screenshot. */ description: string; /** * The unique identifier for the publisher. */ id: string; /** * The name of the listing. */ name: string; } interface GetListingsListingRegion { /** * A code assigned to the item. */ code: string; /** * Countries in the region. */ countries: outputs.Marketplace.GetListingsListingRegionCountry[]; /** * The name of the listing. */ name: string; } interface GetListingsListingRegionCountry { /** * A code assigned to the item. */ code: string; /** * The name of the listing. */ name: string; } interface GetListingsListingSupportedOperatingSystem { /** * The name of the listing. */ name: string; } interface GetMarketplaceMetadataPublicKeysFilter { name: string; regex?: boolean; values: string[]; } interface GetMarketplaceMetadataPublicKeysMarketplaceMetadataPublicKey { /** * chain of certificates used to sign JWT */ certificateChains: string[]; /** * unique identifier of associated X509 certificate */ certificateThumbprint: string; /** * base64 encoded exponent for public key */ exponent: string; /** * algorithm for public key (i.e. RS256) */ keyAlgorithm: string; /** * unique id that maps to public certificate, directs user which certificate to use to verfiy */ keyId: string; /** * key type (i.e. RSA) */ keyType: string; /** * how key is to be used */ keyUse: string; /** * RSA public modulus */ modulus: string; } interface GetPublicationIcon { /** * The content URL of the upload data. */ contentUrl: string; /** * The file extension of the upload data. */ fileExtension: string; /** * The MIME type of the upload data. */ mimeType: string; /** * The name of the operating system. */ name: string; } interface GetPublicationPackageDetail { eulas: outputs.Marketplace.GetPublicationPackageDetailEula[]; imageId: string; operatingSystems: outputs.Marketplace.GetPublicationPackageDetailOperatingSystem[]; /** * The listing's package type. */ packageType: string; packageVersion: string; } interface GetPublicationPackageDetailEula { eulaType: string; licenseText: string; } interface GetPublicationPackageDetailOperatingSystem { /** * The name of the operating system. */ name: string; } interface GetPublicationPackageOperatingSystem { /** * The name of the variable. */ name: string; } interface GetPublicationPackageVariable { /** * The data type of the variable. */ dataType: string; /** * The variable's default value. */ defaultValue: string; /** * A description of the variable. */ description: string; /** * A brief textual description that helps to explain the variable. */ hintMessage: string; /** * Whether the variable is mandatory. */ isMandatory: boolean; /** * The name of the variable. */ name: string; } interface GetPublicationPackagesFilter { /** * The name of the variable. */ name: string; regex?: boolean; values: string[]; } interface GetPublicationPackagesPublicationPackage { /** * The ID of the listing that the specified package belongs to. */ listingId: string; /** * A filter to return only packages that match the given package type exactly. */ packageType: string; /** * The version of the package. Package versions are unique within a listing. */ packageVersion: string; /** * The unique identifier for the package resource. */ resourceId: string; /** * The date and time the publication package was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetPublicationSupportContact { /** * The email of the contact. */ email: string; /** * The name of the operating system. */ name: string; /** * The phone number of the contact. */ phone: string; /** * The email subject line to use when contacting support. */ subject: string; } interface GetPublicationSupportedOperatingSystem { /** * The name of the operating system. */ name: string; } interface GetPublicationsFilter { /** * The name of the publication. */ name: string; regex?: boolean; values: string[]; } interface GetPublicationsPublication { /** * The unique identifier for the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The freeform tags associated with this resource, if any. 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"}` */ freeformTags: { [key: string]: string; }; /** * The model for upload data for images and icons. */ icons: outputs.Marketplace.GetPublicationsPublicationIcon[]; /** * The unique identifier for the publication in Marketplace. */ id: string; isAgreementAcknowledged: boolean; /** * The type of the listing. */ listingType: string; /** * A long description of the publication to use in the listing. */ longDescription: string; /** * The name of the publication. */ name: string; packageDetails: outputs.Marketplace.GetPublicationsPublicationPackageDetail[]; /** * The listing's package type. */ packageType: string; /** * A short description of the publication to use in the listing. */ shortDescription: string; /** * The lifecycle state of the publication. */ state: string; /** * Contact information for getting support from the publisher for the listing. */ supportContacts: outputs.Marketplace.GetPublicationsPublicationSupportContact[]; /** * The list of operating systems supported by the listing. */ supportedOperatingSystems: outputs.Marketplace.GetPublicationsPublicationSupportedOperatingSystem[]; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The date and time the publication was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetPublicationsPublicationIcon { /** * The content URL of the upload data. */ contentUrl: string; /** * The file extension of the upload data. */ fileExtension: string; /** * The MIME type of the upload data. */ mimeType: string; /** * The name of the publication. */ name: string; } interface GetPublicationsPublicationPackageDetail { eulas: outputs.Marketplace.GetPublicationsPublicationPackageDetailEula[]; imageId: string; operatingSystems: outputs.Marketplace.GetPublicationsPublicationPackageDetailOperatingSystem[]; /** * The listing's package type. */ packageType: string; packageVersion: string; } interface GetPublicationsPublicationPackageDetailEula { eulaType: string; licenseText: string; } interface GetPublicationsPublicationPackageDetailOperatingSystem { /** * The name of the publication. */ name: string; } interface GetPublicationsPublicationSupportContact { /** * The email of the contact. */ email: string; /** * The name of the publication. */ name: string; /** * The phone number of the contact. */ phone: string; /** * The email subject line to use when contacting support. */ subject: string; } interface GetPublicationsPublicationSupportedOperatingSystem { /** * The name of the publication. */ name: string; } interface GetPublishersFilter { /** * The name of the publisher. */ name: string; regex?: boolean; values: string[]; } interface GetPublishersPublisher { /** * A description of the publisher. */ description: string; /** * The unique identifier for the publisher. */ id: string; /** * The name of the publisher. */ name: string; } interface PublicationIcon { /** * The content URL of the upload data. */ contentUrl: string; /** * The file extension of the upload data. */ fileExtension: string; /** * The MIME type of the upload data. */ mimeType: string; /** * (Updatable) The name of the publication, which is also used in the listing. */ name: string; } interface PublicationPackageDetails { /** * The end user license agreeement (EULA) that consumers of this listing must accept. */ eulas: outputs.Marketplace.PublicationPackageDetailsEula[]; /** * The unique identifier for the base image of the publication. */ imageId: string; /** * The operating system used by the listing. */ operatingSystem: outputs.Marketplace.PublicationPackageDetailsOperatingSystem; /** * The package's type. */ packageType: string; /** * The package version. */ packageVersion: string; } interface PublicationPackageDetailsEula { /** * The end user license agreement's type. */ eulaType: string; /** * The text of the end user license agreement. */ licenseText: string; } interface PublicationPackageDetailsOperatingSystem { /** * The name of the operating system. */ name: string; } interface PublicationSupportContact { /** * (Updatable) The email of the contact. */ email: string; /** * (Updatable) The name of the contact. */ name: string; /** * (Updatable) The phone number of the contact. */ phone: string; /** * (Updatable) The email subject line to use when contacting support. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ subject: string; } interface PublicationSupportedOperatingSystem { /** * (Updatable) The name of the publication, which is also used in the listing. */ name: string; } } export declare namespace MediaServices { interface GetMediaAssetDistributionChannelAttachmentLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetMediaAssetLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the MediaAsset was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The type of the media asset. */ type: string; } interface GetMediaAssetMediaAssetTag { /** * The type of the media asset. */ type: string; /** * Tag of the MediaAsset. */ value: string; } interface GetMediaAssetMetadata { /** * JSON string containing the technial metadata for the media asset. */ metadata: string; } interface GetMediaAssetsFilter { name: string; regex?: boolean; values: string[]; } interface GetMediaAssetsMediaAssetCollection { items: outputs.MediaServices.GetMediaAssetsMediaAssetCollectionItem[]; } interface GetMediaAssetsMediaAssetCollectionItem { /** * Filter MediaAsset by the bucket where the object is stored. */ bucket: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation. */ id: string; isLockOverride: boolean; /** * Locks associated with this resource. */ locks: outputs.MediaServices.GetMediaAssetsMediaAssetCollectionItemLock[]; /** * Unique MediaAsset identifier of the first asset upload. */ masterMediaAssetId: string; /** * List of tags for the MediaAsset. */ mediaAssetTags: outputs.MediaServices.GetMediaAssetsMediaAssetCollectionItemMediaAssetTag[]; /** * The ID of the MediaWorkflowJob used to produce this asset, if this parameter is supplied then the workflow ID must also be supplied. */ mediaWorkflowJobId: string; /** * JSON string containing the technial metadata for the media asset. */ metadatas: outputs.MediaServices.GetMediaAssetsMediaAssetCollectionItemMetadata[]; /** * The object storage namespace where this asset is located. */ namespace: string; /** * Filter MediaAsset by the name of the object in object storage. */ object: string; /** * eTag of the underlying object storage object. */ objectEtag: string; /** * Unique MediaAsset identifier of the asset from which this asset is derived. */ parentMediaAssetId: string; /** * The end index of video segment files. */ segmentRangeEndIndex: string; /** * The start index for video segment files. */ segmentRangeStartIndex: string; /** * The ID of the MediaWorkflow used to produce this asset. */ sourceMediaWorkflowId: string; /** * The version of the MediaWorkflow used to produce this asset. */ sourceMediaWorkflowVersion: string; /** * A filter to return only the resources with lifecycleState matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the MediaAsset was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the MediaAsset was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Filter MediaAsset by the asset type. */ type: string; } interface GetMediaAssetsMediaAssetCollectionItemLock { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the MediaAsset was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Filter MediaAsset by the asset type. */ type: string; } interface GetMediaAssetsMediaAssetCollectionItemMediaAssetTag { /** * Filter MediaAsset by the asset type. */ type: string; /** * Tag of the MediaAsset. */ value: string; } interface GetMediaAssetsMediaAssetCollectionItemMetadata { /** * JSON string containing the technial metadata for the media asset. */ metadata: string; } interface GetMediaWorkflowConfigurationLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the the MediaWorkflowConfiguration was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetMediaWorkflowConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetMediaWorkflowConfigurationsMediaWorkflowConfigurationCollection { items: outputs.MediaServices.GetMediaWorkflowConfigurationsMediaWorkflowConfigurationCollectionItem[]; } interface GetMediaWorkflowConfigurationsMediaWorkflowConfigurationCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique MediaWorkflowConfiguration identifier. */ id: string; isLockOverride: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecyleDetails: string; /** * Locks associated with this resource. */ locks: outputs.MediaServices.GetMediaWorkflowConfigurationsMediaWorkflowConfigurationCollectionItemLock[]; /** * Reuseable parameter values encoded as a JSON; the top and second level JSON elements are objects. Each key of the top level object refer to a task key that is unqiue to the workflow, each of the second level objects' keys refer to the name of a parameter that is unique to the task. taskKey > parameterName > parameterValue */ parameters: string; /** * A filter to return only the resources with lifecycleState matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the the MediaWorkflowConfiguration was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the MediaWorkflowConfiguration was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetMediaWorkflowConfigurationsMediaWorkflowConfigurationCollectionItemLock { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the the MediaWorkflowConfiguration was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetMediaWorkflowJobFactsFilter { /** * Unique name. It is read-only and generated for the fact. */ name: string; regex?: boolean; values: string[]; } interface GetMediaWorkflowJobFactsMediaWorkflowJobFactCollection { items: outputs.MediaServices.GetMediaWorkflowJobFactsMediaWorkflowJobFactCollectionItem[]; } interface GetMediaWorkflowJobFactsMediaWorkflowJobFactCollectionItem { /** * The body of the detail captured as JSON. */ detail: string; /** * Filter by MediaWorkflowJob ID and MediaWorkflowJobFact key. */ key: string; /** * Unique MediaWorkflowJob identifier. */ mediaWorkflowJobId: string; /** * Unique name. It is read-only and generated for the fact. */ name: string; /** * Types of details to include. */ type: string; } interface GetMediaWorkflowJobLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * Creation time of the job. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetMediaWorkflowJobOutput { /** * Type of job output. */ assetType: string; /** * The bucket name of the job output. */ bucket: string; /** * The ID associated with the job output. */ id: string; /** * The namespace name of the job output. */ namespace: string; /** * The object name of the job output. */ object: string; } interface GetMediaWorkflowJobTaskLifecycleState { /** * Unique key within a MediaWorkflowJob for the task. */ key: string; /** * The lifecycle details of MediaWorkflowJob task. */ lifecycleDetails: string; /** * The current state of the MediaWorkflowJob task. */ state: string; } interface GetMediaWorkflowJobsFilter { name: string; regex?: boolean; values: string[]; } interface GetMediaWorkflowJobsMediaWorkflowJobCollection { items: outputs.MediaServices.GetMediaWorkflowJobsMediaWorkflowJobCollectionItem[]; } interface GetMediaWorkflowJobsMediaWorkflowJobCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * unique MediaWorkflowJob identifier */ id: string; isLockOverride: boolean; /** * The lifecycle details of MediaWorkflowJob task. */ lifecycleDetails: string; /** * Locks associated with this resource. */ locks: outputs.MediaServices.GetMediaWorkflowJobsMediaWorkflowJobCollectionItemLock[]; /** * Configurations to be applied to this run of the workflow. */ mediaWorkflowConfigurationIds: string[]; /** * Unique MediaWorkflow identifier. */ mediaWorkflowId: string; mediaWorkflowName: string; /** * A list of JobOutput for the workflowJob. */ outputs: outputs.MediaServices.GetMediaWorkflowJobsMediaWorkflowJobCollectionItemOutput[]; /** * Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, the MediaWorkflow's MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be JSON objects (vs arrays, scalars, etc). The top level keys refer to a task's key and the 2nd level keys refer to a parameter's name. */ parameters: string; /** * A JSON representation of the job as it will be run by the system. All the task declarations, configurations and parameters are merged. Parameter values are all fully resolved. */ runnable: string; /** * A filter to return only the resources with lifecycleState matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Status of each task. */ taskLifecycleStates: outputs.MediaServices.GetMediaWorkflowJobsMediaWorkflowJobCollectionItemTaskLifecycleState[]; /** * Creation time of the job. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Time when the job finished. An RFC3339 formatted datetime string. */ timeEnded: string; /** * Time when the job started to execute. An RFC3339 formatted datetime string. */ timeStarted: string; /** * Updated time of the job. An RFC3339 formatted datetime string. */ timeUpdated: string; workflowIdentifierType: string; } interface GetMediaWorkflowJobsMediaWorkflowJobCollectionItemLock { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * Creation time of the job. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetMediaWorkflowJobsMediaWorkflowJobCollectionItemOutput { /** * Type of job output. */ assetType: string; /** * The bucket name of the job output. */ bucket: string; /** * unique MediaWorkflowJob identifier */ id: string; /** * The namespace name of the job output. */ namespace: string; /** * The object name of the job output. */ object: string; } interface GetMediaWorkflowJobsMediaWorkflowJobCollectionItemTaskLifecycleState { /** * Unique key within a MediaWorkflowJob for the task. */ key: string; /** * The lifecycle details of MediaWorkflowJob task. */ lifecycleDetails: string; /** * A filter to return only the resources with lifecycleState matching the given lifecycleState. */ state: string; } interface GetMediaWorkflowLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the MediaWorkflow was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration. */ type: string; } interface GetMediaWorkflowTask { /** * Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task. */ enableParameterReference: string; /** * Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node. */ enableWhenReferencedParameterEquals: { [key: string]: string; }; /** * A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state. */ key: string; /** * Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters. */ parameters: string; /** * Keys to the other tasks in this workflow that must be completed before execution of this task can begin. */ prerequisites: string[]; /** * The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration. */ type: string; /** * The version of the MediaWorkflow. */ version: string; } interface GetMediaWorkflowTaskDeclarationItem { /** * A filter to return only the resources with their system defined, unique name matching the given name. */ name: string; /** * JSON schema specifying the parameters supported by this type of task. This is used to validate tasks' parameters when jobs are created. */ parametersSchema: string; /** * JSON schema similar to the parameterSchema, but permits parameter values to refer to other parameters using the ${/path/to/another/parmeter} syntax. This is used to validate task parameters when workflows are created. */ parametersSchemaAllowingReferences: string; /** * A filter to select MediaWorkflowTaskDeclaration by version. */ version: number; } interface GetMediaWorkflowsFilter { name: string; regex?: boolean; values: string[]; } interface GetMediaWorkflowsMediaWorkflowCollection { items: outputs.MediaServices.GetMediaWorkflowsMediaWorkflowCollectionItem[]; } interface GetMediaWorkflowsMediaWorkflowCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique MediaWorkflow identifier. */ id: string; isLockOverride: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecyleDetails: string; /** * Locks associated with this resource. */ locks: outputs.MediaServices.GetMediaWorkflowsMediaWorkflowCollectionItemLock[]; /** * Configurations to be applied to all the runs of this workflow. Parameters in these configurations are overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the parameters of the MediaWorkflowJob. If the same parameter appears in multiple configurations, the values that appear in the configuration at the highest index will be used. */ mediaWorkflowConfigurationIds: string[]; /** * Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters. */ parameters: string; /** * A filter to return only the resources with lifecycleState matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails. */ tasks: outputs.MediaServices.GetMediaWorkflowsMediaWorkflowCollectionItemTask[]; /** * The time when the MediaWorkflow was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The version of the MediaWorkflow. */ version: string; } interface GetMediaWorkflowsMediaWorkflowCollectionItemLock { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the MediaWorkflow was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration. */ type: string; } interface GetMediaWorkflowsMediaWorkflowCollectionItemTask { /** * Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task. */ enableParameterReference: string; /** * Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node. */ enableWhenReferencedParameterEquals: { [key: string]: string; }; /** * A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state. */ key: string; /** * Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters. */ parameters: string; /** * Keys to the other tasks in this workflow that must be completed before execution of this task can begin. */ prerequisites: string[]; /** * The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration. */ type: string; /** * The version of the MediaWorkflow. */ version: string; } interface GetStreamCdnConfigConfig { /** * The hostname of the CDN edge server to use when building CDN URLs. */ edgeHostname: string; /** * The path to prepend when building CDN URLs. */ edgePathPrefix: string; /** * The encryption key to use for edge token authentication. */ edgeTokenKey: string; /** * Salt to use when encrypting authentication token. */ edgeTokenSalt: string; /** * Whether token authentication should be used at the CDN edge. */ isEdgeTokenAuth: boolean; /** * The shared secret key A, two for errorless key rotation. */ originAuthSecretKeyA: string; /** * The shared secret key B, two for errorless key rotation. */ originAuthSecretKeyB: string; /** * Nonce identifier for originAuthSecretKeyA (used to determine key used to sign). */ originAuthSecretKeyNonceA: string; /** * Nonce identifier for originAuthSecretKeyB (used to determine key used to sign). */ originAuthSecretKeyNonceB: string; /** * The type of encryption used to compute the signature. */ originAuthSignEncryption: string; /** * The type of data used to compute the signature. */ originAuthSignType: string; /** * Type of the lock. */ type: string; } interface GetStreamCdnConfigLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the CDN Config was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetStreamCdnConfigsFilter { name: string; regex?: boolean; values: string[]; } interface GetStreamCdnConfigsStreamCdnConfigCollection { items: outputs.MediaServices.GetStreamCdnConfigsStreamCdnConfigCollectionItem[]; } interface GetStreamCdnConfigsStreamCdnConfigCollectionItem { /** * The compartment ID of the lock. */ compartmentId: string; /** * Base fields of the StreamCdnConfig configuration object. */ configs: outputs.MediaServices.GetStreamCdnConfigsStreamCdnConfigCollectionItemConfig[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name given. */ displayName: string; /** * The Stream Distribution Channel identifier this CdnConfig belongs to. */ distributionChannelId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique StreamCdnConfig identifier. */ id: string; /** * Whether publishing to CDN is enabled. */ isEnabled: boolean; isLockOverride: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecyleDetails: string; /** * Locks associated with this resource. */ locks: outputs.MediaServices.GetStreamCdnConfigsStreamCdnConfigCollectionItemLock[]; /** * A filter to return only the resources with lifecycleState matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the CDN Config was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the CDN Config was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetStreamCdnConfigsStreamCdnConfigCollectionItemConfig { /** * The hostname of the CDN edge server to use when building CDN URLs. */ edgeHostname: string; /** * The path to prepend when building CDN URLs. */ edgePathPrefix: string; /** * The encryption key to use for edge token authentication. */ edgeTokenKey: string; /** * Salt to use when encrypting authentication token. */ edgeTokenSalt: string; /** * Whether token authentication should be used at the CDN edge. */ isEdgeTokenAuth: boolean; /** * The shared secret key A, two for errorless key rotation. */ originAuthSecretKeyA: string; /** * The shared secret key B, two for errorless key rotation. */ originAuthSecretKeyB: string; /** * Nonce identifier for originAuthSecretKeyA (used to determine key used to sign). */ originAuthSecretKeyNonceA: string; /** * Nonce identifier for originAuthSecretKeyB (used to determine key used to sign). */ originAuthSecretKeyNonceB: string; /** * The type of encryption used to compute the signature. */ originAuthSignEncryption: string; /** * The type of data used to compute the signature. */ originAuthSignType: string; /** * Type of the lock. */ type: string; } interface GetStreamCdnConfigsStreamCdnConfigCollectionItemLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the CDN Config was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetStreamDistributionChannelLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the Stream Distribution Channel was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetStreamDistributionChannelsFilter { name: string; regex?: boolean; values: string[]; } interface GetStreamDistributionChannelsStreamDistributionChannelCollection { items: outputs.MediaServices.GetStreamDistributionChannelsStreamDistributionChannelCollectionItem[]; } interface GetStreamDistributionChannelsStreamDistributionChannelCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name given. */ displayName: string; /** * Unique domain name of the Distribution Channel. */ domainName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique Stream Distribution Channel identifier. */ id: string; isLockOverride: boolean; /** * Locks associated with this resource. */ locks: outputs.MediaServices.GetStreamDistributionChannelsStreamDistributionChannelCollectionItemLock[]; /** * A filter to return only the resources with lifecycleState matching the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the Stream Distribution Channel was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the Stream Distribution Channel was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetStreamDistributionChannelsStreamDistributionChannelCollectionItemLock { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the Stream Distribution Channel was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetStreamPackagingConfigEncryption { /** * The encryption algorithm for the stream packaging configuration. */ algorithm: string; /** * The identifier of the customer managed Vault KMS symmetric encryption key (null if Oracle managed). */ kmsKeyId: string; } interface GetStreamPackagingConfigLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the Packaging Configuration was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetStreamPackagingConfigsFilter { name: string; regex?: boolean; values: string[]; } interface GetStreamPackagingConfigsStreamPackagingConfigCollection { items: outputs.MediaServices.GetStreamPackagingConfigsStreamPackagingConfigCollectionItem[]; } interface GetStreamPackagingConfigsStreamPackagingConfigCollectionItem { /** * The compartment ID of the lock. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resources that match the entire display name given. */ displayName: string; /** * Unique Stream Distribution Channel identifier. */ distributionChannelId: string; /** * The encryption used by the stream packaging configuration. */ encryptions: outputs.MediaServices.GetStreamPackagingConfigsStreamPackagingConfigCollectionItemEncryption[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation. */ id: string; isLockOverride: boolean; /** * Locks associated with this resource. */ locks: outputs.MediaServices.GetStreamPackagingConfigsStreamPackagingConfigCollectionItemLock[]; /** * The duration in seconds for each fragment. */ segmentTimeInSeconds: number; /** * A filter to return only the resources with lifecycleState matching the given lifecycleState. */ state: string; /** * The output format for the package. */ streamPackagingFormat: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when the Packaging Configuration was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time when the Packaging Configuration was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetStreamPackagingConfigsStreamPackagingConfigCollectionItemEncryption { /** * The encryption algorithm for the stream packaging configuration. */ algorithm: string; /** * The identifier of the customer managed Vault KMS symmetric encryption key (null if Oracle managed). */ kmsKeyId: string; } interface GetStreamPackagingConfigsStreamPackagingConfigCollectionItemLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * The time when the Packaging Configuration was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface GetSystemMediaWorkflowItem { /** * Description of this workflow's processing and how that processing can be customized by specifying parameter values. */ description: string; /** * A filter to return only the resources with their system defined, unique name matching the given name. */ name: string; /** * Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters. */ parameters: string; /** * The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails. */ tasks: outputs.MediaServices.GetSystemMediaWorkflowItemTask[]; } interface GetSystemMediaWorkflowItemTask { /** * Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task. */ enableParameterReference: string; /** * Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node. */ enableWhenReferencedParameterEquals: { [key: string]: string; }; /** * A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state. */ key: string; /** * Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters. */ parameters: string; /** * Keys to the other tasks in this workflow that must be completed before execution of this task can begin. */ prerequisites: string[]; /** * The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration. */ type: string; /** * The version of the MediaWorkflowTaskDeclaration. */ version: string; } interface MediaAssetLock { /** * (Updatable) The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface MediaAssetMediaAssetTag { /** * (Updatable) Type of the tag. */ type: string; /** * (Updatable) Tag of the MediaAsset. */ value: string; } interface MediaAssetMetadata { /** * (Updatable) JSON string containing the technial metadata for the media asset. */ metadata: string; } interface MediaWorkflowConfigurationLock { /** * (Updatable) The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface MediaWorkflowJobLock { /** * (Updatable) The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface MediaWorkflowJobOutput { /** * Type of job output. */ assetType: string; /** * The bucket name of the job output. */ bucket: string; /** * The ID associated with the job output. */ id: string; /** * The namespace name of the job output. */ namespace: string; /** * The object name of the job output. */ object: string; } interface MediaWorkflowJobTaskLifecycleState { /** * Unique key within a MediaWorkflowJob for the task. */ key: string; /** * The lifecycle details of MediaWorkflowJob task. */ lifecycleDetails: string; /** * The current state of the MediaWorkflowJob task. */ state: string; } interface MediaWorkflowLock { /** * (Updatable) The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } interface MediaWorkflowTask { /** * (Updatable) Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task's workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task. */ enableParameterReference: string; /** * (Updatable) Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node. */ enableWhenReferencedParameterEquals: { [key: string]: string; }; /** * (Updatable) A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state. */ key: string; /** * (Updatable) Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters. */ parameters: string; /** * (Updatable) Keys to the other tasks in this workflow that must be completed before execution of this task can begin. */ prerequisites: string[]; /** * (Updatable) The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration. */ type: string; /** * (Updatable) The version of the MediaWorkflowTaskDeclaration. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ version: string; } interface StreamCdnConfigConfig { /** * (Updatable) The hostname of the CDN edge server to use when building CDN URLs. */ edgeHostname: string; /** * (Updatable) The path to prepend when building CDN URLs. */ edgePathPrefix: string; /** * (Updatable) The encryption key to use for edge token authentication. */ edgeTokenKey: string; /** * (Updatable) Salt to use when encrypting authentication token. */ edgeTokenSalt: string; /** * (Updatable) Whether token authentication should be used at the CDN edge. */ isEdgeTokenAuth: boolean; /** * (Updatable) The shared secret key A, two for errorless key rotation. */ originAuthSecretKeyA: string; /** * (Updatable) The shared secret key B, two for errorless key rotation. */ originAuthSecretKeyB: string; /** * (Updatable) Nonce identifier for originAuthSecretKeyA (used to determine key used to sign). */ originAuthSecretKeyNonceA: string; /** * (Updatable) Nonce identifier for originAuthSecretKeyB (used to determine key used to sign). */ originAuthSecretKeyNonceB: string; /** * (Updatable) The type of encryption used to compute the signature. */ originAuthSignEncryption: string; /** * (Updatable) The type of data used to compute the signature. */ originAuthSignType: string; /** * (Updatable) The name of the CDN configuration type. */ type: string; } interface StreamCdnConfigLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface StreamDistributionChannelLock { /** * (Updatable) The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface StreamPackagingConfigEncryption { /** * The encryption algorithm for the stream packaging configuration. */ algorithm: string; /** * The identifier of the customer managed Vault KMS symmetric encryption key (null if Oracle managed). */ kmsKeyId: string; } interface StreamPackagingConfigLock { /** * The compartment ID of the lock. */ compartmentId: string; /** * A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked. */ message: string; /** * The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock. */ relatedResourceId: string; /** * When the lock was created. */ timeCreated: string; /** * Type of the lock. */ type: string; } } export declare namespace MeteringComputation { interface CustomTableSavedCustomTable { /** * (Updatable) The column groupBy key list. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ columnGroupBies: string[]; /** * (Updatable) The compartment depth level. */ compartmentDepth: number; /** * (Updatable) The name of the custom table. */ displayName: string; /** * (Updatable) GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported. For example: `[{"namespace":"oracle", "key":"createdBy"]` */ groupByTags: outputs.MeteringComputation.CustomTableSavedCustomTableGroupByTag[]; /** * (Updatable) The row groupBy key list. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ rowGroupBies: string[]; /** * (Updatable) The version of the custom table. */ version: number; } interface CustomTableSavedCustomTableGroupByTag { /** * (Updatable) The tag key. */ key: string; /** * (Updatable) The tag namespace. */ namespace: string; /** * (Updatable) The tag value. */ value: string; } interface GetConfigurationItem { /** * The configuration key. */ key: string; /** * The configuration value. */ values: string[]; } interface GetCustomTableSavedCustomTable { /** * The column groupBy key list. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ columnGroupBies: string[]; /** * The compartment depth level. */ compartmentDepth: number; /** * The name of the custom table. */ displayName: string; /** * GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported. For example: `[{"namespace":"oracle", "key":"createdBy"]` */ groupByTags: outputs.MeteringComputation.GetCustomTableSavedCustomTableGroupByTag[]; /** * The row groupBy key list. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ rowGroupBies: string[]; /** * The version of the custom table. */ version: number; } interface GetCustomTableSavedCustomTableGroupByTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface GetCustomTablesCustomTableCollection { items: outputs.MeteringComputation.GetCustomTablesCustomTableCollectionItem[]; } interface GetCustomTablesCustomTableCollectionItem { /** * The compartment ID in which to list resources. */ compartmentId: string; /** * The custom table OCID. */ id: string; /** * The custom table for Cost Analysis UI rendering. */ savedCustomTables: outputs.MeteringComputation.GetCustomTablesCustomTableCollectionItemSavedCustomTable[]; /** * The saved report ID in which to list resources. */ savedReportId: string; } interface GetCustomTablesCustomTableCollectionItemSavedCustomTable { /** * The column groupBy key list. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ columnGroupBies: string[]; /** * The compartment depth level. */ compartmentDepth: number; /** * The name of the custom table. */ displayName: string; /** * GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported. For example: `[{"namespace":"oracle", "key":"createdBy"]` */ groupByTags: outputs.MeteringComputation.GetCustomTablesCustomTableCollectionItemSavedCustomTableGroupByTag[]; /** * The row groupBy key list. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ rowGroupBies: string[]; /** * The version of the custom table. */ version: number; } interface GetCustomTablesCustomTableCollectionItemSavedCustomTableGroupByTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface GetCustomTablesFilter { name: string; regex?: boolean; values: string[]; } interface GetQueriesFilter { name: string; regex?: boolean; values: string[]; } interface GetQueriesQueryCollection { items: outputs.MeteringComputation.GetQueriesQueryCollectionItem[]; } interface GetQueriesQueryCollectionItem { /** * The compartment ID in which to list resources. */ compartmentId: string; /** * The query OCID. */ id: string; /** * The common fields for queries. */ queryDefinitions: outputs.MeteringComputation.GetQueriesQueryCollectionItemQueryDefinition[]; } interface GetQueriesQueryCollectionItemQueryDefinition { /** * The common fields for Cost Analysis UI rendering. */ costAnalysisUis: outputs.MeteringComputation.GetQueriesQueryCollectionItemQueryDefinitionCostAnalysisUi[]; /** * The query display name. Avoid entering confidential information. */ displayName: string; /** * The request of the generated Cost Analysis report. */ reportQueries: outputs.MeteringComputation.GetQueriesQueryCollectionItemQueryDefinitionReportQuery[]; /** * The saved query version. */ version: number; } interface GetQueriesQueryCollectionItemQueryDefinitionCostAnalysisUi { /** * The graph type. */ graph: string; /** * A cumulative graph. */ isCumulativeGraph: boolean; } interface GetQueriesQueryCollectionItemQueryDefinitionReportQuery { /** * The compartment depth level. */ compartmentDepth: number; /** * The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded. */ dateRangeName: string; /** * The filter object for query usage. */ filter: string; /** * Forecast configuration of usage/cost. */ forecasts: outputs.MeteringComputation.GetQueriesQueryCollectionItemQueryDefinitionReportQueryForecast[]; /** * The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported. */ granularity: string; /** * Specifies what to aggregate the result by. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ groupBies: string[]; /** * GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: `[{"namespace":"oracle", "key":"createdBy"]` */ groupByTags: outputs.MeteringComputation.GetQueriesQueryCollectionItemQueryDefinitionReportQueryGroupByTag[]; /** * Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up. */ isAggregateByTime: boolean; /** * The query usage type. COST by default if it is missing. * * Usage: Query the usage data. * * Cost: Query the cost/billing data. * * Credit: Query the credit adjustments data. * * ExpiredCredit: Query the expired credits data. * * AllCredit: Query the credit adjustments and expired credit. */ queryType: string; /** * Tenant ID. */ tenantId: string; /** * The usage end time. */ timeUsageEnded: string; /** * The usage start time. */ timeUsageStarted: string; } interface GetQueriesQueryCollectionItemQueryDefinitionReportQueryForecast { /** * BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made. */ forecastType: string; /** * The forecast end time. */ timeForecastEnded: string; /** * The forecast start time. Defaults to UTC-1 if not specified. */ timeForecastStarted: string; } interface GetQueriesQueryCollectionItemQueryDefinitionReportQueryGroupByTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface GetQueryQueryDefinition { /** * The common fields for Cost Analysis UI rendering. */ costAnalysisUis: outputs.MeteringComputation.GetQueryQueryDefinitionCostAnalysisUi[]; /** * The query display name. Avoid entering confidential information. */ displayName: string; /** * The request of the generated Cost Analysis report. */ reportQueries: outputs.MeteringComputation.GetQueryQueryDefinitionReportQuery[]; /** * The saved query version. */ version: number; } interface GetQueryQueryDefinitionCostAnalysisUi { /** * The graph type. */ graph: string; /** * A cumulative graph. */ isCumulativeGraph: boolean; } interface GetQueryQueryDefinitionReportQuery { /** * The compartment depth level. */ compartmentDepth: number; /** * The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded. */ dateRangeName: string; /** * The filter object for query usage. */ filter: string; /** * Forecast configuration of usage/cost. */ forecasts: outputs.MeteringComputation.GetQueryQueryDefinitionReportQueryForecast[]; /** * The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported. */ granularity: string; /** * Specifies what to aggregate the result by. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ groupBies: string[]; /** * GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: `[{"namespace":"oracle", "key":"createdBy"]` */ groupByTags: outputs.MeteringComputation.GetQueryQueryDefinitionReportQueryGroupByTag[]; /** * Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. */ isAggregateByTime: boolean; /** * The query usage type. COST by default if it is missing. * * Usage: Query the usage data. * * Cost: Query the cost/billing data. * * Credit: Query the credit adjustments data. * * ExpiredCredit: Query the expired credits data. * * AllCredit: Query the credit adjustments and expired credit. */ queryType: string; /** * Tenant ID. */ tenantId: string; /** * The usage end time. */ timeUsageEnded: string; /** * The usage start time. */ timeUsageStarted: string; } interface GetQueryQueryDefinitionReportQueryForecast { /** * BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made */ forecastType: string; /** * The forecast end time. */ timeForecastEnded: string; /** * The forecast start time. Defaults to UTC-1 if not specified. */ timeForecastStarted: string; } interface GetQueryQueryDefinitionReportQueryGroupByTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface GetScheduleQueryProperty { /** * The depth level of the compartment. */ compartmentDepth: number; /** * Static or dynamic date range `dateRangeType`, which corresponds with type-specific characteristics. */ dateRanges: outputs.MeteringComputation.GetScheduleQueryPropertyDateRange[]; /** * The filter object for query usage. */ filter: string; /** * The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY */ granularity: string; /** * Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ] */ groupBies: string[]; /** * GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [ { "namespace": "oracle", "key": "createdBy" ] */ groupByTags: outputs.MeteringComputation.GetScheduleQueryPropertyGroupByTag[]; /** * Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. */ isAggregateByTime: boolean; /** * The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. Allowed values are: USAGE COST USAGE_AND_COST */ queryType: string; } interface GetScheduleQueryPropertyDateRange { /** * Defines whether the schedule date range is STATIC or DYNAMIC. */ dateRangeType: string; dynamicDateRangeType: string; /** * The usage end time. */ timeUsageEnded: string; /** * The usage start time. */ timeUsageStarted: string; } interface GetScheduleQueryPropertyGroupByTag { /** * The tag key. */ key: string; /** * The namespace needed to determine the object storage bucket. */ namespace: string; /** * The tag value. */ value: string; } interface GetScheduleResultLocation { /** * The bucket name where usage or cost CSVs will be uploaded. */ bucket: string; /** * Defines the type of location where the usage or cost CSVs will be stored. */ locationType: string; /** * The namespace needed to determine the object storage bucket. */ namespace: string; /** * The destination Object Store Region specified by the customer. */ region: string; } interface GetScheduledRunsFilter { name: string; regex?: boolean; values: string[]; } interface GetScheduledRunsScheduledRunCollection { items: outputs.MeteringComputation.GetScheduledRunsScheduledRunCollectionItem[]; } interface GetScheduledRunsScheduledRunCollectionItem { /** * The OCID representing a unique shedule run. */ id: string; /** * Additional details about the scheduled run. */ lifecycleDetails: string; /** * The schedule unique ID. */ scheduleId: string; /** * Specifies whether or not the schedule job was successfully run. */ state: string; /** * The time the schedule started executing. */ timeCreated: string; /** * The time the schedule finished executing. */ timeFinished: string; } interface GetSchedulesFilter { /** * The query parameter for filtering by name. */ name: string; regex?: boolean; values: string[]; } interface GetSchedulesScheduleCollection { items: outputs.MeteringComputation.GetSchedulesScheduleCollectionItem[]; } interface GetSchedulesScheduleCollectionItem { /** * The compartment ID in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The description of the schedule. */ description: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID representing a unique shedule. */ id: string; /** * The query parameter for filtering by name. */ name: string; /** * Specifies the supported output file format. */ outputFileFormat: string; /** * The query properties. */ queryProperties: outputs.MeteringComputation.GetSchedulesScheduleCollectionItemQueryProperty[]; /** * The location where usage or cost CSVs will be uploaded defined by `locationType`, which corresponds with type-specific characteristics. */ resultLocations: outputs.MeteringComputation.GetSchedulesScheduleCollectionItemResultLocation[]; /** * The saved report ID which can also be used to generate a query. */ savedReportId: string; /** * Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in [RFC 5545 section 3.3.10](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY. */ scheduleRecurrences: string; /** * The schedule lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the schedule was created. */ timeCreated: string; /** * The date and time of the next job execution. */ timeNextRun: string; /** * The date and time of the first time job execution. */ timeScheduled: string; } interface GetSchedulesScheduleCollectionItemQueryProperty { /** * The depth level of the compartment. */ compartmentDepth: number; /** * Static or dynamic date range `dateRangeType`, which corresponds with type-specific characteristics. */ dateRanges: outputs.MeteringComputation.GetSchedulesScheduleCollectionItemQueryPropertyDateRange[]; /** * The filter object for query usage. */ filter: string; /** * The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY */ granularity: string; /** * Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ] */ groupBies: string[]; /** * GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [ { "namespace": "oracle", "key": "createdBy" ] */ groupByTags: outputs.MeteringComputation.GetSchedulesScheduleCollectionItemQueryPropertyGroupByTag[]; /** * Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. */ isAggregateByTime: boolean; /** * The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. Allowed values are: USAGE COST USAGE_AND_COST */ queryType: string; } interface GetSchedulesScheduleCollectionItemQueryPropertyDateRange { /** * Defines whether the schedule date range is STATIC or DYNAMIC. */ dateRangeType: string; dynamicDateRangeType: string; /** * The usage end time. */ timeUsageEnded: string; /** * The usage start time. */ timeUsageStarted: string; } interface GetSchedulesScheduleCollectionItemQueryPropertyGroupByTag { /** * The tag key. */ key: string; /** * The namespace needed to determine the object storage bucket. */ namespace: string; /** * The tag value. */ value: string; } interface GetSchedulesScheduleCollectionItemResultLocation { /** * The bucket name where usage or cost CSVs will be uploaded. */ bucket: string; /** * Defines the type of location where the usage or cost CSVs will be stored. */ locationType: string; /** * The namespace needed to determine the object storage bucket. */ namespace: string; /** * The destination Object Store Region specified by the customer. */ region: string; } interface GetUsageCarbonEmissionsConfigItem { /** * The configuration key. */ key: string; /** * The configuration value. */ values: string[]; } interface GetUsageCarbonEmissionsQueriesFilter { name: string; regex?: boolean; values: string[]; } interface GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollection { items: outputs.MeteringComputation.GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollectionItem[]; } interface GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollectionItem { /** * The compartment ID in which to list resources. */ compartmentId: string; /** * The query OCID. */ id: string; /** * The common fields for queries. */ queryDefinitions: outputs.MeteringComputation.GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollectionItemQueryDefinition[]; } interface GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollectionItemQueryDefinition { /** * The common fields for Cost Analysis UI rendering. */ costAnalysisUis: outputs.MeteringComputation.GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollectionItemQueryDefinitionCostAnalysisUi[]; /** * The query display name. Avoid entering confidential information. */ displayName: string; /** * The request of the generated carbon emissions usage report. */ reportQueries: outputs.MeteringComputation.GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollectionItemQueryDefinitionReportQuery[]; /** * The saved query version. */ version: number; } interface GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollectionItemQueryDefinitionCostAnalysisUi { /** * The graph type. */ graph: string; /** * A cumulative graph. */ isCumulativeGraph: boolean; } interface GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollectionItemQueryDefinitionReportQuery { /** * The compartment depth level. */ compartmentDepth: number; /** * The user interface date range, for example, LAST_THREE_MONTHS. Overrides the timeUsageStarted and timeUsageEnded properties. */ dateRangeName: string; /** * Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED */ emissionCalculationMethod: string; /** * Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED. */ emissionType: string; /** * The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. */ granularity: string; /** * Specifies what to aggregate the result by. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ groupBies: string[]; /** * GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: `[{"namespace":"oracle", "key":"createdBy"]` */ groupByTags: outputs.MeteringComputation.GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollectionItemQueryDefinitionReportQueryGroupByTag[]; /** * Specifies whether aggregated by time. If isAggregateByTime is true, all usage or costs over the query time period are summed. */ isAggregateByTime: boolean; /** * Tenant ID. */ tenantId: string; /** * The usage end time. */ timeUsageEnded: string; /** * The usage start time. */ timeUsageStarted: string; /** * The filter object for query usage. */ usageCarbonEmissionsQueryFilter: string; } interface GetUsageCarbonEmissionsQueriesUsageCarbonEmissionsQueryCollectionItemQueryDefinitionReportQueryGroupByTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface GetUsageCarbonEmissionsQueryQueryDefinition { /** * The common fields for Cost Analysis UI rendering. */ costAnalysisUis: outputs.MeteringComputation.GetUsageCarbonEmissionsQueryQueryDefinitionCostAnalysisUi[]; /** * The query display name. Avoid entering confidential information. */ displayName: string; /** * The request of the generated carbon emissions usage report. */ reportQueries: outputs.MeteringComputation.GetUsageCarbonEmissionsQueryQueryDefinitionReportQuery[]; /** * The saved query version. */ version: number; } interface GetUsageCarbonEmissionsQueryQueryDefinitionCostAnalysisUi { /** * The graph type. */ graph: string; /** * A cumulative graph. */ isCumulativeGraph: boolean; } interface GetUsageCarbonEmissionsQueryQueryDefinitionReportQuery { /** * The compartment depth level. */ compartmentDepth: number; /** * The user interface date range, for example, LAST_THREE_MONTHS. Overrides the timeUsageStarted and timeUsageEnded properties. */ dateRangeName: string; /** * Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED */ emissionCalculationMethod: string; /** * Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED. */ emissionType: string; /** * The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. */ granularity: string; /** * Specifies what to aggregate the result by. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ groupBies: string[]; /** * GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: `[{"namespace":"oracle", "key":"createdBy"]` */ groupByTags: outputs.MeteringComputation.GetUsageCarbonEmissionsQueryQueryDefinitionReportQueryGroupByTag[]; /** * Specifies whether aggregated by time. If isAggregateByTime is true, all usage or costs over the query time period are summed. */ isAggregateByTime: boolean; /** * Tenant ID. */ tenantId: string; /** * The usage end time. */ timeUsageEnded: string; /** * The usage start time. */ timeUsageStarted: string; /** * The filter object for query usage. */ usageCarbonEmissionsQueryFilter: string; } interface GetUsageCarbonEmissionsQueryQueryDefinitionReportQueryGroupByTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface GetUsageStatementEmailRecipientsGroupRecipientsList { /** * The recipient email address. */ emailId: string; /** * The recipient first name. */ firstName: string; /** * The recipient last name. */ lastName: string; /** * The email recipients group lifecycle state. */ state: string; } interface GetUsageStatementEmailRecipientsGroupsEmailRecipientsGroupCollection { items: outputs.MeteringComputation.GetUsageStatementEmailRecipientsGroupsEmailRecipientsGroupCollectionItem[]; } interface GetUsageStatementEmailRecipientsGroupsEmailRecipientsGroupCollectionItem { /** * The compartment ID in which to list resources. */ compartmentId: string; emailRecipientsGroupId: string; /** * The usage statement email recipients group OCID. */ id: string; /** * The list of recipients that will receive usage statement emails. */ recipientsLists: outputs.MeteringComputation.GetUsageStatementEmailRecipientsGroupsEmailRecipientsGroupCollectionItemRecipientsList[]; /** * The email recipients group lifecycle state. */ state: string; /** * The usage statement subscription unique OCID. */ subscriptionId: string; } interface GetUsageStatementEmailRecipientsGroupsEmailRecipientsGroupCollectionItemRecipientsList { /** * The recipient email address. */ emailId: string; /** * The recipient first name. */ firstName: string; /** * The recipient last name. */ lastName: string; /** * The email recipients group lifecycle state. */ state: string; } interface GetUsageStatementEmailRecipientsGroupsFilter { name: string; regex?: boolean; values: string[]; } interface QueryQueryDefinition { /** * (Updatable) The common fields for Cost Analysis UI rendering. */ costAnalysisUi: outputs.MeteringComputation.QueryQueryDefinitionCostAnalysisUi; /** * (Updatable) The query display name. Avoid entering confidential information. */ displayName: string; /** * (Updatable) The request of the generated Cost Analysis report. */ reportQuery: outputs.MeteringComputation.QueryQueryDefinitionReportQuery; /** * (Updatable) The saved query version. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ version: number; } interface QueryQueryDefinitionCostAnalysisUi { /** * (Updatable) The graph type. */ graph: string; /** * (Updatable) A cumulative graph. */ isCumulativeGraph: boolean; } interface QueryQueryDefinitionReportQuery { /** * (Updatable) The compartment depth level. */ compartmentDepth: number; /** * (Updatable) The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded. */ dateRangeName: string; /** * (Updatable) The filter object for query usage. */ filter: string; /** * (Updatable) Forecast configuration of usage/cost. */ forecast: outputs.MeteringComputation.QueryQueryDefinitionReportQueryForecast; /** * (Updatable) The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported. */ granularity: string; /** * (Updatable) Specifies what to aggregate the result by. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ groupBies: string[]; /** * (Updatable) GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: `[{"namespace":"oracle", "key":"createdBy"]` */ groupByTags: outputs.MeteringComputation.QueryQueryDefinitionReportQueryGroupByTag[]; /** * (Updatable) Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. */ isAggregateByTime: boolean; /** * (Updatable) The query usage type. COST by default if it is missing. * * Usage: Query the usage data. * * Cost: Query the cost/billing data. * * Credit: Query the credit adjustments data. * * ExpiredCredit: Query the expired credits data. * * AllCredit: Query the credit adjustments and expired credit. */ queryType: string; /** * (Updatable) Tenant ID. */ tenantId: string; /** * (Updatable) The usage end time. */ timeUsageEnded: string; /** * (Updatable) The usage start time. */ timeUsageStarted: string; } interface QueryQueryDefinitionReportQueryForecast { /** * (Updatable) BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made. */ forecastType: string; /** * (Updatable) The forecast end time. */ timeForecastEnded: string; /** * (Updatable) The forecast start time. Defaults to UTC-1 if not specified. */ timeForecastStarted: string; } interface QueryQueryDefinitionReportQueryGroupByTag { /** * (Updatable) The tag key. */ key: string; /** * (Updatable) The tag namespace. */ namespace: string; /** * (Updatable) The tag value. */ value: string; } interface ScheduleQueryProperties { /** * The depth level of the compartment. */ compartmentDepth: number; /** * Static or dynamic date range `dateRangeType`, which corresponds with type-specific characteristics. */ dateRange: outputs.MeteringComputation.ScheduleQueryPropertiesDateRange; /** * The filter object for query usage. */ filter: string; /** * The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY */ granularity: string; /** * Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ] */ groupBies: string[]; /** * GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [ { "namespace": "oracle", "key": "createdBy" ] */ groupByTags: outputs.MeteringComputation.ScheduleQueryPropertiesGroupByTag[]; /** * Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. */ isAggregateByTime: boolean; /** * The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. Allowed values are: USAGE COST USAGE_AND_COST */ queryType: string; } interface ScheduleQueryPropertiesDateRange { /** * Defines whether the schedule date range is STATIC or DYNAMIC. */ dateRangeType: string; dynamicDateRangeType: string; /** * The usage end time. */ timeUsageEnded: string; /** * The usage start time. */ timeUsageStarted: string; } interface ScheduleQueryPropertiesGroupByTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface ScheduleResultLocation { /** * (Updatable) The bucket name where usage or cost CSVs will be uploaded. */ bucket: string; /** * (Updatable) Defines the type of location where the usage or cost CSVs will be stored. */ locationType: string; /** * (Updatable) The namespace needed to determine the object storage bucket. */ namespace: string; /** * (Updatable) The destination Object Store Region specified by the customer. */ region: string; } interface UsageCarbonEmissionGroupByTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface UsageCarbonEmissionItem { /** * The availability domain of the usage. */ ad: string; /** * The compartment OCID. */ compartmentId: string; /** * The compartment name. */ compartmentName: string; /** * The compartment path, starting from root. */ compartmentPath: string; /** * The carbon emission usage in MTCO2 units. */ computedCarbonEmission: number; /** * Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED */ emissionCalculationMethod: string; /** * Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED. */ emissionType: string; /** * Platform for the cost. */ platform: string; /** * The region of the usage. */ region: string; /** * The resource OCID that is incurring the cost. */ resourceId: string; /** * The resource name that is incurring the cost. */ resourceName: string; /** * The service name that is incurring the cost. */ service: string; /** * The SKU friendly name. */ skuName: string; /** * The SKU part number. */ skuPartNumber: string; /** * The subscription ID. */ subscriptionId: string; /** * For grouping, a tag definition. For filtering, a definition and key. */ tags: outputs.MeteringComputation.UsageCarbonEmissionItemTag[]; /** * Tenant ID. */ tenantId: string; /** * The tenancy name. */ tenantName: string; /** * The usage end time. */ timeUsageEnded: string; /** * The usage start time. */ timeUsageStarted: string; } interface UsageCarbonEmissionItemTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface UsageCarbonEmissionsQueryQueryDefinition { /** * (Updatable) The common fields for Cost Analysis UI rendering. */ costAnalysisUi: outputs.MeteringComputation.UsageCarbonEmissionsQueryQueryDefinitionCostAnalysisUi; /** * (Updatable) The query display name. Avoid entering confidential information. */ displayName: string; /** * (Updatable) The request of the generated carbon emissions usage report. */ reportQuery: outputs.MeteringComputation.UsageCarbonEmissionsQueryQueryDefinitionReportQuery; /** * (Updatable) The saved query version. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ version: number; } interface UsageCarbonEmissionsQueryQueryDefinitionCostAnalysisUi { /** * (Updatable) The graph type. */ graph: string; /** * (Updatable) A cumulative graph. */ isCumulativeGraph: boolean; } interface UsageCarbonEmissionsQueryQueryDefinitionReportQuery { /** * (Updatable) The compartment depth level. */ compartmentDepth: number; /** * (Updatable) The user interface date range, for example, LAST_THREE_MONTHS. Overrides the timeUsageStarted and timeUsageEnded properties. */ dateRangeName: string; /** * (Updatable) Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED */ emissionCalculationMethod: string; /** * (Updatable) Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED. */ emissionType: string; /** * (Updatable) The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. */ granularity: string; /** * (Updatable) Specifies what to aggregate the result by. For example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]` */ groupBies: string[]; /** * (Updatable) GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: `[{"namespace":"oracle", "key":"createdBy"]` */ groupByTags: outputs.MeteringComputation.UsageCarbonEmissionsQueryQueryDefinitionReportQueryGroupByTag[]; /** * (Updatable) Specifies whether aggregated by time. If isAggregateByTime is true, all usage or costs over the query time period are summed. */ isAggregateByTime: boolean; /** * (Updatable) Tenant ID. */ tenantId: string; /** * (Updatable) The usage end time. */ timeUsageEnded: string; /** * (Updatable) The usage start time. */ timeUsageStarted: string; /** * (Updatable) The filter object for query usage. */ usageCarbonEmissionsQueryFilter: string; } interface UsageCarbonEmissionsQueryQueryDefinitionReportQueryGroupByTag { /** * (Updatable) The tag key. */ key: string; /** * (Updatable) The tag namespace. */ namespace: string; /** * (Updatable) The tag value. */ value: string; } interface UsageForecast { /** * BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made. */ forecastType: string; /** * The forecast end time. */ timeForecastEnded: string; /** * The forecast start time. Defaults to UTC-1 if not specified. */ timeForecastStarted: string; } interface UsageGroupByTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface UsageItem { /** * The availability domain of the usage. */ ad: string; /** * The attributed cost with a max value of 9999999999.999999999999 and a minimum value of 0. */ attributedCost: string; /** * The attributed usage with a max value of 9999999999.999999999999 and a minimum value of 0. */ attributedUsage: string; /** * The compartment OCID. */ compartmentId: string; /** * The compartment name. */ compartmentName: string; /** * The compartment path, starting from root. */ compartmentPath: string; /** * The computed cost. */ computedAmount: number; /** * The usage number. */ computedQuantity: number; /** * The price currency. */ currency: string; /** * The discretionary discount applied to the SKU. */ discount: number; /** * The forecasted data. */ isForecast: boolean; /** * The SKU list rate (not discount). */ listRate: number; /** * The overage usage. */ overage: string; /** * The SPM OverageFlag. */ overagesFlag: string; /** * Platform for the cost. */ platform: string; /** * The region of the usage. */ region: string; /** * The resource OCID that is incurring the cost. */ resourceId: string; /** * The resource name that is incurring the cost. */ resourceName: string; /** * The service name that is incurring the cost. */ service: string; /** * The resource shape. */ shape: string; /** * The SKU friendly name. */ skuName: string; /** * The SKU part number. */ skuPartNumber: string; /** * The subscription ID. */ subscriptionId: string; /** * For grouping, a tag definition. For filtering, a definition and key. */ tags: outputs.MeteringComputation.UsageItemTag[]; /** * Tenant ID. */ tenantId: string; /** * The tenancy name. */ tenantName: string; /** * The usage end time. */ timeUsageEnded: string; /** * The usage start time. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ timeUsageStarted: string; /** * The usage unit. */ unit: string; /** * The price per unit. */ unitPrice: number; /** * The resource size being metered. */ weight: number; } interface UsageItemTag { /** * The tag key. */ key: string; /** * The tag namespace. */ namespace: string; /** * The tag value. */ value: string; } interface UsageStatementEmailRecipientsGroupRecipientsList { /** * (Updatable) The recipient email address. */ emailId: string; /** * (Updatable) The recipient first name. */ firstName: string; /** * (Updatable) The recipient last name. */ lastName: string; /** * (Updatable) The email recipient lifecycle state. */ state: string; } } export declare namespace Monitoring { interface AlarmOverride { /** * (Updatable) The human-readable content of the delivered alarm notification. Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.` */ body: string; /** * (Updatable) The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". 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". * * The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M. * * Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING". * * The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute. * * Example: `PT5M` */ pendingDuration: string; /** * (Updatable) 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 depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). * * Example of threshold alarm: * * *** * * CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 * * *** * * Example of absence alarm: * * *** * * CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() * * ----- Example of absence alarm with custom absence detection period of 20 hours: * * ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) ----- */ query: string; /** * (Updatable) A user-friendly description for this alarm override. Must be unique across all `ruleName` values for the alarm. */ ruleName: string; /** * (Updatable) The perceived severity of the alarm with regard to the affected system. Example: `CRITICAL` */ severity: string; } interface AlarmSuppression { /** * (Updatable) Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information. * * Oracle recommends including tracking information for the event or associated work, such as a ticket number. * * Example: `Planned outage due to change IT-1234.` */ description: string; /** * (Updatable) The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` */ timeSuppressFrom: string; /** * (Updatable) The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2023-02-01T02:02:29.600Z` * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ timeSuppressUntil: string; } interface AlarmSuppressionAlarmSuppressionTarget { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm that is the target of the alarm suppression. */ alarmId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment or tenancy that is the target of the alarm suppression. Example: `ocid1.compartment.oc1..exampleuniqueID` */ compartmentId: string; /** * When true, the alarm suppression targets all alarms under all compartments and subcompartments of the tenancy specified. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). When false, the alarm suppression targets only the alarms under the specified compartment. */ compartmentIdInSubtree: boolean; /** * The type of the alarm suppression target. */ targetType: string; } interface AlarmSuppressionSuppressionCondition { /** * Type of suppression condition. */ conditionType: string; /** * Duration of the recurring suppression. Specified as a string in ISO 8601 format. Minimum: `PT1M` (1 minute). Maximum: `PT24H` (24 hours). */ suppressionDuration: string; /** * Frequency and start time of the recurring suppression. The format follows [the iCalendar specification (RFC 5545, section 3.3.10)](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported rule parts: * * `FREQ`: Frequency of the recurring suppression: `WEEKLY` or `DAILY` only. * * `BYDAY`: Comma separated days. Use with weekly suppressions only. Supported values: `MO`, `TU`, `WE`, `TH`, `FR`, `SA` ,`SU`. * * `BYHOUR`, `BYMINUTE`, `BYSECOND`: Start time in UTC, after `timeSuppressFrom` value. Default is 00:00:00 UTC after `timeSuppressFrom`. */ suppressionRecurrence: string; } interface GetAlarmHistoryCollectionEntry { /** * Customizable alarm summary (`alarmSummary` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to [ListAlarmStatus](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) [GetAlarmHistory](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and [RetrieveDimensionStates](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). */ alarmSummary: string; /** * Description for this alarm history entry. */ summary: string; /** * Timestamp for this alarm history entry. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` */ timestamp: string; /** * Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: `2023-02-01T0:59:00.789Z` */ timestampTriggered: string; } interface GetAlarmOverride { /** * The human-readable content of the delivered alarm notification. Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.` */ body: string; /** * The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". 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". */ pendingDuration: string; /** * 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 depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). */ query: string; /** * Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride). */ ruleName: string; /** * The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL` */ severity: string; } interface GetAlarmStatusesAlarmStatus { /** * Customizable alarm summary (`alarmSummary` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to [ListAlarmStatus](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) [GetAlarmHistory](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and [RetrieveDimensionStates](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). */ alarmSummary: string; /** * A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm. */ id: string; /** * Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride). */ ruleName: string; /** * The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL` */ severity: string; /** * The status of the metric stream to use for alarm filtering. For example, set `StatusQueryParam` to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: `FIRING` */ status: string; /** * The configuration details for suppressing an alarm. */ suppressions: outputs.Monitoring.GetAlarmStatusesAlarmStatusSuppression[]; /** * Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: `2023-02-01T01:02:29.600Z` */ timestampTriggered: string; } interface GetAlarmStatusesAlarmStatusSuppression { /** * Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` */ timeSuppressFrom: string; /** * The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2023-02-01T02:02:29.600Z` */ timeSuppressUntil: string; } interface GetAlarmStatusesFilter { name: string; regex?: boolean; values: string[]; } interface GetAlarmSuppression { /** * Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` */ timeSuppressFrom: string; /** * The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2023-02-01T02:02:29.600Z` */ timeSuppressUntil: string; } interface GetAlarmSuppressionAlarmSuppressionTarget { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm that is the target of the alarm suppression. */ alarmId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm suppression. */ compartmentId: string; /** * When true, the alarm suppression targets all alarms under all compartments and subcompartments of the tenancy specified. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). When false, the alarm suppression targets only the alarms under the specified compartment. */ compartmentIdInSubtree: boolean; /** * The type of the alarm suppression target. */ targetType: string; } interface GetAlarmSuppressionSuppressionCondition { /** * Type of suppression condition. */ conditionType: string; /** * Duration of the recurring suppression. Specified as a string in ISO 8601 format. Minimum: `PT1M` (1 minute). Maximum: `PT24H` (24 hours). */ suppressionDuration: string; /** * Frequency and start time of the recurring suppression. The format follows [the iCalendar specification (RFC 5545, section 3.3.10)](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported rule parts: * * `FREQ`: Frequency of the recurring suppression: `WEEKLY` or `DAILY` only. * * `BYDAY`: Comma separated days. Use with weekly suppressions only. Supported values: `MO`, `TU`, `WE`, `TH`, `FR`, `SA` ,`SU`. * * `BYHOUR`, `BYMINUTE`, `BYSECOND`: Start time in UTC, after `timeSuppressFrom` value. Default is 00:00:00 UTC after `timeSuppressFrom`. */ suppressionRecurrence: string; } interface GetAlarmSuppressionsAlarmSuppressionCollection { items: outputs.Monitoring.GetAlarmSuppressionsAlarmSuppressionCollectionItem[]; } interface GetAlarmSuppressionsAlarmSuppressionCollectionItem { /** * The target of the alarm suppression. */ alarmSuppressionTargets: outputs.Monitoring.GetAlarmSuppressionsAlarmSuppressionCollectionItemAlarmSuppressionTarget[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for searching. Use the tenancy OCID to search in the root compartment. * * If targetType is not specified, searches all suppressions defined under the compartment. If targetType is `COMPARTMENT`, searches suppressions in the specified compartment only. * * Example: `ocid1.compartment.oc1..exampleuniqueID` */ compartmentId: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: `{"resourceId": "instance.region1.phx.exampleuniqueID"}` */ dimensions: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. Use this filter to list an alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression. */ id: string; /** * The level of this alarm suppression. `ALARM` indicates a suppression of the entire alarm, regardless of dimension. `DIMENSION` indicates a suppression configured for specified dimensions. */ level: string; /** * A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed. */ state: string; /** * Array of all preconditions for alarm suppression. Example: `[{ conditionType: "RECURRENCE", suppressionRecurrence: "FRQ=DAILY;BYHOUR=10", suppressionDuration: "PT1H" }]` */ suppressionConditions: outputs.Monitoring.GetAlarmSuppressionsAlarmSuppressionCollectionItemSuppressionCondition[]; /** * The date and time the alarm suppression was created. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z` */ timeCreated: string; /** * The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T01:02:29.600Z` */ timeSuppressFrom: string; /** * The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2018-02-01T02:02:29.600Z` */ timeSuppressUntil: string; /** * The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: `2018-02-03T01:02:29.600Z` */ timeUpdated: string; } interface GetAlarmSuppressionsAlarmSuppressionCollectionItemAlarmSuppressionTarget { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm that is the target of the alarm suppression. */ alarmId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for searching. Use the tenancy OCID to search in the root compartment. * * If targetType is not specified, searches all suppressions defined under the compartment. If targetType is `COMPARTMENT`, searches suppressions in the specified compartment only. * * Example: `ocid1.compartment.oc1..exampleuniqueID` */ compartmentId: string; /** * When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false. */ compartmentIdInSubtree: boolean; /** * The target type to use when listing alarm suppressions. `ALARM` lists all suppression records for the specified alarm. `COMPARTMENT` lists all suppression records for the specified compartment or tenancy. */ targetType: string; } interface GetAlarmSuppressionsAlarmSuppressionCollectionItemSuppressionCondition { /** * Type of suppression condition. */ conditionType: string; /** * Duration of the recurring suppression. Specified as a string in ISO 8601 format. Minimum: `PT1M` (1 minute). Maximum: `PT24H` (24 hours). */ suppressionDuration: string; /** * Frequency and start time of the recurring suppression. The format follows [the iCalendar specification (RFC 5545, section 3.3.10)](https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported rule parts: * * `FREQ`: Frequency of the recurring suppression: `WEEKLY` or `DAILY` only. * * `BYDAY`: Comma separated days. Use with weekly suppressions only. Supported values: `MO`, `TU`, `WE`, `TH`, `FR`, `SA` ,`SU`. * * `BYHOUR`, `BYMINUTE`, `BYSECOND`: Start time in UTC, after `timeSuppressFrom` value. Default is 00:00:00 UTC after `timeSuppressFrom`. */ suppressionRecurrence: string; } interface GetAlarmSuppressionsFilter { name: string; regex?: boolean; values: string[]; } interface GetAlarmsAlarm { /** * Customizable alarm summary (`alarmSummary` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to [ListAlarmStatus](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) [GetAlarmHistory](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and [RetrieveDimensionStates](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates). */ alarmSummary: string; /** * The human-readable content of the delivered alarm notification. Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.` */ body: string; /** * 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. Example: `ocid1.compartment.oc1..exampleuniqueID` */ compartmentId: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}` */ definedTags: { [key: string]: string; }; /** * A list of destinations for alarm notifications. Each destination is represented by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a related resource, such as a [topic](https://docs.cloud.oracle.com/iaas/api/#/en/notification/latest/NotificationTopic). Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service. */ destinations: string[]; /** * A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation. */ displayName: string; /** * Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see [About the Internal Reset Period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). */ evaluationSlackDuration: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm. */ id: string; /** * Whether the alarm is enabled. Example: `true` */ isEnabled: boolean; /** * Whether the alarm sends a separate message for each metric stream. See [Creating an Alarm That Splits Messages by Metric Stream](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-alarm-split.htm). Example: `true` */ isNotificationsPerMetricDimensionEnabled: boolean; /** * The format to use for alarm notifications. The formats are: * * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format. * * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only. * * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only. */ messageFormat: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm. */ metricCompartmentId: string; /** * When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: `true` */ metricCompartmentIdInSubtree: boolean; /** * The source service or application emitting the metric that is evaluated by the alarm. Example: `ociComputeagent` */ namespace: string; /** * Customizable notification title (`title` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The notification title appears as the subject line in a formatted email message and as the title in a Slack message. */ notificationTitle: string; /** * The version of the alarm notification to be delivered. Allowed value: `1.X` The value must start with a number (up to four digits), followed by a period and an uppercase X. */ notificationVersion: string; /** * A set of overrides that control evaluations of the alarm. */ overrides: outputs.Monitoring.GetAlarmsAlarmOverride[]; /** * The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". 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". */ pendingDuration: string; /** * 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 depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). */ query: string; /** * The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D. */ repeatNotificationDuration: string; /** * The time between calculated aggregation windows for the alarm. Supported value: `1m` */ resolution: string; /** * Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet` */ resourceGroup: string; /** * Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride). */ ruleName: string; /** * The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL` */ severity: string; /** * A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed. */ state: string; /** * The configuration details for suppressing an alarm. */ suppressions: outputs.Monitoring.GetAlarmsAlarmSuppression[]; /** * The date and time the alarm was created. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` */ timeCreated: string; /** * The date and time the alarm was last updated. Format defined by RFC3339. Example: `2023-02-03T01:02:29.600Z` */ timeUpdated: string; } interface GetAlarmsAlarmOverride { /** * The human-readable content of the delivered alarm notification. Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.` */ body: string; /** * The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". 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". */ pendingDuration: string; /** * 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 depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). */ query: string; /** * Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride). */ ruleName: string; /** * The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL` */ severity: string; } interface GetAlarmsAlarmSuppression { /** * Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` */ timeSuppressFrom: string; /** * The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2023-02-01T02:02:29.600Z` */ timeSuppressUntil: string; } interface GetAlarmsFilter { name: string; regex?: boolean; values: string[]; } interface GetMetricDataFilter { /** * The name of the metric. Example: `CpuUtilization` */ name: string; regex?: boolean; values: string[]; } interface GetMetricDataMetricData { /** * The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page. */ aggregatedDatapoints: outputs.Monitoring.GetMetricDataMetricDataAggregatedDatapoint[]; /** * 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. Example: `ocid1.compartment.oc1..exampleuniqueID` */ compartmentId: string; /** * When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false. */ compartmentIdInSubtree: boolean; /** * Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: `{"resourceId": "instance.region1.phx.exampleuniqueID"}` */ dimensions: { [key: string]: string; }; /** * The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent. Example: `2023-02-01T02:02:29.600Z` */ endTime: string; /** * The references provided in a metric definition to indicate extra information about the metric. Example: `"unit": "bytes"` */ metadata: { [key: string]: string; }; /** * The name of the metric. Example: `CpuUtilization` */ name: string; /** * The source service or application to use when searching for metric data points to aggregate. Example: `ociComputeagent` */ namespace: string; /** * The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate. The query must specify a metric, statistic, and interval. Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. When specifying a dimension value, surround it with double quotes, and escape each double quote with a backslash (`\`) character. Supported grouping functions: `grouping()`, `groupBy()`. * * Construct your query to avoid exceeding limits on returned data. See [MetricData Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/20180401/MetricData). * * For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). * * Example 1: `CpuUtilization[1m].sum()` * * Example 2 (escaped double quotes for value string): `CpuUtilization[1m]{resourceId = \"<instance_OCID>\"}.max()` */ query: string; /** * The time between calculated aggregation windows. Use with the query interval to vary the frequency for returning aggregated data points. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`. Example: `5m` */ resolution: string; /** * Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet` */ resourceGroup: string; /** * The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent. Example: `2023-02-01T01:02:29.600Z` */ startTime: string; } interface GetMetricDataMetricDataAggregatedDatapoint { /** * The date and time associated with the value of this data point. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` */ timestamp: string; /** * Numeric value of the metric. Example: `10.4` */ value: number; } interface GetMetricsFilter { /** * The metric name to use when searching for metric definitions. Example: `CpuUtilization` */ name: string; regex?: boolean; values: string[]; } interface GetMetricsMetric { /** * 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. Example: `ocid1.compartment.oc1..exampleuniqueID` */ compartmentId: string; /** * When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false. */ compartmentIdInSubtree: boolean; /** * Qualifiers that you want to use when searching for metric definitions. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: `{"resourceId": "instance.region1.phx.exampleuniqueID"}` */ dimensionFilters: { [key: string]: string; }; /** * Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: `{"resourceId": "instance.region1.phx.exampleuniqueID"}` */ dimensions: { [key: string]: string; }; /** * Group metrics by these fields in the response. For example, to list all metric namespaces available in a compartment, groupBy the "namespace" field. Supported fields: namespace, name, resourceGroup. If `groupBy` is used, then `dimensionFilters` is ignored. * * Example - group by namespace: `[ "namespace" ]` */ groupBies: string[]; /** * The metric name to use when searching for metric definitions. Example: `CpuUtilization` */ name: string; /** * The source service or application to use when searching for metric definitions. Example: `ociComputeagent` */ namespace: string; /** * Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet` */ resourceGroup: string; } } export declare namespace Mysql { interface ChannelSource { /** * (Updatable) Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does. */ anonymousTransactionsHandling: outputs.Mysql.ChannelSourceAnonymousTransactionsHandling; /** * (Updatable) The network address of the MySQL instance. */ hostname: string; /** * (Updatable) Whether the connection of the channel will be requested using the IPv6 address of the dual stack DB system or not. Default: False. */ mustUseIpv6onDualStack: boolean; /** * (Updatable) The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character. */ password: string; /** * (Updatable) The port the source MySQL instance listens on. */ port: number; /** * (Updatable) The specific source identifier. */ sourceType: string; /** * (Updatable) The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes. */ sslCaCertificate: outputs.Mysql.ChannelSourceSslCaCertificate; /** * (Updatable) The SSL mode of the Channel. */ sslMode: string; /** * (Updatable) The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/change-master-to.html) */ username: string; } interface ChannelSourceAnonymousTransactionsHandling { /** * (Updatable) Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogFilename: string; /** * (Updatable) Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogOffset: string; /** * (Updatable) Specifies how the replication channel handles anonymous transactions. */ policy: string; /** * (Updatable) The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later. */ uuid: string; } interface ChannelSourceSslCaCertificate { /** * (Updatable) The type of CA certificate. */ certificateType: string; /** * (Updatable) The string containing the CA certificate in PEM format. */ contents: string; } interface ChannelTarget { /** * (Updatable) The username for the replication applier of the target MySQL DB System. */ applierUsername: string; /** * (Updatable) The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for [MySQL identifiers](https://dev.mysql.com/doc/refman/8.0/en/identifiers.html). The names of non-Deleted Channels must be unique for each DB System. */ channelName: string; /** * The OCID of the target DB System. */ dbSystemId: string; /** * (Updatable) Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source. */ delayInSeconds: number; /** * (Updatable) Replication filter rules to be applied at the DB System Channel target. */ filters: outputs.Mysql.ChannelTargetFilter[]; /** * (Updatable) Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. The default value is set to ALLOW. */ tablesWithoutPrimaryKeyHandling: string; /** * (Updatable) The specific target identifier. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ targetType: string; } interface ChannelTargetFilter { /** * (Updatable) The type of the filter rule. * * For details on each type, see [Replication Filtering Rules](https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html) */ type: string; /** * (Updatable) The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see [Replication Filtering Rules](https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html). */ value: string; } interface GetChannelSource { /** * Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does. */ anonymousTransactionsHandlings: outputs.Mysql.GetChannelSourceAnonymousTransactionsHandling[]; /** * The network address of the MySQL instance. */ hostname: string; /** * Whether the connection of the channel will be requested using the IPv6 address of the dual stack DB system or not. Default: False. */ mustUseIpv6onDualStack: boolean; password: string; /** * The port the source MySQL instance listens on. */ port: number; /** * The specific source identifier. */ sourceType: string; /** * The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes. */ sslCaCertificates: outputs.Mysql.GetChannelSourceSslCaCertificate[]; /** * The SSL mode of the Channel. */ sslMode: string; /** * The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/change-master-to.html) */ username: string; } interface GetChannelSourceAnonymousTransactionsHandling { /** * Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogFilename: string; /** * Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogOffset: string; /** * Specifies how the replication channel handles anonymous transactions. */ policy: string; /** * The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later. */ uuid: string; } interface GetChannelSourceSslCaCertificate { /** * The type of CA certificate. */ certificateType: string; /** * The string containing the CA certificate in PEM format. */ contents: string; } interface GetChannelTarget { /** * The username for the replication applier of the target MySQL DB System. */ applierUsername: string; /** * The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for [MySQL identifiers](https://dev.mysql.com/doc/refman/8.0/en/identifiers.html). The names of non-Deleted Channels must be unique for each DB System. */ channelName: string; /** * The OCID of the source DB System. */ dbSystemId: string; /** * Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source. */ delayInSeconds: number; /** * Replication filter rules to be applied at the DB System Channel target. */ filters: outputs.Mysql.GetChannelTargetFilter[]; /** * Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. */ tablesWithoutPrimaryKeyHandling: string; /** * The specific target identifier. */ targetType: string; } interface GetChannelTargetFilter { /** * The type of the filter rule. */ type: string; /** * The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see [Replication Filtering Rules](https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html). */ value: string; } interface GetChannelsChannel { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * User provided description of the Channel. */ description: string; /** * A filter to return only the resource matching the given display name exactly. */ displayName: string; /** * Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Channel. */ id: string; /** * If true, returns only Channels that are enabled. If false, returns only Channels that are disabled. */ isEnabled: boolean; /** * A message describing the state of the Channel. */ lifecycleDetails: string; /** * Parameters detailing how to provision the source for the given Channel. */ sources: outputs.Mysql.GetChannelsChannelSource[]; /** * The LifecycleState of the Channel. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Details about the Channel target. */ targets: outputs.Mysql.GetChannelsChannelTarget[]; /** * The date and time the Channel was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; /** * The time the Channel was last updated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; } interface GetChannelsChannelSource { /** * Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does. */ anonymousTransactionsHandlings: outputs.Mysql.GetChannelsChannelSourceAnonymousTransactionsHandling[]; /** * The network address of the MySQL instance. */ hostname: string; /** * Whether the connection of the channel will be requested using the IPv6 address of the dual stack DB system or not. Default: False. */ mustUseIpv6onDualStack: boolean; password: string; /** * The port the source MySQL instance listens on. */ port: number; /** * The specific source identifier. */ sourceType: string; /** * The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes. */ sslCaCertificates: outputs.Mysql.GetChannelsChannelSourceSslCaCertificate[]; /** * The SSL mode of the Channel. */ sslMode: string; /** * The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/change-master-to.html) */ username: string; } interface GetChannelsChannelSourceAnonymousTransactionsHandling { /** * Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogFilename: string; /** * Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogOffset: string; /** * Specifies how the replication channel handles anonymous transactions. */ policy: string; /** * The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later. */ uuid: string; } interface GetChannelsChannelSourceSslCaCertificate { /** * The type of CA certificate. */ certificateType: string; /** * The string containing the CA certificate in PEM format. */ contents: string; } interface GetChannelsChannelTarget { /** * The username for the replication applier of the target MySQL DB System. */ applierUsername: string; /** * The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for [MySQL identifiers](https://dev.mysql.com/doc/refman/8.0/en/identifiers.html). The names of non-Deleted Channels must be unique for each DB System. */ channelName: string; /** * The DB System [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbSystemId: string; /** * Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source. */ delayInSeconds: number; /** * Replication filter rules to be applied at the DB System Channel target. */ filters: outputs.Mysql.GetChannelsChannelTargetFilter[]; /** * Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. */ tablesWithoutPrimaryKeyHandling: string; /** * The specific target identifier. */ targetType: string; } interface GetChannelsChannelTargetFilter { /** * The type of the filter rule. */ type: string; /** * The body of the filter rule. This can represent a database, a table, or a database pair (represented as "db1->db2"). For more information, see [Replication Filtering Rules](https://dev.mysql.com/doc/refman/8.0/en/replication-rules.html). */ value: string; } interface GetChannelsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbSystemMaintenanceEventsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbSystemMaintenanceEventsMaintenanceEvent { /** * The OCID of the compartment the maintenance event belongs to. */ compartmentId: string; /** * The DB System [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbSystemId: string; /** * The nature of the maintenance event. */ maintenanceAction: string; maintenanceNotes: string; /** * The MySQL instances operated during a maintenance event. */ maintenanceScope: string; /** * The last status of the maintenance event. */ maintenanceStatus: string; /** * How the maintenance event was triggered. */ maintenanceType: string; /** * The MySQL version after the maintenance event. */ mysqlVersionAfterMaintenance: string; /** * The MySQL version before the maintenance event. */ mysqlVersionBeforeMaintenance: string; /** * The date and time the record was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; /** * The date and time the maintenance event ended, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeEnded: string; /** * The date and time the DB System came back online during the maintenance, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeMysqlSwitchOverEnded: string; /** * The date and time the DB System was initially down during the maintenance, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeMysqlSwitchOverStarted: string; /** * The date and time the maintenance event started, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeStarted: string; } interface GetHeatWaveClusterClusterNode { /** * The ID of the node within MySQL HeatWave cluster. */ nodeId: string; /** * The current state of the HeatWave cluster. */ state: string; /** * The date and time the HeatWave cluster was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; /** * The time the HeatWave cluster was last updated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; } interface GetMysqlBackupBackupValidationDetail { /** * Indicates whether the backup has been prepared successfully. PREPARED: The backup is prepared one. NOT_PREPARED: The backup is not prepared. */ backupPreparationStatus: string; /** * Error message if the backup validation has failed. */ errorMessage: string; /** * The estimated restore duration of the backup. */ estimatedRestoreDuration: string; /** * Prepared backup details. */ preparedBackupDetails: outputs.Mysql.GetMysqlBackupBackupValidationDetailPreparedBackupDetail[]; /** * The date and time of the most recent validation performed on the backup. */ timeLastValidated: string; /** * The status of backup validation: NOT_VALIDATED (Default): The backup has not been validated. VALIDATED: The backup has been validated successfully. NEEDS_ATTENTION: The backup validation failed due to a transient issue. Validation should be retried. FAILED: The backup cannot be restored. */ validationStatus: string; } interface GetMysqlBackupBackupValidationDetailPreparedBackupDetail { /** * The estimated time saving when this prepared backup is restored. */ preparedBackupRestoreReductionInMinutes: number; /** * The date and time the backup was prepared. */ timePrepared: string; } interface GetMysqlBackupDbSystemSnapshot { /** * The username for the administrative user. */ adminUsername: string; /** * The Availability Domain where the primary DB System should be located. */ availabilityDomain: string; /** * The Backup policy for the DB System. */ backupPolicies: outputs.Mysql.GetMysqlBackupDbSystemSnapshotBackupPolicy[]; /** * The OCID of the compartment the DB System belongs in. */ compartmentId: string; /** * The OCID of the Configuration to be used for Instances in this DB System. */ configurationId: string; /** * Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs. */ crashRecovery: string; /** * DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs. */ dataStorageSizeInGb: number; /** * Data Storage information. */ dataStorages: outputs.Mysql.GetMysqlBackupDbSystemSnapshotDataStorage[]; /** * Database console configuration details. */ databaseConsoles: outputs.Mysql.GetMysqlBackupDbSystemSnapshotDatabaseConsole[]; /** * Whether to enable monitoring via the Database Management service. */ databaseManagement: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The Deletion policy for the DB System. */ deletionPolicies: outputs.Mysql.GetMysqlBackupDbSystemSnapshotDeletionPolicy[]; /** * A user-supplied description for the backup. */ description: string; /** * A user-supplied display name for the backup. */ displayName: string; /** * Encrypt data details. */ encryptDatas: outputs.Mysql.GetMysqlBackupDbSystemSnapshotEncryptData[]; /** * The network endpoints available for this DB System. */ endpoints: outputs.Mysql.GetMysqlBackupDbSystemSnapshotEndpoint[]; /** * The name of the Fault Domain the DB System is located in. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. */ hostnameLabel: string; /** * OCID of the backup itself */ id: string; /** * The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address. */ ipAddress: string; /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. */ ipv6address: string; /** * Specifies if the DB System is highly available. */ isHighlyAvailable: boolean; /** * The Maintenance Policy for the DB System or Read Replica that this model is included in. */ maintenances: outputs.Mysql.GetMysqlBackupDbSystemSnapshotMaintenance[]; /** * The MySQL server version of the DB System used for backup. */ mysqlVersion: string; /** * Network Security Group OCIDs used for the VNIC attachment. */ nsgIds: string[]; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port. */ portX: number; /** * The read endpoint of a DB System. */ readEndpoints: outputs.Mysql.GetMysqlBackupDbSystemSnapshotReadEndpoint[]; /** * The region identifier of the region where the DB system exists. For more information, please see [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm). */ region: string; /** * REST configuration details. */ rests: outputs.Mysql.GetMysqlBackupDbSystemSnapshotRest[]; /** * Secure connection configuration details. */ secureConnections: outputs.Mysql.GetMysqlBackupDbSystemSnapshotSecureConnection[]; /** * Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of the DB System instance used for backup. */ shapeName: string; /** * The OCID of the subnet the DB System is associated with. */ subnetId: string; /** * Telemetry configuration details of a DB System or a read replica. */ telemetryConfigurations: outputs.Mysql.GetMysqlBackupDbSystemSnapshotTelemetryConfiguration[]; } interface GetMysqlBackupDbSystemSnapshotBackupPolicy { /** * List of policies of a DB system to schedule cross-region DB system backup copy. */ copyPolicies: outputs.Mysql.GetMysqlBackupDbSystemSnapshotBackupPolicyCopyPolicy[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * The PITR policy for the DB System. */ pitrPolicies: outputs.Mysql.GetMysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy[]; /** * Number of days to retain this backup. */ retentionInDays: number; /** * Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. */ softDelete: string; /** * The start time of the maintenance window. */ windowStartTime: string; } interface GetMysqlBackupDbSystemSnapshotBackupPolicyCopyPolicy { /** * Number of days to retain the copied DB system backup. */ backupCopyRetentionInDays: number; /** * The destination region name to which the DB system backup will be copied. */ copyToRegion: string; } interface GetMysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy { /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; } interface GetMysqlBackupDbSystemSnapshotDataStorage { /** * The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred. */ allocatedStorageSizeInGbs: number; /** * DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs. */ dataStorageSizeInGb: number; /** * The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value. */ dataStorageSizeLimitInGbs: number; /** * Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs. */ isAutoExpandStorageEnabled: boolean; /** * Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value. */ maxStorageSizeInGbs: number; } interface GetMysqlBackupDbSystemSnapshotDatabaseConsole { /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service. */ status: string; } interface GetMysqlBackupDbSystemSnapshotDeletionPolicy { /** * Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted. */ automaticBackupRetention: string; /** * Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted. */ finalBackup: string; /** * Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow. */ isDeleteProtected: boolean; } interface GetMysqlBackupDbSystemSnapshotEncryptData { /** * Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * The OCID of the key to use. */ keyId: string; } interface GetMysqlBackupDbSystemSnapshotEndpoint { /** * The network address of the DB System. */ hostname: string; /** * The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address. */ ipAddress: string; /** * The internet protocol (IP) version of the IP address. */ ipAddressVersion: string; /** * The access modes from the client that this endpoint supports. */ modes: string[]; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port. */ portX: number; /** * The OCID of the resource that this endpoint is attached to. */ resourceId: string; /** * The type of endpoint that clients and connectors can connect to. */ resourceType: string; /** * The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service. */ status: string; /** * Additional information about the current endpoint status. */ statusDetails: string; } interface GetMysqlBackupDbSystemSnapshotMaintenance { /** * Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches. At most one configured window is supported. */ maintenanceDisabledWindows: outputs.Mysql.GetMysqlBackupDbSystemSnapshotMaintenanceMaintenanceDisabledWindow[]; /** * The maintenance schedule type of the DB system. EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated. REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable. */ maintenanceScheduleType: string; /** * The version that is expected to be targeted during the next scheduled maintenance run. */ targetVersion: string; /** * The time the scheduled maintenance is expected to start, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeScheduled: string; /** * The preferred version to target when performing an automatic MySQL upgrade. */ versionPreference: string; /** * The preferred version track to target when performing an automatic MySQL upgrade. LONG_TERM_SUPPORT: No MySQL database behavior changes. INNOVATION: Provides access to the latest features and all bug fixes. FOLLOW: Follows the track of the current MySQL version. */ versionTrackPreference: string; /** * The start time of the maintenance window. */ windowStartTime: string; } interface GetMysqlBackupDbSystemSnapshotMaintenanceMaintenanceDisabledWindow { /** * The time until when maintenance is disabled. Must be set together with timeStart and must be after timeStart. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeEnd: string; /** * The time from when maintenance is disabled. Must be set together with timeEnd and must be before timeEnd. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeStart: string; } interface GetMysqlBackupDbSystemSnapshotReadEndpoint { /** * A list of IP addresses of read replicas that are excluded from serving read requests. */ excludeIps: string[]; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * The hostname for the read endpoint of the DB System. Used for DNS. */ readEndpointHostnameLabel: string; /** * The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. 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 should be a "dotted-quad" style IPv4 address. */ readEndpointIpAddress: string; /** * Details to assign an IPv6 subnet prefix or IPv6 address to a resource. */ readEndpointIpv6addressIpv6subnetCidrPairDetails: outputs.Mysql.GetMysqlBackupDbSystemSnapshotReadEndpointReadEndpointIpv6addressIpv6subnetCidrPairDetail[]; } interface GetMysqlBackupDbSystemSnapshotReadEndpointReadEndpointIpv6addressIpv6subnetCidrPairDetail { /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. */ ipv6address: string; /** * The IPv6 prefix allocated to the subnet. */ ipv6subnetCidr: string; } interface GetMysqlBackupDbSystemSnapshotRest { /** * Select how REST is configured across the DB System instances. */ configuration: string; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; } interface GetMysqlBackupDbSystemSnapshotSecureConnection { /** * Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). */ certificateGenerationType: string; /** * The OCID of the certificate to use. */ certificateId: string; } interface GetMysqlBackupDbSystemSnapshotSummary { /** * A user-supplied display name for the backup. */ displayName: string; /** * OCID of the backup itself */ id: string; /** * The region identifier of the region where the DB system exists. For more information, please see [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm). */ region: string; } interface GetMysqlBackupDbSystemSnapshotTelemetryConfiguration { /** * Telemetry configuration details for logging. */ logs: outputs.Mysql.GetMysqlBackupDbSystemSnapshotTelemetryConfigurationLog[]; } interface GetMysqlBackupDbSystemSnapshotTelemetryConfigurationLog { /** * Type of destination where MySQL telemetry is exposed to. */ destination: string; /** * List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.GetMysqlBackupDbSystemSnapshotTelemetryConfigurationLogDestinationConfiguration[]; /** * List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface GetMysqlBackupDbSystemSnapshotTelemetryConfigurationLogDestinationConfiguration { /** * Name of the destination configuration variable. */ key: string; /** * Value of the destination configuration variable. */ value: string; } interface GetMysqlBackupEncryptData { /** * Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * The OCID of the key to use. */ keyId: string; } interface GetMysqlBackupSourceDetail { /** * The OCID of the Backup */ backupId: string; /** * The OCID of the compartment the DB System belongs in. */ compartmentId: string; /** * The region identifier of the region where the DB system exists. For more information, please see [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm). */ region: string; } interface GetMysqlBackupValidateBackupDetail { isPreparedBackupRequired: boolean; } interface GetMysqlBackupsBackup { /** * Indicates whether the backup has been prepared successfully. PREPARED: The backup is prepared one. NOT_PREPARED: The backup is not prepared. */ backupPreparationStatus: string; /** * The size of the backup in base-2 (IEC) gibibytes. (GiB). */ backupSizeInGbs: number; /** * The type of backup. */ backupType: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Backup creationType */ creationType: string; /** * DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs. */ dataStorageSizeInGb: number; /** * The DB System [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbSystemId: string; dbSystemSnapshotSummaries: outputs.Mysql.GetMysqlBackupsBackupDbSystemSnapshotSummary[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-supplied description for the backup. */ description: string; /** * A filter to return only the resource matching the given display name exactly. */ displayName: string; /** * Encrypt data details. */ encryptDatas: outputs.Mysql.GetMysqlBackupsBackupEncryptData[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID of the backup itself */ id: string; /** * The OCID of the immediate source DB system backup from which this DB system backup was copied. */ immediateSourceBackupId: string; /** * Additional information about the current lifecycleState. */ lifecycleDetails: string; /** * The MySQL server version of the DB System used for backup. */ mysqlVersion: string; /** * The OCID of the original source DB system backup from which this DB system backup was copied. */ originalSourceBackupId: string; /** * Number of days to retain this backup. */ retentionInDays: number; /** * The shape of the DB System instance used for backup. */ shapeName: string; /** * Backup Soft Delete */ softDelete: string; /** * Backup Lifecycle State */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the DB system backup copy was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCopyCreated: string; /** * The time the backup record was created. */ timeCreated: string; /** * The status of backup validation: NOT_VALIDATED (Default): The backup has not been validated. VALIDATED: The backup has been validated successfully. NEEDS_ATTENTION: The backup validation failed due to a transient issue. Validation should be retried. FAILED: The backup cannot be restored. */ validationStatus: string; } interface GetMysqlBackupsBackupDbSystemSnapshotSummary { /** * A filter to return only the resource matching the given display name exactly. */ displayName: string; /** * OCID of the backup itself */ id: string; /** * The region identifier of the region where the DB system exists. For more information, please see [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm). */ region: string; } interface GetMysqlBackupsBackupEncryptData { /** * Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * The OCID of the key to use. */ keyId: string; } interface GetMysqlBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetMysqlConfigurationInitVariable { /** * Represents the MySQL server system variable lowerCaseTableNames (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_lower_case_table_names). */ lowerCaseTableNames: string; } interface GetMysqlConfigurationOption { /** * The option name. */ name: string; /** * The option value. */ value: string; } interface GetMysqlConfigurationVariable { /** * auto_increment_increment and autoIncrementOffset are intended for use with circular (source-to-source) replication, and can be used to control the operation of AUTO_INCREMENT columns. Both variables have global and session values, and each can assume an integer value between 1 and 65,535 inclusive. */ autoIncrementIncrement: number; /** * This variable has a default value of 1. If it is left with its default value, and Group Replication is started on the server in multi-primary mode, it is changed to the server ID. */ autoIncrementOffset: number; /** * ("autocommit") */ autocommit: boolean; /** * If enabled, the server stores all temporary tables on disk rather than in memory. */ bigTables: boolean; /** * Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable [binlogExpireLogsSeconds](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_expire_logs_seconds). */ binlogExpireLogsSeconds: number; /** * Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk. There is no delay by default. Setting this variable to a microsecond delay enables more transactions to be synchronized together to disk at once, reducing the overall time to commit a group of transactions because the larger groups required fewer time units per group. */ binlogGroupCommitSyncDelay: number; /** * The maximum number of transactions to wait for before aborting the current delay as specified by binlog_group_commit_sync_delay. If binlogGroupCommitSyncDelay is set to 0, then this option has no effect. */ binlogGroupCommitSyncNoDelayCount: number; /** * Configures the amount of table metadata added to the binary log when using row-based logging. binlogRowMetadata corresponds to the MySQL binary logging system variable [binlogRowMetadata](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_metadata). */ binlogRowMetadata: string; /** * When set to PARTIAL_JSON, this enables use of a space-efficient binary log format for updates that modify only a small portion of a JSON document. binlogRowValueOptions corresponds to the MySQL binary logging system variable [binlogRowValueOptions](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_value_options). */ binlogRowValueOptions: string; /** * Enables compression for transactions that are written to binary log files on this server. binlogTransactionCompression corresponds to the MySQL binary logging system variable [binlogTransactionCompression](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_transaction_compression). */ binlogTransactionCompression: boolean; /** * This variable controls the block encryption mode for block-based algorithms such as AES. It affects encryption for AES_ENCRYPT() and AES_DECRYPT(). blockEncryptionMode takes a value in aes-keylen-mode format, where keylen is the key length in bits and mode is the encryption mode. The value is not case-sensitive. Permitted keylen values are 128, 192, and 256. Permitted mode values are ECB, CBC, CFB1, CFB8, CFB128, and OFB. */ blockEncryptionMode: string; /** * The server's default character set. If you set this variable, you should also set collationServer to specify the collation for the character set. */ characterSetServer: string; /** * The server's default collation. */ collationServer: string; /** * ("completionType") */ completionType: string; /** * The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake. */ connectTimeout: number; /** * Set the chunking size for updates to the global memory usage counter Global_connection_memory. */ connectionMemoryChunkSize: number; /** * Set the maximum amount of memory that can be used by a single user connection. */ connectionMemoryLimit: string; /** * ("cteMaxRecursionDepth") */ cteMaxRecursionDepth: string; /** * The default authentication plugin. This must be a plugin that uses internal credentials storage, so these values are permitted: mysql_native_password, sha256_password, caching_sha2_password. */ defaultAuthenticationPlugin: string; /** * This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan. */ explainFormat: string; /** * This system variable determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns. By default, explicitDefaultsForTimestamp is enabled, which disables the nonstandard behaviors. Disabling explicitDefaultsForTimestamp results in a warning. */ explicitDefaultsForTimestamp: boolean; /** * ("foreignKeyChecks") */ foreignKeyChecks: boolean; /** * ("generatedRandomPasswordLength") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'generated_random_password_length' field has been deprecated and may be removed in a future version. Do not use this field. */ generatedRandomPasswordLength: number; /** * Set the total amount of memory that can be used by all user connections. */ globalConnectionMemoryLimit: string; /** * Determines whether the MySQL server calculates Global_connection_memory. */ globalConnectionMemoryTracking: boolean; /** * Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function. */ groupConcatMaxLen: string; /** * * EVENTUAL: Both RO and RW transactions do not wait for preceding transactions to be applied before executing. A RW transaction does not wait for other members to apply a transaction. This means that a transaction could be externalized on one member before the others. This also means that in the event of a primary failover, the new primary can accept new RO and RW transactions before the previous primary transactions are all applied. RO transactions could result in outdated values, RW transactions could result in a rollback due to conflicts. * * BEFORE_ON_PRIMARY_FAILOVER: New RO or RW transactions with a newly elected primary that is applying backlog from the old primary are held (not applied) until any backlog has been applied. This ensures that when a primary failover happens, intentionally or not, clients always see the latest value on the primary. This guarantees consistency, but means that clients must be able to handle the delay in the event that a backlog is being applied. Usually this delay should be minimal, but does depend on the size of the backlog. * * BEFORE: A RW transaction waits for all preceding transactions to complete before being applied. A RO transaction waits for all preceding transactions to complete before being executed. This ensures that this transaction reads the latest value by only affecting the latency of the transaction. This reduces the overhead of synchronization on every RW transaction, by ensuring synchronization is used only on RO transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. * * AFTER: A RW transaction waits until its changes have been applied to all of the other members. This value has no effect on RO transactions. This mode ensures that when a transaction is committed on the local member, any subsequent transaction reads the written value or a more recent value on any group member. Use this mode with a group that is used for predominantly RO operations to ensure that applied RW transactions are applied everywhere once they commit. This could be used by your application to ensure that subsequent reads fetch the latest data which includes the latest writes. This reduces the overhead of synchronization on every RO transaction, by ensuring synchronization is used only on RW transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. * * BEFORE_AND_AFTER: A RW transaction waits for 1) all preceding transactions to complete before being applied and 2) until its changes have been applied on other members. A RO transaction waits for all preceding transactions to complete before execution takes place. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. */ groupReplicationConsistency: string; /** * ("informationSchemaStatsExpiry") */ informationSchemaStatsExpiry: number; /** * Whether the InnoDB adaptive hash index is enabled or disabled. It may be desirable, depending on your workload, to dynamically enable or disable adaptive hash indexing to improve query performance. Because the adaptive hash index may not be useful for all workloads, conduct benchmarks with it both enabled and disabled, using realistic workloads. */ innodbAdaptiveHashIndex: boolean; /** * The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively. */ innodbAutoincLockMode: number; /** * Specifies the percentage of the most recently used pages for each buffer pool to read out and dump. */ innodbBufferPoolDumpPct: number; /** * ("innodbBufferPoolInstances") */ innodbBufferPoolInstances: number; /** * The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data. */ innodbBufferPoolSize: string; /** * Whether InnoDB performs change buffering, an optimization that delays write operations to secondary indexes so that the I/O operations can be performed sequentially. Permitted values are described in the following table. Values may also be specified numerically. */ innodbChangeBuffering: string; /** * innodbDdlBufferSize corresponds to the MySQL system variable [innodbDdlBufferSize] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_buffer_size) */ innodbDdlBufferSize: string; /** * innodbDdlThreads corresponds to the MySQL system variable [innodbDdlThreads] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_threads) */ innodbDdlThreads: number; /** * ("innodbFtEnableStopword") */ innodbFtEnableStopword: boolean; /** * ("innodbFtMaxTokenSize") */ innodbFtMaxTokenSize: number; /** * ("innodbFtMinTokenSize") */ innodbFtMinTokenSize: number; /** * ("innodbFtNumWordOptimize") */ innodbFtNumWordOptimize: number; /** * ("innodbFtResultCacheLimit") */ innodbFtResultCacheLimit: string; /** * ("innodbFtServerStopwordTable") */ innodbFtServerStopwordTable: string; /** * ("innodbLockWaitTimeout") */ innodbLockWaitTimeout: number; /** * Enables dedicated log writer threads for writing redo log records from the log buffer to the system buffers and flushing the system buffers to the redo log files. */ innodbLogWriterThreads: boolean; /** * The desired maximum purge lag in terms of transactions. */ innodbMaxPurgeLag: string; /** * The maximum delay in microseconds for the delay imposed when the innodbMaxPurgeLag threshold is exceeded. */ innodbMaxPurgeLagDelay: number; /** * Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool. When innodbNumaInterleave is enabled, the NUMA memory policy is set to MPOL_INTERLEAVE for the mysqld process. After the InnoDB buffer pool is allocated, the NUMA memory policy is set back to MPOL_DEFAULT. For the innodbNumaInterleave option to be available, MySQL must be compiled on a NUMA-enabled Linux system. */ innodbNumaInterleave: boolean; /** * Specifies an upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables. There is one such log file for each index being created or table being altered. This log file stores data inserted, updated, or deleted in the table during the DDL operation. */ innodbOnlineAlterLogMaxSize: string; /** * Defines the amount of disk space occupied by redo log files. innodbRedoLogCapacity supercedes the innodbLogFilesInGroup and innodbLogFileSize variables, which are both ignored if innodbRedoLogCapacity is defined. If innodbRedoLogCapacity is not defined, and if neither innodbLogFileSize or innodbLogFilesInGroup are defined, then the default innodbRedoLogCapacity value is used. */ innodbRedoLogCapacity: string; /** * InnoDB rolls back only the last statement on a transaction timeout by default. If --innodb-rollback-on-timeout is specified, a transaction timeout causes InnoDB to abort and roll back the entire transaction. */ innodbRollbackOnTimeout: boolean; /** * This variable defines: * * The sort buffer size for online DDL operations that create or rebuild secondary indexes. However, as of MySQL 8.0.27, this responsibility is subsumed by the innodbDdlBufferSize variable. * * The amount by which the temporary log file is extended when recording concurrent DML during an online DDL operation, and the size of the temporary log file read buffer and write buffer. */ innodbSortBufferSize: number; /** * The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE. */ innodbStatsPersistentSamplePages: string; /** * The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by [ANALYZE TABLE](https://dev.mysql.com/doc/refman/8.0/en/analyze-table.html). */ innodbStatsTransientSamplePages: string; /** * When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options. */ innodbStrictMode: boolean; /** * When enabled, undo tablespaces that exceed the threshold value defined by innodbMaxUndoLogSize are marked for truncation. Only undo tablespaces can be truncated. Truncating undo logs that reside in the system tablespace is not supported. For truncation to occur, there must be at least two undo tablespaces. */ innodbUndoLogTruncate: boolean; /** * The number of seconds the server waits for activity on an interactive connection before closing it. */ interactiveTimeout: number; /** * The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans. In MySQL 8.0.18 and later, this variable also controls the amount of memory used for hash joins. Normally, the best way to get fast joins is to add indexes. Increase the value of joinBufferSize to get a faster full join when adding indexes is not possible. One join buffer is allocated for each full join between two tables. For a complex join between several tables for which indexes are not used, multiple join buffers might be necessary. */ joinBufferSize: string; /** * This variable controls server-side LOCAL capability for LOAD DATA statements. Depending on the localInfile setting, the server refuses or permits local data loading by clients that have LOCAL enabled on the client side. */ localInfile: boolean; /** * If a query takes longer than this many seconds, the server increments the Slow_queries status variable. If the slow query log is enabled, the query is logged to the slow query log file. This value is measured in real time, not CPU time, so a query that is under the threshold on a lightly loaded system might be above the threshold on a heavily loaded one. */ longQueryTime: number; /** * ("mandatoryRoles") */ mandatoryRoles: string; /** * The maximum size of one packet or any generated/intermediate string. */ maxAllowedPacket: number; /** * Sets the size of the transaction cache. */ maxBinlogCacheSize: string; /** * ("maxConnectErrors") */ maxConnectErrors: string; /** * ("maxConnections") */ maxConnections: number; /** * ("maxExecutionTime") */ maxExecutionTime: string; /** * This variable sets the maximum size to which user-created MEMORY tables are permitted to grow. */ maxHeapTableSize: string; /** * ("maxPreparedStmtCount") */ maxPreparedStmtCount: number; /** * Limit the assumed maximum number of seeks when looking up rows based on a key. The MySQL optimizer assumes that no more than this number of key seeks are required when searching for matching rows in a table by scanning an index, regardless of the actual cardinality of the index (see Section 15.7.7.22, “SHOW INDEX Statement”). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans. */ maxSeeksForKey: string; /** * The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means “no limit.” This variable has a global value that can be set at server startup or runtime. It also has a read-only session value that indicates the effective simultaneous-connection limit that applies to the account associated with the current session. */ maxUserConnections: string; /** * ("mysqlFirewallMode") */ mysqlFirewallMode: boolean; /** * DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored. * * @deprecated The 'mysql_zstd_default_compression_level' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlZstdDefaultCompressionLevel: number; /** * The number of seconds X Plugin waits for the first packet to be received from newly connected clients. */ mysqlxConnectTimeout: number; /** * Set the default compression level for the deflate algorithm. ("mysqlxDeflateDefaultCompressionLevel") */ mysqlxDeflateDefaultCompressionLevel: number; /** * Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlxDeflateMaxClientCompressionLevel") */ mysqlxDeflateMaxClientCompressionLevel: number; /** * ("mysqlxDocumentIdUniquePrefix") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'mysqlx_document_id_unique_prefix' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlxDocumentIdUniquePrefix: number; /** * ("mysqlxEnableHelloNotice") DEPRECATED -- variable should not be settable and will be ignored */ mysqlxEnableHelloNotice: boolean; /** * ("mysqlxIdleWorkerThreadTimeout") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'mysqlx_idle_worker_thread_timeout' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlxIdleWorkerThreadTimeout: number; /** * The number of seconds to wait for interactive clients to timeout. */ mysqlxInteractiveTimeout: number; /** * Set the default compression level for the lz4 algorithm. ("mysqlxLz4DefaultCompressionLevel") */ mysqlxLz4defaultCompressionLevel: number; /** * Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlxLz4MaxClientCompressionLevel") */ mysqlxLz4maxClientCompressionLevel: number; /** * The maximum size of network packets that can be received by X Plugin. */ mysqlxMaxAllowedPacket: number; /** * ("mysqlxMinWorkerThreads") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'mysqlx_min_worker_threads' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlxMinWorkerThreads: number; /** * The number of seconds that X Plugin waits for blocking read operations to complete. After this time, if the read operation is not successful, X Plugin closes the connection and returns a warning notice with the error code ER_IO_READ_ERROR to the client application. */ mysqlxReadTimeout: number; /** * The number of seconds that X Plugin waits for activity on a connection. */ mysqlxWaitTimeout: number; /** * The number of seconds that X Plugin waits for blocking write operations to complete. After this time, if the write operation is not successful, X Plugin closes the connection. */ mysqlxWriteTimeout: number; /** * Set the default compression level for the zstd algorithm. ("mysqlxZstdDefaultCompressionLevel") */ mysqlxZstdDefaultCompressionLevel: number; /** * Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlxZstdMaxClientCompressionLevel") */ mysqlxZstdMaxClientCompressionLevel: number; /** * The number of seconds to wait for more data from a connection before aborting the read. */ netReadTimeout: number; /** * The number of seconds to wait for a block to be written to a connection before aborting the write. */ netWriteTimeout: number; /** * The optimizerSwitch system variable enables control over optimizer behavior. The value of this variable is a set of flags, each of which has a value of on or off to indicate whether the corresponding optimizer behavior is enabled or disabled. This variable has global and session values and can be changed at runtime. The global default can be set at server startup. */ optimizerSwitch: string; /** * ("parserMaxMemSize") */ parserMaxMemSize: string; /** * ("queryAllocBlockSize") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'query_alloc_block_size' field has been deprecated and may be removed in a future version. Do not use this field. */ queryAllocBlockSize: string; /** * ("queryPreallocSize") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'query_prealloc_size' field has been deprecated and may be removed in a future version. Do not use this field. */ queryPreallocSize: string; /** * The limit on memory consumption for the range optimizer. A value of 0 means “no limit.” If an execution plan considered by the optimizer uses the range access method but the optimizer estimates that the amount of memory needed for this method would exceed the limit, it abandons the plan and considers other plans. */ rangeOptimizerMaxMemSize: string; /** * regexpTimeLimit corresponds to the MySQL system variable [regexpTimeLimit] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_regexp_time_limit) */ regexpTimeLimit: number; /** * The maximum amount of space to use for all relay logs. */ relayLogSpaceLimit: string; /** * Specifies the number of seconds to wait for more data or a heartbeat signal from the source before the replica considers the connection broken, aborts the read, and tries to reconnect. Setting this variable has no immediate effect. The state of the variable applies on all subsequent START REPLICA commands. */ replicaNetTimeout: number; /** * Beginning with MySQL 8.0.26, slaveParallelWorkers is deprecated, and you should use replicaParallelWorkers instead. (Prior to MySQL 8.0.26, you must use slaveParallelWorkers to set the number of applier threads.) */ replicaParallelWorkers: number; /** * From MySQL 8.0.26, use replicaTypeConversions in place of slave_type_conversions, which is deprecated from that release. In releases before MySQL 8.0.26, use slave_type_conversions. */ replicaTypeConversions: string; /** * Whether client connections to the server are required to use some form of secure transport. When this variable is enabled, the server permits only TCP/IP connections encrypted using TLS/SSL, or connections that use a socket file or shared memory. The server rejects nonsecure connection attempts, which fail with an ER_SECURE_TRANSPORT_REQUIRED error. */ requireSecureTransport: boolean; /** * Whether to resolve host names when checking client connections. If this variable is OFF, mysqld resolves host names when checking client connections. If it is ON, mysqld uses only IP numbers; in this case, all Host column values in the grant tables must be IP addresses. See Section 7.1.12.3, “DNS Lookups and the Host Cache”. */ skipNameResolve: boolean; /** * Each session that must perform a sort allocates a buffer of this size. */ sortBufferSize: string; /** * Whether GIPK mode is in effect, in which case a MySQL replication source server adds a generated invisible primary key to any InnoDB table that is created without one. */ sqlGenerateInvisiblePrimaryKey: boolean; /** * ("sqlMode") */ sqlMode: string; /** * ("sqlRequirePrimaryKey") */ sqlRequirePrimaryKey: boolean; /** * ("sqlWarnings") */ sqlWarnings: boolean; /** * The number of table definitions that can be stored in the table definition cache. If you use a large number of tables, you can create a large table definition cache to speed up opening of tables. The table definition cache takes less space and does not use file descriptors, unlike the normal table cache. */ tableDefinitionCache: number; /** * The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires. */ tableOpenCache: number; /** * Defines the maximum amount of memory that can be occupied by the TempTable storage engine before it starts storing data on disk. The default value is 1073741824 bytes (1GiB). For more information, see Section 10.4.4, “Internal Temporary Table Use in MySQL”. */ temptableMaxRam: string; /** * Controls whether the thread pool uses dedicated listener threads. If enabled, a listener thread in each thread group is dedicated to the task of listening for network events from clients, ensuring that the maximum number of query worker threads is no more than the value specified by threadPoolMaxTransactionsLimit. threadPoolDedicatedListeners corresponds to the MySQL Database Service-specific system variable thread_pool_dedicated_listeners. */ threadPoolDedicatedListeners: boolean; /** * Limits the maximum number of open transactions to the defined value. The default value is 0, which enforces no limit. threadPoolMaxTransactionsLimit corresponds to the MySQL Database Service-specific system variable thread_pool_max_transactions_limit. */ threadPoolMaxTransactionsLimit: number; /** * The maximum number of query threads permitted in a thread group. The maximum value is 4096, but if threadPoolMaxTransactionsLimit is set, threadPoolQueryThreadsPerGroup must not exceed that value. The default value of 1 means there is one active query thread in each thread group, which works well for many loads. When you are using the high concurrency thread pool algorithm (thread_pool_algorithm = 1), consider increasing the value if you experience slower response times due to long-running transactions. */ threadPoolQueryThreadsPerGroup: number; /** * The number of thread groups in the thread pool. This is the most important parameter controlling thread pool performance. It affects how many statements can execute simultaneously. If a value outside the range of permissible values is specified, the thread pool plugin does not load and the server writes a message to the error log. */ threadPoolSize: number; /** * The delay period before executing a new transaction, in milliseconds. The maximum value is 300000 (5 minutes). A transaction delay can be used in cases where parallel transactions affect the performance of other operations due to resource contention. For example, if parallel transactions affect index creation or an online buffer pool resizing operation, you can configure a transaction delay to reduce resource contention while those operations are running. */ threadPoolTransactionDelay: number; /** * Initializes the time zone for each client that connects. */ timeZone: string; /** * The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables. */ tmpTableSize: string; /** * ("transactionIsolation") */ transactionIsolation: string; /** * The number of seconds the server waits for activity on a noninteractive connection before closing it. */ waitTimeout: number; } interface GetMysqlConfigurationsConfiguration { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * User-provided data about the Configuration. */ description: string; /** * A filter to return only the resource matching the given display name exactly. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Configuration. */ id: string; /** * DEPRECATED -- please use the `options` field instead. User-defined service variables set only at DB system initialization. These variables cannot be changed later at runtime. * * @deprecated The 'init_variables' field has been deprecated. Please use 'options' instead. */ initVariables: outputs.Mysql.GetMysqlConfigurationsConfigurationInitVariable[]; /** * The MySQL options defined in the Configuration. */ options: outputs.Mysql.GetMysqlConfigurationsConfigurationOption[]; /** * The OCID of the Configuration from which this Configuration is "derived". This is entirely a metadata relationship. There is no relation between the values in this Configuration and its parent. */ parentConfigurationId: string; /** * The requested Shape name. */ shapeName: string; /** * Configuration Lifecycle State */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Configuration was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; /** * The date and time the Configuration was last updated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; /** * The requested Configuration types. */ type: string; /** * DEPRECATED -- please use the `options` field instead. User-defined service variables. * * @deprecated The 'variables' field has been deprecated. Please use 'options' instead. */ variables: outputs.Mysql.GetMysqlConfigurationsConfigurationVariable[]; } interface GetMysqlConfigurationsConfigurationInitVariable { /** * Represents the MySQL server system variable lowerCaseTableNames (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_lower_case_table_names). */ lowerCaseTableNames: string; } interface GetMysqlConfigurationsConfigurationOption { /** * The option name. */ name: string; /** * The option value. */ value: string; } interface GetMysqlConfigurationsConfigurationVariable { /** * auto_increment_increment and autoIncrementOffset are intended for use with circular (source-to-source) replication, and can be used to control the operation of AUTO_INCREMENT columns. Both variables have global and session values, and each can assume an integer value between 1 and 65,535 inclusive. */ autoIncrementIncrement: number; /** * This variable has a default value of 1. If it is left with its default value, and Group Replication is started on the server in multi-primary mode, it is changed to the server ID. */ autoIncrementOffset: number; /** * ("autocommit") */ autocommit: boolean; /** * If enabled, the server stores all temporary tables on disk rather than in memory. */ bigTables: boolean; /** * Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable [binlogExpireLogsSeconds](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_expire_logs_seconds). */ binlogExpireLogsSeconds: number; /** * Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk. There is no delay by default. Setting this variable to a microsecond delay enables more transactions to be synchronized together to disk at once, reducing the overall time to commit a group of transactions because the larger groups required fewer time units per group. */ binlogGroupCommitSyncDelay: number; /** * The maximum number of transactions to wait for before aborting the current delay as specified by binlog_group_commit_sync_delay. If binlogGroupCommitSyncDelay is set to 0, then this option has no effect. */ binlogGroupCommitSyncNoDelayCount: number; /** * Configures the amount of table metadata added to the binary log when using row-based logging. binlogRowMetadata corresponds to the MySQL binary logging system variable [binlogRowMetadata](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_metadata). */ binlogRowMetadata: string; /** * When set to PARTIAL_JSON, this enables use of a space-efficient binary log format for updates that modify only a small portion of a JSON document. binlogRowValueOptions corresponds to the MySQL binary logging system variable [binlogRowValueOptions](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_value_options). */ binlogRowValueOptions: string; /** * Enables compression for transactions that are written to binary log files on this server. binlogTransactionCompression corresponds to the MySQL binary logging system variable [binlogTransactionCompression](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_transaction_compression). */ binlogTransactionCompression: boolean; /** * This variable controls the block encryption mode for block-based algorithms such as AES. It affects encryption for AES_ENCRYPT() and AES_DECRYPT(). blockEncryptionMode takes a value in aes-keylen-mode format, where keylen is the key length in bits and mode is the encryption mode. The value is not case-sensitive. Permitted keylen values are 128, 192, and 256. Permitted mode values are ECB, CBC, CFB1, CFB8, CFB128, and OFB. */ blockEncryptionMode: string; /** * The server's default character set. If you set this variable, you should also set collationServer to specify the collation for the character set. */ characterSetServer: string; /** * The server's default collation. */ collationServer: string; /** * ("completionType") */ completionType: string; /** * The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake. */ connectTimeout: number; /** * Set the chunking size for updates to the global memory usage counter Global_connection_memory. */ connectionMemoryChunkSize: number; /** * Set the maximum amount of memory that can be used by a single user connection. */ connectionMemoryLimit: string; /** * ("cteMaxRecursionDepth") */ cteMaxRecursionDepth: string; /** * The default authentication plugin. This must be a plugin that uses internal credentials storage, so these values are permitted: mysql_native_password, sha256_password, caching_sha2_password. */ defaultAuthenticationPlugin: string; /** * This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan. */ explainFormat: string; /** * This system variable determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns. By default, explicitDefaultsForTimestamp is enabled, which disables the nonstandard behaviors. Disabling explicitDefaultsForTimestamp results in a warning. */ explicitDefaultsForTimestamp: boolean; /** * ("foreignKeyChecks") */ foreignKeyChecks: boolean; /** * ("generatedRandomPasswordLength") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'generated_random_password_length' field has been deprecated and may be removed in a future version. Do not use this field. */ generatedRandomPasswordLength: number; /** * Set the total amount of memory that can be used by all user connections. */ globalConnectionMemoryLimit: string; /** * Determines whether the MySQL server calculates Global_connection_memory. */ globalConnectionMemoryTracking: boolean; /** * Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function. */ groupConcatMaxLen: string; /** * * EVENTUAL: Both RO and RW transactions do not wait for preceding transactions to be applied before executing. A RW transaction does not wait for other members to apply a transaction. This means that a transaction could be externalized on one member before the others. This also means that in the event of a primary failover, the new primary can accept new RO and RW transactions before the previous primary transactions are all applied. RO transactions could result in outdated values, RW transactions could result in a rollback due to conflicts. * * BEFORE_ON_PRIMARY_FAILOVER: New RO or RW transactions with a newly elected primary that is applying backlog from the old primary are held (not applied) until any backlog has been applied. This ensures that when a primary failover happens, intentionally or not, clients always see the latest value on the primary. This guarantees consistency, but means that clients must be able to handle the delay in the event that a backlog is being applied. Usually this delay should be minimal, but does depend on the size of the backlog. * * BEFORE: A RW transaction waits for all preceding transactions to complete before being applied. A RO transaction waits for all preceding transactions to complete before being executed. This ensures that this transaction reads the latest value by only affecting the latency of the transaction. This reduces the overhead of synchronization on every RW transaction, by ensuring synchronization is used only on RO transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. * * AFTER: A RW transaction waits until its changes have been applied to all of the other members. This value has no effect on RO transactions. This mode ensures that when a transaction is committed on the local member, any subsequent transaction reads the written value or a more recent value on any group member. Use this mode with a group that is used for predominantly RO operations to ensure that applied RW transactions are applied everywhere once they commit. This could be used by your application to ensure that subsequent reads fetch the latest data which includes the latest writes. This reduces the overhead of synchronization on every RO transaction, by ensuring synchronization is used only on RW transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. * * BEFORE_AND_AFTER: A RW transaction waits for 1) all preceding transactions to complete before being applied and 2) until its changes have been applied on other members. A RO transaction waits for all preceding transactions to complete before execution takes place. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. */ groupReplicationConsistency: string; /** * ("informationSchemaStatsExpiry") */ informationSchemaStatsExpiry: number; /** * Whether the InnoDB adaptive hash index is enabled or disabled. It may be desirable, depending on your workload, to dynamically enable or disable adaptive hash indexing to improve query performance. Because the adaptive hash index may not be useful for all workloads, conduct benchmarks with it both enabled and disabled, using realistic workloads. */ innodbAdaptiveHashIndex: boolean; /** * The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively. */ innodbAutoincLockMode: number; /** * Specifies the percentage of the most recently used pages for each buffer pool to read out and dump. */ innodbBufferPoolDumpPct: number; /** * ("innodbBufferPoolInstances") */ innodbBufferPoolInstances: number; /** * The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data. */ innodbBufferPoolSize: string; /** * Whether InnoDB performs change buffering, an optimization that delays write operations to secondary indexes so that the I/O operations can be performed sequentially. Permitted values are described in the following table. Values may also be specified numerically. */ innodbChangeBuffering: string; /** * innodbDdlBufferSize corresponds to the MySQL system variable [innodbDdlBufferSize] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_buffer_size) */ innodbDdlBufferSize: string; /** * innodbDdlThreads corresponds to the MySQL system variable [innodbDdlThreads] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_threads) */ innodbDdlThreads: number; /** * ("innodbFtEnableStopword") */ innodbFtEnableStopword: boolean; /** * ("innodbFtMaxTokenSize") */ innodbFtMaxTokenSize: number; /** * ("innodbFtMinTokenSize") */ innodbFtMinTokenSize: number; /** * ("innodbFtNumWordOptimize") */ innodbFtNumWordOptimize: number; /** * ("innodbFtResultCacheLimit") */ innodbFtResultCacheLimit: string; /** * ("innodbFtServerStopwordTable") */ innodbFtServerStopwordTable: string; /** * ("innodbLockWaitTimeout") */ innodbLockWaitTimeout: number; /** * Enables dedicated log writer threads for writing redo log records from the log buffer to the system buffers and flushing the system buffers to the redo log files. */ innodbLogWriterThreads: boolean; /** * The desired maximum purge lag in terms of transactions. */ innodbMaxPurgeLag: string; /** * The maximum delay in microseconds for the delay imposed when the innodbMaxPurgeLag threshold is exceeded. */ innodbMaxPurgeLagDelay: number; /** * Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool. When innodbNumaInterleave is enabled, the NUMA memory policy is set to MPOL_INTERLEAVE for the mysqld process. After the InnoDB buffer pool is allocated, the NUMA memory policy is set back to MPOL_DEFAULT. For the innodbNumaInterleave option to be available, MySQL must be compiled on a NUMA-enabled Linux system. */ innodbNumaInterleave: boolean; /** * Specifies an upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables. There is one such log file for each index being created or table being altered. This log file stores data inserted, updated, or deleted in the table during the DDL operation. */ innodbOnlineAlterLogMaxSize: string; /** * Defines the amount of disk space occupied by redo log files. innodbRedoLogCapacity supercedes the innodbLogFilesInGroup and innodbLogFileSize variables, which are both ignored if innodbRedoLogCapacity is defined. If innodbRedoLogCapacity is not defined, and if neither innodbLogFileSize or innodbLogFilesInGroup are defined, then the default innodbRedoLogCapacity value is used. */ innodbRedoLogCapacity: string; /** * InnoDB rolls back only the last statement on a transaction timeout by default. If --innodb-rollback-on-timeout is specified, a transaction timeout causes InnoDB to abort and roll back the entire transaction. */ innodbRollbackOnTimeout: boolean; /** * This variable defines: * * The sort buffer size for online DDL operations that create or rebuild secondary indexes. However, as of MySQL 8.0.27, this responsibility is subsumed by the innodbDdlBufferSize variable. * * The amount by which the temporary log file is extended when recording concurrent DML during an online DDL operation, and the size of the temporary log file read buffer and write buffer. */ innodbSortBufferSize: number; /** * The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE. */ innodbStatsPersistentSamplePages: string; /** * The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by [ANALYZE TABLE](https://dev.mysql.com/doc/refman/8.0/en/analyze-table.html). */ innodbStatsTransientSamplePages: string; /** * When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options. */ innodbStrictMode: boolean; /** * When enabled, undo tablespaces that exceed the threshold value defined by innodbMaxUndoLogSize are marked for truncation. Only undo tablespaces can be truncated. Truncating undo logs that reside in the system tablespace is not supported. For truncation to occur, there must be at least two undo tablespaces. */ innodbUndoLogTruncate: boolean; /** * The number of seconds the server waits for activity on an interactive connection before closing it. */ interactiveTimeout: number; /** * The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans. In MySQL 8.0.18 and later, this variable also controls the amount of memory used for hash joins. Normally, the best way to get fast joins is to add indexes. Increase the value of joinBufferSize to get a faster full join when adding indexes is not possible. One join buffer is allocated for each full join between two tables. For a complex join between several tables for which indexes are not used, multiple join buffers might be necessary. */ joinBufferSize: string; /** * This variable controls server-side LOCAL capability for LOAD DATA statements. Depending on the localInfile setting, the server refuses or permits local data loading by clients that have LOCAL enabled on the client side. */ localInfile: boolean; /** * If a query takes longer than this many seconds, the server increments the Slow_queries status variable. If the slow query log is enabled, the query is logged to the slow query log file. This value is measured in real time, not CPU time, so a query that is under the threshold on a lightly loaded system might be above the threshold on a heavily loaded one. */ longQueryTime: number; /** * ("mandatoryRoles") */ mandatoryRoles: string; /** * The maximum size of one packet or any generated/intermediate string. */ maxAllowedPacket: number; /** * Sets the size of the transaction cache. */ maxBinlogCacheSize: string; /** * ("maxConnectErrors") */ maxConnectErrors: string; /** * ("maxConnections") */ maxConnections: number; /** * ("maxExecutionTime") */ maxExecutionTime: string; /** * This variable sets the maximum size to which user-created MEMORY tables are permitted to grow. */ maxHeapTableSize: string; /** * ("maxPreparedStmtCount") */ maxPreparedStmtCount: number; /** * Limit the assumed maximum number of seeks when looking up rows based on a key. The MySQL optimizer assumes that no more than this number of key seeks are required when searching for matching rows in a table by scanning an index, regardless of the actual cardinality of the index (see Section 15.7.7.22, “SHOW INDEX Statement”). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans. */ maxSeeksForKey: string; /** * The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means “no limit.” This variable has a global value that can be set at server startup or runtime. It also has a read-only session value that indicates the effective simultaneous-connection limit that applies to the account associated with the current session. */ maxUserConnections: string; /** * ("mysqlFirewallMode") */ mysqlFirewallMode: boolean; /** * DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored. * * @deprecated The 'mysql_zstd_default_compression_level' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlZstdDefaultCompressionLevel: number; /** * The number of seconds X Plugin waits for the first packet to be received from newly connected clients. */ mysqlxConnectTimeout: number; /** * Set the default compression level for the deflate algorithm. ("mysqlxDeflateDefaultCompressionLevel") */ mysqlxDeflateDefaultCompressionLevel: number; /** * Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlxDeflateMaxClientCompressionLevel") */ mysqlxDeflateMaxClientCompressionLevel: number; /** * ("mysqlxDocumentIdUniquePrefix") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'mysqlx_document_id_unique_prefix' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlxDocumentIdUniquePrefix: number; /** * ("mysqlxEnableHelloNotice") DEPRECATED -- variable should not be settable and will be ignored */ mysqlxEnableHelloNotice: boolean; /** * ("mysqlxIdleWorkerThreadTimeout") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'mysqlx_idle_worker_thread_timeout' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlxIdleWorkerThreadTimeout: number; /** * The number of seconds to wait for interactive clients to timeout. */ mysqlxInteractiveTimeout: number; /** * Set the default compression level for the lz4 algorithm. ("mysqlxLz4DefaultCompressionLevel") */ mysqlxLz4defaultCompressionLevel: number; /** * Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlxLz4MaxClientCompressionLevel") */ mysqlxLz4maxClientCompressionLevel: number; /** * The maximum size of network packets that can be received by X Plugin. */ mysqlxMaxAllowedPacket: number; /** * ("mysqlxMinWorkerThreads") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'mysqlx_min_worker_threads' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlxMinWorkerThreads: number; /** * The number of seconds that X Plugin waits for blocking read operations to complete. After this time, if the read operation is not successful, X Plugin closes the connection and returns a warning notice with the error code ER_IO_READ_ERROR to the client application. */ mysqlxReadTimeout: number; /** * The number of seconds that X Plugin waits for activity on a connection. */ mysqlxWaitTimeout: number; /** * The number of seconds that X Plugin waits for blocking write operations to complete. After this time, if the write operation is not successful, X Plugin closes the connection. */ mysqlxWriteTimeout: number; /** * Set the default compression level for the zstd algorithm. ("mysqlxZstdDefaultCompressionLevel") */ mysqlxZstdDefaultCompressionLevel: number; /** * Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlxZstdMaxClientCompressionLevel") */ mysqlxZstdMaxClientCompressionLevel: number; /** * The number of seconds to wait for more data from a connection before aborting the read. */ netReadTimeout: number; /** * The number of seconds to wait for a block to be written to a connection before aborting the write. */ netWriteTimeout: number; /** * The optimizerSwitch system variable enables control over optimizer behavior. The value of this variable is a set of flags, each of which has a value of on or off to indicate whether the corresponding optimizer behavior is enabled or disabled. This variable has global and session values and can be changed at runtime. The global default can be set at server startup. */ optimizerSwitch: string; /** * ("parserMaxMemSize") */ parserMaxMemSize: string; /** * ("queryAllocBlockSize") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'query_alloc_block_size' field has been deprecated and may be removed in a future version. Do not use this field. */ queryAllocBlockSize: string; /** * ("queryPreallocSize") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'query_prealloc_size' field has been deprecated and may be removed in a future version. Do not use this field. */ queryPreallocSize: string; /** * The limit on memory consumption for the range optimizer. A value of 0 means “no limit.” If an execution plan considered by the optimizer uses the range access method but the optimizer estimates that the amount of memory needed for this method would exceed the limit, it abandons the plan and considers other plans. */ rangeOptimizerMaxMemSize: string; /** * regexpTimeLimit corresponds to the MySQL system variable [regexpTimeLimit] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_regexp_time_limit) */ regexpTimeLimit: number; /** * The maximum amount of space to use for all relay logs. */ relayLogSpaceLimit: string; /** * Specifies the number of seconds to wait for more data or a heartbeat signal from the source before the replica considers the connection broken, aborts the read, and tries to reconnect. Setting this variable has no immediate effect. The state of the variable applies on all subsequent START REPLICA commands. */ replicaNetTimeout: number; /** * Beginning with MySQL 8.0.26, slaveParallelWorkers is deprecated, and you should use replicaParallelWorkers instead. (Prior to MySQL 8.0.26, you must use slaveParallelWorkers to set the number of applier threads.) */ replicaParallelWorkers: number; /** * From MySQL 8.0.26, use replicaTypeConversions in place of slave_type_conversions, which is deprecated from that release. In releases before MySQL 8.0.26, use slave_type_conversions. */ replicaTypeConversions: string; /** * Whether client connections to the server are required to use some form of secure transport. When this variable is enabled, the server permits only TCP/IP connections encrypted using TLS/SSL, or connections that use a socket file or shared memory. The server rejects nonsecure connection attempts, which fail with an ER_SECURE_TRANSPORT_REQUIRED error. */ requireSecureTransport: boolean; /** * Whether to resolve host names when checking client connections. If this variable is OFF, mysqld resolves host names when checking client connections. If it is ON, mysqld uses only IP numbers; in this case, all Host column values in the grant tables must be IP addresses. See Section 7.1.12.3, “DNS Lookups and the Host Cache”. */ skipNameResolve: boolean; /** * Each session that must perform a sort allocates a buffer of this size. */ sortBufferSize: string; /** * Whether GIPK mode is in effect, in which case a MySQL replication source server adds a generated invisible primary key to any InnoDB table that is created without one. */ sqlGenerateInvisiblePrimaryKey: boolean; /** * ("sqlMode") */ sqlMode: string; /** * ("sqlRequirePrimaryKey") */ sqlRequirePrimaryKey: boolean; /** * ("sqlWarnings") */ sqlWarnings: boolean; /** * The number of table definitions that can be stored in the table definition cache. If you use a large number of tables, you can create a large table definition cache to speed up opening of tables. The table definition cache takes less space and does not use file descriptors, unlike the normal table cache. */ tableDefinitionCache: number; /** * The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires. */ tableOpenCache: number; /** * Defines the maximum amount of memory that can be occupied by the TempTable storage engine before it starts storing data on disk. The default value is 1073741824 bytes (1GiB). For more information, see Section 10.4.4, “Internal Temporary Table Use in MySQL”. */ temptableMaxRam: string; /** * Controls whether the thread pool uses dedicated listener threads. If enabled, a listener thread in each thread group is dedicated to the task of listening for network events from clients, ensuring that the maximum number of query worker threads is no more than the value specified by threadPoolMaxTransactionsLimit. threadPoolDedicatedListeners corresponds to the MySQL Database Service-specific system variable thread_pool_dedicated_listeners. */ threadPoolDedicatedListeners: boolean; /** * Limits the maximum number of open transactions to the defined value. The default value is 0, which enforces no limit. threadPoolMaxTransactionsLimit corresponds to the MySQL Database Service-specific system variable thread_pool_max_transactions_limit. */ threadPoolMaxTransactionsLimit: number; /** * The maximum number of query threads permitted in a thread group. The maximum value is 4096, but if threadPoolMaxTransactionsLimit is set, threadPoolQueryThreadsPerGroup must not exceed that value. The default value of 1 means there is one active query thread in each thread group, which works well for many loads. When you are using the high concurrency thread pool algorithm (thread_pool_algorithm = 1), consider increasing the value if you experience slower response times due to long-running transactions. */ threadPoolQueryThreadsPerGroup: number; /** * The number of thread groups in the thread pool. This is the most important parameter controlling thread pool performance. It affects how many statements can execute simultaneously. If a value outside the range of permissible values is specified, the thread pool plugin does not load and the server writes a message to the error log. */ threadPoolSize: number; /** * The delay period before executing a new transaction, in milliseconds. The maximum value is 300000 (5 minutes). A transaction delay can be used in cases where parallel transactions affect the performance of other operations due to resource contention. For example, if parallel transactions affect index creation or an online buffer pool resizing operation, you can configure a transaction delay to reduce resource contention while those operations are running. */ threadPoolTransactionDelay: number; /** * Initializes the time zone for each client that connects. */ timeZone: string; /** * The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables. */ tmpTableSize: string; /** * ("transactionIsolation") */ transactionIsolation: string; /** * The number of seconds the server waits for activity on a noninteractive connection before closing it. */ waitTimeout: number; } interface GetMysqlConfigurationsFilter { /** * The option name. */ name: string; regex?: boolean; values: string[]; } interface GetMysqlDbSystemBackupPolicy { /** * List of policies of a DB system to schedule cross-region DB system backup copy. */ copyPolicies: outputs.Mysql.GetMysqlDbSystemBackupPolicyCopyPolicy[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * The PITR policy for the DB System. */ pitrPolicies: outputs.Mysql.GetMysqlDbSystemBackupPolicyPitrPolicy[]; /** * The number of days automated backups are retained. */ retentionInDays: number; /** * Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. */ softDelete: string; /** * The start time of the maintenance window. */ windowStartTime: string; } interface GetMysqlDbSystemBackupPolicyCopyPolicy { /** * Number of days to retain the copied DB system backup. */ backupCopyRetentionInDays: number; /** * The destination region name to which the DB system backup will be copied. */ copyToRegion: string; } interface GetMysqlDbSystemBackupPolicyPitrPolicy { /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; } interface GetMysqlDbSystemChannel { /** * The OCID of the compartment the DB System belongs in. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The user-friendly name for the DB System. It does not have to be unique. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the DB System. */ id: string; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * Additional information about the current lifecycleState. */ lifecycleDetails: string; /** * Parameters detailing how to provision the initial data of the DB System. */ sources: outputs.Mysql.GetMysqlDbSystemChannelSource[]; /** * The current state of the DB System. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Details about the Channel target. */ targets: outputs.Mysql.GetMysqlDbSystemChannelTarget[]; /** * The date and time the DB System was created. */ timeCreated: string; /** * The time the DB System was last updated. */ timeUpdated: string; } interface GetMysqlDbSystemChannelSource { /** * Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does. */ anonymousTransactionsHandlings: outputs.Mysql.GetMysqlDbSystemChannelSourceAnonymousTransactionsHandling[]; /** * The network address of the DB System. */ hostname: string; /** * Whether the connection of the channel will be requested using the IPv6 address of the dual stack DB system or not. Default: False. */ mustUseIpv6onDualStack: boolean; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The specific source identifier. */ sourceType: string; /** * The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes. */ sslCaCertificates: outputs.Mysql.GetMysqlDbSystemChannelSourceSslCaCertificate[]; /** * The SSL mode of the Channel. */ sslMode: string; /** * The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/change-master-to.html) */ username: string; } interface GetMysqlDbSystemChannelSourceAnonymousTransactionsHandling { /** * Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogFilename: string; /** * Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogOffset: string; /** * Specifies how the replication channel handles anonymous transactions. */ policy: string; /** * The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later. */ uuid: string; } interface GetMysqlDbSystemChannelSourceSslCaCertificate { /** * The type of CA certificate. */ certificateType: string; /** * The string containing the CA certificate in PEM format. */ contents: string; } interface GetMysqlDbSystemChannelTarget { /** * The username for the replication applier of the target MySQL DB System. */ applierUsername: string; /** * The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for [MySQL identifiers](https://dev.mysql.com/doc/refman/8.0/en/identifiers.html). The names of non-Deleted Channels must be unique for each DB System. */ channelName: string; /** * The DB System [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbSystemId: string; /** * Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source. */ delayInSeconds: number; /** * Replication filter rules to be applied at the DB System Channel target. */ filters: outputs.Mysql.GetMysqlDbSystemChannelTargetFilter[]; /** * Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. */ tablesWithoutPrimaryKeyHandling: string; /** * The specific target identifier. */ targetType: string; } interface GetMysqlDbSystemChannelTargetFilter { /** * The type of the filter rule. */ type: string; /** * Value of the destination configuration variable. */ value: string; } interface GetMysqlDbSystemCurrentPlacement { /** * The availability domain in which the DB System is placed. */ availabilityDomain: string; /** * The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. */ faultDomain: string; } interface GetMysqlDbSystemCustomerContact { /** * The email address used by Oracle to send notifications regarding the DB System. */ email: string; } interface GetMysqlDbSystemDataStorage { /** * The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred. */ allocatedStorageSizeInGbs: number; /** * Initial size of the data volume in GiBs that will be created and attached. */ dataStorageSizeInGb: number; /** * The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value. */ dataStorageSizeLimitInGbs: number; /** * Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs. */ isAutoExpandStorageEnabled: boolean; /** * Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value. */ maxStorageSizeInGbs: number; } interface GetMysqlDbSystemDatabaseConsole { /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service. */ status: string; } interface GetMysqlDbSystemDeletionPolicy { /** * Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted. */ automaticBackupRetention: string; /** * Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted. */ finalBackup: string; /** * Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow. */ isDeleteProtected: boolean; } interface GetMysqlDbSystemEncryptData { /** * Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * The OCID of the key to use. */ keyId: string; } interface GetMysqlDbSystemEndpoint { /** * The network address of the DB System. */ hostname: string; /** * The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address. */ ipAddress: string; /** * The internet protocol (IP) version of the IP address. */ ipAddressVersion: string; /** * The access modes from the client that this endpoint supports. */ modes: string[]; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port. */ portX: number; /** * The OCID of the resource that this endpoint is attached to. */ resourceId: string; /** * The type of endpoint that clients and connectors can connect to. */ resourceType: string; /** * The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service. */ status: string; /** * Additional information about the current endpoint status. */ statusDetails: string; } interface GetMysqlDbSystemHeatWaveCluster { /** * The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster. */ clusterSize: number; /** * Lakehouse enabled status for the HeatWave cluster. */ isLakehouseEnabled: boolean; /** * The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/mysql/20181021/ShapeSummary/ListShapes) operation. */ shapeName: string; /** * The current state of the DB System. */ state: string; /** * The date and time the DB System was created. */ timeCreated: string; /** * The time the DB System was last updated. */ timeUpdated: string; } interface GetMysqlDbSystemIpv6addressIpv6subnetCidrPairDetail { /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. */ ipv6address: string; /** * The IPv6 prefix allocated to the subnet. */ ipv6subnetCidr: string; } interface GetMysqlDbSystemMaintenance { /** * Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches. At most one configured window is supported. */ maintenanceDisabledWindows: outputs.Mysql.GetMysqlDbSystemMaintenanceMaintenanceDisabledWindow[]; /** * The maintenance schedule type of the DB system. EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated. REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable. */ maintenanceScheduleType: string; /** * The version that is expected to be targeted during the next scheduled maintenance run. */ targetVersion: string; /** * The time the scheduled maintenance is expected to start, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeScheduled: string; /** * The preferred version to target when performing an automatic MySQL upgrade. */ versionPreference: string; /** * The preferred version track to target when performing an automatic MySQL upgrade. LONG_TERM_SUPPORT: No MySQL database behavior changes. INNOVATION: Provides access to the latest features and all bug fixes. FOLLOW: Follows the track of the current MySQL version. */ versionTrackPreference: string; /** * The start time of the maintenance window. */ windowStartTime: string; } interface GetMysqlDbSystemMaintenanceMaintenanceDisabledWindow { /** * The time until when maintenance is disabled. Must be set together with timeStart and must be after timeStart. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeEnd: string; /** * The time from when maintenance is disabled. Must be set together with timeEnd and must be before timeEnd. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeStart: string; } interface GetMysqlDbSystemPointInTimeRecoveryDetail { /** * Earliest recovery time point for the DB System, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeEarliestRecoveryPoint: string; /** * Latest recovery time point for the DB System, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeLatestRecoveryPoint: string; } interface GetMysqlDbSystemReadEndpoint { /** * A list of IP addresses of read replicas that are excluded from serving read requests. */ excludeIps: string[]; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * The hostname for the read endpoint of the DB System. Used for DNS. */ readEndpointHostnameLabel: string; /** * The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. 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 should be a "dotted-quad" style IPv4 address. */ readEndpointIpAddress: string; /** * Details to assign an IPv6 subnet prefix or IPv6 address to a resource. */ readEndpointIpv6addressIpv6subnetCidrPairDetails: outputs.Mysql.GetMysqlDbSystemReadEndpointReadEndpointIpv6addressIpv6subnetCidrPairDetail[]; } interface GetMysqlDbSystemReadEndpointReadEndpointIpv6addressIpv6subnetCidrPairDetail { /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. */ ipv6address: string; /** * The IPv6 prefix allocated to the subnet. */ ipv6subnetCidr: string; } interface GetMysqlDbSystemRest { /** * Select how REST is configured across the DB System instances. */ configuration: string; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; } interface GetMysqlDbSystemSecureConnection { /** * Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). */ certificateGenerationType: string; /** * The OCID of the certificate to use. */ certificateId: string; } interface GetMysqlDbSystemSource { /** * The OCID of the backup to be used as the source for the new DB System. */ backupId: string; channels: outputs.Mysql.GetMysqlDbSystemSourceChannel[]; /** * The DB System [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbSystemId: string; /** * The date and time, as per RFC 3339, of the change up to which the new DB System shall be restored to, using a backup and logs from the original DB System. In case no point in time is specified, then this new DB System shall be restored up to the latest change recorded for the original DB System. */ recoveryPoint: string; region: string; /** * The specific source identifier. */ sourceType: string; sourceUrl: string; } interface GetMysqlDbSystemSourceChannel { /** * The username for the replication applier of the target MySQL DB System. */ applierUsername: string; sourcePassword: string; sourceUsername: string; /** * The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes. */ sslCaCertificates: outputs.Mysql.GetMysqlDbSystemSourceChannelSslCaCertificate[]; /** * The SSL mode of the Channel. */ sslMode: string; } interface GetMysqlDbSystemSourceChannelSslCaCertificate { /** * The type of CA certificate. */ certificateType: string; /** * The string containing the CA certificate in PEM format. */ contents: string; } interface GetMysqlDbSystemTelemetryConfiguration { /** * Telemetry configuration details for logging. */ logs: outputs.Mysql.GetMysqlDbSystemTelemetryConfigurationLog[]; } interface GetMysqlDbSystemTelemetryConfigurationLog { /** * Type of destination where MySQL telemetry is exposed to. */ destination: string; /** * List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.GetMysqlDbSystemTelemetryConfigurationLogDestinationConfiguration[]; /** * List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface GetMysqlDbSystemTelemetryConfigurationLogDestinationConfiguration { /** * Name of the destination configuration variable. */ key: string; /** * Value of the destination configuration variable. */ value: string; } interface GetMysqlDbSystemsDbSystem { /** * The access mode indicating if the database access is unrestricted (to all MySQL user accounts), or restricted (to only certain users with specific privileges): * * UNRESTRICTED: the access to the database is not restricted; * * RESTRICTED: the access is allowed only to users with specific privileges; RESTRICTED will correspond to setting the MySQL system variable [offlineMode](https://dev.mysql.com/doc/en/server-system-variables.html#sysvar_offline_mode) to ON. */ accessMode: string; adminPassword: string; adminUsername: string; /** * The availability domain in which the DB System is placed. */ availabilityDomain: string; /** * The Backup policy for the DB System. */ backupPolicies: outputs.Mysql.GetMysqlDbSystemsDbSystemBackupPolicy[]; /** * A list with a summary of all the Channels attached to the DB System. */ channels: outputs.Mysql.GetMysqlDbSystemsDbSystemChannel[]; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The requested Configuration instance. */ configurationId: string; /** * Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs. */ crashRecovery: string; /** * The availability domain and fault domain a DB System is placed in. */ currentPlacements: outputs.Mysql.GetMysqlDbSystemsDbSystemCurrentPlacement[]; /** * The list of customer email addresses that receive information from Oracle about the specified Oracle Cloud Infrastructure DB System resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a DB System. */ customerContacts: outputs.Mysql.GetMysqlDbSystemsDbSystemCustomerContact[]; /** * Initial size of the data volume in GiBs that will be created and attached. */ dataStorageSizeInGb: number; /** * Data Storage information. */ dataStorages: outputs.Mysql.GetMysqlDbSystemsDbSystemDataStorage[]; /** * Database console configuration details. */ databaseConsoles: outputs.Mysql.GetMysqlDbSystemsDbSystemDatabaseConsole[]; /** * Filter DB Systems by their Database Management configuration. */ databaseManagement: string; /** * The database mode indicating the types of statements that are allowed to run in the the DB system. This mode applies only to statements run by user connections. Replicated write statements continue to be allowed regardless of the DatabaseMode. * * READ_WRITE: allow running read and write statements on the DB system; * * READ_ONLY: only allow running read statements on the DB system. */ databaseMode: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The Deletion policy for the DB System. */ deletionPolicies: outputs.Mysql.GetMysqlDbSystemsDbSystemDeletionPolicy[]; /** * User-provided data about the DB System. */ description: string; /** * A filter to return only the resource matching the given display name exactly. */ displayName: string; /** * Encrypt data details. */ encryptDatas: outputs.Mysql.GetMysqlDbSystemsDbSystemEncryptData[]; /** * The network endpoints available for this DB System. */ endpoints: outputs.Mysql.GetMysqlDbSystemsDbSystemEndpoint[]; /** * The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A summary of a HeatWave cluster. */ heatWaveClusters: outputs.Mysql.GetMysqlDbSystemsDbSystemHeatWaveCluster[]; /** * The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. */ hostnameLabel: string; /** * The OCID of the DB System. */ id: string; /** * The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address. */ ipAddress: string; /** * Details to assign an IPv6 subnet prefix or IPv6 address to a resource. */ ipv6addressIpv6subnetCidrPairDetails: outputs.Mysql.GetMysqlDbSystemsDbSystemIpv6addressIpv6subnetCidrPairDetail[]; /** * If true, return only DB Systems with a HeatWave cluster attached, if false return only DB Systems with no HeatWave cluster attached. If not present, return all DB Systems. */ isHeatWaveClusterAttached: boolean; /** * Specifies if the DB System is highly available. */ isHighlyAvailable: boolean; /** * Whether an IPv6 address has been allocated for the DB system when attached to an IPv6 enabled subnet. Default: False. */ isIpv6enabled: boolean; /** * Additional information about the current lifecycleState. */ lifecycleDetails: string; /** * The Maintenance Policy for the DB System or Read Replica that this model is included in. */ maintenances: outputs.Mysql.GetMysqlDbSystemsDbSystemMaintenance[]; /** * Name of the MySQL Version in use for the DB System. */ mysqlVersion: string; /** * Network Security Group OCIDs used for the VNIC attachment. */ nsgIds: string[]; /** * Point-in-time Recovery details like earliest and latest recovery time point for the DB System. */ pointInTimeRecoveryDetails: outputs.Mysql.GetMysqlDbSystemsDbSystemPointInTimeRecoveryDetail[]; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port. */ portX: number; /** * The read endpoint of a DB System. */ readEndpoints: outputs.Mysql.GetMysqlDbSystemsDbSystemReadEndpoint[]; /** * REST configuration details. */ rests: outputs.Mysql.GetMysqlDbSystemsDbSystemRest[]; /** * Secure connection configuration details. */ secureConnections: outputs.Mysql.GetMysqlDbSystemsDbSystemSecureConnection[]; /** * Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/mysql/20181021/ShapeSummary/ListShapes) operation. */ shapeName: string; shutdownType: string; /** * Parameters detailing how to provision the initial data of the DB System. */ sources: outputs.Mysql.GetMysqlDbSystemsDbSystemSource[]; /** * DbSystem Lifecycle State */ state: string; /** * The OCID of the subnet the DB System is associated with. */ subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Telemetry configuration details of a DB System or a read replica. */ telemetryConfigurations: outputs.Mysql.GetMysqlDbSystemsDbSystemTelemetryConfiguration[]; /** * The date and time the DB System was created. */ timeCreated: string; /** * The time the DB System was last updated. */ timeUpdated: string; } interface GetMysqlDbSystemsDbSystemBackupPolicy { /** * List of policies of a DB system to schedule cross-region DB system backup copy. */ copyPolicies: outputs.Mysql.GetMysqlDbSystemsDbSystemBackupPolicyCopyPolicy[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * The PITR policy for the DB System. */ pitrPolicies: outputs.Mysql.GetMysqlDbSystemsDbSystemBackupPolicyPitrPolicy[]; /** * The number of days automated backups are retained. */ retentionInDays: number; /** * Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. */ softDelete: string; /** * The start time of the maintenance window. */ windowStartTime: string; } interface GetMysqlDbSystemsDbSystemBackupPolicyCopyPolicy { /** * Number of days to retain the copied DB system backup. */ backupCopyRetentionInDays: number; /** * The destination region name to which the DB system backup will be copied. */ copyToRegion: string; } interface GetMysqlDbSystemsDbSystemBackupPolicyPitrPolicy { /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; } interface GetMysqlDbSystemsDbSystemChannel { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only the resource matching the given display name exactly. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the DB System. */ id: string; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * Additional information about the current lifecycleState. */ lifecycleDetails: string; /** * Parameters detailing how to provision the initial data of the DB System. */ sources: outputs.Mysql.GetMysqlDbSystemsDbSystemChannelSource[]; /** * DbSystem Lifecycle State */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Details about the Channel target. */ targets: outputs.Mysql.GetMysqlDbSystemsDbSystemChannelTarget[]; /** * The date and time the DB System was created. */ timeCreated: string; /** * The time the DB System was last updated. */ timeUpdated: string; } interface GetMysqlDbSystemsDbSystemChannelSource { /** * Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does. */ anonymousTransactionsHandlings: outputs.Mysql.GetMysqlDbSystemsDbSystemChannelSourceAnonymousTransactionsHandling[]; /** * The network address of the DB System. */ hostname: string; /** * Whether the connection of the channel will be requested using the IPv6 address of the dual stack DB system or not. Default: False. */ mustUseIpv6onDualStack: boolean; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The specific source identifier. */ sourceType: string; /** * The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes. */ sslCaCertificates: outputs.Mysql.GetMysqlDbSystemsDbSystemChannelSourceSslCaCertificate[]; /** * The SSL mode of the Channel. */ sslMode: string; /** * The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/change-master-to.html) */ username: string; } interface GetMysqlDbSystemsDbSystemChannelSourceAnonymousTransactionsHandling { /** * Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogFilename: string; /** * Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogOffset: string; /** * Specifies how the replication channel handles anonymous transactions. */ policy: string; /** * The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later. */ uuid: string; } interface GetMysqlDbSystemsDbSystemChannelSourceSslCaCertificate { /** * The type of CA certificate. */ certificateType: string; /** * The string containing the CA certificate in PEM format. */ contents: string; } interface GetMysqlDbSystemsDbSystemChannelTarget { /** * The username for the replication applier of the target MySQL DB System. */ applierUsername: string; /** * The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for [MySQL identifiers](https://dev.mysql.com/doc/refman/8.0/en/identifiers.html). The names of non-Deleted Channels must be unique for each DB System. */ channelName: string; /** * The DB System [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbSystemId: string; /** * Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source. */ delayInSeconds: number; /** * Replication filter rules to be applied at the DB System Channel target. */ filters: outputs.Mysql.GetMysqlDbSystemsDbSystemChannelTargetFilter[]; /** * Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. */ tablesWithoutPrimaryKeyHandling: string; /** * The specific target identifier. */ targetType: string; } interface GetMysqlDbSystemsDbSystemChannelTargetFilter { /** * The type of the filter rule. */ type: string; /** * Value of the destination configuration variable. */ value: string; } interface GetMysqlDbSystemsDbSystemCurrentPlacement { /** * The availability domain in which the DB System is placed. */ availabilityDomain: string; /** * The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. */ faultDomain: string; } interface GetMysqlDbSystemsDbSystemCustomerContact { /** * The email address used by Oracle to send notifications regarding the DB System. */ email: string; } interface GetMysqlDbSystemsDbSystemDataStorage { /** * The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred. */ allocatedStorageSizeInGbs: number; /** * Initial size of the data volume in GiBs that will be created and attached. */ dataStorageSizeInGb: number; /** * The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value. */ dataStorageSizeLimitInGbs: number; /** * Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs. */ isAutoExpandStorageEnabled: boolean; /** * Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value. */ maxStorageSizeInGbs: number; } interface GetMysqlDbSystemsDbSystemDatabaseConsole { /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service. */ status: string; } interface GetMysqlDbSystemsDbSystemDeletionPolicy { /** * Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted. */ automaticBackupRetention: string; /** * Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted. */ finalBackup: string; /** * Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow. */ isDeleteProtected: boolean; } interface GetMysqlDbSystemsDbSystemEncryptData { /** * Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * The OCID of the key to use. */ keyId: string; } interface GetMysqlDbSystemsDbSystemEndpoint { /** * The network address of the DB System. */ hostname: string; /** * The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address. */ ipAddress: string; /** * The internet protocol (IP) version of the IP address. */ ipAddressVersion: string; /** * The access modes from the client that this endpoint supports. */ modes: string[]; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port. */ portX: number; /** * The OCID of the resource that this endpoint is attached to. */ resourceId: string; /** * The type of endpoint that clients and connectors can connect to. */ resourceType: string; /** * The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service. */ status: string; /** * Additional information about the current endpoint status. */ statusDetails: string; } interface GetMysqlDbSystemsDbSystemHeatWaveCluster { /** * The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster. */ clusterSize: number; /** * Lakehouse enabled status for the HeatWave cluster. */ isLakehouseEnabled: boolean; /** * The shape of the primary instances of the DB System. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use (the [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/mysql/20181021/ShapeSummary/ListShapes) operation. */ shapeName: string; /** * DbSystem Lifecycle State */ state: string; /** * The date and time the DB System was created. */ timeCreated: string; /** * The time the DB System was last updated. */ timeUpdated: string; } interface GetMysqlDbSystemsDbSystemIpv6addressIpv6subnetCidrPairDetail { /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. */ ipv6address: string; /** * The IPv6 prefix allocated to the subnet. */ ipv6subnetCidr: string; } interface GetMysqlDbSystemsDbSystemMaintenance { /** * Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches. At most one configured window is supported. */ maintenanceDisabledWindows: outputs.Mysql.GetMysqlDbSystemsDbSystemMaintenanceMaintenanceDisabledWindow[]; /** * The maintenance schedule type of the DB system. EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated. REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable. */ maintenanceScheduleType: string; /** * The version that is expected to be targeted during the next scheduled maintenance run. */ targetVersion: string; /** * The time the scheduled maintenance is expected to start, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeScheduled: string; /** * The preferred version to target when performing an automatic MySQL upgrade. */ versionPreference: string; /** * The preferred version track to target when performing an automatic MySQL upgrade. LONG_TERM_SUPPORT: No MySQL database behavior changes. INNOVATION: Provides access to the latest features and all bug fixes. FOLLOW: Follows the track of the current MySQL version. */ versionTrackPreference: string; /** * The start time of the maintenance window. */ windowStartTime: string; } interface GetMysqlDbSystemsDbSystemMaintenanceMaintenanceDisabledWindow { /** * The time until when maintenance is disabled. Must be set together with timeStart and must be after timeStart. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeEnd: string; /** * The time from when maintenance is disabled. Must be set together with timeEnd and must be before timeEnd. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeStart: string; } interface GetMysqlDbSystemsDbSystemPointInTimeRecoveryDetail { /** * Earliest recovery time point for the DB System, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeEarliestRecoveryPoint: string; /** * Latest recovery time point for the DB System, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeLatestRecoveryPoint: string; } interface GetMysqlDbSystemsDbSystemReadEndpoint { /** * A list of IP addresses of read replicas that are excluded from serving read requests. */ excludeIps: string[]; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * The hostname for the read endpoint of the DB System. Used for DNS. */ readEndpointHostnameLabel: string; /** * The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. 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 should be a "dotted-quad" style IPv4 address. */ readEndpointIpAddress: string; /** * Details to assign an IPv6 subnet prefix or IPv6 address to a resource. */ readEndpointIpv6addressIpv6subnetCidrPairDetails: outputs.Mysql.GetMysqlDbSystemsDbSystemReadEndpointReadEndpointIpv6addressIpv6subnetCidrPairDetail[]; } interface GetMysqlDbSystemsDbSystemReadEndpointReadEndpointIpv6addressIpv6subnetCidrPairDetail { /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. */ ipv6address: string; /** * The IPv6 prefix allocated to the subnet. */ ipv6subnetCidr: string; } interface GetMysqlDbSystemsDbSystemRest { /** * Select how REST is configured across the DB System instances. */ configuration: string; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; } interface GetMysqlDbSystemsDbSystemSecureConnection { /** * Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). */ certificateGenerationType: string; /** * The OCID of the certificate to use. */ certificateId: string; } interface GetMysqlDbSystemsDbSystemSource { /** * The OCID of the backup to be used as the source for the new DB System. */ backupId: string; channels: outputs.Mysql.GetMysqlDbSystemsDbSystemSourceChannel[]; /** * The DB System [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbSystemId: string; /** * The date and time, as per RFC 3339, of the change up to which the new DB System shall be restored to, using a backup and logs from the original DB System. In case no point in time is specified, then this new DB System shall be restored up to the latest change recorded for the original DB System. */ recoveryPoint: string; region: string; /** * The specific source identifier. */ sourceType: string; sourceUrl: string; } interface GetMysqlDbSystemsDbSystemSourceChannel { /** * The username for the replication applier of the target MySQL DB System. */ applierUsername: string; sourcePassword: string; sourceUsername: string; /** * The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes. */ sslCaCertificates: outputs.Mysql.GetMysqlDbSystemsDbSystemSourceChannelSslCaCertificate[]; /** * The SSL mode of the Channel. */ sslMode: string; } interface GetMysqlDbSystemsDbSystemSourceChannelSslCaCertificate { /** * The type of CA certificate. */ certificateType: string; /** * The string containing the CA certificate in PEM format. */ contents: string; } interface GetMysqlDbSystemsDbSystemTelemetryConfiguration { /** * Telemetry configuration details for logging. */ logs: outputs.Mysql.GetMysqlDbSystemsDbSystemTelemetryConfigurationLog[]; } interface GetMysqlDbSystemsDbSystemTelemetryConfigurationLog { /** * Type of destination where MySQL telemetry is exposed to. */ destination: string; /** * List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.GetMysqlDbSystemsDbSystemTelemetryConfigurationLogDestinationConfiguration[]; /** * List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface GetMysqlDbSystemsDbSystemTelemetryConfigurationLogDestinationConfiguration { /** * Name of the destination configuration variable. */ key: string; /** * Value of the destination configuration variable. */ value: string; } interface GetMysqlDbSystemsFilter { name: string; regex?: boolean; values: string[]; } interface GetMysqlVersionFilter { name: string; regex?: boolean; values: string[]; } interface GetMysqlVersionVersion { /** * A descriptive summary of a group of versions. */ versionFamily: string; /** * The list of supported MySQL Versions. */ versions: outputs.Mysql.GetMysqlVersionVersionVersion[]; } interface GetMysqlVersionVersionVersion { /** * A link to a page describing the version. */ description: string; /** * The specific version identifier */ version: string; } interface GetReplicaEncryptData { /** * Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * The OCID of the key to use. */ keyId: string; } interface GetReplicaReplicaOverride { /** * The OCID of the Configuration to be used by the read replica. */ configurationId: string; /** * The MySQL version to be used by the read replica. */ mysqlVersion: string; /** * Network Security Group OCIDs used for the VNIC attachment. */ nsgIds: string[]; /** * Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/mysql/20190415/ShapeSummary/ListShapes) operation. */ shapeName: string; /** * Telemetry configuration details of a DB System or a read replica. */ telemetryConfigurations: outputs.Mysql.GetReplicaReplicaOverrideTelemetryConfiguration[]; } interface GetReplicaReplicaOverrideTelemetryConfiguration { /** * Telemetry configuration details for logging. */ logs: outputs.Mysql.GetReplicaReplicaOverrideTelemetryConfigurationLog[]; } interface GetReplicaReplicaOverrideTelemetryConfigurationLog { /** * Type of destination where MySQL telemetry is exposed to. */ destination: string; /** * List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.GetReplicaReplicaOverrideTelemetryConfigurationLogDestinationConfiguration[]; /** * List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface GetReplicaReplicaOverrideTelemetryConfigurationLogDestinationConfiguration { /** * Name of the destination configuration variable. */ key: string; /** * Value of the destination configuration variable. */ value: string; } interface GetReplicaSecureConnection { /** * Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). */ certificateGenerationType: string; /** * The OCID of the certificate to use. */ certificateId: string; } interface GetReplicaTelemetryConfiguration { /** * Telemetry configuration details for logging. */ logs: outputs.Mysql.GetReplicaTelemetryConfigurationLog[]; } interface GetReplicaTelemetryConfigurationLog { /** * Type of destination where MySQL telemetry is exposed to. */ destination: string; /** * List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.GetReplicaTelemetryConfigurationLogDestinationConfiguration[]; /** * List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface GetReplicaTelemetryConfigurationLogDestinationConfiguration { /** * Name of the destination configuration variable. */ key: string; /** * Value of the destination configuration variable. */ value: string; } interface GetReplicasFilter { name: string; regex?: boolean; values: string[]; } interface GetReplicasReplica { /** * The name of the Availability Domain the read replica is located in. */ availabilityDomain: string; /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * The requested Configuration instance. */ configurationId: string; /** * The DB System [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ dbSystemId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * User provided description of the read replica. */ description: string; /** * A filter to return only the resource matching the given display name exactly. */ displayName: string; /** * Encrypt data details. */ encryptDatas: outputs.Mysql.GetReplicasReplicaEncryptData[]; /** * The name of the Fault Domain the read replica is located in. */ faultDomain: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the read replica. */ id: string; /** * The IP address the read replica is configured to listen on. */ ipAddress: string; /** * The IPv6 address the read replica is configured to listen on. */ ipv6address: string; /** * Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves. */ isDeleteProtected: boolean; /** * A message describing the state of the read replica. */ lifecycleDetails: string; /** * The MySQL version to be used by the read replica. */ mysqlVersion: string; /** * Network Security Group OCIDs used for the VNIC attachment. */ nsgIds: string[]; /** * The port the read replica is configured to listen on. */ port: number; /** * The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port. */ portX: number; /** * By default a read replica inherits the MySQL version, shape, and configuration of the source DB system. If you want to override any of these, provide values in the properties, mysqlVersion, shapeName, and configurationId. If you set a property value to "", then the value is inherited from its source DB system. */ replicaOverrides: outputs.Mysql.GetReplicasReplicaReplicaOverride[]; /** * Secure connection configuration details. */ secureConnections: outputs.Mysql.GetReplicasReplicaSecureConnection[]; /** * Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/mysql/20190415/ShapeSummary/ListShapes) operation. */ shapeName: string; /** * The LifecycleState of the read replica. */ state: string; /** * Telemetry configuration details of a DB System or a read replica. */ telemetryConfigurations: outputs.Mysql.GetReplicasReplicaTelemetryConfiguration[]; /** * The date and time the read replica was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; /** * The time the read replica was last updated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; } interface GetReplicasReplicaEncryptData { /** * Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * The OCID of the key to use. */ keyId: string; } interface GetReplicasReplicaReplicaOverride { /** * The requested Configuration instance. */ configurationId: string; /** * The MySQL version to be used by the read replica. */ mysqlVersion: string; /** * Network Security Group OCIDs used for the VNIC attachment. */ nsgIds: string[]; /** * Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/mysql/20190415/ShapeSummary/ListShapes) operation. */ shapeName: string; /** * Telemetry configuration details of a DB System or a read replica. */ telemetryConfigurations: outputs.Mysql.GetReplicasReplicaReplicaOverrideTelemetryConfiguration[]; } interface GetReplicasReplicaReplicaOverrideTelemetryConfiguration { /** * Telemetry configuration details for logging. */ logs: outputs.Mysql.GetReplicasReplicaReplicaOverrideTelemetryConfigurationLog[]; } interface GetReplicasReplicaReplicaOverrideTelemetryConfigurationLog { /** * Type of destination where MySQL telemetry is exposed to. */ destination: string; /** * List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.GetReplicasReplicaReplicaOverrideTelemetryConfigurationLogDestinationConfiguration[]; /** * List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface GetReplicasReplicaReplicaOverrideTelemetryConfigurationLogDestinationConfiguration { /** * Name of the destination configuration variable. */ key: string; /** * Value of the destination configuration variable. */ value: string; } interface GetReplicasReplicaSecureConnection { /** * Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). */ certificateGenerationType: string; /** * The OCID of the certificate to use. */ certificateId: string; } interface GetReplicasReplicaTelemetryConfiguration { /** * Telemetry configuration details for logging. */ logs: outputs.Mysql.GetReplicasReplicaTelemetryConfigurationLog[]; } interface GetReplicasReplicaTelemetryConfigurationLog { /** * Type of destination where MySQL telemetry is exposed to. */ destination: string; /** * List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.GetReplicasReplicaTelemetryConfigurationLogDestinationConfiguration[]; /** * List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface GetReplicasReplicaTelemetryConfigurationLogDestinationConfiguration { /** * Name of the destination configuration variable. */ key: string; /** * Value of the destination configuration variable. */ value: string; } interface GetShapesFilter { /** * Name */ name: string; regex?: boolean; values: string[]; } interface GetShapesShape { /** * The number of CPU Cores the Instance provides. These are "OCPU"s. */ cpuCoreCount: number; /** * Return shapes that are supported by the service feature. */ isSupportedFors: string[]; /** * The amount of RAM the Instance provides. This is an IEC base-2 number. */ memorySizeInGbs: number; /** * Name */ name: string; } interface HeatWaveClusterClusterNode { /** * The ID of the node within MySQL HeatWave cluster. */ nodeId: string; /** * (Updatable) The target state for the HeatWave cluster. Could be set to `ACTIVE` or `INACTIVE`. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ state: string; /** * The date and time the HeatWave cluster was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; /** * The time the HeatWave cluster was last updated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; } interface MysqlBackupBackupValidationDetail { /** * Indicates whether the backup has been prepared successfully. PREPARED: The backup is prepared one. NOT_PREPARED: The backup is not prepared. */ backupPreparationStatus: string; /** * Error message if the backup validation has failed. */ errorMessage: string; /** * The estimated restore duration of the backup. */ estimatedRestoreDuration: string; /** * Prepared backup details. */ preparedBackupDetails: outputs.Mysql.MysqlBackupBackupValidationDetailPreparedBackupDetail[]; /** * The date and time of the most recent validation performed on the backup. */ timeLastValidated: string; /** * The status of backup validation: NOT_VALIDATED (Default): The backup has not been validated. VALIDATED: The backup has been validated successfully. NEEDS_ATTENTION: The backup validation failed due to a transient issue. Validation should be retried. FAILED: The backup cannot be restored. */ validationStatus: string; } interface MysqlBackupBackupValidationDetailPreparedBackupDetail { /** * The estimated time saving when this prepared backup is restored. */ preparedBackupRestoreReductionInMinutes: number; /** * The date and time the backup was prepared. */ timePrepared: string; } interface MysqlBackupDbSystemSnapshot { /** * The username for the administrative user. */ adminUsername: string; /** * The Availability Domain where the primary DB System should be located. */ availabilityDomain: string; /** * The Backup policy for the DB System. */ backupPolicies: outputs.Mysql.MysqlBackupDbSystemSnapshotBackupPolicy[]; /** * (Updatable) The OCID of the compartment the backup exists in. */ compartmentId: string; /** * The OCID of the Configuration to be used for Instances in this DB System. */ configurationId: string; /** * Whether to run the DB System with InnoDB Redo Logs and the Double Write Buffer enabled or disabled, and whether to enable or disable syncing of the Binary Logs. */ crashRecovery: string; /** * DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs. */ dataStorageSizeInGb: number; /** * Data Storage information. */ dataStorages: outputs.Mysql.MysqlBackupDbSystemSnapshotDataStorage[]; /** * Database console configuration details. */ databaseConsoles: outputs.Mysql.MysqlBackupDbSystemSnapshotDatabaseConsole[]; /** * Whether to enable monitoring via the Database Management service. */ databaseManagement: string; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The Deletion policy for the DB System. */ deletionPolicies: outputs.Mysql.MysqlBackupDbSystemSnapshotDeletionPolicy[]; /** * (Updatable) A user-supplied description for the backup. */ description: string; /** * (Updatable) A user-supplied display name for the backup. */ displayName: string; /** * Encrypt data details. */ encryptDatas: outputs.Mysql.MysqlBackupDbSystemSnapshotEncryptData[]; /** * The network endpoints available for this DB System. */ endpoints: outputs.Mysql.MysqlBackupDbSystemSnapshotEndpoint[]; /** * The name of the Fault Domain the DB System is located in. */ faultDomain: string; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The hostname for the primary endpoint of the DB System. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. */ hostnameLabel: string; /** * OCID of the backup itself */ id: string; /** * The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address. */ ipAddress: string; /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. */ ipv6address: string; /** * Specifies if the DB System is highly available. */ isHighlyAvailable: boolean; /** * The Maintenance Policy for the DB System or Read Replica that this model is included in. */ maintenances: outputs.Mysql.MysqlBackupDbSystemSnapshotMaintenance[]; /** * The MySQL server version of the DB System used for backup. */ mysqlVersion: string; /** * Network Security Group OCIDs used for the VNIC attachment. */ nsgIds: string[]; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port. */ portX: number; /** * The read endpoint of a DB System. */ readEndpoints: outputs.Mysql.MysqlBackupDbSystemSnapshotReadEndpoint[]; /** * The region identifier of the region where the DB system exists. For more information, please see [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm). */ region: string; /** * REST configuration details. */ rests: outputs.Mysql.MysqlBackupDbSystemSnapshotRest[]; /** * Secure connection configuration details. */ secureConnections: outputs.Mysql.MysqlBackupDbSystemSnapshotSecureConnection[]; /** * Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * The shape of the DB System instance used for backup. */ shapeName: string; /** * The OCID of the subnet the DB System is associated with. */ subnetId: string; /** * Telemetry configuration details of a DB System or a read replica. */ telemetryConfiguration: outputs.Mysql.MysqlBackupDbSystemSnapshotTelemetryConfiguration; } interface MysqlBackupDbSystemSnapshotBackupPolicy { /** * List of policies of a DB system to schedule cross-region DB system backup copy. */ copyPolicies: outputs.Mysql.MysqlBackupDbSystemSnapshotBackupPolicyCopyPolicy[]; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * The PITR policy for the DB System. */ pitrPolicies: outputs.Mysql.MysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy[]; /** * (Updatable) Number of days to retain this backup. */ retentionInDays: number; /** * (Updatable) Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. */ softDelete: string; /** * The start time of the maintenance window. */ windowStartTime: string; } interface MysqlBackupDbSystemSnapshotBackupPolicyCopyPolicy { /** * Number of days to retain the copied DB system backup. */ backupCopyRetentionInDays: number; /** * The destination region name to which the DB system backup will be copied. */ copyToRegion: string; } interface MysqlBackupDbSystemSnapshotBackupPolicyPitrPolicy { /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; } interface MysqlBackupDbSystemSnapshotDataStorage { /** * The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred. */ allocatedStorageSizeInGbs: number; /** * DEPRECATED: User specified size of the data volume. May be less than current allocatedStorageSizeInGBs. Replaced by dataStorage.dataStorageSizeInGBs. */ dataStorageSizeInGb: number; /** * The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value. */ dataStorageSizeLimitInGbs: number; /** * Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs. */ isAutoExpandStorageEnabled: boolean; /** * Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value. */ maxStorageSizeInGbs: number; } interface MysqlBackupDbSystemSnapshotDatabaseConsole { /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service. */ status: string; } interface MysqlBackupDbSystemSnapshotDeletionPolicy { /** * Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted. */ automaticBackupRetention: string; /** * Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted. */ finalBackup: string; /** * Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow. */ isDeleteProtected: boolean; } interface MysqlBackupDbSystemSnapshotEncryptData { /** * Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * The OCID of the key to use. */ keyId: string; } interface MysqlBackupDbSystemSnapshotEndpoint { /** * The network address of the DB System. */ hostname: string; /** * The IP address the DB System is configured to listen on. A private IP address of the primary endpoint of the DB System. Must be an available IP address within the subnet's CIDR. This will be a "dotted-quad" style IPv4 address. */ ipAddress: string; /** * The internet protocol (IP) version of the IP address. */ ipAddressVersion: string; /** * The access modes from the client that this endpoint supports. */ modes: string[]; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * The network port on which X Plugin listens for TCP/IP connections. This is the X Plugin equivalent of port. */ portX: number; /** * The OCID of the resource that this endpoint is attached to. */ resourceId: string; /** * The type of endpoint that clients and connectors can connect to. */ resourceType: string; /** * The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service. */ status: string; /** * Additional information about the current endpoint status. */ statusDetails: string; } interface MysqlBackupDbSystemSnapshotMaintenance { /** * Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches. At most one configured window is supported. */ maintenanceDisabledWindows: outputs.Mysql.MysqlBackupDbSystemSnapshotMaintenanceMaintenanceDisabledWindow[]; /** * The maintenance schedule type of the DB system. EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated. REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable. */ maintenanceScheduleType: string; /** * The version that is expected to be targeted during the next scheduled maintenance run. */ targetVersion: string; /** * The time the scheduled maintenance is expected to start, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeScheduled: string; /** * The preferred version to target when performing an automatic MySQL upgrade. */ versionPreference: string; /** * The preferred version track to target when performing an automatic MySQL upgrade. LONG_TERM_SUPPORT: No MySQL database behavior changes. INNOVATION: Provides access to the latest features and all bug fixes. FOLLOW: Follows the track of the current MySQL version. */ versionTrackPreference: string; /** * The start time of the maintenance window. */ windowStartTime: string; } interface MysqlBackupDbSystemSnapshotMaintenanceMaintenanceDisabledWindow { /** * The time until when maintenance is disabled. Must be set together with timeStart and must be after timeStart. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeEnd: string; /** * The time from when maintenance is disabled. Must be set together with timeEnd and must be before timeEnd. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeStart: string; } interface MysqlBackupDbSystemSnapshotReadEndpoint { /** * A list of IP addresses of read replicas that are excluded from serving read requests. */ excludeIps: string[]; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * The hostname for the read endpoint of the DB System. Used for DNS. */ readEndpointHostnameLabel: string; /** * The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. 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 should be a "dotted-quad" style IPv4 address. */ readEndpointIpAddress: string; /** * Details to assign an IPv6 subnet prefix or IPv6 address to a resource. */ readEndpointIpv6addressIpv6subnetCidrPairDetails: outputs.Mysql.MysqlBackupDbSystemSnapshotReadEndpointReadEndpointIpv6addressIpv6subnetCidrPairDetail[]; } interface MysqlBackupDbSystemSnapshotReadEndpointReadEndpointIpv6addressIpv6subnetCidrPairDetail { /** * An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. */ ipv6address: string; /** * The IPv6 prefix allocated to the subnet. */ ipv6subnetCidr: string; } interface MysqlBackupDbSystemSnapshotRest { /** * Select how REST is configured across the DB System instances. */ configuration: string; /** * The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; } interface MysqlBackupDbSystemSnapshotSecureConnection { /** * Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). */ certificateGenerationType: string; /** * The OCID of the certificate to use. */ certificateId: string; } interface MysqlBackupDbSystemSnapshotSummary { /** * (Updatable) A user-supplied display name for the backup. */ displayName: string; /** * OCID of the backup itself */ id: string; /** * The region identifier of the region where the DB system exists. For more information, please see [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm). */ region: string; } interface MysqlBackupDbSystemSnapshotTelemetryConfiguration { /** * Telemetry configuration details for logging. */ logs: outputs.Mysql.MysqlBackupDbSystemSnapshotTelemetryConfigurationLog[]; } interface MysqlBackupDbSystemSnapshotTelemetryConfigurationLog { /** * Type of destination where MySQL telemetry is exposed to. */ destination: string; /** * List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.MysqlBackupDbSystemSnapshotTelemetryConfigurationLogDestinationConfiguration[]; /** * List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface MysqlBackupDbSystemSnapshotTelemetryConfigurationLogDestinationConfiguration { /** * Name of the destination configuration variable. */ key: string; /** * Value of the destination configuration variable. */ value: string; } interface MysqlBackupEncryptData { /** * Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * The OCID of the key to use. */ keyId: string; } interface MysqlBackupSourceDetails { /** * The OCID of the source backup. */ backupId: string; /** * (Updatable) The OCID of the compartment the backup exists in. */ compartmentId: string; /** * The region of the backup source. */ region: string; } interface MysqlBackupValidateBackupDetail { /** * Specifies whether the backup needs to be prepared for fast restore or not. Set to true to prepare the backup **Note:** Prepare backup is a one time operation, therefore this field can be set to true only once. */ isPreparedBackupRequired: boolean; } interface MysqlConfigurationInitVariables { /** * Represents the MySQL server system variable lowerCaseTableNames (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_lower_case_table_names). * * lowerCaseTableNames controls case-sensitivity of tables and schema names and how they are stored in the DB System. * * Valid values are: * * CASE_SENSITIVE - (default) Table and schema name comparisons are case-sensitive and stored as specified. (lower_case_table_names=0) * * CASE_INSENSITIVE_LOWERCASE - Table and schema name comparisons are not case-sensitive and stored in lowercase. (lower_case_table_names=1) */ lowerCaseTableNames: string; } interface MysqlConfigurationOption { /** * The option name. */ name: string; /** * The option value. */ value: string; } interface MysqlConfigurationVariables { /** * auto_increment_increment and autoIncrementOffset are intended for use with circular (source-to-source) replication, and can be used to control the operation of AUTO_INCREMENT columns. Both variables have global and session values, and each can assume an integer value between 1 and 65,535 inclusive. * * autoIncrementIncrement corresponds to the MySQL Replication Source Options variable [autoIncrementIncrement] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-source.html#sysvar_auto_increment_increment). */ autoIncrementIncrement: number; /** * This variable has a default value of 1. If it is left with its default value, and Group Replication is started on the server in multi-primary mode, it is changed to the server ID. * * autoIncrementOffset corresponds to the MySQL Replication Source Options variable [autoIncrementOffset] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-source.html#sysvar_auto_increment_offset). */ autoIncrementOffset: number; /** * ("autocommit") */ autocommit: boolean; /** * If enabled, the server stores all temporary tables on disk rather than in memory. * * bigTables corresponds to the MySQL server variable [bigTables](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_big_tables). */ bigTables: boolean; /** * Sets the binary log expiration period in seconds. binlogExpireLogsSeconds corresponds to the MySQL binary logging system variable [binlogExpireLogsSeconds](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_expire_logs_seconds). */ binlogExpireLogsSeconds: number; /** * Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk. There is no delay by default. Setting this variable to a microsecond delay enables more transactions to be synchronized together to disk at once, reducing the overall time to commit a group of transactions because the larger groups required fewer time units per group. * * binlogGroupCommitSyncDelay corresponds to the MySQL Replication system variable [binlogGroupCommitSyncDelay](https://dev.mysql.com/doc/refman/5.7/en/replication-options-binary-log.html#sysvar_binlog_group_commit_sync_delay) */ binlogGroupCommitSyncDelay: number; /** * The maximum number of transactions to wait for before aborting the current delay as specified by binlog_group_commit_sync_delay. If binlogGroupCommitSyncDelay is set to 0, then this option has no effect. * * binlogGroupCommitSyncNoDelayCount corresponds to the MySQL Replication system variable [binlogGroupCommitSyncNoDelayCount](https://dev.mysql.com/doc/refman/5.7/en/replication-options-binary-log.html#sysvar_binlog_group_commit_sync_no_delay_count) */ binlogGroupCommitSyncNoDelayCount: number; /** * Configures the amount of table metadata added to the binary log when using row-based logging. binlogRowMetadata corresponds to the MySQL binary logging system variable [binlogRowMetadata](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_metadata). */ binlogRowMetadata: string; /** * When set to PARTIAL_JSON, this enables use of a space-efficient binary log format for updates that modify only a small portion of a JSON document. binlogRowValueOptions corresponds to the MySQL binary logging system variable [binlogRowValueOptions](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_row_value_options). */ binlogRowValueOptions: string; /** * Enables compression for transactions that are written to binary log files on this server. binlogTransactionCompression corresponds to the MySQL binary logging system variable [binlogTransactionCompression](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_binlog_transaction_compression). */ binlogTransactionCompression: boolean; /** * This variable controls the block encryption mode for block-based algorithms such as AES. It affects encryption for AES_ENCRYPT() and AES_DECRYPT(). blockEncryptionMode takes a value in aes-keylen-mode format, where keylen is the key length in bits and mode is the encryption mode. The value is not case-sensitive. Permitted keylen values are 128, 192, and 256. Permitted mode values are ECB, CBC, CFB1, CFB8, CFB128, and OFB. * * blockEncryptionMode corresponds to the MySQL Server Administration system variable [blockEncryptionMode](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_block_encryption_mode) */ blockEncryptionMode: string; /** * The server's default character set. If you set this variable, you should also set collationServer to specify the collation for the character set. * * characterSetServer corresponds to the MySQL server variable [characterSetServer](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_character_set_server). */ characterSetServer: string; /** * The server's default collation. * * collationServer corresponds to the MySQL server variable [collationServer](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_collation_server). */ collationServer: string; /** * ("completionType") */ completionType: string; /** * The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake. * * connectTimeout corresponds to the MySQL system variable [connectTimeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_connect_timeout) * * Increasing the connectTimeout value might help if clients frequently encounter errors of the form "Lost connection to MySQL server at 'XXX', system error: errno". */ connectTimeout: number; /** * Set the chunking size for updates to the global memory usage counter Global_connection_memory. * * connectionMemoryChunkSize corresponds to the MySQL system variable [connectionMemoryChunkSize](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_connection_memory_chunk_size). */ connectionMemoryChunkSize: number; /** * Set the maximum amount of memory that can be used by a single user connection. * * connectionMemoryLimit corresponds to the MySQL system variable [connectionMemoryLimit](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_connection_memory_limit). */ connectionMemoryLimit: string; /** * ("cteMaxRecursionDepth") */ cteMaxRecursionDepth: string; /** * The default authentication plugin. This must be a plugin that uses internal credentials storage, so these values are permitted: mysql_native_password, sha256_password, caching_sha2_password. * * As of MySQL 8.0.27, which introduces multifactor authentication, defaultAuthenticationPlugin is still used, but in conjunction with and at a lower precedence than the authenticationPolicy system variable. For details, see The Default Authentication Plugin. Because of this diminished role, defaultAuthenticationPlugin is deprecated as of MySQL 8.0.27 and subject to removal in a future MySQL version. * * defaultAuthenticationPlugin corresponds to the MySQL system variable [defaultAuthenticationPlugin](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_default_authentication_plugin). */ defaultAuthenticationPlugin: string; /** * This variable determines the default output format used by EXPLAIN in the absence of a FORMAT option when displaying a query execution plan. * * explainFormat corresponds to the MySQL system variable [explainFormat](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_explain_format). */ explainFormat: string; /** * This system variable determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns. By default, explicitDefaultsForTimestamp is enabled, which disables the nonstandard behaviors. Disabling explicitDefaultsForTimestamp results in a warning. * * explicitDefaultsForTimestamp corresponds to the MySQL Server Administration system variable [explicitDefaultsForTimestamp](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_explicit_defaults_for_timestamp) */ explicitDefaultsForTimestamp: boolean; /** * ("foreignKeyChecks") */ foreignKeyChecks: boolean; /** * ("generatedRandomPasswordLength") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'generated_random_password_length' field has been deprecated and may be removed in a future version. Do not use this field. */ generatedRandomPasswordLength: number; /** * Set the total amount of memory that can be used by all user connections. * * globalConnectionMemoryLimit corresponds to the MySQL system variable [globalConnectionMemoryLimit](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_global_connection_memory_limit). */ globalConnectionMemoryLimit: string; /** * Determines whether the MySQL server calculates Global_connection_memory. * * globalConnectionMemoryTracking corresponds to the MySQL system variable [globalConnectionMemoryTracking](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_global_connection_memory_tracking). */ globalConnectionMemoryTracking: boolean; /** * Specifies the maximum permitted result length in bytes for the GROUP_CONCAT() function. * * This is the MySQL variable "groupConcatMaxLen". For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_group_concat_max_len) */ groupConcatMaxLen: string; /** * * EVENTUAL: Both RO and RW transactions do not wait for preceding transactions to be applied before executing. A RW transaction does not wait for other members to apply a transaction. This means that a transaction could be externalized on one member before the others. This also means that in the event of a primary failover, the new primary can accept new RO and RW transactions before the previous primary transactions are all applied. RO transactions could result in outdated values, RW transactions could result in a rollback due to conflicts. * * BEFORE_ON_PRIMARY_FAILOVER: New RO or RW transactions with a newly elected primary that is applying backlog from the old primary are held (not applied) until any backlog has been applied. This ensures that when a primary failover happens, intentionally or not, clients always see the latest value on the primary. This guarantees consistency, but means that clients must be able to handle the delay in the event that a backlog is being applied. Usually this delay should be minimal, but does depend on the size of the backlog. * * BEFORE: A RW transaction waits for all preceding transactions to complete before being applied. A RO transaction waits for all preceding transactions to complete before being executed. This ensures that this transaction reads the latest value by only affecting the latency of the transaction. This reduces the overhead of synchronization on every RW transaction, by ensuring synchronization is used only on RO transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. * * AFTER: A RW transaction waits until its changes have been applied to all of the other members. This value has no effect on RO transactions. This mode ensures that when a transaction is committed on the local member, any subsequent transaction reads the written value or a more recent value on any group member. Use this mode with a group that is used for predominantly RO operations to ensure that applied RW transactions are applied everywhere once they commit. This could be used by your application to ensure that subsequent reads fetch the latest data which includes the latest writes. This reduces the overhead of synchronization on every RO transaction, by ensuring synchronization is used only on RW transactions. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. * * BEFORE_AND_AFTER: A RW transaction waits for 1) all preceding transactions to complete before being applied and 2) until its changes have been applied on other members. A RO transaction waits for all preceding transactions to complete before execution takes place. This consistency level also includes the consistency guarantees provided by BEFORE_ON_PRIMARY_FAILOVER. */ groupReplicationConsistency: string; /** * ("informationSchemaStatsExpiry") */ informationSchemaStatsExpiry: number; /** * Whether the InnoDB adaptive hash index is enabled or disabled. It may be desirable, depending on your workload, to dynamically enable or disable adaptive hash indexing to improve query performance. Because the adaptive hash index may not be useful for all workloads, conduct benchmarks with it both enabled and disabled, using realistic workloads. * * innodbAdaptiveHashIndex corresponds to the MySQL InnoDB Startup Options and System Variables [innodbAdaptiveHashIndex] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_adaptive_hash_index). */ innodbAdaptiveHashIndex: boolean; /** * The lock mode to use for generating auto-increment values. Permissible values are 0, 1, or 2, for traditional, consecutive, or interleaved, respectively. * * innodbAutoincLockMode corresponds to the MySQL InnoDB Startup Options and System Variables [innodbAutoincLockMode] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_autoinc_lock_mode). */ innodbAutoincLockMode: number; /** * Specifies the percentage of the most recently used pages for each buffer pool to read out and dump. * * innodbBufferPoolDumpPct corresponds to the MySQL InnoDB system variable [innodbBufferPoolDumpPct](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_buffer_pool_dump_pct). * * The range is 1 to 100. The default value is 25. * * For example, if there are 4 buffer pools with 100 pages each, and innodbBufferPoolDumpPct is set to 25, the 25 most recently used pages from each buffer pool are dumped. */ innodbBufferPoolDumpPct: number; /** * ("innodbBufferPoolInstances") */ innodbBufferPoolInstances: number; /** * The size (in bytes) of the buffer pool, that is, the memory area where InnoDB caches table and index data. * * innodbBufferPoolSize corresponds to the MySQL server system variable [innodbBufferPoolSize](https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_buffer_pool_size). * * The default and maximum values depend on the amount of RAM provisioned by the shape. See [Default User Variables](https://www.terraform.io/mysql-database/doc/configuring-db-system.html#GUID-B5504C19-F6F4-4DAB-8506-189A4E8F4A6A). */ innodbBufferPoolSize: string; /** * Whether InnoDB performs change buffering, an optimization that delays write operations to secondary indexes so that the I/O operations can be performed sequentially. Permitted values are described in the following table. Values may also be specified numerically. * * innodbChangeBuffering corresponds to the MySQL InnoDB Startup Options and System Variables [innodbChangeBuffering] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_change_buffering). */ innodbChangeBuffering: string; /** * innodbDdlBufferSize corresponds to the MySQL system variable [innodbDdlBufferSize] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_buffer_size) */ innodbDdlBufferSize: string; /** * innodbDdlThreads corresponds to the MySQL system variable [innodbDdlThreads] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_ddl_threads) */ innodbDdlThreads: number; /** * ("innodbFtEnableStopword") */ innodbFtEnableStopword: boolean; /** * ("innodbFtMaxTokenSize") */ innodbFtMaxTokenSize: number; /** * ("innodbFtMinTokenSize") */ innodbFtMinTokenSize: number; /** * ("innodbFtNumWordOptimize") */ innodbFtNumWordOptimize: number; /** * ("innodbFtResultCacheLimit") */ innodbFtResultCacheLimit: string; /** * ("innodbFtServerStopwordTable") */ innodbFtServerStopwordTable: string; /** * ("innodbLockWaitTimeout") */ innodbLockWaitTimeout: number; /** * Enables dedicated log writer threads for writing redo log records from the log buffer to the system buffers and flushing the system buffers to the redo log files. * * This is the MySQL variable "innodbLogWriterThreads". For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_log_writer_threads) */ innodbLogWriterThreads: boolean; /** * The desired maximum purge lag in terms of transactions. * * InnoDB maintains a list of transactions that have index records delete-marked by UPDATE or DELETE operations. The length of the list is the purge lag. * * If this value is exceeded, a delay is imposed on INSERT, UPDATE, and DELETE operations to allow time for purge to catch up. * * The default value is 0, which means there is no maximum purge lag and no delay. * * innodbMaxPurgeLag corresponds to the MySQL server system variable [innodbMaxPurgeLag](https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_max_purge_lag). */ innodbMaxPurgeLag: string; /** * The maximum delay in microseconds for the delay imposed when the innodbMaxPurgeLag threshold is exceeded. * * The specified innodbMaxPurgeLagDelay value is an upper limit on the delay period. * * innodbMaxPurgeLagDelay corresponds to the MySQL server system variable [innodbMaxPurgeLagDelay](https://dev.mysql.com/doc/refman/en/innodb-parameters.html#sysvar_innodb_max_purge_lag_delay). */ innodbMaxPurgeLagDelay: number; /** * Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool. When innodbNumaInterleave is enabled, the NUMA memory policy is set to MPOL_INTERLEAVE for the mysqld process. After the InnoDB buffer pool is allocated, the NUMA memory policy is set back to MPOL_DEFAULT. For the innodbNumaInterleave option to be available, MySQL must be compiled on a NUMA-enabled Linux system. * * innodbNumaInterleave corresponds to the MySQL InnoDB Startup Options and System Variables [innodbNumaInterleave] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_numa_interleave). */ innodbNumaInterleave: boolean; /** * Specifies an upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables. There is one such log file for each index being created or table being altered. This log file stores data inserted, updated, or deleted in the table during the DDL operation. * * innodbOnlineAlterLogMaxSize corresponds to the MySQL InnoDB Startup Options and System Variables [innodbOnlineAlterLogMaxSize] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_online_alter_log_max_size). */ innodbOnlineAlterLogMaxSize: string; /** * Defines the amount of disk space occupied by redo log files. innodbRedoLogCapacity supercedes the innodbLogFilesInGroup and innodbLogFileSize variables, which are both ignored if innodbRedoLogCapacity is defined. If innodbRedoLogCapacity is not defined, and if neither innodbLogFileSize or innodbLogFilesInGroup are defined, then the default innodbRedoLogCapacity value is used. * * innodbRedoLogCapacity corresponds to the InnoDB Startup Options and System Variables [innodbRedoLogCapacity](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_redo_log_capacity) */ innodbRedoLogCapacity: string; /** * InnoDB rolls back only the last statement on a transaction timeout by default. If --innodb-rollback-on-timeout is specified, a transaction timeout causes InnoDB to abort and roll back the entire transaction. * * innodbRollbackOnTimeout corresponds to the MySQL InnoDB Startup Options and System Variables [innodbRollbackOnTimeout] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_rollback_on_timeout). */ innodbRollbackOnTimeout: boolean; /** * This variable defines: * * The sort buffer size for online DDL operations that create or rebuild secondary indexes. However, as of MySQL 8.0.27, this responsibility is subsumed by the innodbDdlBufferSize variable. * * The amount by which the temporary log file is extended when recording concurrent DML during an online DDL operation, and the size of the temporary log file read buffer and write buffer. * * innodbSortBufferSize corresponds to the MySQL InnoDB Startup Options and System Variables [innodbSortBufferSize] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_sort_buffer_size). */ innodbSortBufferSize: number; /** * The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by ANALYZE TABLE. * * innodbStatsPersistentSamplePages corresponds to the MySQL InnoDB system variable [innodbStatsPersistentSamplePages](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_stats_persistent_sample_pages) * * innodbStatsPersistentSamplePages only applies when innodbStatsPersistent is enabled for a table; when innodbStatsPersistent is disabled, innodbStatsTransientSamplePages applies instead. */ innodbStatsPersistentSamplePages: string; /** * The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by [ANALYZE TABLE](https://dev.mysql.com/doc/refman/8.0/en/analyze-table.html). * * innodbStatsTransientSamplePages corresponds to the MySQL InnoDB system variable [innodbStatsTransientSamplePages](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_stats_transient_sample_pages) * * innodbStatsTransientSamplePages only applies when innodbStatsPersistent is disabled for a table; when innodbStatsPersistent is enabled, innodbStatsPersistentSamplePages applies instead. * * innodbStatsPersistent is ON by default and cannot be changed. It is possible to override it using the STATS_PERSISTENT clause of the [CREATE TABLE](https://dev.mysql.com/doc/refman/8.0/en/create-table.html) and [ALTER TABLE](https://dev.mysql.com/doc/refman/8.0/en/alter-table.html) statements. */ innodbStatsTransientSamplePages: string; /** * When you enable innodbStrictMode, the InnoDB storage engine returns errors instead of warnings for invalid or incompatible table options. * * innodbStrictMode corresponds to the MySQL InnoDB system variable [innodbStrictMode](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_strict_mode) */ innodbStrictMode: boolean; /** * When enabled, undo tablespaces that exceed the threshold value defined by innodbMaxUndoLogSize are marked for truncation. Only undo tablespaces can be truncated. Truncating undo logs that reside in the system tablespace is not supported. For truncation to occur, there must be at least two undo tablespaces. * * innodbUndoLogTruncate corresponds to the MySQL InnoDB Startup Options and System Variables [innodbUndoLogTruncate] (https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_undo_log_truncate). */ innodbUndoLogTruncate: boolean; /** * The number of seconds the server waits for activity on an interactive connection before closing it. * * interactiveTimeout corresponds to the MySQL system variable. [interactiveTimeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_interactive_timeout) */ interactiveTimeout: number; /** * The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans. In MySQL 8.0.18 and later, this variable also controls the amount of memory used for hash joins. Normally, the best way to get fast joins is to add indexes. Increase the value of joinBufferSize to get a faster full join when adding indexes is not possible. One join buffer is allocated for each full join between two tables. For a complex join between several tables for which indexes are not used, multiple join buffers might be necessary. * * joinBufferSize corresponds to the MySQL Server System variable [joinBufferSize] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_join_buffer_size). */ joinBufferSize: string; /** * This variable controls server-side LOCAL capability for LOAD DATA statements. Depending on the localInfile setting, the server refuses or permits local data loading by clients that have LOCAL enabled on the client side. * * localInfile corresponds to the MySQL Server system variable [localInfile](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_local_infile) */ localInfile: boolean; /** * If a query takes longer than this many seconds, the server increments the Slow_queries status variable. If the slow query log is enabled, the query is logged to the slow query log file. This value is measured in real time, not CPU time, so a query that is under the threshold on a lightly loaded system might be above the threshold on a heavily loaded one. * * longQueryTime corresponds to the MySQL Server System variable [longQueryTime] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_long_query_time). */ longQueryTime: number; /** * ("mandatoryRoles") */ mandatoryRoles: string; /** * The maximum size of one packet or any generated/intermediate string. * * This is the mysql variable "maxAllowedPacket". */ maxAllowedPacket: number; /** * Sets the size of the transaction cache. * * maxBinlogCacheSize corresponds to the MySQL server system variable [maxBinlogCacheSize](https://dev.mysql.com/doc/refman/8.0/en/replication-options-binary-log.html#sysvar_max_binlog_cache_size). */ maxBinlogCacheSize: string; /** * ("maxConnectErrors") */ maxConnectErrors: string; /** * ("maxConnections") */ maxConnections: number; /** * ("maxExecutionTime") */ maxExecutionTime: string; /** * This variable sets the maximum size to which user-created MEMORY tables are permitted to grow. * * maxHeapTableSize corresponds to the MySQL system variable [maxHeapTableSize](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_heap_table_size) */ maxHeapTableSize: string; /** * ("maxPreparedStmtCount") */ maxPreparedStmtCount: number; /** * Limit the assumed maximum number of seeks when looking up rows based on a key. The MySQL optimizer assumes that no more than this number of key seeks are required when searching for matching rows in a table by scanning an index, regardless of the actual cardinality of the index (see Section 15.7.7.22, “SHOW INDEX Statement”). By setting this to a low value (say, 100), you can force MySQL to prefer indexes instead of table scans. * * maxSeeksForKey corresponds to the MySQL Server System variable [maxSeeksForKey] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_seeks_for_key). */ maxSeeksForKey: string; /** * The maximum number of simultaneous connections permitted to any given MySQL user account. A value of 0 (the default) means “no limit.” This variable has a global value that can be set at server startup or runtime. It also has a read-only session value that indicates the effective simultaneous-connection limit that applies to the account associated with the current session. * * maxUserConnections corresponds to the MySQL Server System variable [maxUserConnections] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_max_user_connections). */ maxUserConnections: string; /** * ("mysqlFirewallMode") */ mysqlFirewallMode: boolean; /** * DEPRECATED -- typo of mysqlx_zstd_default_compression_level. variable will be ignored. * * @deprecated The 'mysql_zstd_default_compression_level' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlZstdDefaultCompressionLevel: number; /** * The number of seconds X Plugin waits for the first packet to be received from newly connected clients. * * mysqlxConnectTimeout corresponds to the MySQL X Plugin system variable [mysqlxConnectTimeout](https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_connect_timeout) */ mysqlxConnectTimeout: number; /** * Set the default compression level for the deflate algorithm. ("mysqlxDeflateDefaultCompressionLevel") */ mysqlxDeflateDefaultCompressionLevel: number; /** * Limit the upper bound of accepted compression levels for the deflate algorithm. ("mysqlxDeflateMaxClientCompressionLevel") */ mysqlxDeflateMaxClientCompressionLevel: number; /** * ("mysqlxDocumentIdUniquePrefix") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'mysqlx_document_id_unique_prefix' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlxDocumentIdUniquePrefix: number; /** * ("mysqlxEnableHelloNotice") DEPRECATED -- variable should not be settable and will be ignored */ mysqlxEnableHelloNotice: boolean; /** * ("mysqlxIdleWorkerThreadTimeout") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'mysqlx_idle_worker_thread_timeout' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlxIdleWorkerThreadTimeout: number; /** * The number of seconds to wait for interactive clients to timeout. * * mysqlxInteractiveTimeout corresponds to the MySQL X Plugin system variable. [mysqlxInteractiveTimeout](https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_interactive_timeout) */ mysqlxInteractiveTimeout: number; /** * Set the default compression level for the lz4 algorithm. ("mysqlxLz4DefaultCompressionLevel") */ mysqlxLz4defaultCompressionLevel: number; /** * Limit the upper bound of accepted compression levels for the lz4 algorithm. ("mysqlxLz4MaxClientCompressionLevel") */ mysqlxLz4maxClientCompressionLevel: number; /** * The maximum size of network packets that can be received by X Plugin. * * This is the mysql variable "mysqlxMaxAllowedPacket". */ mysqlxMaxAllowedPacket: number; /** * ("mysqlxMinWorkerThreads") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'mysqlx_min_worker_threads' field has been deprecated and may be removed in a future version. Do not use this field. */ mysqlxMinWorkerThreads: number; /** * The number of seconds that X Plugin waits for blocking read operations to complete. After this time, if the read operation is not successful, X Plugin closes the connection and returns a warning notice with the error code ER_IO_READ_ERROR to the client application. * * mysqlxReadTimeout corresponds to the MySQL X Plugin system variable [mysqlxReadTimeout](https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_read_timeout) */ mysqlxReadTimeout: number; /** * The number of seconds that X Plugin waits for activity on a connection. * * mysqlxWaitTimeout corresponds to the MySQL X Plugin system variable. [mysqlxWaitTimeout](https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_wait_timeout) */ mysqlxWaitTimeout: number; /** * The number of seconds that X Plugin waits for blocking write operations to complete. After this time, if the write operation is not successful, X Plugin closes the connection. * * mysqlxReadmysqlxWriteTimeoutTimeout corresponds to the MySQL X Plugin system variable [mysqlxWriteTimeout](https://dev.mysql.com/doc/refman/8.0/en/x-plugin-options-system-variables.html#sysvar_mysqlx_write_timeout) */ mysqlxWriteTimeout: number; /** * Set the default compression level for the zstd algorithm. ("mysqlxZstdDefaultCompressionLevel") */ mysqlxZstdDefaultCompressionLevel: number; /** * Limit the upper bound of accepted compression levels for the zstd algorithm. ("mysqlxZstdMaxClientCompressionLevel") */ mysqlxZstdMaxClientCompressionLevel: number; /** * The number of seconds to wait for more data from a connection before aborting the read. * * netReadTimeout corresponds to the MySQL system variable [netReadTimeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_net_read_timeout) */ netReadTimeout: number; /** * The number of seconds to wait for a block to be written to a connection before aborting the write. * * netWriteTimeout corresponds to the MySQL system variable [netWriteTimeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_net_write_timeout) */ netWriteTimeout: number; /** * The optimizerSwitch system variable enables control over optimizer behavior. The value of this variable is a set of flags, each of which has a value of on or off to indicate whether the corresponding optimizer behavior is enabled or disabled. This variable has global and session values and can be changed at runtime. The global default can be set at server startup. * * Setting hypergraph_optimizer=on for cloud builds below 9.0.0 will fail. * * optimizerSwitch corresponds to the MySQL Server System variable [optimizerSwitch] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_optimizer_switch). */ optimizerSwitch: string; /** * ("parserMaxMemSize") */ parserMaxMemSize: string; /** * ("queryAllocBlockSize") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'query_alloc_block_size' field has been deprecated and may be removed in a future version. Do not use this field. */ queryAllocBlockSize: string; /** * ("queryPreallocSize") DEPRECATED -- variable should not be settable and will be ignored * * @deprecated The 'query_prealloc_size' field has been deprecated and may be removed in a future version. Do not use this field. */ queryPreallocSize: string; /** * The limit on memory consumption for the range optimizer. A value of 0 means “no limit.” If an execution plan considered by the optimizer uses the range access method but the optimizer estimates that the amount of memory needed for this method would exceed the limit, it abandons the plan and considers other plans. * * rangeOptimizerMaxMemSize corresponds to the MySQL Server System variable [rangeOptimizerMaxMemSize] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_range_optimizer_max_mem_size). */ rangeOptimizerMaxMemSize: string; /** * regexpTimeLimit corresponds to the MySQL system variable [regexpTimeLimit] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_regexp_time_limit) */ regexpTimeLimit: number; /** * The maximum amount of space to use for all relay logs. * * relayLogSpaceLimit corresponds to the MySQL Replica Server Options variable [relayLogSpaceLimit] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_relay_log_space_limit). */ relayLogSpaceLimit: string; /** * Specifies the number of seconds to wait for more data or a heartbeat signal from the source before the replica considers the connection broken, aborts the read, and tries to reconnect. Setting this variable has no immediate effect. The state of the variable applies on all subsequent START REPLICA commands. * * replicaNetTimeout corresponds to the MySQL Replica server system variable [replicaNetTimeout](https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_replica_net_timeout) */ replicaNetTimeout: number; /** * Beginning with MySQL 8.0.26, slaveParallelWorkers is deprecated, and you should use replicaParallelWorkers instead. (Prior to MySQL 8.0.26, you must use slaveParallelWorkers to set the number of applier threads.) * * replicaParallelWorkers corresponds to the MySQL Replica Server Options variable [replicaParallelWorkers] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_replica_parallel_workers). */ replicaParallelWorkers: number; /** * From MySQL 8.0.26, use replicaTypeConversions in place of slave_type_conversions, which is deprecated from that release. In releases before MySQL 8.0.26, use slave_type_conversions. * * replicaTypeConversions controls the type conversion mode in effect on the replica when using row-based replication. Its value is a comma-delimited set of zero or more elements from the list: ALL_LOSSY, ALL_NON_LOSSY, ALL_SIGNED, ALL_UNSIGNED. Set this variable to an empty string to disallow type conversions between the source and the replica. Setting this variable takes effect for all replication channels immediately, including running channels. * * replicaTypeConversions corresponds to the MySQL Replica Server Options variable [replicaTypeConversions] (https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_replica_type_conversions). */ replicaTypeConversions: string; /** * Whether client connections to the server are required to use some form of secure transport. When this variable is enabled, the server permits only TCP/IP connections encrypted using TLS/SSL, or connections that use a socket file or shared memory. The server rejects nonsecure connection attempts, which fail with an ER_SECURE_TRANSPORT_REQUIRED error. * * requireSecureTransport corresponds to the MySQL Server Administration system variable [requireSecureTransport](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_require_secure_transport) */ requireSecureTransport: boolean; /** * Whether to resolve host names when checking client connections. If this variable is OFF, mysqld resolves host names when checking client connections. If it is ON, mysqld uses only IP numbers; in this case, all Host column values in the grant tables must be IP addresses. See Section 7.1.12.3, “DNS Lookups and the Host Cache”. * * skipNameResolve corresponds to the MySQL Server System variable [skipNameResolve] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_skip_name_resolve). */ skipNameResolve: boolean; /** * Each session that must perform a sort allocates a buffer of this size. * * sortBufferSize corresponds to the MySQL system variable [sortBufferSize](https://dev.mysql.com/doc/refman/en/server-system-variables.html#sysvar_sort_buffer_size) */ sortBufferSize: string; /** * Whether GIPK mode is in effect, in which case a MySQL replication source server adds a generated invisible primary key to any InnoDB table that is created without one. * * sqlGenerateInvisiblePrimaryKey corresponds to the MySQL system variable [sqlGenerateInvisiblePrimaryKey] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_sql_generate_invisible_primary_key). */ sqlGenerateInvisiblePrimaryKey: boolean; /** * ("sqlMode") */ sqlMode: string; /** * ("sqlRequirePrimaryKey") */ sqlRequirePrimaryKey: boolean; /** * ("sqlWarnings") */ sqlWarnings: boolean; /** * The number of table definitions that can be stored in the table definition cache. If you use a large number of tables, you can create a large table definition cache to speed up opening of tables. The table definition cache takes less space and does not use file descriptors, unlike the normal table cache. * * tableDefinitionCache corresponds to the MySQL Server Administration system variable [tableDefinitionCache](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_table_definition_cache) */ tableDefinitionCache: number; /** * The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires. * * tableOpenCache corresponds to the MySQL Server Administration system variable [tableOpenCache](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_table_open_cache) */ tableOpenCache: number; /** * Defines the maximum amount of memory that can be occupied by the TempTable storage engine before it starts storing data on disk. The default value is 1073741824 bytes (1GiB). For more information, see Section 10.4.4, “Internal Temporary Table Use in MySQL”. * * temptableMaxRam corresponds to the MySQL system variable [temptableMaxRam] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_temptable_max_ram). */ temptableMaxRam: string; /** * Controls whether the thread pool uses dedicated listener threads. If enabled, a listener thread in each thread group is dedicated to the task of listening for network events from clients, ensuring that the maximum number of query worker threads is no more than the value specified by threadPoolMaxTransactionsLimit. threadPoolDedicatedListeners corresponds to the MySQL Database Service-specific system variable thread_pool_dedicated_listeners. */ threadPoolDedicatedListeners: boolean; /** * Limits the maximum number of open transactions to the defined value. The default value is 0, which enforces no limit. threadPoolMaxTransactionsLimit corresponds to the MySQL Database Service-specific system variable thread_pool_max_transactions_limit. */ threadPoolMaxTransactionsLimit: number; /** * The maximum number of query threads permitted in a thread group. The maximum value is 4096, but if threadPoolMaxTransactionsLimit is set, threadPoolQueryThreadsPerGroup must not exceed that value. The default value of 1 means there is one active query thread in each thread group, which works well for many loads. When you are using the high concurrency thread pool algorithm (thread_pool_algorithm = 1), consider increasing the value if you experience slower response times due to long-running transactions. * * threadPoolQueryThreadsPerGroup corresponds to the MySQL Server system variable [threadPoolQueryThreadsPerGroup](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_thread_pool_query_threads_per_group) */ threadPoolQueryThreadsPerGroup: number; /** * The number of thread groups in the thread pool. This is the most important parameter controlling thread pool performance. It affects how many statements can execute simultaneously. If a value outside the range of permissible values is specified, the thread pool plugin does not load and the server writes a message to the error log. * * threadPoolSize corresponds to the MySQL Server System variable [threadPoolSize] (https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_thread_pool_size). */ threadPoolSize: number; /** * The delay period before executing a new transaction, in milliseconds. The maximum value is 300000 (5 minutes). A transaction delay can be used in cases where parallel transactions affect the performance of other operations due to resource contention. For example, if parallel transactions affect index creation or an online buffer pool resizing operation, you can configure a transaction delay to reduce resource contention while those operations are running. * * threadPoolTransactionDelay corresponds to the MySQL Server system variable [threadPoolTransactionDelay](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_thread_pool_transaction_delay) */ threadPoolTransactionDelay: number; /** * Initializes the time zone for each client that connects. * * This corresponds to the MySQL System Variable "timeZone". * * The values can be given in one of the following formats, none of which are case-sensitive: * * As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. The permitted range is '-13:59' to '+14:00', inclusive. * * As a named time zone, as defined by the "IANA Time Zone database", such as 'Europe/Helsinki', 'US/Eastern', 'MET', or 'UTC'. */ timeZone: string; /** * The maximum size of internal in-memory temporary tables. This variable does not apply to user-created MEMORY tables. * * tmpTableSize corresponds to the MySQL system variable [tmpTableSize](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_tmp_table_size) */ tmpTableSize: string; /** * ("transactionIsolation") */ transactionIsolation: string; /** * The number of seconds the server waits for activity on a noninteractive connection before closing it. * * waitTimeout corresponds to the MySQL system variable. [waitTimeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_wait_timeout) * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ waitTimeout: number; } interface MysqlDbSystemBackupPolicy { /** * (Updatable) List of policies of a DB system to schedule cross-region DB system backup copy. * * The policy includes the name of the destination region to which the DB system backup will be copied, and an optional parameter which specifies the retention period of the copied DB system backup in days. * * **Note:** Currently, only one policy can be specified in the list. */ copyPolicies: outputs.Mysql.MysqlDbSystemBackupPolicyCopyPolicy[]; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. * * Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. * * Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. * * Tags defined here will be copied verbatim as tags on the Backup resource created by this BackupPolicy. * * Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * (Updatable) Specifies if automatic backups are enabled. */ isEnabled: boolean; /** * (Updatable) The PITR policy for the DB System. */ pitrPolicy: outputs.Mysql.MysqlDbSystemBackupPolicyPitrPolicy; /** * (Updatable) Number of days to retain an automatic backup. */ retentionInDays: number; /** * (Updatable) Retains the backup to be deleted due to the retention policy in DELETE SCHEDULED state for 7 days before permanently deleting it. */ softDelete: string; /** * (Updatable) The start of a 30-minute window of time in which daily, automated backups occur. * * This should be in the format of the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. * * At some point in the window, the system may incur a brief service disruption as the backup is performed. */ windowStartTime: string; } interface MysqlDbSystemBackupPolicyCopyPolicy { /** * (Updatable) Number of days to retain the copied DB system backup. */ backupCopyRetentionInDays: number; /** * (Updatable) The destination region name to which the DB system backup will be copied. */ copyToRegion: string; } interface MysqlDbSystemBackupPolicyPitrPolicy { /** * (Updatable) Specifies if PITR is enabled or disabled. */ isEnabled: boolean; } interface MysqlDbSystemChannel { /** * The OCID of the compartment. */ compartmentId: string; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) The user-friendly name for the DB System. It does not have to be unique. */ displayName: string; /** * (Updatable) Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the DB System. */ id: string; /** * Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * Additional information about the current lifecycleState. */ lifecycleDetails: string; /** * Parameters detailing how to provision the initial data of the system. */ sources: outputs.Mysql.MysqlDbSystemChannelSource[]; /** * (Updatable) The target state for the DB System. Could be set to `ACTIVE` or `INACTIVE`. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Details about the Channel target. */ targets: outputs.Mysql.MysqlDbSystemChannelTarget[]; /** * The date and time the DB System was created. */ timeCreated: string; /** * The time the DB System was last updated. */ timeUpdated: string; } interface MysqlDbSystemChannelSource { /** * Specifies how the replication channel handles replicated transactions without an identifier, enabling replication from a source that does not use transaction-id-based replication to a replica that does. */ anonymousTransactionsHandlings: outputs.Mysql.MysqlDbSystemChannelSourceAnonymousTransactionsHandling[]; /** * The network address of the DB System. */ hostname: string; /** * Whether the connection of the channel will be requested using the IPv6 address of the dual stack DB system or not. Default: False. */ mustUseIpv6onDualStack: boolean; /** * The port for primary endpoint of the DB System to listen on. */ port: number; /** * The specific source identifier. Use `BACKUP` for creating a new database by restoring from a backup. Use `IMPORTURL` for creating a new database from a URL Object Storage PAR. */ sourceType: string; /** * The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes. */ sslCaCertificates: outputs.Mysql.MysqlDbSystemChannelSourceSslCaCertificate[]; /** * The SSL mode of the Channel. */ sslMode: string; /** * The name of the replication user on the source MySQL instance. The username has a maximum length of 96 characters. For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/change-master-to.html) */ username: string; } interface MysqlDbSystemChannelSourceAnonymousTransactionsHandling { /** * Specifies one of the coordinates (file) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogFilename: string; /** * Specifies one of the coordinates (offset) at which the replica should begin reading the source's log. As this value specifies the point where replication starts from, it is only used once, when it starts. It is never used again, unless a new UpdateChannel operation modifies it. */ lastConfiguredLogOffset: string; /** * Specifies how the replication channel handles anonymous transactions. */ policy: string; /** * The UUID that is used as a prefix when generating transaction identifiers for anonymous transactions coming from the source. You can change the UUID later. */ uuid: string; } interface MysqlDbSystemChannelSourceSslCaCertificate { /** * The type of CA certificate. */ certificateType: string; /** * The string containing the CA certificate in PEM format. */ contents: string; } interface MysqlDbSystemChannelTarget { /** * The username for the replication applier of the target MySQL DB System. */ applierUsername: string; /** * The case-insensitive name that identifies the replication channel. Channel names must follow the rules defined for [MySQL identifiers](https://dev.mysql.com/doc/refman/8.0/en/identifiers.html). The names of non-Deleted Channels must be unique for each DB System. */ channelName: string; /** * The OCID of the DB System from which a backup shall be selected to be restored when creating the new DB System. Use this together with recovery point to perform a point in time recovery operation. */ dbSystemId: string; /** * Specifies the amount of time, in seconds, that the channel waits before applying a transaction received from the source. */ delayInSeconds: number; /** * Replication filter rules to be applied at the DB System Channel target. */ filters: outputs.Mysql.MysqlDbSystemChannelTargetFilter[]; /** * Specifies how a replication channel handles the creation and alteration of tables that do not have a primary key. */ tablesWithoutPrimaryKeyHandling: string; /** * The specific target identifier. */ targetType: string; } interface MysqlDbSystemChannelTargetFilter { /** * The type of the filter rule. */ type: string; /** * Value of the destination configuration variable. */ value: string; } interface MysqlDbSystemCurrentPlacement { /** * The availability domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. * * In a failover scenario, the Read/Write endpoint is redirected to one of the other availability domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way. * * For a standalone DB System, this defines the availability domain in which the DB System is placed. */ availabilityDomain: string; /** * The fault domain on which to deploy the Read/Write endpoint. This defines the preferred primary instance. * * In a failover scenario, the Read/Write endpoint is redirected to one of the other fault domains and the MySQL instance in that domain is promoted to the primary instance. This redirection does not affect the IP address of the DB System in any way. * * For a standalone DB System, this defines the fault domain in which the DB System is placed. */ faultDomain: string; } interface MysqlDbSystemCustomerContact { /** * (Updatable) The email address used by Oracle to send notifications regarding the DB System. */ email: string; } interface MysqlDbSystemDataStorage { /** * The actual allocated storage size for the DB System. This may be higher than dataStorageSizeInGBs if an automatic storage expansion has occurred. */ allocatedStorageSizeInGbs: number; /** * (Updatable) Initial size of the data volume in GBs that will be created and attached. Keep in mind that this only specifies the size of the database data volume, the log volume for the database will be scaled appropriately with its shape. It is required if you are creating a new database. It cannot be set if you are creating a database from a backup. */ dataStorageSizeInGb: number; /** * The absolute limit the DB System's storage size may ever expand to, either manually or automatically. This limit is based based on the initial dataStorageSizeInGBs when the DB System was first created. Both dataStorageSizeInGBs and maxDataStorageSizeInGBs can not exceed this value. */ dataStorageSizeLimitInGbs: number; /** * (Updatable) Enable/disable automatic storage expansion. When set to true, the DB System will automatically add storage incrementally up to the value specified in maxStorageSizeInGBs. */ isAutoExpandStorageEnabled: boolean; /** * (Updatable) Maximum storage size this DB System can expand to. When isAutoExpandStorageEnabled is set to true, the DB System will add storage incrementally up to this value. * * DB Systems with an initial storage size of 400 GB or less can be expanded up to 32 TB. DB Systems with an initial storage size between 401-800 GB can be expanded up to 64 TB. DB Systems with an initial storage size between 801-1200 GB can be expanded up to 96 TB. DB Systems with an initial storage size of 1201 GB or more can be expanded up to 128 TB. * * It is not possible to decrease data storage size. You cannot set the maximum data storage size to less than either current DB System dataStorageSizeInGBs or allocatedStorageSizeInGBs. */ maxStorageSizeInGbs: number; } interface MysqlDbSystemDatabaseConsole { /** * (Updatable) The port on which the database console can be accessed. Supported port numbers are 443 and from 1024 to 65535. */ port: number; /** * (Updatable) Enable/disable the database console on the DB System. */ status: string; } interface MysqlDbSystemDeletionPolicy { /** * (Updatable) Specifies if any automatic backups created for a DB System should be retained or deleted when the DB System is deleted. */ automaticBackupRetention: string; /** * (Updatable) Specifies whether or not a backup is taken when the DB System is deleted. REQUIRE_FINAL_BACKUP: a backup is taken if the DB System is deleted. SKIP_FINAL_BACKUP: a backup is not taken if the DB System is deleted. */ finalBackup: string; /** * (Updatable) Specifies whether the DB System can be deleted. Set to true to prevent deletion, false (default) to allow. */ isDeleteProtected: boolean; } interface MysqlDbSystemEncryptData { /** * (Updatable) Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * (Updatable) The OCID of the key to use. */ keyId: string; } interface MysqlDbSystemEndpoint { /** * The network address of the DB System. */ hostname: string; /** * The IP address the DB System is configured to listen on. A private IP address of your choice to assign to the primary endpoint of the DB System. 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 should be a "dotted-quad" style IPv4 address. */ ipAddress: string; /** * The internet protocol (IP) version of the IP address. */ ipAddressVersion: string; /** * The access modes from the client that this endpoint supports. */ modes: string[]; /** * The port for primary endpoint of the DB System to listen on. */ port: number; /** * The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port. */ portX: number; /** * The OCID of the resource that this endpoint is attached to. */ resourceId: string; /** * The type of endpoint that clients and connectors can connect to. */ resourceType: string; /** * The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service. */ status: string; /** * Additional information about the current endpoint status. */ statusDetails: string; } interface MysqlDbSystemHeatWaveCluster { /** * The number of analytics-processing compute instances, of the specified shape, in the HeatWave cluster. */ clusterSize: number; /** * Lakehouse enabled status for the HeatWave cluster. */ isLakehouseEnabled: boolean; /** * (Updatable) The name of the shape. The shape determines the resources allocated * * CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes. To get a list of shapes, use the [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/mysql/20190415/ShapeSummary/ListShapes) operation. */ shapeName: string; /** * (Updatable) The target state for the DB System. Could be set to `ACTIVE` or `INACTIVE`. */ state: string; /** * The date and time the DB System was created. */ timeCreated: string; /** * The time the DB System was last updated. */ timeUpdated: string; } interface MysqlDbSystemIpv6addressIpv6subnetCidrPairDetails { /** * (Updatable) An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. */ ipv6address: string; /** * (Updatable) The IPv6 prefix allocated to the subnet. */ ipv6subnetCidr: string; } interface MysqlDbSystemMaintenance { /** * (Updatable) Time window during which downtime-inducing maintenance shall not be performed. Downtime-free maintenance may be performed to apply required security patches. At most one configured window is supported. */ maintenanceDisabledWindows: outputs.Mysql.MysqlDbSystemMaintenanceMaintenanceDisabledWindow[]; /** * (Updatable) The maintenance schedule type of the DB system. Defaults to REGULAR. EARLY: Maintenance schedule follows a cycle where upgrades are performed when versions become deprecated. REGULAR: Maintenance schedule follows the normal cycle where upgrades are performed when versions become unavailable. */ maintenanceScheduleType: string; /** * The version that is expected to be targeted during the next scheduled maintenance run. */ targetVersion: string; /** * The time the scheduled maintenance is expected to start, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeScheduled: string; /** * (Updatable) The preferred version to target when performing an automatic MySQL upgrade. Defaults to OLDEST. * * OLDEST: Choose the oldest available MySQL version based on the current version of the DB System. SECOND_NEWEST: Choose the MySQL version before the newest for auto-upgrade. NEWEST: Choose the latest and greatest MySQL version available for auto-upgrade. */ versionPreference: string; /** * (Updatable) The preferred version track to target when performing an automatic MySQL upgrade. Defaults to FOLLOW. LONG_TERM_SUPPORT: No MySQL database behavior changes. INNOVATION: Provides access to the latest features and all bug fixes. FOLLOW: Follows the track of the current MySQL version. */ versionTrackPreference: string; /** * (Updatable) The start of the 2 hour maintenance window. * * This string is of the format: "{day-of-week} {time-of-day}". * * "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. * * "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. * * If you set the read replica maintenance window to "" or if not specified, the read replica is set same as the DB system maintenance window. */ windowStartTime: string; } interface MysqlDbSystemMaintenanceMaintenanceDisabledWindow { /** * (Updatable) The time until when maintenance is disabled. Must be set together with timeStart and must be after timeStart. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeEnd: string; /** * (Updatable) The time from when maintenance is disabled. Must be set together with timeEnd and must be before timeEnd. as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeStart: string; } interface MysqlDbSystemPointInTimeRecoveryDetail { /** * Earliest recovery time point for the DB System, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeEarliestRecoveryPoint: string; /** * Latest recovery time point for the DB System, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeLatestRecoveryPoint: string; } interface MysqlDbSystemReadEndpoint { /** * (Updatable) A list of IP addresses of read replicas that are excluded from serving read requests. */ excludeIps: string[]; /** * (Updatable) Specifies if the DB System read endpoint is enabled or not. */ isEnabled: boolean; /** * (Updatable) The hostname for the read endpoint of the DB System. Used for DNS. * * The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, "dbsystem-1" in FQDN "dbsystem-1.subnet123.vcn1.oraclevcn.com"). * * Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123. */ readEndpointHostnameLabel: string; /** * (Updatable) The IP address the DB System read endpoint is configured to listen on. A private IP address of your choice to assign to the read endpoint of the DB System. 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 should be a "dotted-quad" style IPv4 address. */ readEndpointIpAddress: string; /** * (Updatable) Details to assign an IPv6 subnet prefix or IPv6 address to a resource. */ readEndpointIpv6addressIpv6subnetCidrPairDetails: outputs.Mysql.MysqlDbSystemReadEndpointReadEndpointIpv6addressIpv6subnetCidrPairDetails; } interface MysqlDbSystemReadEndpointReadEndpointIpv6addressIpv6subnetCidrPairDetails { /** * (Updatable) An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. */ ipv6address: string; /** * (Updatable) The IPv6 prefix allocated to the subnet. */ ipv6subnetCidr: string; } interface MysqlDbSystemRest { /** * (Updatable) Select how REST is configured across the DB System instances. */ configuration: string; /** * (Updatable) The port for REST to listen on. Supported port numbers are 443 and from 1024 to 65535. */ port: number; } interface MysqlDbSystemSecureConnections { /** * (Updatable) Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). */ certificateGenerationType: string; /** * (Updatable) The OCID of the certificate to use. */ certificateId: string; } interface MysqlDbSystemSource { /** * The OCID of the backup to be used as the source for the new DB System. */ backupId: string; /** * Properties to setup a replication channel with the source (cloned) DB system. */ channel: outputs.Mysql.MysqlDbSystemSourceChannel; /** * The OCID of the DB System from which a backup shall be selected to be restored when creating the new DB System. Use this together with recovery point to perform a point in time recovery operation. */ dbSystemId: string; /** * The date and time, as per RFC 3339, of the change up to which the new DB System shall be restored to, using a backup and logs from the original DB System. In case no point in time is specified, then this new DB System shall be restored up to the latest change recorded for the original DB System. */ recoveryPoint: string; /** * The region identifier of the source region where the DB system exists, only if it is in a different region. If the source DB system is in the same region, then no region must be specified. For more information, please see [Regions and Availability Domains](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm). */ region: string; /** * The specific source identifier. Use `BACKUP` for creating a new database by restoring from a backup. Use `IMPORTURL` for creating a new database from a URL Object Storage PAR. */ sourceType: string; /** * The Pre-Authenticated Request (PAR) of a bucket/prefix or PAR of a @.manifest.json object from the Object Storage. Check [Using Pre-Authenticated Requests](https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm) for information related to PAR creation. Please create PAR with "Permit object reads" access type and "Enable Object Listing" permission when using a bucket/prefix PAR. Please create PAR with "Permit object reads" access type when using a @.manifest.json object PAR. */ sourceUrl?: string; } interface MysqlDbSystemSourceChannel { /** * The username for the replication applier of the created MySQL DB System. */ applierUsername: string; /** * The password for the replication user. The password must be between 8 and 32 characters long, and must contain at least 1 numeric character, 1 lowercase character, 1 uppercase character, and 1 special (nonalphanumeric) character. */ sourcePassword: string; /** * The name of the replication user on the source DB system. The username has a maximum length of 96 characters. For more information, please see the [MySQL documentation](https://dev.mysql.com/doc/en/change-replication-source-to.html) */ sourceUsername: string; /** * The CA certificate of the server used for VERIFY_IDENTITY and VERIFY_CA ssl modes. */ sslCaCertificate: outputs.Mysql.MysqlDbSystemSourceChannelSslCaCertificate; /** * The SSL mode of the Channel. */ sslMode: string; } interface MysqlDbSystemSourceChannelSslCaCertificate { /** * The type of CA certificate. */ certificateType: string; /** * The string containing the CA certificate in PEM format. */ contents: string; } interface MysqlDbSystemTelemetryConfiguration { /** * (Updatable) Telemetry configuration details for logging. */ logs?: outputs.Mysql.MysqlDbSystemTelemetryConfigurationLog[]; } interface MysqlDbSystemTelemetryConfigurationLog { /** * (Updatable) Type of destination where MySQL telemetry is exposed to. Use `LOG_ANALYTICS` to send logs to OCI Log Analytics. */ destination: string; /** * (Updatable) List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.MysqlDbSystemTelemetryConfigurationLogDestinationConfiguration[]; /** * (Updatable) List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface MysqlDbSystemTelemetryConfigurationLogDestinationConfiguration { /** * (Updatable) Name of the destination configuration variable. Use `log-group-id` to specify Log Analytics Log Group OCID. Also specify `log-set` when using the Log Partitioning feature of Log Analytics. */ key: string; /** * (Updatable) Value of the destination configuration variable. */ value: string; } interface ReplicaEncryptData { /** * Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK). */ keyGenerationType: string; /** * The OCID of the key to use. */ keyId: string; } interface ReplicaReplicaOverrides { /** * (Updatable) The OCID of the Configuration to be used by the read replica. */ configurationId: string; /** * (Updatable) The MySQL version to be used by the read replica. */ mysqlVersion: string; /** * (Updatable) Network Security Group OCIDs used for the VNIC attachment. */ nsgIds: string[]; /** * (Updatable) Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}` */ securityAttributes: { [key: string]: string; }; /** * (Updatable) The shape to be used by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/mysql/20190415/ShapeSummary/ListShapes) operation. */ shapeName: string; /** * (Updatable) Telemetry configuration details of a DB System or a read replica. */ telemetryConfiguration: outputs.Mysql.ReplicaReplicaOverridesTelemetryConfiguration; } interface ReplicaReplicaOverridesTelemetryConfiguration { /** * (Updatable) Telemetry configuration details for logging. */ logs?: outputs.Mysql.ReplicaReplicaOverridesTelemetryConfigurationLog[]; } interface ReplicaReplicaOverridesTelemetryConfigurationLog { /** * Type of destination where MySQL telemetry is exposed to. */ destination: string; /** * List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.ReplicaReplicaOverridesTelemetryConfigurationLogDestinationConfiguration[]; /** * List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface ReplicaReplicaOverridesTelemetryConfigurationLogDestinationConfiguration { /** * Name of the destination configuration variable. */ key: string; /** * Value of the destination configuration variable. */ value: string; } interface ReplicaSecureConnection { /** * Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC). */ certificateGenerationType: string; /** * The OCID of the certificate to use. */ certificateId: string; } interface ReplicaTelemetryConfiguration { /** * Telemetry configuration details for logging. */ logs: outputs.Mysql.ReplicaTelemetryConfigurationLog[]; } interface ReplicaTelemetryConfigurationLog { /** * Type of destination where MySQL telemetry is exposed to. */ destination: string; /** * List of configuration variables for a given destination type. */ destinationConfigurations: outputs.Mysql.ReplicaTelemetryConfigurationLogDestinationConfiguration[]; /** * List of MySQL telemetry types that can be exposed on a telemetry destination */ logTypes: string[]; } interface ReplicaTelemetryConfigurationLogDestinationConfiguration { /** * Name of the destination configuration variable. */ key: string; /** * Value of the destination configuration variable. */ value: string; } } export declare namespace NetworkFirewall { interface GetNetworkFirewallNatConfiguration { /** * True indicates that NAT configuration is enabled. False indicates NAT configuration is disabled. */ mustEnablePrivateNat: boolean; /** * An array of Private NAT IP addresses that are associated with the Network Firewall. These IP addresses are reserved for NAT and shouldn't be used for any other purpose in the subnet. This list contains IP addresses when NAT configuration is enabled. This list is empty or null IP when NAT configuration is disabled. */ natIpAddressLists: string[]; } interface GetNetworkFirewallPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPoliciesNetworkFirewallPolicySummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPoliciesNetworkFirewallPolicySummaryCollectionItem[]; } interface GetNetworkFirewallPoliciesNetworkFirewallPolicySummaryCollectionItem { /** * Count of number of Network Firewall attached to the Policy. */ attachedNetworkFirewallCount: number; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the network firewall policy. This field can be used to add additional info. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Unique Network Firewall Policy identifier */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter to return only resources with a lifecycleState matching the given value. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time instant at which the Network Firewall Policy was created in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The time instant at which the Network Firewall Policy was updated in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetNetworkFirewallPolicyAddressListsAddressListSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyAddressListsAddressListSummaryCollectionItem[]; } interface GetNetworkFirewallPolicyAddressListsAddressListSummaryCollectionItem { /** * List of addresses. */ addresses: string[]; /** * The description of the address list. This field can be used to add additional info. */ description?: string; /** * Unique name to identify the group of addresses to be used in the policy rules. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this Address List belongs to. */ parentResourceId: string; /** * Count of total Addresses in the AddressList */ totalAddresses: number; /** * Type of address list. */ type: string; } interface GetNetworkFirewallPolicyAddressListsFilter { /** * Unique name to identify the group of addresses to be used in the policy rules. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicyApplicationGroupsApplicationGroupSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyApplicationGroupsApplicationGroupSummaryCollectionItem[]; } interface GetNetworkFirewallPolicyApplicationGroupsApplicationGroupSummaryCollectionItem { /** * List of apps in the group. */ apps: string[]; /** * The description of the application list. This field can be used to add additional info. */ description?: string; /** * Name of the application Group. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this application group belongs to. */ parentResourceId: string; /** * Count of total applications in the given application group. */ totalApps: number; } interface GetNetworkFirewallPolicyApplicationGroupsFilter { /** * Name of the application Group. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicyApplicationsApplicationSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyApplicationsApplicationSummaryCollectionItem[]; } interface GetNetworkFirewallPolicyApplicationsApplicationSummaryCollectionItem { /** * The description of the application. This field can be used to add additional info. */ description?: string; /** * The value of the ICMP/ICMP_V6 message Code (subtype) field as defined by [RFC 4443](https://www.rfc-editor.org/rfc/rfc4443.html#section-2.1). */ icmpCode: number; /** * The value of the ICMP/ICMP_V6 message Type field as defined by [RFC 4443](https://www.rfc-editor.org/rfc/rfc4443.html#section-2.1). */ icmpType: number; /** * Name of the application. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this application belongs to. */ parentResourceId: string; /** * Describes the type of Application. */ type: string; } interface GetNetworkFirewallPolicyApplicationsFilter { /** * Name of the application. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicyDecryptionProfilesDecryptionProfileSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyDecryptionProfilesDecryptionProfileSummaryCollectionItem[]; } interface GetNetworkFirewallPolicyDecryptionProfilesDecryptionProfileSummaryCollectionItem { /** * Whether to block sessions if the server's certificate uses extensions other than key usage and/or extended key usage. */ areCertificateExtensionsRestricted: boolean; /** * The description of the decryption profile. This field can be used to add additional info. */ description?: string; /** * Whether to automatically append SAN to impersonating certificate if server certificate is missing SAN. */ isAutoIncludeAltName: boolean; /** * Whether to block sessions if server's certificate is expired. */ isExpiredCertificateBlocked: boolean; /** * Whether to block sessions if the firewall is temporarily unable to decrypt their traffic. */ isOutOfCapacityBlocked: boolean; /** * Whether to block sessions if the revocation status check for server's certificate does not succeed within the maximum allowed time (defaulting to 5 seconds). */ isRevocationStatusTimeoutBlocked: boolean; /** * Whether to block sessions if the revocation status check for server's certificate results in "unknown". */ isUnknownRevocationStatusBlocked: boolean; /** * Whether to block sessions if SSL cipher suite is not supported. */ isUnsupportedCipherBlocked: boolean; /** * Whether to block sessions if SSL version is not supported. */ isUnsupportedVersionBlocked: boolean; /** * Whether to block sessions if server's certificate is issued by an untrusted certificate authority (CA). */ isUntrustedIssuerBlocked: boolean; /** * Unique Name of the decryption profile. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this decryption profile belongs to. */ parentResourceId: string; /** * Describes the type of Decryption Profile SslForwardProxy or SslInboundInspection. */ type: string; } interface GetNetworkFirewallPolicyDecryptionProfilesFilter { /** * Unique Name of the decryption profile. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicyDecryptionRuleCondition { /** * An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses: string[]; /** * An array of address list names to be evaluated against the traffic source address. */ sourceAddresses: string[]; } interface GetNetworkFirewallPolicyDecryptionRulePosition { /** * Identifier for rule after which this rule lies. */ afterRule: string; /** * Identifier for rule before which this rule lies. */ beforeRule: string; } interface GetNetworkFirewallPolicyDecryptionRulesDecryptionRuleSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyDecryptionRulesDecryptionRuleSummaryCollectionItem[]; } interface GetNetworkFirewallPolicyDecryptionRulesDecryptionRuleSummaryCollectionItem { /** * Action: * * NO_DECRYPT - Matching traffic is not decrypted. * * DECRYPT - Matching traffic is decrypted with the specified `secret` according to the specified `decryptionProfile`. */ action: string; /** * Match criteria used in Decryption Rule used on the firewall policy rules. */ condition: outputs.NetworkFirewall.GetNetworkFirewallPolicyDecryptionRulesDecryptionRuleSummaryCollectionItemCondition; /** * The name of the decryption profile to use. */ decryptionProfile?: string; /** * The description of the decryption rule. This field can be used to add additional info. */ description?: string; /** * Name for the decryption rule, must be unique within the policy. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this decryption rule belongs to. */ parentResourceId: string; /** * An object which defines the position of the rule. */ position: outputs.NetworkFirewall.GetNetworkFirewallPolicyDecryptionRulesDecryptionRuleSummaryCollectionItemPosition; priorityOrder?: string; /** * The name of a mapped secret. Its `type` must match that of the specified decryption profile. */ secret?: string; /** * An array of mapped secrets. */ secrets?: string[]; } interface GetNetworkFirewallPolicyDecryptionRulesDecryptionRuleSummaryCollectionItemCondition { /** * An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses?: string[]; /** * An array of address list names to be evaluated against the traffic source address. */ sourceAddresses?: string[]; } interface GetNetworkFirewallPolicyDecryptionRulesDecryptionRuleSummaryCollectionItemPosition { /** * Identifier for rule after which this rule lies. */ afterRule: string; /** * Identifier for rule before which this rule lies. */ beforeRule: string; } interface GetNetworkFirewallPolicyDecryptionRulesFilter { /** * Name for the decryption rule, must be unique within the policy. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicyMappedSecretsMappedSecretSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyMappedSecretsMappedSecretSummaryCollectionItem[]; } interface GetNetworkFirewallPolicyMappedSecretsMappedSecretSummaryCollectionItem { /** * The description of the mapped secret. This field can be used to add additional info. */ description?: string; /** * Name of the secret. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this Mapped Secret belongs to. */ parentResourceId: string; /** * Source of the secrets, where the secrets are stored. */ source: string; /** * Type of the secrets mapped based on the policy. * * `SSL_INBOUND_INSPECTION`: For Inbound inspection of SSL traffic. * * `SSL_FORWARD_PROXY`: For forward proxy certificates for SSL inspection. */ type: string; /** * OCID for the Vault Secret to be used. */ vaultSecretId: string; /** * Version number of the secret to be used. */ versionNumber: number; } interface GetNetworkFirewallPolicyNatRuleCondition { /** * An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses: string[]; /** * A Service name to be evaluated against the traffic protocol and protocol-specific parameters. */ service: string; /** * An array of address list names to be evaluated against the traffic source address. */ sourceAddresses: string[]; } interface GetNetworkFirewallPolicyNatRulePosition { /** * Identifier for rule after which this rule lies. */ afterRule: string; /** * Identifier for rule before which this rule lies. */ beforeRule: string; } interface GetNetworkFirewallPolicyNatRulesFilter { /** * Name for the NAT rule, must be unique within the policy. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicyNatRulesNatRuleCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyNatRulesNatRuleCollectionItem[]; } interface GetNetworkFirewallPolicyNatRulesNatRuleCollectionItem { /** * action: * * DIPP_SRC_NAT - Dynamic-ip-port source NAT. */ action: string; /** * Match criteria used in NAT rule used on the firewall policy. */ condition: outputs.NetworkFirewall.GetNetworkFirewallPolicyNatRulesNatRuleCollectionItemCondition; /** * Description of a NAT rule. This field can be used to add additional info. */ description?: string; /** * Name for the NAT rule, must be unique within the policy. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall policy this NAT rule belongs to. */ parentResourceId: string; /** * An object which defines the position of the rule. */ position: outputs.NetworkFirewall.GetNetworkFirewallPolicyNatRulesNatRuleCollectionItemPosition; /** * The priority order in which this rule should be evaluated */ priorityOrder: string; /** * NAT type: * * NATV4 - NATV4 type NAT. */ type: string; } interface GetNetworkFirewallPolicyNatRulesNatRuleCollectionItemCondition { /** * An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses?: string[]; /** * A Service name to be evaluated against the traffic protocol and protocol-specific parameters. */ service?: string; /** * An array of address list names to be evaluated against the traffic source address. */ sourceAddresses?: string[]; } interface GetNetworkFirewallPolicyNatRulesNatRuleCollectionItemPosition { /** * Identifier for rule after which this rule lies. */ afterRule: string; /** * Identifier for rule before which this rule lies. */ beforeRule: string; } interface GetNetworkFirewallPolicySecurityRuleCondition { /** * An array of application list names to be evaluated against the traffic protocol and protocol-specific parameters. */ applications: string[]; /** * An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses: string[]; /** * An array of service list names to be evaluated against the traffic protocol and protocol-specific parameters. */ services: string[]; /** * An array of address list names to be evaluated against the traffic source address. */ sourceAddresses: string[]; /** * An array of URL pattern list names to be evaluated against the HTTP(S) request target. */ urls: string[]; } interface GetNetworkFirewallPolicySecurityRulePosition { /** * Identifier for rule after which this rule lies. */ afterRule: string; /** * Identifier for rule before which this rule lies. */ beforeRule: string; } interface GetNetworkFirewallPolicySecurityRulesFilter { /** * Name for the Security rule, must be unique within the policy. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicySecurityRulesSecurityRuleSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicySecurityRulesSecurityRuleSummaryCollectionItem[]; } interface GetNetworkFirewallPolicySecurityRulesSecurityRuleSummaryCollectionItem { /** * Types of Action on the Traffic flow. * * ALLOW - Allows the traffic. * * DROP - Silently drops the traffic, e.g. without sending a TCP reset. * * REJECT - Rejects the traffic, sending a TCP reset to client and/or server as applicable. * * INSPECT - Inspects traffic for vulnerability as specified in `inspection`, which may result in rejection. */ action: string; /** * Criteria to evaluate against network traffic. A match occurs when at least one item in the array associated with each specified property corresponds with the relevant aspect of the traffic. */ condition: outputs.NetworkFirewall.GetNetworkFirewallPolicySecurityRulesSecurityRuleSummaryCollectionItemCondition; /** * The description of the security rule. This field can be used to add additional info. */ description?: string; /** * Type of inspection to affect the Traffic flow. This is only applicable if action is INSPECT. * * INTRUSION_DETECTION - Intrusion Detection. * * INTRUSION_PREVENTION - Intrusion Detection and Prevention. Traffic classified as potentially malicious will be rejected as described in `type`. */ inspection?: string; /** * Name for the Security rule, must be unique within the policy. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this security rule belongs to. */ parentResourceId: string; /** * An object which defines the position of the rule. */ positions: outputs.NetworkFirewall.GetNetworkFirewallPolicySecurityRulesSecurityRuleSummaryCollectionItemPosition[]; priorityOrder?: string; } interface GetNetworkFirewallPolicySecurityRulesSecurityRuleSummaryCollectionItemCondition { /** * An array of application list names to be evaluated against the traffic protocol and protocol-specific parameters. */ applications?: string[]; /** * An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses?: string[]; /** * An array of service list names to be evaluated against the traffic protocol and protocol-specific parameters. */ services?: string[]; /** * An array of address list names to be evaluated against the traffic source address. */ sourceAddresses?: string[]; /** * An array of URL pattern list names to be evaluated against the HTTP(S) request target. */ urls?: string[]; } interface GetNetworkFirewallPolicySecurityRulesSecurityRuleSummaryCollectionItemPosition { /** * Identifier for rule after which this rule lies. */ afterRule: string; /** * Identifier for rule before which this rule lies. */ beforeRule: string; } interface GetNetworkFirewallPolicyServiceListsFilter { /** * Name of the service Group. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicyServiceListsServiceListSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyServiceListsServiceListSummaryCollectionItem[]; } interface GetNetworkFirewallPolicyServiceListsServiceListSummaryCollectionItem { /** * The description of the service list. This field can be used to add additional info. */ description?: string; /** * Name of the service Group. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this serviceList belongs to. */ parentResourceId: string; /** * List of services in the group. */ services: string[]; /** * Count of total services in the given service List. */ totalServices: number; } interface GetNetworkFirewallPolicyServicePortRange { /** * The maximum port in the range (inclusive), which may be absent for a single-port range. */ maximumPort: number; /** * The minimum port in the range (inclusive), or the sole port of a single-port range. */ minimumPort: number; } interface GetNetworkFirewallPolicyServicesFilter { /** * Name of the service. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicyServicesServiceSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyServicesServiceSummaryCollectionItem[]; } interface GetNetworkFirewallPolicyServicesServiceSummaryCollectionItem { /** * The description of the service. This field can be used to add additional info. */ description?: string; /** * Name of the service. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this service belongs to. */ parentResourceId: string; /** * List of port-ranges used. */ portRanges: outputs.NetworkFirewall.GetNetworkFirewallPolicyServicesServiceSummaryCollectionItemPortRange[]; /** * Describes the type of Service. */ type: string; } interface GetNetworkFirewallPolicyServicesServiceSummaryCollectionItemPortRange { /** * The maximum port in the range (inclusive), which may be absent for a single-port range. */ maximumPort: number; /** * The minimum port in the range (inclusive), or the sole port of a single-port range. */ minimumPort: number; } interface GetNetworkFirewallPolicyTunnelInspectionRuleCondition { /** * An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses: string[]; /** * An array of address list names to be evaluated against the traffic source address. */ sourceAddresses: string[]; } interface GetNetworkFirewallPolicyTunnelInspectionRulePosition { /** * Identifier for rule after which this rule lies. */ afterRule: string; /** * Identifier for rule before which this rule lies. */ beforeRule: string; } interface GetNetworkFirewallPolicyTunnelInspectionRuleProfile { /** * Return scanned VXLAN tunnel traffic to source. */ mustReturnTrafficToSource: boolean; } interface GetNetworkFirewallPolicyTunnelInspectionRulesFilter { /** * Name for the Tunnel Inspection Rule, must be unique within the policy. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicyTunnelInspectionRulesTunnelInspectionRuleSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyTunnelInspectionRulesTunnelInspectionRuleSummaryCollectionItem[]; } interface GetNetworkFirewallPolicyTunnelInspectionRulesTunnelInspectionRuleSummaryCollectionItem { /** * Types of Inspect Action on the Traffic flow. * * INSPECT - Inspect the traffic. * * INSPECT_AND_CAPTURE_LOG - Inspect and capture logs for the traffic. */ action: string; /** * Criteria to evaluate against incoming network traffic. A match occurs when at least one item in the array associated with each specified property corresponds with the relevant aspect of the traffic. */ condition: outputs.NetworkFirewall.GetNetworkFirewallPolicyTunnelInspectionRulesTunnelInspectionRuleSummaryCollectionItemCondition; /** * The description of the tunnel inspect rule. This field can be used to add additional info. */ description?: string; /** * Name for the Tunnel Inspection Rule, must be unique within the policy. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this Tunnel Inspection Rule belongs to. */ parentResourceId: string; /** * An object which defines the position of the rule. */ position: outputs.NetworkFirewall.GetNetworkFirewallPolicyTunnelInspectionRulesTunnelInspectionRuleSummaryCollectionItemPosition; /** * The priority order in which this rule should be evaluated */ priorityOrder: string; /** * Vxlan Inspect profile used in Vxlan Tunnel Inspection Rules. */ profile: outputs.NetworkFirewall.GetNetworkFirewallPolicyTunnelInspectionRulesTunnelInspectionRuleSummaryCollectionItemProfile; /** * Types of Tunnel Inspection Protocol to be applied on the traffic. * * VXLAN - VXLAN Tunnel Inspection Protocol will be applied on the traffic. */ protocol: string; } interface GetNetworkFirewallPolicyTunnelInspectionRulesTunnelInspectionRuleSummaryCollectionItemCondition { /** * An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses: string[]; /** * An array of address list names to be evaluated against the traffic source address. */ sourceAddresses: string[]; } interface GetNetworkFirewallPolicyTunnelInspectionRulesTunnelInspectionRuleSummaryCollectionItemPosition { /** * Identifier for rule after which this rule lies. */ afterRule: string; /** * Identifier for rule before which this rule lies. */ beforeRule: string; } interface GetNetworkFirewallPolicyTunnelInspectionRulesTunnelInspectionRuleSummaryCollectionItemProfile { /** * Return scanned VXLAN tunnel traffic to source. */ mustReturnTrafficToSource: boolean; } interface GetNetworkFirewallPolicyUrlListUrl { /** * A string consisting of a concatenation of optional host component and optional path component. The host component may start with `*.` to match the case-insensitive domain and all its subdomains. The path component must start with a `/`, and may end with `*` to match all paths of which it is a case-sensitive prefix. A missing host component matches all request domains, and a missing path component matches all request paths. An empty value matches all requests. */ pattern: string; /** * The type of pattern. * * SIMPLE - A simple pattern with optional subdomain and/or path suffix wildcards. */ type: string; } interface GetNetworkFirewallPolicyUrlListsFilter { /** * Unique name identifier for the URL list. */ name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallPolicyUrlListsUrlListSummaryCollection { items: outputs.NetworkFirewall.GetNetworkFirewallPolicyUrlListsUrlListSummaryCollectionItem[]; } interface GetNetworkFirewallPolicyUrlListsUrlListSummaryCollectionItem { /** * The description of the Url list. This field can be used to add additional info. */ description?: string; /** * Unique name identifier for the URL list. */ name: string; /** * Unique Network Firewall Policy identifier */ networkFirewallPolicyId: string; /** * OCID of the Network Firewall Policy this URL List belongs to. */ parentResourceId: string; /** * Total count of URLs in the URL List */ totalUrls: number; /** * List of urls. */ urls: outputs.NetworkFirewall.GetNetworkFirewallPolicyUrlListsUrlListSummaryCollectionItemUrl[]; } interface GetNetworkFirewallPolicyUrlListsUrlListSummaryCollectionItemUrl { /** * A string consisting of a concatenation of optional host component and optional path component. The host component may start with `*.` to match the case-insensitive domain and all its subdomains. The path component must start with a `/`, and may end with `*` to match all paths of which it is a case-sensitive prefix. A missing host component matches all request domains, and a missing path component matches all request paths. An empty value matches all requests. */ pattern: string; /** * The type of pattern. * * SIMPLE - A simple pattern with optional subdomain and/or path suffix wildcards. */ type: string; } interface GetNetworkFirewallsFilter { name: string; regex?: boolean; values: string[]; } interface GetNetworkFirewallsNetworkFirewallCollection { items: outputs.NetworkFirewall.GetNetworkFirewallsNetworkFirewallCollectionItem[]; } interface GetNetworkFirewallsNetworkFirewallCollectionItem { /** * A filter to return only resources that are present within the specified availability domain. To get a list of availability domains for a tenancy, use [ListAvailabilityDomains](https://docs.cloud.oracle.com/iaas/api/#/en/identity/20160918/AvailabilityDomain/ListAvailabilityDomains) operation. Example: `kIdk:PHX-AD-1` */ availabilityDomain: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Network Firewall resource. */ id: string; /** * IPv4 address for the Network Firewall. */ ipv4address: string; /** * IPv6 address for the Network Firewall. */ ipv6address: string; /** * 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. */ lifecycleDetails: string; /** * Response to a request to configure Network Address Translation (NAT) on a firewall. To perform NAT on traffic passing the private NAT IPs to the firewall, the attached network firewall policy must also have NAT rules and NAT configuration must be enabled. If NAT configuration is enabled and the attached firewall policy does not contain NAT rule then NAT IPs will get allocated but NAT will not be performed on any traffic. */ natConfigurations: outputs.NetworkFirewall.GetNetworkFirewallsNetworkFirewallCollectionItemNatConfiguration[]; /** * A filter to return only resources that match the entire networkFirewallPolicyId given. */ networkFirewallPolicyId: string; /** * An array of network security groups [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the Network Firewall. */ networkSecurityGroupIds: string[]; /** * 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"}}} */ securityAttributes: { [key: string]: string; }; /** * The shape of a firewall to determine the bandwidth that the firewall allows. */ shape: string; /** * A filter to return only resources with a lifecycleState matching the given value. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Network Firewall. */ subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time at which the Network Firewall was created in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The time at which the Network Firewall was updated in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetNetworkFirewallsNetworkFirewallCollectionItemNatConfiguration { /** * True indicates that NAT configuration is enabled. False indicates NAT configuration is disabled. */ mustEnablePrivateNat: boolean; /** * An array of Private NAT IP addresses that are associated with the Network Firewall. These IP addresses are reserved for NAT and shouldn't be used for any other purpose in the subnet. This list contains IP addresses when NAT configuration is enabled. This list is empty or null IP when NAT configuration is disabled. */ natIpAddressLists: string[]; } interface NetworkFirewallNatConfiguration { /** * (Updatable) The value of this field must be set to true if the network firewall policy being applied contains NAT rules. The value of this field can be set to false if the network firewall policy being applied or the currently attached firewall policy doesn't contain NAT rules. */ mustEnablePrivateNat: boolean; /** * An array of Private NAT IP addresses that are associated with the Network Firewall. These IP addresses are reserved for NAT and shouldn't be used for any other purpose in the subnet. This list contains IP addresses when NAT configuration is enabled. This list is empty or null IP when NAT configuration is disabled. */ natIpAddressLists: string[]; } interface NetworkFirewallPolicyDecryptionRuleCondition { /** * (Updatable) An array of IP address list names to be evaluated against the traffic destination address. */ destinationAddresses?: string[]; /** * (Updatable) An array of IP address list names to be evaluated against the traffic source address. */ sourceAddresses?: string[]; } interface NetworkFirewallPolicyDecryptionRulePosition { /** * (Updatable) Identifier for rule after which this rule lies. */ afterRule: string; /** * (Updatable) Identifier for rule before which this rule lies. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ beforeRule: string; } interface NetworkFirewallPolicyNatRuleCondition { /** * (Updatable) An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses?: string[]; /** * (Updatable) A Service name to be evaluated against the traffic protocol and protocol-specific parameters. */ service?: string; /** * (Updatable) An array of address list names to be evaluated against the traffic source address. */ sourceAddresses?: string[]; } interface NetworkFirewallPolicyNatRulePosition { /** * (Updatable) Identifier for rule after which this rule lies. */ afterRule: string; /** * (Updatable) Identifier for rule before which this rule lies. */ beforeRule: string; } interface NetworkFirewallPolicySecurityRuleCondition { /** * (Updatable) An array of application group names to be evaluated against the traffic protocol and protocol-specific parameters. */ applications?: string[]; /** * (Updatable) An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses?: string[]; /** * (Updatable) An array of service list names to be evaluated against the traffic protocol and protocol-specific parameters. */ services?: string[]; /** * (Updatable) An array of address list names to be evaluated against the traffic source address. */ sourceAddresses?: string[]; /** * (Updatable) An array of URL list names to be evaluated against the HTTP(S) request target. */ urls?: string[]; } interface NetworkFirewallPolicySecurityRulePosition { /** * (Updatable) Identifier for rule after which this rule lies. */ afterRule: string; /** * (Updatable) Identifier for rule before which this rule lies. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ beforeRule: string; } interface NetworkFirewallPolicyServicePortRange { /** * (Updatable) The maximum port in the range (inclusive), which may be absent for a single-port range. */ maximumPort: number; /** * (Updatable) The minimum port in the range (inclusive), or the sole port of a single-port range. */ minimumPort: number; } interface NetworkFirewallPolicyTunnelInspectionRuleCondition { /** * (Updatable) An array of address list names to be evaluated against the traffic destination address. */ destinationAddresses: string[]; /** * (Updatable) An array of address list names to be evaluated against the traffic source address. */ sourceAddresses: string[]; } interface NetworkFirewallPolicyTunnelInspectionRulePosition { /** * (Updatable) Identifier for rule after which this rule lies. */ afterRule: string; /** * (Updatable) Identifier for rule before which this rule lies. */ beforeRule: string; } interface NetworkFirewallPolicyTunnelInspectionRuleProfile { /** * (Updatable) Return scanned VXLAN tunnel traffic to source. */ mustReturnTrafficToSource: boolean; } interface NetworkFirewallPolicyUrlListUrl { /** * (Updatable) A string consisting of a concatenation of optional host component and optional path component. The host component may start with `*.` to match the case-insensitive domain and all its subdomains. The path component must start with a `/`, and may end with `*` to match all paths of which it is a case-sensitive prefix. A missing host component matches all request domains, and a missing path component matches all request paths. An empty value matches all requests. */ pattern: string; /** * (Updatable) The type of pattern. * * SIMPLE - The only accepted value is `SIMPLE`. A simple pattern with optional subdomain and/or path suffix wildcards. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } } export declare namespace NetworkLoadBalancer { interface BackendSetBackend { /** * (Updatable) The IP address of the backend server. Example: `10.0.0.3` */ ipAddress: string; /** * (Updatable) Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: `false` */ isBackup: boolean; /** * (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out. Example: `false` */ isDrain: boolean; /** * (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ isOffline: boolean; /** * (Updatable) A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<unique_ID>:443` or `10.0.0.3:0` */ name: string; /** * (Updatable) The communication port for the backend server. Example: `8080` */ port: number; /** * (Updatable) The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<unique_ID>` */ targetId: string; /** * (Updatable) The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see [Network Load Balancer Policies](https://docs.cloud.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: `3` */ weight: number; } interface BackendSetHealthChecker { /** * (Updatable) DNS healthcheck configurations. */ dns: outputs.NetworkLoadBalancer.BackendSetHealthCheckerDns; /** * (Updatable) The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: `10000` */ intervalInMillis: number; /** * (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the `Backend` object. The port must be specified if the backend port is 0. Example: `8080` */ port: number; /** * (Updatable) The protocol the health check must use; either HTTP, HTTPS, UDP, TCP or DNS. Example: `HTTP` */ protocol: string; /** * (Updatable) Base64 encoded pattern to be sent as UDP or TCP health check probe. */ requestData: string; /** * (Updatable) A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` */ responseBodyRegex: string; /** * (Updatable) Base64 encoded pattern to be validated as UDP or TCP health check probe response. */ responseData: string; /** * (Updatable) The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: `3` */ retries: number; /** * (Updatable) The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: `200` */ returnCode: number; /** * (Updatable) The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: `3000` */ timeoutInMillis: number; /** * (Updatable) The path against which to run the health check. Example: `/healthcheck` */ urlPath: string; } interface BackendSetHealthCheckerDns { /** * (Updatable) The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query. */ domainName: string; /** * (Updatable) The class the dns health check query to use; either IN or CH. Example: `IN` */ queryClass: string; /** * (Updatable) The type the dns health check query to use; A, AAAA, TXT. Example: `A` */ queryType: string; /** * (Updatable) An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"] */ rcodes: string[]; /** * (Updatable) DNS transport protocol; either UDP or TCP. Example: `UDP` */ transportProtocol: string; } interface GetBackendHealthHealthCheckResult { /** * The result of the most recent health check. */ healthCheckStatus: string; /** * The date and time the data was retrieved, in the format defined by RFC3339. Example: `2020-05-01T18:28:11+00:00` */ timestamp: string; } interface GetBackendSetBackend { /** * The IP address of the backend server. Example: `10.0.0.3` */ ipAddress: string; /** * Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: `false` */ isBackup: boolean; /** * Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out. Example: `false` */ isDrain: boolean; /** * Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ isOffline: boolean; /** * A user-friendly name for the backend set that must be unique and cannot be changed. */ name: string; /** * The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the `Backend` object. The port must be specified if the backend port is 0. Example: `8080` */ port: number; /** * The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<unique_ID>` */ targetId: string; /** * The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about network load balancing policies, see [Network Load Balancer Policies](https://docs.cloud.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: `3` */ weight: number; } interface GetBackendSetHealthChecker { /** * DNS healthcheck configurations. */ dns: outputs.NetworkLoadBalancer.GetBackendSetHealthCheckerDn[]; /** * The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: `10000` */ intervalInMillis: number; /** * The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the `Backend` object. The port must be specified if the backend port is 0. Example: `8080` */ port: number; /** * The protocol the health check must use; either HTTP, HTTPS, UDP, TCP or DNS. Example: `HTTP` */ protocol: string; /** * Base64 encoded pattern to be sent as UDP or TCP health check probe. */ requestData: string; /** * A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` */ responseBodyRegex: string; /** * Base64 encoded pattern to be validated as UDP or TCP health check probe response. */ responseData: string; /** * The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: `3` */ retries: number; /** * The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: `200` */ returnCode: number; /** * The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: `3000` */ timeoutInMillis: number; /** * The path against which to run the health check. Example: `/healthcheck` */ urlPath: string; } interface GetBackendSetHealthCheckerDn { /** * The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query. */ domainName: string; /** * The class the dns health check query to use; either IN or CH. Example: `IN` */ queryClass: string; /** * The type the dns health check query to use; A, AAAA, TXT. Example: `A` */ queryType: string; /** * An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"] */ rcodes: string[]; /** * DNS transport protocol; either UDP or TCP. Example: `UDP` */ transportProtocol: string; } interface GetBackendSetsBackendSetCollection { items: outputs.NetworkLoadBalancer.GetBackendSetsBackendSetCollectionItem[]; } interface GetBackendSetsBackendSetCollectionItem { /** * If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. The new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy. */ areOperationallyActiveBackendsPreferred: boolean; /** * An array of backends. */ backends: outputs.NetworkLoadBalancer.GetBackendSetsBackendSetCollectionItemBackend[]; /** * The health check policy configuration. For more information, see [Editing Network Load Balancer Health Check Policies](https://docs.cloud.oracle.com/iaas/Content/NetworkLoadBalancer/HealthCheckPolicies/update-health-check-policy.htm). */ healthCheckers: outputs.NetworkLoadBalancer.GetBackendSetsBackendSetCollectionItemHealthChecker[]; id: string; /** * IP version associated with the backend set. */ ipVersion: string; /** * If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default. */ isFailOpen: boolean; /** * If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy. */ isInstantFailoverEnabled: boolean; /** * This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. If disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled. */ isInstantFailoverTcpResetEnabled: boolean; /** * If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default. */ isPreserveSource: boolean; /** * A user-friendly name for the backend set that must be unique and cannot be changed. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer to update. */ networkLoadBalancerId: string; /** * The network load balancer policy for the backend set. Example: `FIVE_TUPLE` */ policy: string; } interface GetBackendSetsBackendSetCollectionItemBackend { /** * The IP address of the backend server. Example: `10.0.0.3` */ ipAddress: string; /** * Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: `false` */ isBackup: boolean; /** * Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out. Example: `false` */ isDrain: boolean; /** * Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ isOffline: boolean; /** * A user-friendly name for the backend set that must be unique and cannot be changed. */ name: string; /** * The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the `Backend` object. The port must be specified if the backend port is 0. Example: `8080` */ port: number; /** * The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<unique_ID>` */ targetId: string; /** * The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about network load balancing policies, see [Network Load Balancer Policies](https://docs.cloud.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: `3` */ weight: number; } interface GetBackendSetsBackendSetCollectionItemHealthChecker { /** * DNS healthcheck configurations. */ dns: outputs.NetworkLoadBalancer.GetBackendSetsBackendSetCollectionItemHealthCheckerDn[]; /** * The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: `10000` */ intervalInMillis: number; /** * The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the `Backend` object. The port must be specified if the backend port is 0. Example: `8080` */ port: number; /** * The protocol the health check must use; either HTTP, HTTPS, UDP, TCP or DNS. Example: `HTTP` */ protocol: string; /** * Base64 encoded pattern to be sent as UDP or TCP health check probe. */ requestData: string; /** * A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` */ responseBodyRegex: string; /** * Base64 encoded pattern to be validated as UDP or TCP health check probe response. */ responseData: string; /** * The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: `3` */ retries: number; /** * The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: `200` */ returnCode: number; /** * The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: `3000` */ timeoutInMillis: number; /** * The path against which to run the health check. Example: `/healthcheck` */ urlPath: string; } interface GetBackendSetsBackendSetCollectionItemHealthCheckerDn { /** * The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query. */ domainName: string; /** * The class the dns health check query to use; either IN or CH. Example: `IN` */ queryClass: string; /** * The type the dns health check query to use; A, AAAA, TXT. Example: `A` */ queryType: string; /** * An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"] */ rcodes: string[]; /** * DNS transport protocol; either UDP or TCP. Example: `UDP` */ transportProtocol: string; } interface GetBackendSetsFilter { /** * A user-friendly name for the backend set that must be unique and cannot be changed. */ name: string; regex?: boolean; values: string[]; } interface GetBackendsBackendCollection { items: outputs.NetworkLoadBalancer.GetBackendsBackendCollectionItem[]; } interface GetBackendsBackendCollectionItem { /** * The name of the backend set associated with the backend servers. Example: `exampleBackendSet` */ backendSetName: string; id: string; /** * The IP address of the backend server. Example: `10.0.0.3` */ ipAddress: string; /** * Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: `false` */ isBackup: boolean; /** * Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out. Example: `false` */ isDrain: boolean; /** * Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ isOffline: boolean; /** * A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<unique_ID>:443` or `10.0.0.3:0` */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer to update. */ networkLoadBalancerId: string; /** * The communication port for the backend server. Example: `8080` */ port: number; /** * The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<unique_ID>` */ targetId: string; /** * The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about network load balancing policies, see [Network Load Balancer Policies](https://docs.cloud.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: `3` */ weight: number; } interface GetBackendsFilter { /** * A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<unique_ID>:443` or `10.0.0.3:0` */ name: string; regex?: boolean; values: string[]; } interface GetListenersFilter { /** * A friendly name for the listener. It must be unique and it cannot be changed. Example: `exampleListener` */ name: string; regex?: boolean; values: string[]; } interface GetListenersListenerCollection { items: outputs.NetworkLoadBalancer.GetListenersListenerCollectionItem[]; } interface GetListenersListenerCollectionItem { /** * The name of the associated backend set. Example: `exampleBackendSet` */ defaultBackendSetName: string; id: string; /** * IP version associated with the listener. */ ipVersion: string; /** * Property to enable/disable PPv2 feature for this listener. */ isPpv2enabled: boolean; /** * The duration for L3IP idle timeout in seconds. Example: `200` */ l3ipIdleTimeout: number; /** * A friendly name for the listener. It must be unique and it cannot be changed. Example: `exampleListener` */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer to update. */ networkLoadBalancerId: string; /** * The communication port for the listener. Example: `80` */ port: number; /** * The protocol on which the listener accepts connection requests. For public network load balancers, ANY protocol refers to TCP/UDP with the wildcard port. For private network load balancers, ANY protocol refers to TCP/UDP/ICMP (note that ICMP requires isPreserveSourceDestination to be set to true). "ListNetworkLoadBalancersProtocols" API is deprecated and it will not return the updated values. Use the allowed values for the protocol instead. Example: `TCP` */ protocol: string; /** * The duration for TCP idle timeout in seconds. Example: `300` */ tcpIdleTimeout: number; /** * The duration for UDP idle timeout in seconds. Example: `120` */ udpIdleTimeout: number; } interface GetNetworkLoadBalancerIpAddress { /** * An IP address. Example: `192.168.0.3` */ ipAddress: string; /** * IP version associated with the listener. */ ipVersion: string; /** * Whether the IP address is public or private. */ isPublic: boolean; /** * An object representing a reserved IP address to be attached or that is already attached to a network load balancer. */ reservedIps: outputs.NetworkLoadBalancer.GetNetworkLoadBalancerIpAddressReservedIp[]; } interface GetNetworkLoadBalancerIpAddressReservedIp { /** * Ocid of the Reserved IP (Public IP, Private IP or IPv6) created with VCN. */ id: string; } interface GetNetworkLoadBalancerReservedIp { /** * Ocid of the Reserved IP (Public IP, Private IP or IPv6) created with VCN. */ id: string; } interface GetNetworkLoadBalancersFilter { /** * A friendly name for the listener. It must be unique and it cannot be changed. Example: `exampleListener` */ name: string; regex?: boolean; values: string[]; } interface GetNetworkLoadBalancersNetworkLoadBalancerCollection { items: outputs.NetworkLoadBalancer.GetNetworkLoadBalancersNetworkLoadBalancerCollectionItem[]; } interface GetNetworkLoadBalancersNetworkLoadBalancerCollectionItem { assignedIpv6: string; assignedPrivateIpv4: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the network load balancers to list. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Ocid of the Reserved IP (Public IP, Private IP or IPv6) created with VCN. */ id: string; /** * An array of IP addresses. */ ipAddresses: outputs.NetworkLoadBalancer.GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddress[]; /** * When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP. */ isPreserveSourceDestination: boolean; /** * Whether the network load balancer has a virtual cloud network-local (private) IP address. */ isPrivate: boolean; isSymmetricHashEnabled: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * An array of network security groups [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the network load balancer. */ networkSecurityGroupIds: string[]; /** * IP version associated with the NLB. */ nlbIpVersion: string; reservedIps: outputs.NetworkLoadBalancer.GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemReservedIp[]; /** * ZPR 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: `{ "oracle-zpr": { "td": { "value": "42", "mode": "audit" } } }` */ securityAttributes: { [key: string]: string; }; /** * A filter to return only resources that match the given lifecycle state. */ state: string; /** * The subnet in which the network load balancer is spawned [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)." */ subnetId: string; subnetIpv6cidr: string; /** * Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` */ systemTags: { [key: string]: string; }; /** * The date and time the network load balancer was created, in the format defined by RFC3339. Example: `2020-05-01T21:10:29.600Z` */ timeCreated: string; /** * The time the network load balancer was updated. An RFC3339 formatted date-time string. Example: `2020-05-01T22:10:29.600Z` */ timeUpdated: string; } interface GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddress { /** * An IP address. Example: `192.168.0.3` */ ipAddress: string; /** * IP version associated with the listener. */ ipVersion: string; /** * Whether the IP address is public or private. * If "true", then the IP address is public and accessible from the internet. */ isPublic: boolean; /** * An object representing a reserved IP address to be attached or that is already attached to a network load balancer. */ reservedIps: outputs.NetworkLoadBalancer.GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddressReservedIp[]; } interface GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemIpAddressReservedIp { /** * Ocid of the Reserved IP (Public IP, Private IP or IPv6) created with VCN. */ id: string; } interface GetNetworkLoadBalancersNetworkLoadBalancerCollectionItemReservedIp { /** * Ocid of the Reserved IP (Public IP, Private IP or IPv6) created with VCN. */ id: string; } interface GetNetworkLoadBalancersPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetNetworkLoadBalancersPoliciesNetworkLoadBalancersPolicyCollection { /** * Array of NetworkLoadBalancersPolicySummary objects. */ items: string[]; } interface GetNetworkLoadBalancersProtocolsFilter { name: string; regex?: boolean; values: string[]; } interface GetNetworkLoadBalancersProtocolsNetworkLoadBalancersProtocolCollection { /** * Array of NetworkLoadBalancersProtocolSummary objects. */ items: string[]; } interface NetworkLoadBalancerIpAddress { /** * An IP address. Example: `192.168.0.3` */ ipAddress: string; /** * IP version associated with the listener. */ ipVersion: string; /** * Whether the IP address is public or private. */ isPublic: boolean; /** * An object representing a reserved IP address to be attached or that is already attached to a network load balancer. */ reservedIps: outputs.NetworkLoadBalancer.NetworkLoadBalancerIpAddressReservedIp[]; } interface NetworkLoadBalancerIpAddressReservedIp { /** * Ocid of the Reserved IP (Public IP, Private IP or IPv6) created with VCN. */ id: string; } interface NetworkLoadBalancerReservedIp { /** * Ocid of the Reserved IP (Public IP, Private IP or IPv6) created with VCN. * * Reserved IPs are IPs which are already registered using VCN API. * * For public Network load balancers, customer can create a reserved Public IP and/or reserved private IP and/or reserved IPv6 and pass the OCID's in the reservedIps array field to attach the IP addresses to the network load balancer during create For private Network load balancers, customer can create a reserved Private IP and/or reserved IPv6 and pass the OCID's in the reservedIps array field to attach the IP addresses to the network load balancer during create * * Reserved IPs will not be deleted when the Network Load balancer is deleted. They will be detached from the Network Load balancer. * * Public IP Example: "ocid1.publicip.oc1.phx.unique_ID" Private IP Example: "ocid1.privateip.oc1.phx.unique_ID" IPV6 example: "ocid1.ipv6.oc1.phx.unique_ID" */ id: string; } interface NetworkLoadBalancersBackendSetsUnifiedBackend { /** * (Updatable) The IP address of the backend server. Example: `10.0.0.3` */ ipAddress: string; /** * (Updatable) Whether the network load balancer should treat this server as a backup unit. If `true`, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy. Example: `false` */ isBackup: boolean; /** * (Updatable) Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out. Example: `false` */ isDrain: boolean; /** * (Updatable) Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: `false` */ isOffline: boolean; /** * (Updatable) A read-only field showing the IP address/OCID and port that uniquely identify this backend server in the backend set. Example: `10.0.0.3:8080`, or `ocid1.privateip..oc1.<unique_ID>:443` or `10.0.0.3:0` */ name: string; /** * (Updatable) The communication port for the backend server. Example: `8080` */ port: number; /** * (Updatable) The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<unique_ID>` */ targetId: string; /** * (Updatable) The network load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see [Network Load Balancer Policies](https://docs.cloud.oracle.com/iaas/Content/NetworkLoadBalancer/introduction.htm#Policies). Example: `3` */ weight: number; } interface NetworkLoadBalancersBackendSetsUnifiedHealthChecker { /** * (Updatable) DNS healthcheck configurations. */ dns: outputs.NetworkLoadBalancer.NetworkLoadBalancersBackendSetsUnifiedHealthCheckerDns; /** * (Updatable) The interval between health checks, in milliseconds. The default value is 10000 (10 seconds). Example: `10000` */ intervalInMillis: number; /** * (Updatable) The backend server port against which to run the health check. If the port is not specified, then the network load balancer uses the port information from the `Backend` object. The port must be specified if the backend port is 0. Example: `8080` */ port: number; /** * (Updatable) The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP. Example: `HTTP` */ protocol: string; /** * (Updatable) Base64 encoded pattern to be sent as UDP or TCP health check probe. */ requestData: string; /** * (Updatable) A regular expression for parsing the response body from the backend server. Example: `^((?!false).|\s)*$` */ responseBodyRegex: string; /** * (Updatable) Base64 encoded pattern to be validated as UDP or TCP health check probe response. */ responseData: string; /** * (Updatable) The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. The default value is 3. Example: `3` */ retries: number; /** * (Updatable) The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as "200". Example: `200` */ returnCode: number; /** * (Updatable) The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default value is 3000 (3 seconds). Example: `3000` */ timeoutInMillis: number; /** * (Updatable) The path against which to run the health check. Example: `/healthcheck` */ urlPath: string; } interface NetworkLoadBalancersBackendSetsUnifiedHealthCheckerDns { /** * (Updatable) The absolute fully-qualified domain name to perform periodic DNS queries. If not provided, an extra dot will be added at the end of a domain name during the query. */ domainName: string; /** * (Updatable) The class the dns health check query to use; either IN or CH. Example: `IN` */ queryClass: string; /** * (Updatable) The type the dns health check query to use; A, AAAA, TXT. Example: `A` */ queryType: string; /** * (Updatable) An array that represents accepetable RCODE values for DNS query response. Example: ["NOERROR", "NXDOMAIN"] */ rcodes: string[]; /** * (Updatable) DNS transport protocol; either UDP or TCP. Example: `UDP` */ transportProtocol: string; } } export declare namespace Nosql { interface ConfigurationKmsKey { /** * (Updatable) The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string. */ id?: string; /** * (Updatable) The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state. */ kmsKeyState: string; /** * (Updatable) The OCID of the vault containing the encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the kmsVaultId will be a null string. */ kmsVaultId: string; /** * (Updatable) The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted. */ timeCreated: string; /** * (Updatable) The timestamp of the last update to the encryption key status. RFC3339 formatted. * * ** IMPORTANT ** * The configuration cannot be deleted. */ timeUpdated: string; } interface GetConfigurationKmsKey { /** * The OCID of the KMS encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the id will be a null string. */ id: string; /** * The current state of the encryption key assigned to this Hosted Environment. Oracle-managed keys will always report an ACTIVE state. */ kmsKeyState: string; /** * The OCID of the vault containing the encryption key assigned to this Hosted Environment. If the Hosted Environment is using an Oracle-managed Key (i.e., not a CMEK), then the kmsVaultId will be a null string. */ kmsVaultId: string; /** * The timestamp when encryption key was first enabled for this Hosted Environment. RFC3339 formatted. */ timeCreated: string; /** * The timestamp of the last update to the encryption key status. RFC3339 formatted. */ timeUpdated: string; } interface GetIndexKey { /** * The name of a column to be included as an index key. */ columnName: string; /** * If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath. */ jsonFieldType: string; /** * If the specified column is of type JSON, jsonPath contains a dotted path indicating the field within the JSON object that will be the index key. */ jsonPath: string; } interface GetIndexesFilter { /** * A shell-globbing-style (*?[]) filter for names. */ name: string; regex?: boolean; values: string[]; } interface GetIndexesIndexCollection { /** * The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name. */ compartmentId: string; id: string; isIfNotExists: boolean; /** * A set of keys for a secondary index. */ keys: outputs.Nosql.GetIndexesIndexCollectionKey[]; /** * A message describing the current state in more detail. */ lifecycleDetails: string; /** * A shell-globbing-style (*?[]) filter for names. */ name: string; /** * Filter list by the lifecycle state of the item. */ state: string; /** * the OCID of the table to which this index belongs. */ tableId: string; /** * The name of the table to which this index belongs. */ tableName: string; /** * A table name within the compartment, or a table OCID. */ tableNameOrId: string; } interface GetIndexesIndexCollectionKey { /** * The name of a column to be included as an index key. */ columnName: string; /** * If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath. */ jsonFieldType: string; /** * If the specified column is of type JSON, jsonPath contains a dotted path indicating the field within the JSON object that will be the index key. */ jsonPath: string; } interface GetTableReplica { /** * The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero. */ capacityMode: string; /** * A message describing the current state in more detail. */ lifecycleDetails: string; /** * Maximum sustained write throughput limit for the table. */ maxWriteUnits: number; /** * A customer-facing region identifier */ region: string; /** * The state of a table. */ state: string; /** * The OCID of the replica table */ tableId: string; } interface GetTableSchema { /** * The columns of a table. */ columns: outputs.Nosql.GetTableSchemaColumn[]; /** * The identity properties of a table, if any. */ identities: outputs.Nosql.GetTableSchemaIdentity[]; /** * A list of column names that make up a key. */ primaryKeys: string[]; /** * A list of column names that make up a key. */ shardKeys: string[]; /** * The default Time-to-Live for the table, in days. */ ttl: number; } interface GetTableSchemaColumn { /** * The column default value. */ defaultValue: string; /** * True if the STRING column was declared AS UUID. */ isAsUuid: boolean; /** * True if the STRING AS UUID column is also GENERATED BY DEFAULT. */ isGenerated: boolean; /** * The column nullable flag. */ isNullable: boolean; /** * The column name. */ name: string; /** * The column type. */ type: string; } interface GetTableSchemaIdentity { /** * The name of the identity column. */ columnName: string; /** * True if the identity value is GENERATED ALWAYS. */ isAlways: boolean; /** * True if the identity value is GENERATED BY DEFAULT ON NULL. */ isNull: boolean; } interface GetTableTableLimit { /** * The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero. */ capacityMode: string; /** * Maximum sustained read throughput limit for the table. */ maxReadUnits: number; /** * Maximum size of storage used by the table. */ maxStorageInGbs: number; /** * Maximum sustained write throughput limit for the table. */ maxWriteUnits: number; } interface GetTablesFilter { /** * A shell-globbing-style (*?[]) filter for names. */ name: string; regex?: boolean; values: string[]; } interface GetTablesTableCollection { /** * The ID of a table's compartment. */ compartmentId: string; ddlStatement: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable. */ id: string; /** * True if this table can be reclaimed after an idle period. */ isAutoReclaimable: boolean; /** * True if this table is currently a member of a replication set. */ isMultiRegion: boolean; /** * A message describing the current state in more detail. */ lifecycleDetails: string; localReplicaInitializationInPercent: number; /** * A shell-globbing-style (*?[]) filter for names. */ name: string; replicas: outputs.Nosql.GetTablesTableCollectionReplica[]; /** * The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication. */ schemaState: string; schemas: outputs.Nosql.GetTablesTableCollectionSchema[]; /** * Filter list by the lifecycle state of the item. */ state: string; /** * Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is `"orcl-cloud"`; and the only key in that namespace is `"free-tier-retained"`. Example: `{"orcl-cloud"": {"free-tier-retained": "true"}}` */ systemTags: { [key: string]: string; }; /** * Throughput and storage limits configuration of a table. */ tableLimits: outputs.Nosql.GetTablesTableCollectionTableLimit[]; /** * The time the the table was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string. */ timeOfExpiration: string; /** * The time the the table's metadata was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetTablesTableCollectionReplica { /** * The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero. */ capacityMode: string; /** * A message describing the current state in more detail. */ lifecycleDetails: string; /** * Maximum sustained write throughput limit for the table. */ maxWriteUnits: number; region: string; /** * Filter list by the lifecycle state of the item. */ state: string; tableId: string; } interface GetTablesTableCollectionSchema { columns: outputs.Nosql.GetTablesTableCollectionSchemaColumn[]; identities: outputs.Nosql.GetTablesTableCollectionSchemaIdentity[]; primaryKeys: string[]; shardKeys: string[]; ttl: number; } interface GetTablesTableCollectionSchemaColumn { defaultValue: string; isAsUuid: boolean; isGenerated: boolean; isNullable: boolean; /** * A shell-globbing-style (*?[]) filter for names. */ name: string; type: string; } interface GetTablesTableCollectionSchemaIdentity { columnName: string; isAlways: boolean; isNull: boolean; } interface GetTablesTableCollectionTableLimit { /** * The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero. */ capacityMode: string; /** * Maximum sustained read throughput limit for the table. */ maxReadUnits: number; /** * Maximum size of storage used by the table. */ maxStorageInGbs: number; /** * Maximum sustained write throughput limit for the table. */ maxWriteUnits: number; } interface IndexKey { /** * The name of a column to be included as an index key. */ columnName: string; /** * If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath. */ jsonFieldType: string; /** * If the specified column is of type JSON, jsonPath contains a dotted path indicating the field within the JSON object that will be the index key. */ jsonPath: string; } interface TableReplica { /** * The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero. */ capacityMode: string; /** * A message describing the current state in more detail. */ lifecycleDetails: string; /** * Maximum sustained write throughput limit for the table. */ maxWriteUnits: number; /** * A customer-facing region identifier */ region: string; /** * The state of a table. */ state: string; /** * The OCID of the replica table */ tableId: string; } interface TableSchema { /** * The columns of a table. */ columns: outputs.Nosql.TableSchemaColumn[]; /** * The identity properties of a table, if any. */ identities: outputs.Nosql.TableSchemaIdentity[]; /** * A list of column names that make up a key. */ primaryKeys: string[]; /** * A list of column names that make up a key. */ shardKeys: string[]; /** * The default Time-to-Live for the table, in days. */ ttl: number; } interface TableSchemaColumn { /** * The column default value. */ defaultValue: string; /** * True if the STRING column was declared AS UUID. */ isAsUuid: boolean; /** * True if the STRING AS UUID column is also GENERATED BY DEFAULT. */ isGenerated: boolean; /** * The column nullable flag. */ isNullable: boolean; /** * Table name. */ name: string; /** * The column type. */ type: string; } interface TableSchemaIdentity { /** * The name of the identity column. */ columnName: string; /** * True if the identity value is GENERATED ALWAYS. */ isAlways: boolean; /** * True if the identity value is GENERATED BY DEFAULT ON NULL. */ isNull: boolean; } interface TableTableLimits { /** * (Updatable) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero. */ capacityMode: string; /** * (Updatable) Maximum sustained read throughput limit for the table. */ maxReadUnits: number; /** * (Updatable) Maximum size of storage used by the table. */ maxStorageInGbs: number; /** * (Updatable) Maximum sustained write throughput limit for the table. * * ** IMPORTANT ** * Any change to a property that is not identified as "Updateable" will force the destruction and recreation of the resource with the new property values. */ maxWriteUnits: number; } } export declare namespace ObjectStorage { interface BucketRetentionRule { /** * A user-specified name for the retention rule. Names can be helpful in identifying retention rules. The name should be unique. This attribute is a forcenew attribute */ displayName: string; /** * (Updatable) */ duration?: outputs.ObjectStorage.BucketRetentionRuleDuration; /** * Unique identifier for the retention rule. */ retentionRuleId: string; /** * The date and time the bucket was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ timeCreated: string; /** * The date and time that the retention rule was modified as per [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeModified: string; /** * (Updatable) The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) after which this rule is locked and can only be deleted by deleting the bucket. Once a rule is locked, only increases in the duration are allowed and no other properties can be changed. This property cannot be updated for rules that are in a locked state. Specifying it when a duration is not specified is considered an error. */ timeRuleLocked?: string; } interface BucketRetentionRuleDuration { /** * (Updatable) The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation to each object's Last-Modified timestamp. */ timeAmount: string; /** * (Updatable) The unit that should be used to interpret timeAmount. */ timeUnit: string; } interface GetBucketRetentionRule { /** * User specified name for the retention rule. */ displayName: string; durations: outputs.ObjectStorage.GetBucketRetentionRuleDuration[]; /** * Unique identifier for the retention rule. */ retentionRuleId: string; /** * The date and time the bucket was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ timeCreated: string; /** * The date and time that the retention rule was modified as per [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeModified: string; /** * The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) after which this rule becomes locked. and can only be deleted by deleting the bucket. */ timeRuleLocked: string; } interface GetBucketRetentionRuleDuration { /** * The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation to each object's Last-Modified timestamp. */ timeAmount: string; /** * The unit that should be used to interpret timeAmount. */ timeUnit: string; } interface GetBucketSummariesBucketSummary { /** * The type of public access enabled on this bucket. A bucket is set to `NoPublicAccess` by default, which only allows an authenticated caller to access the bucket and its contents. When `ObjectRead` is enabled on the bucket, public access is allowed for the `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled on the bucket, public access is allowed for the `GetObject` and `HeadObject` operations. */ accessType: string; /** * The approximate number of objects in the bucket. Count statistics are reported periodically. You will see a lag between what is displayed and the actual object count. */ approximateCount: string; /** * The approximate total size in bytes of all objects in the bucket. Size statistics are reported periodically. You will see a lag between what is displayed and the actual size of the bucket. */ approximateSize: string; /** * The auto tiering status on the bucket. A bucket is created with auto tiering `Disabled` by default. For auto tiering `InfrequentAccess`, objects are transitioned automatically between the 'Standard' and 'InfrequentAccess' tiers based on the access pattern of the objects. */ autoTiering: string; bucketId: string; /** * Scope in which the bucket is unique. Default value is NAMESPACE. Bucket scope as NAMESPACE means that the bucket is unique only in the owning namespace/tenancy. Other tenancies can have a bucket with same name in their namespace. Bucket scope as REGION means that the bucket is regionally unique. No other tenancy can have a bucket with same name and scope REGION. */ bucketScope: string; /** * The ID of the compartment in which to list buckets. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the bucket. */ createdBy: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The entity tag (ETag) for the bucket. */ etag: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; id: string; /** * Specifies whether Object Storage should use intermediate cached Bucket Encryption Keys with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. This reduces calls to Oracle Cloud Infrastructure Vault Key Management Service (KMS). Existing objects are not affected. */ isBucketKeyEnabled: boolean; /** * Whether or not this bucket is read only. By default, `isReadOnly` is set to `false`. This will be set to 'true' when this bucket is configured as a destination in a replication policy. */ isReadOnly: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key. */ kmsKeyId: string; /** * Arbitrary string keys and values for user-defined metadata. */ metadata: { [key: string]: string; }; /** * The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1 */ name: string; /** * The Object Storage namespace used for the request. */ namespace: string; /** * Whether or not events are emitted for object state changes in this bucket. By default, `objectEventsEnabled` is set to `false`. Set `objectEventsEnabled` to `true` to emit events for object state changes. For more information about events, see [Overview of Events](https://docs.cloud.oracle.com/iaas/Content/Events/Concepts/eventsoverview.htm). */ objectEventsEnabled: boolean; /** * The entity tag (ETag) for the live object lifecycle policy on the bucket. */ objectLifecyclePolicyEtag: string; /** * Whether or not this bucket is a replication source. By default, `replicationEnabled` is set to `false`. This will be set to 'true' when you create a replication policy for the bucket. */ replicationEnabled: boolean; retentionRules: outputs.ObjectStorage.GetBucketSummariesBucketSummaryRetentionRule[]; /** * The storage tier type assigned to the bucket. A bucket is set to `Standard` tier by default, which means objects uploaded or copied to the bucket will be in the standard storage tier. When the `Archive` tier type is set explicitly for a bucket, objects uploaded or copied to the bucket will be stored in archive storage. The `storageTier` property is immutable after bucket is created. */ storageTier: string; /** * The date and time the bucket was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ timeCreated: string; /** * The versioning status on the bucket. A bucket is created with versioning `Disabled` by default. For versioning `Enabled`, objects are protected from overwrites and deletes, by maintaining their version history. When versioning is `Suspended`, the previous versions will still remain but new versions will no longer be created when overwitten or deleted. */ versioning: string; } interface GetBucketSummariesBucketSummaryRetentionRule { displayName: string; durations: outputs.ObjectStorage.GetBucketSummariesBucketSummaryRetentionRuleDuration[]; retentionRuleId: string; /** * The date and time the bucket was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ timeCreated: string; timeModified: string; timeRuleLocked: string; } interface GetBucketSummariesBucketSummaryRetentionRuleDuration { timeAmount: string; timeUnit: string; } interface GetBucketSummariesFilter { /** * The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1 */ name: string; regex?: boolean; values: string[]; } interface GetObjectLifecyclePolicyRule { /** * The action of the object lifecycle policy rule. Rules using the action 'ARCHIVE' move objects from Standard and InfrequentAccess storage tiers into the [Archive storage tier](https://docs.cloud.oracle.com/iaas/Content/Archive/Concepts/archivestorageoverview.htm). Rules using the action 'INFREQUENT_ACCESS' move objects from Standard storage tier into the Infrequent Access Storage tier. Objects that are already in InfrequentAccess tier or in Archive tier are left untouched. Rules using the action 'DELETE' permanently delete objects from buckets. Rules using 'ABORT' abort the uncommitted multipart-uploads and permanently delete their parts from buckets. */ action: string; /** * A Boolean that determines whether this rule is currently enabled. */ isEnabled: boolean; /** * The name of the lifecycle rule to be applied. */ name: string; /** * A filter that compares object names to a set of prefixes or patterns to determine if a rule applies to a given object. The filter can contain include glob patterns, exclude glob patterns and inclusion prefixes. The inclusion prefixes property is kept for backward compatibility. It is recommended to use inclusion patterns instead of prefixes. Exclusions take precedence over inclusions. */ objectNameFilters: outputs.ObjectStorage.GetObjectLifecyclePolicyRuleObjectNameFilter[]; /** * The target of the object lifecycle policy rule. The values of target can be either "objects", "multipart-uploads" or "previous-object-versions". This field when declared as "objects" is used to specify ARCHIVE, INFREQUENT_ACCESS or DELETE rule for objects. This field when declared as "previous-object-versions" is used to specify ARCHIVE, INFREQUENT_ACCESS or DELETE rule for previous versions of existing objects. This field when declared as "multipart-uploads" is used to specify the ABORT (only) rule for uncommitted multipart-uploads. */ target: string; /** * Specifies the age of objects to apply the rule to. The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation to each object's Last-Modified time. */ timeAmount: string; /** * The unit that should be used to interpret timeAmount. Days are defined as starting and ending at midnight UTC. Years are defined as 365.2425 days long and likewise round up to the next midnight UTC. */ timeUnit: string; } interface GetObjectLifecyclePolicyRuleObjectNameFilter { /** * An array of glob patterns to match the object names to exclude. An empty array is ignored. Exclusion patterns take precedence over inclusion patterns. A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other than the special pattern characters described below, matches itself. Glob patterns must be between 1 and 1024 characters. */ exclusionPatterns: string[]; /** * An array of glob patterns to match the object names to include. An empty array includes all objects in the bucket. Exclusion patterns take precedence over inclusion patterns. A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other than the special pattern characters described below, matches itself. Glob patterns must be between 1 and 1024 characters. */ inclusionPatterns: string[]; /** * An array of object name prefixes that the rule will apply to. An empty array means to include all objects. */ inclusionPrefixes: string[]; } interface GetObjectVersionsFilter { /** * The name of the object. Avoid entering confidential information. Example: test/object1.log */ name: string; regex?: boolean; values: string[]; } interface GetObjectVersionsItem { /** * Archival state of an object. This field is set only for objects in Archive tier. */ archivalState: string; /** * The current entity tag (ETag) for the object. */ etag: string; /** * This flag will indicate if the version is deleted or not. */ isDeleteMarker: boolean; /** * Base64-encoded MD5 hash of the object data. */ md5: string; /** * The name of the object. Avoid entering confidential information. Example: test/object1.log */ name: string; /** * Size of the object in bytes. */ size: string; /** * The storage tier that the object is stored in. */ storageTier: string; /** * The date and time the object was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ timeCreated: string; /** * The date and time the object was modified, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616#section-14.29). */ timeModified: string; /** * VersionId of the object. */ versionId: string; } interface GetObjectsFilter { /** * The name of the object. */ name: string; regex?: boolean; values: string[]; } interface GetObjectsObject { archivalState: string; /** * The current entity tag (ETag) for the object. */ etag: string; /** * Base64-encoded MD5 hash of the object data. */ md5: string; /** * The name of the object. */ name: string; /** * Size of the object in bytes. */ size: string; /** * The storage tier that the object is stored in. * * `archival-state` - Archival state of an object. This field is set only for objects in Archive tier. */ storageTier: string; /** * The date and time the object was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ timeCreated: string; /** * The date and time the object was modified, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616#section-14.29). */ timeModified: string; } interface GetPreauthrequestsFilter { /** * The user-provided name of the pre-authenticated request. */ name: string; regex?: boolean; values: string[]; } interface GetPreauthrequestsPreauthenticatedRequest { /** * The operation that can be performed on this resource. */ accessType: string; /** * The URI to embed in the URL when using the pre-authenticated request. */ accessUri: string; /** * The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1` */ bucket: string; /** * Specifies whether a list operation is allowed on a PAR with accessType "AnyObjectRead" or "AnyObjectReadWrite". Deny: Prevents the user from performing a list operation. ListObjects: Authorizes the user to perform a list operation. */ bucketListingAction: string; fullPath: string; /** * The unique identifier to use when directly addressing the pre-authenticated request. */ id: string; /** * The user-provided name of the pre-authenticated request. */ name: string; /** * The Object Storage namespace used for the request. */ namespace: string; /** * Deprecated. Instead use `objectName`.The name of the object that is being granted access to by the pre-authenticated request. Avoid entering confidential information. The object name can be null and if so, the pre-authenticated request grants access to the entire bucket. Example: test/object1.log * * @deprecated The 'object' field has been deprecated. Please use 'object_name' instead. */ object: string; /** * The name of the object that is being granted access to by the pre-authenticated request. Avoid entering confidential information. The object name can be null and if so, the pre-authenticated request grants access to the entire bucket. Example: test/object1.log */ objectName: string; parId: string; /** * The date when the pre-authenticated request was created as per specification [RFC 3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The expiration date for the pre-authenticated request as per [RFC 3339](https://tools.ietf.org/html/rfc3339). After this date the pre-authenticated request will no longer be valid. */ timeExpires: string; } interface GetPrivateEndpointAccessTarget { bucket: string; /** * The compartment ID in which the private endpoint resource exists in. */ compartmentId: string; /** * The Object Storage namespace used for the request. */ namespace: string; } interface GetPrivateEndpointSummariesFilter { /** * The name of the private endpoint. Avoid entering confidential information. Example: my-pe1 */ name: string; regex?: boolean; values: string[]; } interface GetPrivateEndpointSummariesPrivateEndpointSummary { accessTargets: outputs.ObjectStorage.GetPrivateEndpointSummariesPrivateEndpointSummaryAccessTarget[]; additionalPrefixes: string[]; /** * The ID of the compartment in which to list private endpoints. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the private endpoint. */ createdBy: string; definedTags: { [key: string]: string; }; /** * The entity tag for the Private Endpoint. */ etag: string; /** * The object representing FQDN details formed using prefix and additionalPrefixes. */ fqdns: { [key: string]: { [key: string]: { [key: string]: string; }; }; }; freeformTags: { [key: string]: string; }; id: string; /** * The name of the private endpoint. Avoid entering confidential information. Example: my-pe1 */ name: string; /** * The Object Storage namespace used for the request. */ namespace: string; nsgIds: string[]; /** * The DNS prefix value chosen which is the first part of the URL used to access Object Storage. */ prefix: string; privateEndpointIp: string; securityAttributes: { [key: string]: string; }; /** * The lifecycle state of the private endpoint resource. */ state: string; subnetId: string; /** * The date and time the private endpoint was created, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ timeCreated: string; /** * The date and time the private endpoint was updated, as described in [RFC 2616](https://tools.ietf.org/html/rfc2616#section-14.29). */ timeModified: string; } interface GetPrivateEndpointSummariesPrivateEndpointSummaryAccessTarget { bucket: string; /** * The ID of the compartment in which to list private endpoints. */ compartmentId: string; /** * The Object Storage namespace used for the request. */ namespace: string; } interface GetReplicationPoliciesFilter { /** * The name of the policy. */ name: string; regex?: boolean; values: string[]; } interface GetReplicationPoliciesReplicationPolicy { /** * The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1` */ bucket: string; /** * @deprecated The 'delete_object_in_destination_bucket' field has been deprecated. It is no longer supported. */ deleteObjectInDestinationBucket: string; /** * The bucket to replicate to in the destination region. Replication policy creation does not automatically create a destination bucket. Create the destination bucket before creating the policy. */ destinationBucketName: string; /** * The destination region to replicate to, for example "us-ashburn-1". */ destinationRegionName: string; /** * The id of the replication policy. */ id: string; /** * The name of the policy. */ name: string; /** * The Object Storage namespace used for the request. */ namespace: string; /** * The replication status of the policy. If the status is CLIENT_ERROR, once the user fixes the issue described in the status message, the status will become ACTIVE. */ status: string; /** * A human-readable description of the status. */ statusMessage: string; /** * The date when the replication policy was created as per [RFC 3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * Changes made to the source bucket before this time has been replicated. */ timeLastSync: string; } interface GetReplicationSourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetReplicationSourcesReplicationSource { /** * The name of the policy. */ policyName: string; /** * The source bucket replicating data from. */ sourceBucketName: string; /** * The source region replicating data from, for example "us-ashburn-1". */ sourceRegionName: string; } interface ObjectLifecyclePolicyRule { /** * (Updatable) The action of the object lifecycle policy rule. Rules using the action 'ARCHIVE' move objects from Standard and InfrequentAccess storage tiers into the [Archive storage tier](https://docs.cloud.oracle.com/iaas/Content/Archive/Concepts/archivestorageoverview.htm). Rules using the action 'INFREQUENT_ACCESS' move objects from Standard storage tier into the Infrequent Access Storage tier. Objects that are already in InfrequentAccess tier or in Archive tier are left untouched. Rules using the action 'DELETE' permanently delete objects from buckets. Rules using 'ABORT' abort the uncommitted multipart-uploads and permanently delete their parts from buckets. */ action: string; /** * (Updatable) A Boolean that determines whether this rule is currently enabled. */ isEnabled: boolean; /** * (Updatable) The name of the lifecycle rule to be applied. */ name: string; /** * (Updatable) A filter that compares object names to a set of prefixes or patterns to determine if a rule applies to a given object. The filter can contain include glob patterns, exclude glob patterns and inclusion prefixes. The inclusion prefixes property is kept for backward compatibility. It is recommended to use inclusion patterns instead of prefixes. Exclusions take precedence over inclusions. */ objectNameFilter: outputs.ObjectStorage.ObjectLifecyclePolicyRuleObjectNameFilter; /** * (Updatable) The target of the object lifecycle policy rule. The values of target can be either "objects", "multipart-uploads" or "previous-object-versions". This field when declared as "objects" is used to specify ARCHIVE, INFREQUENT_ACCESS or DELETE rule for objects. This field when declared as "previous-object-versions" is used to specify ARCHIVE, INFREQUENT_ACCESS or DELETE rule for previous versions of existing objects. This field when declared as "multipart-uploads" is used to specify the ABORT (only) rule for uncommitted multipart-uploads. */ target?: string; /** * (Updatable) Specifies the age of objects to apply the rule to. The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation to each object's Last-Modified time. */ timeAmount: string; /** * (Updatable) The unit that should be used to interpret timeAmount. Days are defined as starting and ending at midnight UTC. Years are defined as 365.2425 days long and likewise round up to the next midnight UTC. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ timeUnit: string; } interface ObjectLifecyclePolicyRuleObjectNameFilter { /** * (Updatable) An array of glob patterns to match the object names to exclude. An empty array is ignored. Exclusion patterns take precedence over inclusion patterns. A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other than the special pattern characters described below, matches itself. Glob patterns must be between 1 and 1024 characters. * * The special pattern characters have the following meanings: * * \ Escapes the following character * * Matches any string of characters. ? Matches any single character . [...] Matches a group of characters. A group of characters can be: A set of characters, for example: [Zafg9@]. This matches any character in the brackets. A range of characters, for example: [a-z]. This matches any character in the range. [a-f] is equivalent to [abcdef]. For character ranges only the CHARACTER-CHARACTER pattern is supported. [ab-yz] is not valid [a-mn-z] is not valid Character ranges can not start with ^ or : To include a '-' in the range, make it the first or last character. */ exclusionPatterns: string[]; /** * (Updatable) An array of glob patterns to match the object names to include. An empty array includes all objects in the bucket. Exclusion patterns take precedence over inclusion patterns. A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other than the special pattern characters described below, matches itself. Glob patterns must be between 1 and 1024 characters. * * The special pattern characters have the following meanings: * * \ Escapes the following character * * Matches any string of characters. ? Matches any single character . [...] Matches a group of characters. A group of characters can be: A set of characters, for example: [Zafg9@]. This matches any character in the brackets. A range of characters, for example: [a-z]. This matches any character in the range. [a-f] is equivalent to [abcdef]. For character ranges only the CHARACTER-CHARACTER pattern is supported. [ab-yz] is not valid [a-mn-z] is not valid Character ranges can not start with ^ or : To include a '-' in the range, make it the first or last character. */ inclusionPatterns: string[]; /** * (Updatable) An array of object name prefixes that the rule will apply to. An empty array means to include all objects. */ inclusionPrefixes: string[]; } interface PrivateEndpointAccessTarget { /** * (Updatable) Specifies what namespace/buckets within the allowed compartments the private endpoint can access. You can configure either a single bucket or all buckets within the allowed compartments. */ bucket: string; /** * (Updatable) Specifies what namespace/compartments the private endpoint can access. You can configure either a single compartment or all compartments. */ compartmentId: string; /** * (Updatable) Specifies the target namespace that's to be allowed to egress from the private endpoint. */ namespace: string; } interface StorageObjectSourceUriDetails { /** * The name of the bucket for the source object. */ bucket: string; /** * The entity tag to match the target object. */ destinationObjectIfMatchEtag?: string; /** * The entity tag to not match the target object. */ destinationObjectIfNoneMatchEtag?: string; /** * The top-level namespace of the source object. */ namespace: string; /** * The name of the source object. */ object: string; /** * The region of the source object. */ region: string; /** * The entity tag to match the source object. */ sourceObjectIfMatchEtag?: string; /** * The version id of the object to be restored. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ sourceVersionId?: string; } } export declare namespace Oce { interface GetOceInstancesFilter { /** * OceInstance Name */ name: string; regex?: boolean; values: string[]; } interface GetOceInstancesOceInstance { /** * a list of add-on features for the ocm instance */ addOnFeatures: string[]; /** * Admin Email for Notification */ adminEmail: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * OceInstance description, can be updated */ description: string; /** * disaster recovery paired ragion name */ drRegion: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique GUID identifier that is immutable on creation */ guid: string; /** * Unique identifier that is immutable on creation */ id: string; idcsAccessToken: string; /** * IDCS Tenancy Identifier */ idcsTenancy: string; /** * Flag indicating whether the instance access is private or public */ instanceAccessType: string; /** * Flag indicating whether the instance license is new cloud or bring your own license */ instanceLicenseType: string; /** * Instance type based on its usage */ instanceUsageType: string; /** * Details of the current state of the instance lifecycle */ lifecycleDetails: string; /** * OceInstance Name */ name: string; /** * Object Storage Namespace of tenancy */ objectStorageNamespace: string; /** * SERVICE data. Example: `{"service": {"IDCS": "value"}}` */ service: { [key: string]: string; }; /** * Filter results on lifecycleState. */ state: string; /** * An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ stateMessage: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The ID of the tenancy in which to list resources. */ tenancyId: string; /** * Tenancy Name */ tenancyName: string; /** * The time the the OceInstance was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the OceInstance was updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version */ upgradeSchedule: string; /** * Web Application Firewall(WAF) primary domain */ wafPrimaryDomain: string; } } export declare namespace Ocvp { interface ClusterClusterByolAllocationDetails { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall. */ firewallByolAllocationId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN. */ vsanByolAllocationId: string; } interface ClusterDatastore { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. */ blockVolumeIds: string[]; /** * Size of the Block Storage Volume in GB. */ capacity: number; /** * Type of the datastore. */ datastoreType: string; } interface ClusterNetworkConfiguration { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. * * This attribute is not guaranteed to reflect the HCX VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the HCX VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this SDDC in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20230701/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the HCX component of the VMware environment, you should use [UpdateSddc](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20230701/Sddc/UpdateSddc) to update the SDDC's `hcxVlanId` with that new VLAN's OCID. */ hcxVlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. * * This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 1 component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's `nsxEdgeUplink1VlanId` with that new VLAN's OCID. */ nsxEdgeUplink1vlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. * * This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 2 component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's `nsxEdgeUplink2VlanId` with that new VLAN's OCID. */ nsxEdgeUplink2vlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment. * * This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge VTEP component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's `nsxEdgeVTepVlanId` with that new VLAN's OCID. */ nsxEdgeVtepVlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment. * * This attribute is not guaranteed to reflect the NSX VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX VTEP component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's `nsxVTepVlanId` with that new VLAN's OCID. */ nsxVtepVlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the Cluster. */ provisioningSubnetId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the Provisioning component of the VMware environment. */ provisioningVlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment. */ replicationVlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vMotion component of the VMware environment. * * This attribute is not guaranteed to reflect the vMotion VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vMotion VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vMotion component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Sddc/UpdateCluster) to update the Cluster's `vmotionVlanId` with that new VLAN's OCID. */ vmotionVlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSAN component of the VMware environment. * * This attribute is not guaranteed to reflect the vSAN VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSAN VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSAN component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's `vsanVlanId` with that new VLAN's OCID. */ vsanVlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. * * This attribute is not guaranteed to reflect the vSphere VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSphere VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSphere component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Sddc/UpdateSddc) to update the Cluster's `vsphereVlanId` with that new VLAN's OCID. */ vsphereVlanId: string; } interface ClusterUpgradeLicense { /** * vSphere license key value. */ licenseKey: string; /** * vSphere license type. */ licenseType: string; } interface ClusterVsphereUpgradeObject { /** * Binary object download link. */ downloadLink: string; /** * Binary object description. */ linkDescription: string; } interface DatastoreBlockVolumeDetail { /** * List of BlockVolumeAttachment objects containing information about attachment details */ attachments: outputs.Ocvp.DatastoreBlockVolumeDetailAttachment[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Datastore. */ id: string; /** * An IQN of the Block Storage Volume. */ iqn: string; } interface DatastoreBlockVolumeDetailAttachment { /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that block volume is attached to. */ esxiHostId: string; /** * The IP address of block volume attachment. */ ipAddress: string; /** * The port of block volume attachment. */ port: number; } interface EsxiHostDatastoreAttachment { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Block Volume that belongs to the datastore. */ blockVolumeId: string; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Datastore that ESXi host is attached to. */ datastoreId: string; /** * The IP address of datastore attachment. */ ipAddress: string; /** * The port of datastore attachment. */ port: number; /** * An IQN of the Block Storage Volume. */ volumeIqn: string; } interface GetByolAllocationsByolAllocationCollection { items: outputs.Ocvp.GetByolAllocationsByolAllocationCollectionItem[]; } interface GetByolAllocationsByolAllocationCollectionItem { /** * The quantity of licensed units that allocated to this region. */ allocatedUnits: number; /** * The quantity of licensed units that not yet consumed by resources. */ availableUnits: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the BYOL. */ byolId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The Broadcom-supplied identifier of a BYOL license. */ entitlementKey: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the BYOL Allocation. */ id: string; /** * The hyperscaler identifier in Broadcom systems. */ siteId: string; /** * A filter to return only resources whose softwareType matches the given value. */ softwareType: string; /** * A filter to return only resources whose lifecycle state matches the given value. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{orcl-cloud: {free-tier-retain: true}}` */ systemTags: { [key: string]: string; }; /** * The date and time the BYOL Allocation was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time when the BYOL Allocation expires and becomes inactive. In the format defined by[RFC3339](https://tools.ietf.org/html/rfc3339). */ timeTermEnd: string; /** * The date and time when the BYOL Allocation becomes active. VMware software functionality cannot begin before this time. In the format defined by[RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeTermStart: string; /** * The date and time the BYOL Allocation was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetByolAllocationsFilter { name: string; regex?: boolean; values: string[]; } interface GetByolsByolCollection { items: outputs.Ocvp.GetByolsByolCollectionItem[]; } interface GetByolsByolCollectionItem { /** * The quantity of licensed units that not yet allocated to specific region. */ availableUnits: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A description of the BYOL. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The Broadcom-supplied identifier of a BYOL license. */ entitlementKey: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the BYOL. */ id: string; /** * The hyperscaler identifier in Broadcom systems. */ siteId: string; /** * A filter to return only resources whose softwareType matches the given value. */ softwareType: string; /** * A filter to return only resources whose lifecycle state matches the given value. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{orcl-cloud: {free-tier-retain: true}}` */ systemTags: { [key: string]: string; }; /** * The date and time the BYOL was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time when the BYOL expires and becomes inactive. In the format defined by[RFC3339](https://tools.ietf.org/html/rfc3339). */ timeTermEnd: string; /** * The date and time when the BYOL becomes active. VMware software functionality cannot begin before this time. In the format defined by[RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeTermStart: string; /** * The date and time the BYOL was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * Total quantity of licensed units for the specified `softwareType`: * * VCF, VDEFEND: number of OCPUs * * VSAN: storage capacity in TiB (tebibytes) * * AVI_LOAD_BALANCER: number of instances */ totalUnits: number; } interface GetByolsFilter { name: string; regex?: boolean; values: string[]; } interface GetClusterClusterByolAllocationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall. */ firewallByolAllocationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN. */ vsanByolAllocationId: string; } interface GetClusterDatastore { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. */ blockVolumeIds: string[]; /** * Size of the Block Storage Volume in GB. */ capacity: number; /** * Type of the datastore. */ datastoreType: string; } interface GetClusterNetworkConfiguration { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. */ hcxVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. */ nsxEdgeUplink1vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. */ nsxEdgeUplink2vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment. */ nsxEdgeVtepVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment. */ nsxVtepVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the Cluster. */ provisioningSubnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the Provisioning component of the VMware environment. */ provisioningVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment. */ replicationVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vMotion component of the VMware environment. */ vmotionVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSAN component of the VMware environment. */ vsanVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. */ vsphereVlanId: string; } interface GetClusterUpgradeLicense { /** * vSphere license key value. */ licenseKey: string; /** * vSphere license type. */ licenseType: string; } interface GetClusterVsphereUpgradeObject { /** * Binary object download link. */ downloadLink: string; /** * Binary object description. */ linkDescription: string; } interface GetClustersClusterCollection { items: outputs.Ocvp.GetClustersClusterCollectionItem[]; } interface GetClustersClusterCollectionItem { actualEsxiHostsCount: number; attachDatastoreClusterIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. */ capacityReservationId: string; /** * The BYOL allocations used for VMware Cluster provisioning. */ clusterByolAllocationDetails: outputs.Ocvp.GetClustersClusterCollectionItemClusterByolAllocationDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment as optional parameter. */ compartmentId: string; /** * The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is `multi-AD`. Example: `Uocm:PHX-AD-1`, `multi-AD` */ computeAvailabilityDomain: string; /** * A list of datastore clusters. */ datastoreClusterIds: string[]; /** * Datastores used for the Cluster. */ datastores: outputs.Ocvp.GetClustersClusterCollectionItemDatastore[]; /** * 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"}` */ definedTags: { [key: string]: string; }; detachDatastoreClusterIds: string[]; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The number of ESXi hosts in the Cluster. */ esxiHostsCount: number; /** * In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see [ListSupportedVmwareSoftwareVersions](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20230701/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions)). */ esxiSoftwareVersion: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cluster. */ id: string; /** * The billing option selected during Cluster creation. [ListSupportedCommitments](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedCommitmentSummary/ListSupportedCommitments). */ initialCommitment: string; /** * The initial OCPU count of the Cluster's ESXi hosts. */ initialHostOcpuCount: number; /** * The initial compute shape of the Cluster's ESXi hosts. [ListSupportedHostShapes](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes). */ initialHostShapeName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation. */ initialVcfByolAllocationId: string; /** * A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's `displayName` is used as the prefix. */ instanceDisplayNamePrefix: string; /** * Indicates whether shielded instance is enabled at the Cluster level. */ isShieldedInstanceEnabled: boolean; /** * The network configurations used by Cluster, including [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet and VLANs. */ networkConfigurations: outputs.Ocvp.GetClustersClusterCollectionItemNetworkConfiguration[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC. */ sddcId: string; /** * The lifecycle state of the resource. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{orcl-cloud: {free-tier-retain: true}}` */ systemTags: { [key: string]: string; }; /** * The date and time the Cluster was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Cluster was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The vSphere licenses to use when upgrading the Cluster. */ upgradeLicenses: outputs.Ocvp.GetClustersClusterCollectionItemUpgradeLicense[]; /** * In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see [ListSupportedVmwareSoftwareVersions](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions)). */ vmwareSoftwareVersion: string; /** * vSphere Cluster types. */ vsphereType: string; /** * The links to binary objects needed to upgrade vSphere. */ vsphereUpgradeObjects: outputs.Ocvp.GetClustersClusterCollectionItemVsphereUpgradeObject[]; /** * The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads. */ workloadNetworkCidr: string; } interface GetClustersClusterCollectionItemClusterByolAllocationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall. */ firewallByolAllocationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN. */ vsanByolAllocationId: string; } interface GetClustersClusterCollectionItemDatastore { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. */ blockVolumeIds: string[]; /** * Size of the Block Storage Volume in GB. */ capacity: number; /** * Type of the datastore. */ datastoreType: string; } interface GetClustersClusterCollectionItemNetworkConfiguration { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. */ hcxVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. */ nsxEdgeUplink1vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. */ nsxEdgeUplink2vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment. */ nsxEdgeVtepVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment. */ nsxVtepVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the Cluster. */ provisioningSubnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the Provisioning component of the VMware environment. */ provisioningVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment. */ replicationVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vMotion component of the VMware environment. */ vmotionVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSAN component of the VMware environment. */ vsanVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. */ vsphereVlanId: string; } interface GetClustersClusterCollectionItemUpgradeLicense { /** * vSphere license key value. */ licenseKey: string; /** * vSphere license type. */ licenseType: string; } interface GetClustersClusterCollectionItemVsphereUpgradeObject { /** * Binary object download link. */ downloadLink: string; /** * Binary object description. */ linkDescription: string; } interface GetClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetDatastoreBlockVolumeDetail { /** * List of BlockVolumeAttachment objects containing information about attachment details */ attachments: outputs.Ocvp.GetDatastoreBlockVolumeDetailAttachment[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Datastore. */ id: string; /** * An IQN of the Block Storage Volume. */ iqn: string; } interface GetDatastoreBlockVolumeDetailAttachment { /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that block volume is attached to. */ esxiHostId: string; /** * The IP address of block volume attachment. */ ipAddress: string; /** * The port of block volume attachment. */ port: number; } interface GetDatastoreClustersDatastoreClusterCollection { items: outputs.Ocvp.GetDatastoreClustersDatastoreClusterCollectionItem[]; } interface GetDatastoreClustersDatastoreClusterCollectionItem { /** * The availability domain of the Datastore Cluster. */ availabilityDomain: string; /** * Total size of all datastores associated with the datastore cluster in GB. */ capacityInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC Cluster. */ clusterId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Type of the datastore cluster. */ datastoreClusterType: string; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Datastores that belong to the Datastore Cluster */ datastoreIds: string[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi hosts to attach the datastore to. All ESXi hosts must belong to the same VMware cluster. */ esxiHostIds: string[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Datastore cluster. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that Datastore cluster is associated with. */ sddcId: string; /** * The lifecycle state of the resource. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{orcl-cloud: {free-tier-retain: true}}` */ systemTags: { [key: string]: string; }; /** * The date and time the Datastore Cluster was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Datastore Cluster was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetDatastoreClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetDatastoresDatastoreCollection { items: outputs.Ocvp.GetDatastoresDatastoreCollectionItem[]; } interface GetDatastoresDatastoreCollectionItem { /** * The availability domain of the Datastore. */ availabilityDomain: string; /** * The list of Block Volume details that belong to the datastore. */ blockVolumeDetails: outputs.Ocvp.GetDatastoresDatastoreCollectionItemBlockVolumeDetail[]; /** * The List of Block volume [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s that belong to the Datastore. */ blockVolumeIds: string[]; /** * Total size of the datastore in GB. */ capacityInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC Cluster. */ clusterId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Datastore. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that Datastore is associated with. */ sddcId: string; /** * The lifecycle state of the resource. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{orcl-cloud: {free-tier-retain: true}}` */ systemTags: { [key: string]: string; }; /** * The date and time the Datastore was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Datastore was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetDatastoresDatastoreCollectionItemBlockVolumeDetail { /** * List of BlockVolumeAttachment objects containing information about attachment details */ attachments: outputs.Ocvp.GetDatastoresDatastoreCollectionItemBlockVolumeDetailAttachment[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Datastore. */ id: string; /** * An IQN of the Block Storage Volume. */ iqn: string; } interface GetDatastoresDatastoreCollectionItemBlockVolumeDetailAttachment { /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that block volume is attached to. */ esxiHostId: string; /** * The IP address of block volume attachment. */ ipAddress: string; /** * The port of block volume attachment. */ port: number; } interface GetDatastoresFilter { name: string; regex?: boolean; values: string[]; } interface GetExsiHostDatastoreAttachment { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Block Volume that belongs to the datastore. */ blockVolumeId: string; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Datastore that ESXi host is attached to. */ datastoreId: string; /** * The IP address of datastore attachment. */ ipAddress: string; /** * The port of datastore attachment. */ port: number; /** * An IQN of the Block Storage Volume. */ volumeIqn: string; } interface GetExsiHostsEsxiHostCollection { attachDatastoreClusterIds: string[]; /** * Current billing cycle end date. If the value in `currentCommitment` and `nextCommitment` are different, the value specified in `nextCommitment` becomes the new `currentCommitment` when the `contractEndDate` is reached. Example: `2016-08-25T21:10:29.600Z` */ billingContractEndDate: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle. * * @deprecated This 'billing_donor_host_id' argument has been deprecated and will be computed only. */ billingDonorHostId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. */ capacityReservationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC Cluster. */ clusterId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment as optional parameter. */ compartmentId: string; /** * The availability domain of the ESXi host. */ computeAvailabilityDomain: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Compute instance. */ computeInstanceId: string; /** * The billing option currently used by the ESXi host. [ListSupportedCommitments](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20230701/SupportedCommitmentSummary/ListSupportedCommitments). */ currentCommitment: string; /** * (**Deprecated**) The billing option currently used by the ESXi host. [ListSupportedSkus](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus). **Deprecated**. Please use `currentCommitment` instead. * * @deprecated The 'current_sku' field has been deprecated. It is no longer supported. */ currentSku: string; /** * List of DatastoreAttachment objects containing information about attachment details */ datastoreAttachments: outputs.Ocvp.GetExsiHostsEsxiHostCollectionDatastoreAttachment[]; /** * A list of datastore clusters. */ datastoreClusterIds: string[]; /** * 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"}` */ definedTags: { [key: string]: string; }; detachDatastoreClusterIds: string[]; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The version of ESXi software that Oracle Cloud VMware Solution installed on the ESXi hosts. */ esxiSoftwareVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that failed. * * @deprecated This 'failed_esxi_host_id' argument has been deprecated and will be computed only. */ failedEsxiHostId: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The date and time when the new esxi host should start billing cycle. [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2021-07-25T21:10:29.600Z` */ gracePeriodEndDate: string; /** * The OCPU count of the ESXi host. */ hostOcpuCount: number; /** * The compute shape name of the ESXi host. [ListSupportedHostShapes](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20230701/SupportedHostShapes/ListSupportedHostShapes). */ hostShapeName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host. */ id: string; /** * Indicates whether this host is in the progress of billing continuation. */ isBillingContinuationInProgress: boolean; /** * Indicates whether this host is in the progress of swapping billing. */ isBillingSwappingInProgress: boolean; /** * Indicates whether this host embedded VMware vSAN with BYOL Allocation. */ isVsanByolEnabled: boolean; /** * The billing option to switch to after the current billing cycle ends. If `nextCommitment` is null or empty, `currentCommitment` continues to the next billing cycle. [ListSupportedCommitments](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20230701/SupportedCommitmentSummary/ListSupportedCommitments). */ nextCommitment: string; /** * (**Deprecated**) The billing option to switch to after the current billing cycle ends. If `nextSku` is null or empty, `currentSku` continues to the next billing cycle. [ListSupportedSkus](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus). **Deprecated**. Please use `nextCommitment` instead. * * @deprecated The 'next_sku' field has been deprecated. It is no longer supported. */ nextSku: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that will be upgraded. * * @deprecated This 'non_upgraded_esxi_host_id' argument has been deprecated and will be computed only. */ nonUpgradedEsxiHostId: string; primaryVnicMacAddress: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the esxi host that is newly created to replace the failed node. */ replacementEsxiHostId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC. * * @deprecated The 'sddc_id' field has been deprecated. Please use 'cluster_id' instead. */ sddcId: string; /** * The lifecycle state of the resource. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the active ESXi Host to swap billing with current host. */ swapBillingHostId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{orcl-cloud: {free-tier-retain: true}}` */ systemTags: { [key: string]: string; }; /** * The date and time the ESXi host was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the ESXi host was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ESXi host that is newly created to upgrade the original host. */ upgradedReplacementEsxiHostId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Byol Allocation for VCF (VMware Cloud Foundation) deployment. */ vcfByolAllocationId: string; /** * The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts. */ vmwareSoftwareVersion: string; } interface GetExsiHostsEsxiHostCollectionDatastoreAttachment { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Block Volume that belongs to the datastore. */ blockVolumeId: string; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Datastore that ESXi host is attached to. */ datastoreId: string; /** * The IP address of datastore attachment. */ ipAddress: string; /** * The port of datastore attachment. */ port: number; /** * An IQN of the Block Storage Volume. */ volumeIqn: string; } interface GetExsiHostsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagementApplianceConfiguration { /** * Is log ingestion from SDDC to Oracle Cloud Infrastructure enabled. */ isLogIngestionEnabled: boolean; /** * Is metrics collection and publishing is enabled for appliance. */ isMetricsCollectionEnabled: boolean; /** * Array of metrics ids to collect. */ metrics: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of support bundle Object Storage bucket. */ supportBundleBucketId: string; } interface GetManagementApplianceConnection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of secret in Oracle Cloud Infrastructure vault, that is used for storage of username and password in JSON format. */ credentialsSecretId: string; /** * Type of connection. */ type: string; } interface GetManagementApplianceHeartbeatConnectionState { /** * Information about current connection status. */ details: string; /** * Current state of the management appliance. */ state: string; /** * Type of connection. */ type: string; } interface GetManagementAppliancesFilter { name: string; regex?: boolean; values: string[]; } interface GetManagementAppliancesManagementApplianceCollection { items: outputs.Ocvp.GetManagementAppliancesManagementApplianceCollectionItem[]; } interface GetManagementAppliancesManagementApplianceCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of compute instance of management appliance in OCI. */ computeInstanceId: string; /** * Configuration of management appliance. */ configurations: outputs.Ocvp.GetManagementAppliancesManagementApplianceCollectionItemConfiguration[]; /** * Array of connections for management appliance. */ connections: outputs.Ocvp.GetManagementAppliancesManagementApplianceCollectionItemConnection[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Current states of connections. */ heartbeatConnectionStates: outputs.Ocvp.GetManagementAppliancesManagementApplianceCollectionItemHeartbeatConnectionState[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of management appliance. */ id: string; /** * Information about current lifecycleState. For FAILED and NEEDS_ATTENTION contains explanations. For other states may contain some details about their progress. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of management agent, that this appliance is running in. */ managementAgentId: string; /** * Current version of OCVS management plugin installed by Management Agent. As soon as OCVS service team publishes a new version OCVS management plugin (ocvs-ma-plugin-.zip) to Management Agent service, the service distributes it to Management Appliances owned by customers. This field shows which version of the OCVS management plugin is currently installed and running for this customer. */ pluginVersion: string; publicSshKeys: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC. */ sddcId: string; /** * The lifecycle state of the management appliance. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{orcl-cloud: {free-tier-retain: true}}` */ systemTags: { [key: string]: string; }; /** * The date and time the configuration of management appliance was last updated in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeConfigurationUpdated: string; /** * The date and time the management appliance was created in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the management appliance has last received heartbeat in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeLastHeartbeat: string; /** * The date and time the management appliance was last updated in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetManagementAppliancesManagementApplianceCollectionItemConfiguration { /** * Is log ingestion from SDDC to Oracle Cloud Infrastructure enabled. */ isLogIngestionEnabled: boolean; /** * Is metrics collection and publishing is enabled for appliance. */ isMetricsCollectionEnabled: boolean; /** * Array of metrics ids to collect. */ metrics: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of support bundle Object Storage bucket. */ supportBundleBucketId: string; } interface GetManagementAppliancesManagementApplianceCollectionItemConnection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of secret in Oracle Cloud Infrastructure vault, that is used for storage of username and password in JSON format. */ credentialsSecretId: string; /** * Type of connection. */ type: string; } interface GetManagementAppliancesManagementApplianceCollectionItemHeartbeatConnectionState { /** * Information about current connection status. */ details: string; /** * The lifecycle state of the management appliance. */ state: string; /** * Type of connection. */ type: string; } interface GetSddcDatastore { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. */ blockVolumeIds: string[]; /** * Size of the Block Storage Volume in GB. */ capacity: number; /** * Type of the datastore. */ datastoreType: string; } interface GetSddcHcxOnPremLicense { /** * HCX on-premise license key value. */ activationKey: string; /** * status of HCX on-premise license. */ status: string; /** * Name of the system that consumed the HCX on-premise license */ systemName: string; } interface GetSddcInitialConfiguration { /** * The configurations for Clusters initially created in the SDDC. */ initialClusterConfigurations: outputs.Ocvp.GetSddcInitialConfigurationInitialClusterConfiguration[]; } interface GetSddcInitialConfigurationInitialClusterConfiguration { /** * (**Deprecated**) The number of actual ESXi hosts in the SDDC on the cloud. This attribute will be different when esxi Host is added to an existing SDDC. **Deprecated**. Please use `actualEsxiHostsCount` of `initialClusterConfigurations` instead. */ actualEsxiHostsCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. */ capacityReservationId: string; /** * The BYOL allocations used for VMware Cluster provisioning. */ clusterByolAllocationDetails: outputs.Ocvp.GetSddcInitialConfigurationInitialClusterConfigurationClusterByolAllocationDetail[]; /** * The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to `multi-AD`. */ computeAvailabilityDomain: string; /** * A list of datastore clusters. */ datastoreClusterIds: string[]; /** * A list of datastore info for the Cluster. This value is required only when `initialHostShapeName` is a standard shape. */ datastores: outputs.Ocvp.GetSddcInitialConfigurationInitialClusterConfigurationDatastore[]; /** * A descriptive name for the Cluster. Cluster name requirements are 1-22 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region. Avoid entering confidential information. */ displayName: string; /** * The number of ESXi hosts to create in the Cluster. You can add more hosts later (see [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost)). Creating a Cluster with a ESXi host count of 1 will be considered a single ESXi host Cluster. */ esxiHostsCount: number; /** * The billing option selected during Cluster creation. [ListSupportedCommitments](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedCommitmentSummary/ListSupportedCommitments). */ initialCommitment: string; /** * (**Deprecated**) The initial OCPU count of the SDDC's ESXi hosts. **Deprecated**. Please use `initialHostOcpuCount` of `initialClusterConfigurations` instead. */ initialHostOcpuCount: number; /** * (**Deprecated**) The initial compute shape of the SDDC's ESXi hosts. [ListSupportedHostShapes](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes). **Deprecated**. Please use `initialHostShapeName` of `initialClusterConfigurations` instead. */ initialHostShapeName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation. */ initialVcfByolAllocationId: string; /** * (**Deprecated**) A prefix used in the name of each ESXi host and Compute instance in the SDDC. If this isn't set, the SDDC's `displayName` is used as the prefix. */ instanceDisplayNamePrefix: string; /** * (**Deprecated**) Indicates whether shielded instance is enabled at the SDDC level. **Deprecated**. Please use `isShieldedInstanceEnabled` of `initialClusterConfigurations` instead. */ isShieldedInstanceEnabled: boolean; /** * The network configurations used by Cluster, including [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet and VLANs. */ networkConfigurations: outputs.Ocvp.GetSddcInitialConfigurationInitialClusterConfigurationNetworkConfiguration[]; /** * vSphere Cluster types. */ vsphereType: string; /** * (**Deprecated**) The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads. **Deprecated**. Please use `workloadNetworkCidr` of `initialClusterConfigurations` instead. */ workloadNetworkCidr: string; } interface GetSddcInitialConfigurationInitialClusterConfigurationClusterByolAllocationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall. */ firewallByolAllocationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN. */ vsanByolAllocationId: string; } interface GetSddcInitialConfigurationInitialClusterConfigurationDatastore { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. */ blockVolumeIds: string[]; /** * Type of the datastore. */ datastoreType: string; } interface GetSddcInitialConfigurationInitialClusterConfigurationNetworkConfiguration { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. */ hcxVlanId: string; /** * (**Deprecated**) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. */ nsxEdgeUplink1vlanId: string; /** * (**Deprecated**) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. */ nsxEdgeUplink2vlanId: string; /** * (**Deprecated**) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge VTEP component of the VMware environment. */ nsxEdgeVtepVlanId: string; /** * (**Deprecated**) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX VTEP component of the VMware environment. */ nsxVtepVlanId: string; /** * (**Deprecated**) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the SDDC. **Deprecated**. Please use `provisioningSubnetId` of `networkConfiguration` instead. */ provisioningSubnetId: string; /** * (**Deprecated**) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the Provisioning component of the VMware environment. **Deprecated**. Please use `provisioningVlanId` of `networkConfiguration` instead. */ provisioningVlanId: string; /** * (**Deprecated**) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere Replication component of the VMware environment. **Deprecated**. Please use `replicationVlanId` of `networkConfiguration` instead. */ replicationVlanId: string; /** * (**Deprecated**) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vMotion component of the VMware environment. */ vmotionVlanId: string; /** * (**Deprecated**) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSAN component of the VMware environment. */ vsanVlanId: string; /** * (**Deprecated**) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. */ vsphereVlanId: string; } interface GetSddcSddcByolAllocationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware Avi Load Balancer. */ loadBalancerByolAllocationId: string; /** * The number of VMware Avi Load Balancer instances to be deployed on VMware SDDC. */ loadBalancerInstanceCount: number; } interface GetSddcUpgradeLicense { /** * vSphere license key value. */ licenseKey: string; /** * vSphere license type. */ licenseType: string; } interface GetSddcVsphereUpgradeObject { /** * Binary object download link. */ downloadLink: string; /** * Binary object description. */ linkDescription: string; } interface GetSddcsFilter { name: string; regex?: boolean; values: string[]; } interface GetSddcsSddcCollection { /** * (**Deprecated**) The number of actual ESXi hosts in the SDDC on the cloud. This attribute will be different when esxi Host is added to an existing SDDC. * * @deprecated The 'actual_esxi_hosts_count' field has been deprecated. Please use 'initial_configuration' instead. */ actualEsxiHostsCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. * * @deprecated The 'capacity_reservation_id' field has been deprecated. Please use 'initial_configuration' instead. */ capacityReservationId: string; /** * The number of Clusters in the SDDC. */ clustersCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The name of the availability domain that the Compute instances are running in. Example: `Uocm:PHX-AD-1` * * @deprecated The 'compute_availability_domain' field has been deprecated. Please use 'initial_configuration' instead. */ computeAvailabilityDomain: string; /** * A list of datastore info for the Cluster. This value is required only when `initialHostShapeName` is a standard shape. * * @deprecated The 'datastores' field has been deprecated. Please use 'initial_configuration' instead. */ datastores: outputs.Ocvp.GetSddcsSddcCollectionDatastore[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The number of ESXi hosts to create in the Cluster. You can add more hosts later (see [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost)). Creating a Cluster with a ESXi host count of 1 will be considered a single ESXi host Cluster. * * @deprecated The 'esxi_hosts_count' field has been deprecated. Please use 'initial_configuration' instead. */ esxiHostsCount: number; /** * In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see [ListSupportedVmwareSoftwareVersions](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20230701/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions)). */ esxiSoftwareVersion: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; hcxAction: string; /** * The FQDN for HCX Manager. Example: `hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com` */ hcxFqdn: string; /** * @deprecated The 'hcx_initial_password' field has been deprecated. Please use the 'oci_ocvp_retrieve_password' data source instead. */ hcxInitialPassword: string; /** * HCX configuration of the SDDC. */ hcxMode: string; /** * @deprecated The 'hcx_on_prem_key' field has been deprecated and may be removed in a future version. Do not use this field. */ hcxOnPremKey: string; /** * The activation licenses to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution. */ hcxOnPremLicenses: outputs.Ocvp.GetSddcsSddcCollectionHcxOnPremLicense[]; hcxPrivateIpId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. * * @deprecated The 'hcx_vlan_id' field has been deprecated. Please use 'initial_configuration' instead. */ hcxVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC. */ id: string; /** * Details of SDDC initial configuration */ initialConfigurations: outputs.Ocvp.GetSddcsSddcCollectionInitialConfiguration[]; /** * (**Deprecated**) The initial OCPU count of the SDDC's ESXi hosts. * * @deprecated The 'initial_host_ocpu_count' field has been deprecated. Please use 'initial_configuration' instead. */ initialHostOcpuCount: number; /** * (**Deprecated**) The initial compute shape of the SDDC's ESXi hosts. [ListSupportedHostShapes](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes). * * @deprecated The 'initial_host_shape_name' field has been deprecated. Please use 'initial_configuration' instead. */ initialHostShapeName: string; /** * @deprecated The 'initial_sku' field has been deprecated. Please use 'initial_configuration' instead. */ initialSku: string; /** * A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's `displayName` is used as the prefix. * * @deprecated The 'instance_display_name_prefix' field has been deprecated. Please use 'initial_configuration' instead. */ instanceDisplayNamePrefix: string; /** * (**Deprecated**) Indicates whether HCX is enabled for this SDDC. **Deprecated**. Please use `hcxMode` instead. */ isHcxEnabled: boolean; /** * (**Deprecated**) Indicates whether HCX Enterprise is enabled for this SDDC. **Deprecated**. Please use `hcxMode` instead. * * @deprecated The 'is_hcx_enterprise_enabled' field has been deprecated and may be removed in a future version. Do not use this field. */ isHcxEnterpriseEnabled: boolean; /** * Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced. */ isHcxPendingDowngrade: boolean; /** * (**Deprecated**) Indicates whether shielded instance is enabled at the SDDC level. * * @deprecated The 'is_shielded_instance_enabled' field has been deprecated. Please use 'initial_configuration' instead. */ isShieldedInstanceEnabled: boolean; /** * Indicates whether this SDDC is designated for only single ESXi host. */ isSingleHostSddc: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. * * @deprecated The 'nsx_edge_uplink1vlan_id' field has been deprecated. Please use 'initial_configuration' instead. */ nsxEdgeUplink1vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. * * @deprecated The 'nsx_edge_uplink2vlan_id' field has been deprecated. Please use 'initial_configuration' instead. */ nsxEdgeUplink2vlanId: string; nsxEdgeUplinkIpId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment. * * @deprecated The 'nsx_edge_vtep_vlan_id' field has been deprecated. Please use 'initial_configuration' instead. */ nsxEdgeVtepVlanId: string; /** * The FQDN for NSX Manager. Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com` */ nsxManagerFqdn: string; /** * @deprecated The 'nsx_manager_initial_password' field has been deprecated. Please use the 'oci_ocvp_retrieve_password' data source instead. */ nsxManagerInitialPassword: string; nsxManagerPrivateIpId: string; /** * The SDDC includes an administrator username and initial password for NSX Manager. You can change this initial username to a different value in NSX Manager. */ nsxManagerUsername: string; /** * @deprecated The 'nsx_overlay_segment_name' field has been deprecated and may be removed in a future version. Do not use this field. */ nsxOverlaySegmentName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment. * * @deprecated The 'nsx_vtep_vlan_id' field has been deprecated. Please use 'initial_configuration' instead. */ nsxVtepVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the Cluster. * * @deprecated The 'provisioning_subnet_id' field has been deprecated. Please use 'initial_configuration' instead. */ provisioningSubnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the Provisioning component of the VMware environment. * * @deprecated The 'provisioning_vlan_id' field has been deprecated. Please use 'initial_configuration' instead. */ provisioningVlanId: string; refreshHcxLicenseStatus: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment. * * @deprecated The 'replication_vlan_id' field has been deprecated. Please use 'initial_configuration' instead. */ replicationVlanId: string; reservingHcxOnPremiseLicenseKeys: string[]; /** * The BYOL allocations used for VMware SDDC provisioning. */ sddcByolAllocationDetails: outputs.Ocvp.GetSddcsSddcCollectionSddcByolAllocationDetail[]; sshAuthorizedKeys: string; /** * The lifecycle state of the resource. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{orcl-cloud: {free-tier-retain: true}}` */ systemTags: { [key: string]: string; }; /** * The date and time the SDDC was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; timeHcxBillingCycleEnd: string; timeHcxLicenseStatusUpdated: string; /** * The date and time the SDDC was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; /** * @deprecated The 'upgrade_licenses' field has been deprecated. Please use the 'ocvp_cluster_resource' resource instead. */ upgradeLicenses: outputs.Ocvp.GetSddcsSddcCollectionUpgradeLicense[]; /** * The FQDN for vCenter. Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com` */ vcenterFqdn: string; /** * @deprecated The 'vcenter_initial_password' field has been deprecated. Please use the 'oci_ocvp_retrieve_password' data source instead. */ vcenterInitialPassword: string; vcenterPrivateIpId: string; vcenterUsername: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vMotion component of the VMware environment. * * @deprecated The 'vmotion_vlan_id' field has been deprecated. Please use 'initial_configuration' instead. */ vmotionVlanId: string; /** * In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see [ListSupportedVmwareSoftwareVersions](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20230701/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions)). */ vmwareSoftwareVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSAN component of the VMware environment. * * @deprecated The 'vsan_vlan_id' field has been deprecated. Please use 'initial_configuration' instead. */ vsanVlanId: string; /** * @deprecated The 'vsphere_upgrade_guide' field has been deprecated and may be removed in a future version. Do not use this field. */ vsphereUpgradeGuide: string; /** * @deprecated The 'vsphere_upgrade_objects' field has been deprecated. Please use the 'ocvp_cluster_resource' resource instead. */ vsphereUpgradeObjects: outputs.Ocvp.GetSddcsSddcCollectionVsphereUpgradeObject[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. * * @deprecated The 'vsphere_vlan_id' field has been deprecated. Please use 'initial_configuration' instead. */ vsphereVlanId: string; /** * The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application workloads. * * @deprecated The 'workload_network_cidr' field has been deprecated. Please use 'initial_configuration' instead. */ workloadNetworkCidr: string; } interface GetSddcsSddcCollectionDatastore { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. */ blockVolumeIds: string[]; capacity: number; /** * Type of the datastore. */ datastoreType: string; } interface GetSddcsSddcCollectionHcxOnPremLicense { /** * HCX on-premise license key value. */ activationKey: string; /** * status of HCX on-premise license. */ status: string; /** * Name of the system that consumed the HCX on-premise license */ systemName: string; } interface GetSddcsSddcCollectionInitialConfiguration { /** * The configurations for Clusters initially created in the SDDC. */ initialClusterConfigurations: outputs.Ocvp.GetSddcsSddcCollectionInitialConfigurationInitialClusterConfiguration[]; } interface GetSddcsSddcCollectionInitialConfigurationInitialClusterConfiguration { /** * (**Deprecated**) The number of actual ESXi hosts in the SDDC on the cloud. This attribute will be different when esxi Host is added to an existing SDDC. */ actualEsxiHostsCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. */ capacityReservationId: string; /** * The BYOL allocations used for VMware Cluster provisioning. */ clusterByolAllocationDetails: outputs.Ocvp.GetSddcsSddcCollectionInitialConfigurationInitialClusterConfigurationClusterByolAllocationDetail[]; /** * The name of the availability domain that the Compute instances are running in. Example: `Uocm:PHX-AD-1` */ computeAvailabilityDomain: string; /** * A list of datastore clusters. */ datastoreClusterIds: string[]; /** * A list of datastore info for the Cluster. This value is required only when `initialHostShapeName` is a standard shape. */ datastores: outputs.Ocvp.GetSddcsSddcCollectionInitialConfigurationInitialClusterConfigurationDatastore[]; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The number of ESXi hosts to create in the Cluster. You can add more hosts later (see [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost)). Creating a Cluster with a ESXi host count of 1 will be considered a single ESXi host Cluster. */ esxiHostsCount: number; /** * The billing option selected during Cluster creation. [ListSupportedCommitments](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedCommitmentSummary/ListSupportedCommitments). */ initialCommitment: string; /** * (**Deprecated**) The initial OCPU count of the SDDC's ESXi hosts. */ initialHostOcpuCount: number; /** * (**Deprecated**) The initial compute shape of the SDDC's ESXi hosts. [ListSupportedHostShapes](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes). */ initialHostShapeName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation. */ initialVcfByolAllocationId: string; /** * A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's `displayName` is used as the prefix. */ instanceDisplayNamePrefix: string; /** * (**Deprecated**) Indicates whether shielded instance is enabled at the SDDC level. */ isShieldedInstanceEnabled: boolean; /** * The network configurations used by Cluster, including [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet and VLANs. */ networkConfigurations: outputs.Ocvp.GetSddcsSddcCollectionInitialConfigurationInitialClusterConfigurationNetworkConfiguration[]; /** * vSphere Cluster types. */ vsphereType: string; /** * The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application workloads. */ workloadNetworkCidr: string; } interface GetSddcsSddcCollectionInitialConfigurationInitialClusterConfigurationClusterByolAllocationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall. */ firewallByolAllocationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN. */ vsanByolAllocationId: string; } interface GetSddcsSddcCollectionInitialConfigurationInitialClusterConfigurationDatastore { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. */ blockVolumeIds: string[]; /** * Type of the datastore. */ datastoreType: string; } interface GetSddcsSddcCollectionInitialConfigurationInitialClusterConfigurationNetworkConfiguration { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. */ hcxVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. */ nsxEdgeUplink1vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. */ nsxEdgeUplink2vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment. */ nsxEdgeVtepVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment. */ nsxVtepVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the Cluster. */ provisioningSubnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the Provisioning component of the VMware environment. */ provisioningVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment. */ replicationVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vMotion component of the VMware environment. */ vmotionVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSAN component of the VMware environment. */ vsanVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. */ vsphereVlanId: string; } interface GetSddcsSddcCollectionSddcByolAllocationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware Avi Load Balancer. */ loadBalancerByolAllocationId: string; /** * The number of VMware Avi Load Balancer instances to be deployed on VMware SDDC. */ loadBalancerInstanceCount: number; } interface GetSddcsSddcCollectionUpgradeLicense { licenseKey: string; licenseType: string; } interface GetSddcsSddcCollectionVsphereUpgradeObject { downloadLink: string; linkDescription: string; } interface GetSupportedCommitmentsFilter { /** * name of Commitment */ name: string; regex?: boolean; values: string[]; } interface GetSupportedCommitmentsItem { /** * name of Commitment */ name: string; } interface GetSupportedHostShapesFilter { /** * A filter to return only resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetSupportedHostShapesItem { /** * The default OCPU count of the shape. */ defaultOcpuCount: number; /** * Description of the shape. */ description: string; /** * A filter to return only resources that support single host SDDC. */ isSingleHostSddcSupported: boolean; /** * Whether the shape supports "MONTH" Commitment. */ isSupportMonthlyCommitment: boolean; /** * (**Deprecated**) Whether the shape supports "MONTH" SKU. * * @deprecated The 'is_support_monthly_sku' field has been deprecated. Please use 'is_support_monthly_commitment' instead. */ isSupportMonthlySku: boolean; /** * Indicates whether the shape supports shielded instances. */ isSupportShieldedInstances: boolean; /** * A filter to return only resources that match the given name exactly. */ name: string; /** * The family of the shape. ESXi hosts of one SDDC must have the same shape family. */ shapeFamily: string; /** * Support OCPU count of the shape. */ supportedOcpuCounts: number[]; /** * The operations where you can use the shape. The operations can be CREATE_SDDC or CREATE_ESXI_HOST. */ supportedOperations: string[]; /** * (**Deprecated**) The supported SDDC types for the shape. * * @deprecated The 'supported_sddc_types' field has been deprecated. Please use 'is_single_host_sddc_supported' instead. */ supportedSddcTypes: string[]; /** * The VMware software versions supported by the shape. */ supportedVmwareSoftwareVersions: string[]; } interface GetSupportedSkusFilter { /** * name of SKU */ name: string; regex?: boolean; values: string[]; } interface GetSupportedSkusItem { /** * name of SKU */ name: string; } interface GetSupportedVmwareSoftwareVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSupportedVmwareSoftwareVersionsItem { /** * A description of the software in the bundle. */ description: string; /** * A list of supported ESXi software versions. */ esxiSoftwareVersions: outputs.Ocvp.GetSupportedVmwareSoftwareVersionsItemEsxiSoftwareVersion[]; /** * A filter to return only resources that match the given VMware software version exactly. */ version: string; } interface GetSupportedVmwareSoftwareVersionsItemEsxiSoftwareVersion { /** * A description of the software in the bundle. */ description: string; /** * A list of ESXi host shapes supported by the version of bundled software. */ supportedHostShapeNames: string[]; /** * A filter to return only resources that match the given VMware software version exactly. */ version: string; } interface ManagementApplianceConfiguration { /** * (Updatable) Is log ingestion from SDDC to Oracle Cloud Infrastructure enabled. */ isLogIngestionEnabled: boolean; /** * (Updatable) Is metrics collection and publishing is enabled for appliance. */ isMetricsCollectionEnabled: boolean; /** * (Updatable) Array of metrics ids to collect. */ metrics: string[]; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of support bundle Object Storage bucket. */ supportBundleBucketId: string; } interface ManagementApplianceConnection { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of secret in Oracle Cloud Infrastructure vault, that is used for storage of username and password in JSON format. */ credentialsSecretId: string; /** * (Updatable) Type of connection. */ type: string; } interface ManagementApplianceHeartbeatConnectionState { /** * Information about current connection status. */ details: string; /** * Current state of the management appliance. */ state: string; /** * Type of connection. */ type: string; } interface SddcDatastore { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. */ blockVolumeIds: string[]; /** * Size of the Block Storage Volume in GB. */ capacity: number; /** * Type of the datastore. */ datastoreType: string; } interface SddcHcxOnPremLicense { /** * HCX on-premise license key value. */ activationKey: string; /** * status of HCX on-premise license. */ status: string; /** * Name of the system that consumed the HCX on-premise license */ systemName: string; } interface SddcInitialConfiguration { /** * The configurations for Clusters initially created in the SDDC. */ initialClusterConfigurations: outputs.Ocvp.SddcInitialConfigurationInitialClusterConfiguration[]; } interface SddcInitialConfigurationInitialClusterConfiguration { /** * The number of actual ESXi hosts in the SDDC on the cloud. This attribute will be different when esxi Host is added to an existing SDDC. **Deprecated**. */ actualEsxiHostsCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. */ capacityReservationId: string; /** * The BYOL allocations used for VMware Cluster provisioning. */ clusterByolAllocationDetails: outputs.Ocvp.SddcInitialConfigurationInitialClusterConfigurationClusterByolAllocationDetails; /** * The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to `multi-AD`. */ computeAvailabilityDomain: string; /** * A list of datastore clusters. */ datastoreClusterIds: string[]; /** * A list of datastore info for the Cluster. This value is required only when `initialHostShapeName` is a standard shape. */ datastores: outputs.Ocvp.SddcInitialConfigurationInitialClusterConfigurationDatastore[]; /** * A descriptive name for the Cluster. Cluster name requirements are 1-22 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region. Avoid entering confidential information. */ displayName: string; /** * The number of ESXi hosts to create in the Cluster. You can add more hosts later (see [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost)). Creating a Cluster with a ESXi host count of 1 will be considered a single ESXi host Cluster. * * **Note:** If you later delete EXSi hosts from a production Cluster to total less than 3, you are still billed for the 3 minimum recommended ESXi hosts. Also, you cannot add more VMware workloads to the Cluster until it again has at least 3 ESXi hosts. */ esxiHostsCount: number; /** * The billing option selected during Cluster creation. [ListSupportedCommitments](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedCommitmentSummary/ListSupportedCommitments). */ initialCommitment: string; /** * The initial OCPU count of the Cluster's ESXi hosts. */ initialHostOcpuCount: number; /** * The initial compute shape of the Cluster's ESXi hosts. [ListSupportedHostShapes](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes). */ initialHostShapeName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation. */ initialVcfByolAllocationId: string; /** * A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's `displayName` is used as the prefix. * * For example, if the value is `myCluster`, the ESXi hosts are named `myCluster-1`, `myCluster-2`, and so on. */ instanceDisplayNamePrefix: string; /** * Indicates whether shielded instance is enabled for this Cluster. */ isShieldedInstanceEnabled: boolean; /** * The network configurations used by Cluster, including [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet and VLANs. */ networkConfiguration?: outputs.Ocvp.SddcInitialConfigurationInitialClusterConfigurationNetworkConfiguration; /** * vSphere Cluster types. */ vsphereType: string; /** * The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application workloads. */ workloadNetworkCidr: string; } interface SddcInitialConfigurationInitialClusterConfigurationClusterByolAllocationDetails { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall. */ firewallByolAllocationId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN. */ vsanByolAllocationId: string; } interface SddcInitialConfigurationInitialClusterConfigurationDatastore { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes. */ blockVolumeIds: string[]; /** * Type of the datastore. */ datastoreType: string; } interface SddcInitialConfigurationInitialClusterConfigurationNetworkConfiguration { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled. * * This attribute is not guaranteed to reflect the HCX VLAN currently used by the ESXi hosts in the SDDC. The purpose of this attribute is to show the HCX VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this SDDC in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20230701/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN for the HCX component of the VMware environment, you should use [UpdateSddc](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20230701/Sddc/UpdateSddc) to update the SDDC's `hcxVlanId` with that new VLAN's OCID. */ hcxVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. * * This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 1 component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's `nsxEdgeUplink1VlanId` with that new VLAN's OCID. */ nsxEdgeUplink1vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. * * This attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge Uplink 2 component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's `nsxEdgeUplink2VlanId` with that new VLAN's OCID. */ nsxEdgeUplink2vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment. * * This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX Edge VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX Edge VTEP component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's `nsxEdgeVTepVlanId` with that new VLAN's OCID. */ nsxEdgeVtepVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment. * * This attribute is not guaranteed to reflect the NSX VTEP VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the NSX VTEP VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the NSX VTEP component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's `nsxVTepVlanId` with that new VLAN's OCID. */ nsxVtepVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management subnet used to provision the Cluster. */ provisioningSubnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the Provisioning component of the VMware environment. */ provisioningVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment. */ replicationVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vMotion component of the VMware environment. * * This attribute is not guaranteed to reflect the vMotion VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vMotion VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vMotion component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Sddc/UpdateCluster) to update the Cluster's `vmotionVlanId` with that new VLAN's OCID. */ vmotionVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster for the vSAN component of the VMware environment. * * This attribute is not guaranteed to reflect the vSAN VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSAN VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSAN component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's `vsanVlanId` with that new VLAN's OCID. */ vsanVlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster. * * This attribute is not guaranteed to reflect the vSphere VLAN currently used by the ESXi hosts in the Cluster. The purpose of this attribute is to show the vSphere VLAN that the Oracle Cloud VMware Solution will use for any new ESXi hosts that you *add to this Cluster in the future* with [CreateEsxiHost](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/EsxiHost/CreateEsxiHost). * * Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN for the vSphere component of the VMware environment, you should use [UpdateCluster](https://docs.cloud.oracle.com/iaas/api/#/en/vmware/20200501/Sddc/UpdateSddc) to update the Cluster's `vsphereVlanId` with that new VLAN's OCID. */ vsphereVlanId: string; } interface SddcSddcByolAllocationDetails { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware Avi Load Balancer. */ loadBalancerByolAllocationId: string; /** * (Updatable) The number of VMware Avi Load Balancer instances to be deployed on VMware SDDC. */ loadBalancerInstanceCount: number; } interface SddcUpgradeLicense { /** * vSphere license key value. */ licenseKey: string; /** * vSphere license type. */ licenseType: string; } interface SddcVsphereUpgradeObject { /** * Binary object download link. */ downloadLink: string; /** * Binary object description. */ linkDescription: string; } } export declare namespace Oda { interface GetOdaInstanceRestrictedOperation { /** * Name of the restricted operation. */ operationName: string; /** * Name of the service restricting the operation. */ restrictingService: string; } interface GetOdaInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetOdaInstancesOdaInstance { /** * A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. */ attachmentIds: string[]; /** * A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments. */ attachmentTypes: string[]; /** * List the Digital Assistant instances that belong to this compartment. */ compartmentId: string; /** * URL for the connector's endpoint. */ connectorUrl: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of the Digital Assistant instance. */ description: string; /** * List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: `My new resource` */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique immutable identifier that was assigned when the instance was created. */ id: string; /** * If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain. */ identityAppConsoleUrl: string; /** * If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain. */ identityAppGuid: string; /** * If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain. */ identityDomain: string; /** * A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages. */ importedPackageIds: string[]; /** * A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages. */ importedPackageNames: string[]; /** * Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false) */ isRoleBasedAccess: boolean; /** * The current sub-state of the Digital Assistant instance. */ lifecycleSubState: string; /** * A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments. */ restrictedOperations: outputs.Oda.GetOdaInstancesOdaInstanceRestrictedOperation[]; /** * Shape or size of the instance. */ shapeName: string; /** * List only the Digital Assistant instances that are in this lifecycle state. */ state: string; /** * A message that describes the current state in more detail. For example, actionable information about an instance that's in the `FAILED` state. */ stateMessage: string; /** * When the Digital Assistant instance was created. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeCreated: string; /** * When the Digital Assistance instance was last updated. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeUpdated: string; /** * URL for the Digital Assistant web application that's associated with the instance. */ webAppUrl: string; } interface GetOdaInstancesOdaInstanceRestrictedOperation { /** * Name of the restricted operation. */ operationName: string; /** * Name of the service restricting the operation. */ restrictingService: string; } interface GetOdaPrivateEndpointAttachmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetOdaPrivateEndpointAttachmentsOdaPrivateEndpointAttachmentCollection { items: outputs.Oda.GetOdaPrivateEndpointAttachmentsOdaPrivateEndpointAttachmentCollectionItem[]; } interface GetOdaPrivateEndpointAttachmentsOdaPrivateEndpointAttachmentCollectionItem { /** * List the ODA Private Endpoint Attachments that belong to this compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint Attachment. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached ODA Instance. */ odaInstanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of ODA Private Endpoint. */ odaPrivateEndpointId: string; /** * List only the ODA Private Endpoint Attachments that are in this lifecycle state. */ state: string; /** * When the resource was created. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeCreated: string; /** * When the resource was last updated. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeUpdated: string; } interface GetOdaPrivateEndpointScanProxiesFilter { name: string; regex?: boolean; values: string[]; } interface GetOdaPrivateEndpointScanProxiesOdaPrivateEndpointScanProxyCollection { items: outputs.Oda.GetOdaPrivateEndpointScanProxiesOdaPrivateEndpointScanProxyCollectionItem[]; } interface GetOdaPrivateEndpointScanProxiesOdaPrivateEndpointScanProxyCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint Scan Proxy. */ id: string; /** * Unique ODA Private Endpoint identifier which is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ odaPrivateEndpointId: string; /** * The protocol used for communication between client, scanProxy and RAC's scan listeners */ protocol: string; /** * The FQDN/IPs and port information of customer's Real Application Cluster (RAC)'s SCAN listeners. */ scanListenerInfos: outputs.Oda.GetOdaPrivateEndpointScanProxiesOdaPrivateEndpointScanProxyCollectionItemScanListenerInfo[]; /** * Type indicating whether Scan listener is specified by its FQDN or list of IPs */ scanListenerType: string; /** * List only the ODA Private Endpoint Scan Proxies that are in this lifecycle state. */ state: string; /** * When the resource was created. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeCreated: string; } interface GetOdaPrivateEndpointScanProxiesOdaPrivateEndpointScanProxyCollectionItemScanListenerInfo { /** * FQDN of the customer's Real Application Cluster (RAC)'s SCAN listeners. */ scanListenerFqdn: string; /** * A SCAN listener's IP of the customer's Real Application Cluster (RAC). */ scanListenerIp: string; /** * The port that customer's Real Application Cluster (RAC)'s SCAN listeners are listening on. */ scanListenerPort: number; } interface GetOdaPrivateEndpointScanProxyScanListenerInfo { /** * FQDN of the customer's Real Application Cluster (RAC)'s SCAN listeners. */ scanListenerFqdn: string; /** * A SCAN listener's IP of the customer's Real Application Cluster (RAC). */ scanListenerIp: string; /** * The port that customer's Real Application Cluster (RAC)'s SCAN listeners are listening on. */ scanListenerPort: number; } interface GetOdaPrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetOdaPrivateEndpointsOdaPrivateEndpointCollection { items: outputs.Oda.GetOdaPrivateEndpointsOdaPrivateEndpointCollectionItem[]; } interface GetOdaPrivateEndpointsOdaPrivateEndpointCollectionItem { /** * List the ODA Private Endpoints that belong to this compartment. */ compartmentId: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of the ODA private endpoint. */ description: string; /** * List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. Example: `My new resource` */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type, or scope. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that was assigned when the ODA private endpoint was created. */ id: string; /** * List of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of [network security groups](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm) */ nsgIds: string[]; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * List only the ODA Private Endpoints that are in this lifecycle state. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to. */ subnetId: string; /** * When the resource was created. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeCreated: string; /** * When the resource was last updated. A date-time string as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeUpdated: string; } interface OdaInstanceRestrictedOperation { /** * Name of the restricted operation. */ operationName: string; /** * Name of the service restricting the operation. */ restrictingService: string; } interface OdaPrivateEndpointScanProxyScanListenerInfo { /** * FQDN of the customer's Real Application Cluster (RAC)'s SCAN listeners. */ scanListenerFqdn: string; /** * A SCAN listener's IP of the customer's Real Application Cluster (RAC). */ scanListenerIp: string; /** * The port that customer's Real Application Cluster (RAC)'s SCAN listeners are listening on. */ scanListenerPort: number; } } export declare namespace OneSubsription { interface GetAggregatedComputedUsagesAggregatedComputedUsage { /** * Aggregation of computed usages for the subscribed service. */ aggregatedComputedUsages: outputs.OneSubsription.GetAggregatedComputedUsagesAggregatedComputedUsageAggregatedComputedUsage[]; /** * Currency code */ currencyCode: string; /** * Product part number for subscribed service line, called parent product. */ parentProducts: outputs.OneSubsription.GetAggregatedComputedUsagesAggregatedComputedUsageParentProduct[]; /** * Subscribed service line parent id */ parentSubscribedServiceId: string; /** * Subscribed service asociated subscription plan number. */ planNumber: string; /** * Subscribed services pricing model */ pricingModel: string; /** * Inernal SPM Ratecard Id at line level */ rateCardId: string; /** * Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM. */ subscriptionId: string; /** * Subscribed services contract line end date, expressed in RFC 3339 timestamp format. */ timeEnd: string; /** * Subscribed services contract line start date, expressed in RFC 3339 timestamp format. */ timeStart: string; } interface GetAggregatedComputedUsagesAggregatedComputedUsageAggregatedComputedUsage { /** * Sum of Computed Line Amount rounded */ cost: string; /** * Sum of Computed Line Amount unrounded */ costUnrounded: string; /** * Data Center Attribute as sent by MQS to SPM. */ dataCenter: string; /** * Net Unit Price for the product in consideration. */ netUnitPrice: string; /** * Product description */ products: outputs.OneSubsription.GetAggregatedComputedUsagesAggregatedComputedUsageAggregatedComputedUsageProduct[]; /** * Total Quantity that was used for computation */ quantity: string; /** * Metered Service date , expressed in RFC 3339 timestamp format. */ timeMeteredOn: string; /** * Usage compute type in SPM. */ type: string; } interface GetAggregatedComputedUsagesAggregatedComputedUsageAggregatedComputedUsageProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Measure */ unitOfMeasure: string; } interface GetAggregatedComputedUsagesAggregatedComputedUsageParentProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Measure */ unitOfMeasure: string; } interface GetAggregatedComputedUsagesFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } interface GetBillingSchedulesBillingSchedule { /** * Billing schedule line net amount */ amount: string; /** * Indicates the associated AR Customer transaction id a unique identifier existing on AR. */ arCustomerTransactionId: string; /** * Indicates the associated AR Invoice Number */ arInvoiceNumber: string; /** * Billing frequency */ billingFrequency: string; /** * Billing schedule invoice status */ invoiceStatus: string; /** * Billing schedule net unit price */ netUnitPrice: string; /** * Order number associated with the Subscribed Service */ orderNumber: string; /** * Product description */ products: outputs.OneSubsription.GetBillingSchedulesBillingScheduleProduct[]; /** * Billing schedule quantity */ quantity: string; /** * This param is used to get only the billing schedules for a particular Subscribed Service */ subscribedServiceId: string; /** * Billing schedule end date */ timeEnd: string; /** * Billing schedule invoicing date */ timeInvoicing: string; /** * Billing schedule start date */ timeStart: string; } interface GetBillingSchedulesBillingScheduleProduct { /** * Product name */ name: string; /** * Indicates the associated AR Invoice Number */ partNumber: string; } interface GetBillingSchedulesFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } interface GetCommitmentsCommitment { /** * Commitment available amount */ availableAmount: string; /** * Funded Allocation line value example: 12000.00 */ fundedAllocationValue: string; /** * SPM internal Commitment ID */ id: string; /** * Commitment quantity */ quantity: string; /** * This param is used to get the commitments for a particular subscribed service */ subscribedServiceId: string; /** * Commitment end date */ timeEnd: string; /** * Commitment start date */ timeStart: string; /** * Commitment used amount */ usedAmount: string; } interface GetCommitmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetComputedUsageParentProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Messure */ unitOfMeasure: string; } interface GetComputedUsageProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Messure */ unitOfMeasure: string; } interface GetComputedUsagesComputedUsage { /** * Subscribed service commitmentId. */ commitmentServiceId: string; /** * SPM Internal compute records source . */ computeSource: string; computedUsageId: string; /** * Computed Line Amount not rounded */ cost: string; /** * Computed Line Amount rounded. */ costRounded: string; /** * Currency code */ currencyCode: string; /** * Data Center Attribute as sent by MQS to SPM. */ dataCenter: string; /** * SPM Internal computed usage Id , 32 character string */ id: string; /** * Invoicing status for the aggregated compute usage */ isInvoiced: boolean; /** * MQS Identfier send to SPM , SPM does not transform this attribute and is received as is. */ mqsMessageId: string; /** * Net Unit Price for the product in consideration, price actual. */ netUnitPrice: string; /** * SPM Internal Original usage Line number identifier in SPM coming from Metered Services entity. */ originalUsageNumber: string; /** * Product part number for subscribed service line, called parent product. */ parentProducts: outputs.OneSubsription.GetComputedUsagesComputedUsageParentProduct[]; /** * Subscribed service line parent id */ parentSubscribedServiceId: string; /** * Subscription plan number */ planNumber: string; /** * Product description */ products: outputs.OneSubsription.GetComputedUsagesComputedUsageProduct[]; /** * Total Quantity that was used for computation */ quantity: string; /** * Ratecard Id at subscribed service level */ rateCardId: string; /** * References the tier in the ratecard for that usage (OCI will be using the same reference to cross-reference for correctness on the usage csv report), comes from Entity OBSCNTR_IPT_PRODUCTTIER. */ rateCardTierdId: string; /** * Computed Usage created time, expressed in RFC 3339 timestamp format. */ timeCreated: string; /** * Metered Service date, expressed in RFC 3339 timestamp format. */ timeMeteredOn: string; /** * Usae computation date, expressed in RFC 3339 timestamp format. */ timeOfArrival: string; /** * Computed Usage updated time, expressed in RFC 3339 timestamp format. */ timeUpdated: string; /** * Usage compute type in SPM. */ type: string; /** * Unit of Messure */ unitOfMeasure: string; /** * SPM Internal usage Line number identifier in SPM coming from Metered Services entity. */ usageNumber: string; } interface GetComputedUsagesComputedUsageParentProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Messure */ unitOfMeasure: string; } interface GetComputedUsagesComputedUsageProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Messure */ unitOfMeasure: string; } interface GetComputedUsagesFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } interface GetInvoiceLineComputedUsagesFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } interface GetInvoiceLineComputedUsagesInvoicelineComputedUsage { /** * Sum of Usage/Service Billing Line net Amount */ cost: number; /** * Computed Line Amount rounded. */ costRounded: number; /** * Net Unit Price for the product in consideration, price actual. */ netUnitPrice: number; /** * Product description */ parentProducts: outputs.OneSubsription.GetInvoiceLineComputedUsagesInvoicelineComputedUsageParentProduct[]; /** * Product description */ products: outputs.OneSubsription.GetInvoiceLineComputedUsagesInvoicelineComputedUsageProduct[]; /** * Total Quantity that was used for computation */ quantity: number; /** * Metered Service date. */ timeMeteredOn: string; /** * Usage compute type in SPM. */ type: string; } interface GetInvoiceLineComputedUsagesInvoicelineComputedUsageParentProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Measure */ unitOfMeasure: string; } interface GetInvoiceLineComputedUsagesInvoicelineComputedUsageProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Measure */ unitOfMeasure: string; } interface GetInvoicesFilter { /** * Payment Term name */ name: string; regex?: boolean; values: string[]; } interface GetInvoicesInvoice { /** * AR Invoice Numbers comma separated under one invoice */ arInvoices: string; /** * Address. */ billToAddresses: outputs.OneSubsription.GetInvoicesInvoiceBillToAddress[]; /** * User. */ billToContacts: outputs.OneSubsription.GetInvoicesInvoiceBillToContact[]; /** * Business partner. */ billToCustomers: outputs.OneSubsription.GetInvoicesInvoiceBillToCustomer[]; /** * User that created the Payment term */ createdBy: string; /** * Currency details */ currencies: outputs.OneSubsription.GetInvoicesInvoiceCurrency[]; /** * Invoice Lines under particular invoice. */ invoiceLines: outputs.OneSubsription.GetInvoicesInvoiceInvoiceLine[]; /** * Organization details */ organizations: outputs.OneSubsription.GetInvoicesInvoiceOrganization[]; /** * Payment Method */ paymentMethod: string; /** * Payment Term details */ paymentTerms: outputs.OneSubsription.GetInvoicesInvoicePaymentTerm[]; /** * Receipt Method of Payment Mode */ receiptMethod: string; /** * SPM Document Number is an functional identifier for invoice in SPM */ spmInvoiceNumber: string; /** * Document Status in SPM which depicts current state of invoice */ status: string; /** * Invoice associated subscription plan number. */ subscriptionNumber: string; /** * SPM Invocie creation date */ timeCreated: string; /** * Invoice Date */ timeInvoiceDate: string; /** * SPM Invoice updated date */ timeUpdated: string; /** * Document Type in SPM like SPM Invoice,SPM Credit Memo etc., */ type: string; /** * User that updated SPM Invoice */ updatedBy: string; } interface GetInvoicesInvoiceBillToAddress { /** * Bill to site use Id. */ billSiteUseId: string; /** * Identify as the customer's billing address. */ isBillTo: boolean; /** * Identify as the customer's shipping address. */ isShipTo: boolean; /** * Address location. */ locations: outputs.OneSubsription.GetInvoicesInvoiceBillToAddressLocation[]; /** * Payment Term name */ name: string; /** * Phone. */ phone: string; /** * Service to site use Id. */ service2siteUseId: string; /** * TCA customer account site Id. */ tcaCustAcctSiteId: string; /** * Party site number. */ tcaPartySiteNumber: string; } interface GetInvoicesInvoiceBillToAddressLocation { /** * Address first line. */ address1: string; /** * Address second line. */ address2: string; /** * City. */ city: string; /** * Country. */ country: string; /** * Postal code. */ postalCode: string; /** * Region. */ region: string; /** * TCA Location identifier. */ tcaLocationId: string; } interface GetInvoicesInvoiceBillToContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Payment Term name */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * userName. */ userName: string; } interface GetInvoicesInvoiceBillToCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Payment Term name */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA customer account number. */ tcaCustomerAccountNumber: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetInvoicesInvoiceCurrency { /** * Currency Code */ isoCode: string; /** * Payment Term name */ name: string; /** * Standard Precision of the Currency */ stdPrecision: string; } interface GetInvoicesInvoiceInvoiceLine { /** * AR Invoice Number for Invoice Line */ arInvoiceNumber: string; /** * Data Center Attribute. */ dataCenter: string; /** * SPM Invoice Line internal identifier */ id: string; /** * Product description */ products: outputs.OneSubsription.GetInvoicesInvoiceInvoiceLineProduct[]; /** * Usage end time */ timeEnd: string; /** * Usage start time */ timeStart: string; } interface GetInvoicesInvoiceInvoiceLineProduct { /** * Metered service billing category */ billingCategory: string; /** * Payment Term name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Measure */ unitOfMeasure: string; } interface GetInvoicesInvoiceOrganization { /** * Payment Term name */ name: string; /** * Organization ID */ number: number; } interface GetInvoicesInvoicePaymentTerm { /** * User that created the Payment term */ createdBy: string; /** * Payment term Description */ description: string; /** * Payment term active flag */ isActive: boolean; /** * Payment Term name */ name: string; /** * SPM Invocie creation date */ timeCreated: string; /** * SPM Invoice updated date */ timeUpdated: string; /** * User that updated SPM Invoice */ updatedBy: string; /** * Payment Term value */ value: string; } interface GetOrganizationSubscriptionsFilter { /** * Currency name */ name: string; regex?: boolean; values: string[]; } interface GetOrganizationSubscriptionsOrganizationSubscription { /** * Currency details */ currencies: outputs.OneSubsription.GetOrganizationSubscriptionsOrganizationSubscriptionCurrency[]; /** * SPM internal Subscription ID */ id: string; /** * Customer friendly service name provided by PRG */ serviceName: string; /** * Status of the plan */ status: string; /** * Represents the date when the last service of the subscription ends */ timeEnd: string; /** * Represents the date when the first service of the subscription was activated */ timeStart: string; /** * Total aggregate TCLV of all lines for the subscription including expired, active, and signed */ totalValue: string; /** * Subscription Type i.e. IAAS,SAAS,PAAS */ type: string; } interface GetOrganizationSubscriptionsOrganizationSubscriptionCurrency { /** * Currency Code */ isoCode: string; /** * Currency name */ name: string; /** * Standard Precision of the Currency */ stdPrecision: string; } interface GetRatecardsFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } interface GetRatecardsRateCard { /** * Currency details */ currencies: outputs.OneSubsription.GetRatecardsRateCardCurrency[]; /** * Rate card discretionary discount percentage */ discretionaryDiscountPercentage: string; /** * Rate card price tier flag */ isTier: boolean; /** * Rate card tier net unit price */ netUnitPrice: string; /** * Rate card tier overage price */ overagePrice: string; /** * Product description */ products: outputs.OneSubsription.GetRatecardsRateCardProduct[]; /** * List of tiered rate card prices */ rateCardTiers: outputs.OneSubsription.GetRatecardsRateCardRateCardTier[]; /** * SPM internal Subscribed Service ID */ subscribedServiceId: string; /** * Rate card end date */ timeEnd: string; /** * Rate card start date */ timeStart: string; } interface GetRatecardsRateCardCurrency { /** * Currency Code */ isoCode: string; /** * Product name */ name: string; /** * Standard Precision of the Currency */ stdPrecision: string; } interface GetRatecardsRateCardProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * This param is used to get the rate card(s) filterd by the partNumber */ partNumber: string; /** * Product category */ productCategory: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of measure */ unitOfMeasure: string; } interface GetRatecardsRateCardRateCardTier { /** * Rate card tier net unit price */ netUnitPrice: string; /** * Rate card tier overage price */ overagePrice: string; /** * Rate card tier quantity range */ upToQuantity: string; } interface GetSubscribedServiceBillToAddress { /** * Bill to site use Id. */ billSiteUseId: string; /** * Identify as the customer shipping address. */ isBillTo: boolean; /** * Identify as the customer invoicing address. */ isShipTo: boolean; /** * Address location. */ locations: outputs.OneSubsription.GetSubscribedServiceBillToAddressLocation[]; /** * Commercial name also called customer name. */ name: string; /** * Phone. */ phone: string; /** * Service to site use Id. */ service2siteUseId: string; /** * TCA customer account site Id. */ tcaCustAcctSiteId: string; /** * Party site number. */ tcaPartySiteNumber: string; } interface GetSubscribedServiceBillToAddressLocation { /** * Address first line. */ address1: string; /** * Address second line. */ address2: string; /** * City. */ city: string; /** * Country. */ country: string; /** * Postal code. */ postalCode: string; /** * Region. */ region: string; /** * Region. */ tcaLocationId: string; } interface GetSubscribedServiceBillToContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Commercial name also called customer name. */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * Username. */ username: string; } interface GetSubscribedServiceBillToCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Commercial name also called customer name. */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account number. */ tcaCustAccountNumber: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetSubscribedServiceCommitmentService { /** * Commitment available amount */ availableAmount: string; /** * Funded Allocation line value example: 12000.00 */ fundedAllocationValue: string; /** * Subscribed service line net amount */ lineNetAmount: string; /** * Subscribed service quantity */ quantity: string; /** * Subscribed service end date */ timeEnd: string; /** * Subscribed service start date */ timeStart: string; } interface GetSubscribedServiceEndUserAddress { /** * Bill to site use Id. */ billSiteUseId: string; /** * Identify as the customer shipping address. */ isBillTo: boolean; /** * Identify as the customer invoicing address. */ isShipTo: boolean; /** * Address location. */ locations: outputs.OneSubsription.GetSubscribedServiceEndUserAddressLocation[]; /** * Commercial name also called customer name. */ name: string; /** * Phone. */ phone: string; /** * Service to site use Id. */ service2siteUseId: string; /** * TCA customer account site Id. */ tcaCustAcctSiteId: string; /** * Party site number. */ tcaPartySiteNumber: string; } interface GetSubscribedServiceEndUserAddressLocation { /** * Address first line. */ address1: string; /** * Address second line. */ address2: string; /** * City. */ city: string; /** * Country. */ country: string; /** * Postal code. */ postalCode: string; /** * Region. */ region: string; /** * Region. */ tcaLocationId: string; } interface GetSubscribedServiceEndUserContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Commercial name also called customer name. */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * Username. */ username: string; } interface GetSubscribedServiceEndUserCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Commercial name also called customer name. */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account number. */ tcaCustAccountNumber: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetSubscribedServicePaymentTerm { /** * User that created the Payment term */ createdBy: string; /** * Payment term Description */ description: string; /** * Payment term active flag */ isActive: boolean; /** * Commercial name also called customer name. */ name: string; /** * Subscribed service creation date */ timeCreated: string; /** * Subscribed service last update date */ timeUpdated: string; /** * User that updated the subscribed service */ updatedBy: string; /** * Payment Term value */ value: string; } interface GetSubscribedServiceProduct { /** * Metered service billing category */ billingCategory: string; /** * Commercial name also called customer name. */ name: string; /** * Product part numner */ partNumber: string; /** * Product category */ productCategory: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of measure */ unitOfMeasure: string; } interface GetSubscribedServiceRateCard { /** * Currency details */ currencies: outputs.OneSubsription.GetSubscribedServiceRateCardCurrency[]; /** * Rate card discretionary discount percentage */ discretionaryDiscountPercentage: string; /** * Rate card price tier flag */ isTier: boolean; /** * Rate card tier net unit price */ netUnitPrice: string; /** * Rate card tier overage price */ overagePrice: string; /** * Product description */ products: outputs.OneSubsription.GetSubscribedServiceRateCardProduct[]; /** * List of tiered rate card prices */ rateCardTiers: outputs.OneSubsription.GetSubscribedServiceRateCardRateCardTier[]; /** * The Subscribed Service Id */ subscribedServiceId: string; /** * Subscribed service end date */ timeEnd: string; /** * Subscribed service start date */ timeStart: string; } interface GetSubscribedServiceRateCardCurrency { /** * Currency Code */ isoCode: string; /** * Commercial name also called customer name. */ name: string; /** * Standard Precision of the Currency */ stdPrecision: string; } interface GetSubscribedServiceRateCardProduct { /** * Metered service billing category */ billingCategory: string; /** * Commercial name also called customer name. */ name: string; /** * Product part numner */ partNumber: string; /** * Product category */ productCategory: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of measure */ unitOfMeasure: string; } interface GetSubscribedServiceRateCardRateCardTier { /** * Rate card tier net unit price */ netUnitPrice: string; /** * Rate card tier overage price */ overagePrice: string; /** * Rate card tier quantity range */ upToQuantity: string; } interface GetSubscribedServiceResellerAddress { /** * Bill to site use Id. */ billSiteUseId: string; /** * Identify as the customer shipping address. */ isBillTo: boolean; /** * Identify as the customer invoicing address. */ isShipTo: boolean; /** * Address location. */ locations: outputs.OneSubsription.GetSubscribedServiceResellerAddressLocation[]; /** * Commercial name also called customer name. */ name: string; /** * Phone. */ phone: string; /** * Service to site use Id. */ service2siteUseId: string; /** * TCA customer account site Id. */ tcaCustAcctSiteId: string; /** * Party site number. */ tcaPartySiteNumber: string; } interface GetSubscribedServiceResellerAddressLocation { /** * Address first line. */ address1: string; /** * Address second line. */ address2: string; /** * City. */ city: string; /** * Country. */ country: string; /** * Postal code. */ postalCode: string; /** * Region. */ region: string; /** * Region. */ tcaLocationId: string; } interface GetSubscribedServiceResellerContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Commercial name also called customer name. */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * Username. */ username: string; } interface GetSubscribedServiceResellerCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Commercial name also called customer name. */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account number. */ tcaCustAccountNumber: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetSubscribedServiceServiceToAddress { /** * Bill to site use Id. */ billSiteUseId: string; /** * Identify as the customer shipping address. */ isBillTo: boolean; /** * Identify as the customer invoicing address. */ isShipTo: boolean; /** * Address location. */ locations: outputs.OneSubsription.GetSubscribedServiceServiceToAddressLocation[]; /** * Commercial name also called customer name. */ name: string; /** * Phone. */ phone: string; /** * Service to site use Id. */ service2siteUseId: string; /** * TCA customer account site Id. */ tcaCustAcctSiteId: string; /** * Party site number. */ tcaPartySiteNumber: string; } interface GetSubscribedServiceServiceToAddressLocation { /** * Address first line. */ address1: string; /** * Address second line. */ address2: string; /** * City. */ city: string; /** * Country. */ country: string; /** * Postal code. */ postalCode: string; /** * Region. */ region: string; /** * Region. */ tcaLocationId: string; } interface GetSubscribedServiceServiceToContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Commercial name also called customer name. */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * Username. */ username: string; } interface GetSubscribedServiceServiceToCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Commercial name also called customer name. */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account number. */ tcaCustAccountNumber: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetSubscribedServiceSoldToContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Commercial name also called customer name. */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * Username. */ username: string; } interface GetSubscribedServiceSoldToCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Commercial name also called customer name. */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account number. */ tcaCustAccountNumber: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetSubscribedServicesFilter { /** * Commercial name also called customer name. */ name: string; regex?: boolean; values: string[]; } interface GetSubscribedServicesSubscribedService { /** * Subscribed service admin email id */ adminEmail: string; /** * Subscribed service agreement ID */ agreementId: string; /** * Subscribed service agrrement name */ agreementName: string; /** * Subscribed service agrrement type */ agreementType: string; /** * Commitment available amount */ availableAmount: string; /** * Address. */ billToAddresses: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceBillToAddress[]; /** * User. */ billToContacts: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceBillToContact[]; /** * Business partner. */ billToCustomers: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceBillToCustomer[]; /** * Subscribed service invoice frequency */ billingFrequency: string; /** * Booking Opportunity Number of Subscribed Service */ bookingOptyNumber: string; /** * Subscribed service buyer email id */ buyerEmail: string; /** * Subscribed service commitment schedule Id */ commitmentScheduleId: string; /** * List of Commitment services of a line */ commitmentServices: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceCommitmentService[]; /** * User that created the Payment term */ createdBy: string; /** * Subscribed service credit percentage */ creditPercentage: string; /** * Subscribed service CSI number */ csi: string; /** * Identifier for a customer's transactions for purchase of ay oracle services */ customerTransactionReference: string; /** * Subscribed service data center */ dataCenter: string; /** * Subscribed service data center region */ dataCenterRegion: string; /** * Subscribed service eligible to renew field */ eligibleToRenew: string; /** * Address. */ endUserAddresses: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceEndUserAddress[]; /** * User. */ endUserContacts: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceEndUserContact[]; /** * Business partner. */ endUserCustomers: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceEndUserCustomer[]; /** * Subscribed service fulfillment set */ fulfillmentSet: string; /** * Funded Allocation line value example: 12000.00 */ fundedAllocationValue: string; /** * SPM internal Subscribed Service ID */ id: string; /** * Indicates if a service can recieve usages and consequently have available amounts computed */ isAllowance: boolean; /** * If true compares rate between ratecard and the active pricelist and minimum rate would be fetched */ isCapToPriceList: boolean; /** * Used in context of service credit lines */ isCreditEnabled: boolean; /** * Indicator on whether or not there has been usage for the subscribed service */ isHavingUsage: boolean; /** * Subscribed service intent to pay flag */ isIntentToPay: boolean; /** * Subscribed service payg flag */ isPayg: boolean; /** * Indicates if the Subscribed service has a single ratecard */ isSingleRateCard: boolean; /** * Indicates if the commitment lines can have different quantities */ isVariableCommitment: boolean; /** * Subscribed service line net amount */ lineNetAmount: string; /** * Subscribed service Major Set */ majorSet: string; /** * Rate card tier net unit price */ netUnitPrice: string; /** * Subscribed service operation type */ operationType: string; /** * Sales Order Header associated to the subscribed service */ orderHeaderId: string; /** * Order Line identifier at subscribed service level . This identifier is originated in Order Management module. Default is null. */ orderLineId: string; /** * Sales Order Line Number associated to the subscribed service */ orderLineNumber: number; /** * Sales Order Number associated to the subscribed service */ orderNumber: string; /** * Order Type of Subscribed Service */ orderType: string; /** * Subscribed service Promotion Amount */ originalPromoAmount: string; /** * Overage Bill To of Subscribed Service */ overageBillTo: string; /** * Subscribed service Overage Discount Percentage */ overageDiscountPercentage: string; /** * Overage Policy of Subscribed Service */ overagePolicy: string; /** * Subscribed service partner credit amount */ partnerCreditAmount: string; /** * This field contains the name of the partner to which the subscription belongs - depending on which the invoicing may differ */ partnerTransactionType: string; /** * Pay As You Go policy of Subscribed Service (Can be null - indicating no payg policy) */ paygPolicy: string; /** * Payment Method of Subscribed Service */ paymentMethod: string; /** * Payment Number of Subscribed Service */ paymentNumber: string; /** * Payment Term details */ paymentTerms: outputs.OneSubsription.GetSubscribedServicesSubscribedServicePaymentTerm[]; /** * Indicates the period for which the commitment amount can be utilised exceeding which the amount lapses. Also used in calculation of total contract line value */ pricePeriod: string; /** * Subscribed service pricing model */ pricingModel: string; /** * Product description */ products: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceProduct[]; /** * Subscribed service program type */ programType: string; /** * Not null if this service has an associated promotion line in SPM. Contains the line identifier from Order Management of the associated promo line. */ promoOrderLineId: string; /** * Subscribed service promotion type */ promoType: string; /** * Promotion Pricing Type of Subscribed Service (Can be null - indicating no promotion pricing) */ promotionPricingType: string; /** * Subscribed service provisioning source */ provisioningSource: string; /** * Subscribed service quantity */ quantity: string; /** * Subscribed service Rate Card Discount Percentage */ rateCardDiscountPercentage: string; /** * List of Rate Cards of a Subscribed Service */ rateCards: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceRateCard[]; /** * SPM Ratecard Type */ ratecardType: string; /** * Subscribed service Opportunity Id */ renewalOptyId: string; /** * Renewal Opportunity Number of Subscribed Service */ renewalOptyNumber: string; /** * Renewal Opportunity Type of Subscribed Service */ renewalOptyType: string; /** * SPM renewed Subscription ID */ renewedSubscribedServiceId: string; /** * Address. */ resellerAddresses: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceResellerAddress[]; /** * User. */ resellerContacts: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceResellerContact[]; /** * Business partner. */ resellerCustomers: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceResellerCustomer[]; /** * Subscribed service Revenue Line Id */ revenueLineId: string; /** * Revenue Line NUmber of Subscribed Service */ revenueLineNumber: string; /** * Subscribed service Revised ARR */ revisedArrInLc: string; /** * Subscribed service Revised ARR in Standard Currency */ revisedArrInSc: string; /** * Subscribed service sales account party id */ salesAccountPartyId: string; /** * Sales Channel of Subscribed Service */ salesChannel: string; /** * Subscribed service line number */ serialNumber: string; /** * Address. */ serviceToAddresses: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceServiceToAddress[]; /** * User. */ serviceToContacts: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceServiceToContact[]; /** * Business partner. */ serviceToCustomers: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceServiceToCustomer[]; /** * User. */ soldToContacts: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceSoldToContact[]; /** * Business partner. */ soldToCustomers: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceSoldToCustomer[]; /** * Subscribed service start date type */ startDateType: string; /** * This param is used to filter subscribed services based on its status */ status: string; /** * Line level Subscription Id */ subscriptionId: string; /** * Subscribed service source */ subscriptionSource: string; /** * Subscribed service System ARR */ systemArrInLc: string; /** * Subscribed service System ARR in Standard Currency */ systemArrInSc: string; /** * Subscribed service System ATR-ARR */ systemAtrArrInLc: string; /** * Subscribed service System ATR-ARR in Standard Currency */ systemAtrArrInSc: string; /** * Term value in Months */ termValue: string; /** * Term value UOM */ termValueUom: string; /** * Subscribed service agrrement end date */ timeAgreementEnd: string; /** * Subscribed service creation date */ timeCreated: string; /** * Subscribed service customer config date */ timeCustomerConfig: string; /** * Subscribed service end date */ timeEnd: string; /** * Subscribed service Major Set End date */ timeMajorsetEnd: string; /** * Subscribed service Major Set Start date */ timeMajorsetStart: string; /** * Subscribed service payment expiry date */ timePaymentExpiry: string; /** * Subscribed service provisioning date */ timeProvisioned: string; /** * Subscribed service service configuration email sent date */ timeServiceConfigurationEmailSent: string; /** * Subscribed service start date */ timeStart: string; /** * Subscribed service last update date */ timeUpdated: string; /** * Subscribed service welcome email sent date */ timeWelcomeEmailSent: string; /** * Subscribed service total value */ totalValue: string; /** * Subscribed service Transaction Extension Id */ transactionExtensionId: string; /** * Subscribed Service line type */ type: string; /** * User that updated the subscribed service */ updatedBy: string; /** * Subscribed service used amount */ usedAmount: string; } interface GetSubscribedServicesSubscribedServiceBillToAddress { /** * Bill to site use Id. */ billSiteUseId: string; /** * Identify as the customer shipping address. */ isBillTo: boolean; /** * Identify as the customer invoicing address. */ isShipTo: boolean; /** * Address location. */ locations: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceBillToAddressLocation[]; /** * Commercial name also called customer name. */ name: string; /** * Phone. */ phone: string; /** * Service to site use Id. */ service2siteUseId: string; /** * TCA customer account site Id. */ tcaCustAcctSiteId: string; /** * Party site number. */ tcaPartySiteNumber: string; } interface GetSubscribedServicesSubscribedServiceBillToAddressLocation { /** * Address first line. */ address1: string; /** * Address second line. */ address2: string; /** * City. */ city: string; /** * Country. */ country: string; /** * Postal code. */ postalCode: string; /** * Region. */ region: string; /** * Region. */ tcaLocationId: string; } interface GetSubscribedServicesSubscribedServiceBillToContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Commercial name also called customer name. */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * Username. */ username: string; } interface GetSubscribedServicesSubscribedServiceBillToCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Commercial name also called customer name. */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account number. */ tcaCustAccountNumber: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetSubscribedServicesSubscribedServiceCommitmentService { /** * Commitment available amount */ availableAmount: string; /** * Funded Allocation line value example: 12000.00 */ fundedAllocationValue: string; /** * Subscribed service line net amount */ lineNetAmount: string; /** * Subscribed service quantity */ quantity: string; /** * Subscribed service end date */ timeEnd: string; /** * Subscribed service start date */ timeStart: string; } interface GetSubscribedServicesSubscribedServiceEndUserAddress { /** * Bill to site use Id. */ billSiteUseId: string; /** * Identify as the customer shipping address. */ isBillTo: boolean; /** * Identify as the customer invoicing address. */ isShipTo: boolean; /** * Address location. */ locations: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceEndUserAddressLocation[]; /** * Commercial name also called customer name. */ name: string; /** * Phone. */ phone: string; /** * Service to site use Id. */ service2siteUseId: string; /** * TCA customer account site Id. */ tcaCustAcctSiteId: string; /** * Party site number. */ tcaPartySiteNumber: string; } interface GetSubscribedServicesSubscribedServiceEndUserAddressLocation { /** * Address first line. */ address1: string; /** * Address second line. */ address2: string; /** * City. */ city: string; /** * Country. */ country: string; /** * Postal code. */ postalCode: string; /** * Region. */ region: string; /** * Region. */ tcaLocationId: string; } interface GetSubscribedServicesSubscribedServiceEndUserContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Commercial name also called customer name. */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * Username. */ username: string; } interface GetSubscribedServicesSubscribedServiceEndUserCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Commercial name also called customer name. */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account number. */ tcaCustAccountNumber: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetSubscribedServicesSubscribedServicePaymentTerm { /** * User that created the Payment term */ createdBy: string; /** * Payment term Description */ description: string; /** * Payment term active flag */ isActive: boolean; /** * Commercial name also called customer name. */ name: string; /** * Subscribed service creation date */ timeCreated: string; /** * Subscribed service last update date */ timeUpdated: string; /** * User that updated the subscribed service */ updatedBy: string; /** * Payment Term value */ value: string; } interface GetSubscribedServicesSubscribedServiceProduct { /** * Metered service billing category */ billingCategory: string; /** * Commercial name also called customer name. */ name: string; /** * Product part numner */ partNumber: string; /** * Product category */ productCategory: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of measure */ unitOfMeasure: string; } interface GetSubscribedServicesSubscribedServiceRateCard { /** * Currency details */ currencies: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceRateCardCurrency[]; /** * Rate card discretionary discount percentage */ discretionaryDiscountPercentage: string; /** * Rate card price tier flag */ isTier: boolean; /** * Rate card tier net unit price */ netUnitPrice: string; /** * Rate card tier overage price */ overagePrice: string; /** * Product description */ products: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceRateCardProduct[]; /** * List of tiered rate card prices */ rateCardTiers: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceRateCardRateCardTier[]; /** * SPM internal Subscribed Service ID */ subscribedServiceId: string; /** * Subscribed service end date */ timeEnd: string; /** * Subscribed service start date */ timeStart: string; } interface GetSubscribedServicesSubscribedServiceRateCardCurrency { /** * Currency Code */ isoCode: string; /** * Commercial name also called customer name. */ name: string; /** * Standard Precision of the Currency */ stdPrecision: string; } interface GetSubscribedServicesSubscribedServiceRateCardProduct { /** * Metered service billing category */ billingCategory: string; /** * Commercial name also called customer name. */ name: string; /** * Product part numner */ partNumber: string; /** * Product category */ productCategory: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of measure */ unitOfMeasure: string; } interface GetSubscribedServicesSubscribedServiceRateCardRateCardTier { /** * Rate card tier net unit price */ netUnitPrice: string; /** * Rate card tier overage price */ overagePrice: string; /** * Rate card tier quantity range */ upToQuantity: string; } interface GetSubscribedServicesSubscribedServiceResellerAddress { /** * Bill to site use Id. */ billSiteUseId: string; /** * Identify as the customer shipping address. */ isBillTo: boolean; /** * Identify as the customer invoicing address. */ isShipTo: boolean; /** * Address location. */ locations: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceResellerAddressLocation[]; /** * Commercial name also called customer name. */ name: string; /** * Phone. */ phone: string; /** * Service to site use Id. */ service2siteUseId: string; /** * TCA customer account site Id. */ tcaCustAcctSiteId: string; /** * Party site number. */ tcaPartySiteNumber: string; } interface GetSubscribedServicesSubscribedServiceResellerAddressLocation { /** * Address first line. */ address1: string; /** * Address second line. */ address2: string; /** * City. */ city: string; /** * Country. */ country: string; /** * Postal code. */ postalCode: string; /** * Region. */ region: string; /** * Region. */ tcaLocationId: string; } interface GetSubscribedServicesSubscribedServiceResellerContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Commercial name also called customer name. */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * Username. */ username: string; } interface GetSubscribedServicesSubscribedServiceResellerCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Commercial name also called customer name. */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account number. */ tcaCustAccountNumber: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetSubscribedServicesSubscribedServiceServiceToAddress { /** * Bill to site use Id. */ billSiteUseId: string; /** * Identify as the customer shipping address. */ isBillTo: boolean; /** * Identify as the customer invoicing address. */ isShipTo: boolean; /** * Address location. */ locations: outputs.OneSubsription.GetSubscribedServicesSubscribedServiceServiceToAddressLocation[]; /** * Commercial name also called customer name. */ name: string; /** * Phone. */ phone: string; /** * Service to site use Id. */ service2siteUseId: string; /** * TCA customer account site Id. */ tcaCustAcctSiteId: string; /** * Party site number. */ tcaPartySiteNumber: string; } interface GetSubscribedServicesSubscribedServiceServiceToAddressLocation { /** * Address first line. */ address1: string; /** * Address second line. */ address2: string; /** * City. */ city: string; /** * Country. */ country: string; /** * Postal code. */ postalCode: string; /** * Region. */ region: string; /** * Region. */ tcaLocationId: string; } interface GetSubscribedServicesSubscribedServiceServiceToContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Commercial name also called customer name. */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * Username. */ username: string; } interface GetSubscribedServicesSubscribedServiceServiceToCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Commercial name also called customer name. */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account number. */ tcaCustAccountNumber: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetSubscribedServicesSubscribedServiceSoldToContact { /** * Email. */ email: string; /** * First name. */ firstName: string; /** * Last name. */ lastName: string; /** * Commercial name also called customer name. */ name: string; /** * TCA contact ID. */ tcaContactId: string; /** * TCA customer account site ID. */ tcaCustAccntSiteId: string; /** * TCA party ID. */ tcaPartyId: string; /** * Username. */ username: string; } interface GetSubscribedServicesSubscribedServiceSoldToCustomer { /** * Customer chain type. */ customerChainType: string; /** * The business partner is chain customer or not. */ isChainCustomer: boolean; /** * The business partner is part of the public sector or not. */ isPublicSector: boolean; /** * Commercial name also called customer name. */ name: string; /** * Phonetic name. */ namePhonetic: string; /** * TCA customer account number. */ tcaCustAccountNumber: string; /** * TCA customer account ID. */ tcaCustomerAccountId: string; /** * TCA party ID. */ tcaPartyId: string; /** * TCA party number. */ tcaPartyNumber: string; } interface GetSubscriptionsFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } interface GetSubscriptionsSubscription { /** * Currency details */ currencies: outputs.OneSubsription.GetSubscriptionsSubscriptionCurrency[]; /** * Hold reason of the plan */ holdReason: string; /** * Customer friendly service name provided by PRG */ serviceName: string; /** * Subscribed service status */ status: string; /** * List of Subscribed Services of the plan */ subscribedServices: outputs.OneSubsription.GetSubscriptionsSubscriptionSubscribedService[]; /** * Represents the date when the last service of the subscription ends */ timeEnd: string; /** * Represents the date of the hold release */ timeHoldReleaseEta: string; /** * Represents the date when the first service of the subscription was activated */ timeStart: string; } interface GetSubscriptionsSubscriptionCurrency { /** * Currency Code */ isoCode: string; /** * Product name */ name: string; /** * Standard Precision of the Currency */ stdPrecision: string; } interface GetSubscriptionsSubscriptionSubscribedService { /** * Commitment available amount */ availableAmount: string; /** * Booking Opportunity Number of Subscribed Service */ bookingOptyNumber: string; /** * List of Commitment services of a line */ commitmentServices: outputs.OneSubsription.GetSubscriptionsSubscriptionSubscribedServiceCommitmentService[]; /** * Subscribed service CSI number */ csi: string; /** * Subscribed service data center region */ dataCenterRegion: string; /** * Funded Allocation line value example: 12000.00 */ fundedAllocationValue: string; /** * SPM internal Subscribed Service ID */ id: string; /** * Subscribed service intent to pay flag */ isIntentToPay: boolean; /** * Subscribed service net unit price */ netUnitPrice: string; /** * Subscribed service operation type */ operationType: string; /** * Sales Order Number associated to the subscribed service */ orderNumber: string; /** * Subscribed service Promotion Amount */ originalPromoAmount: string; /** * This field contains the name of the partner to which the subscription belongs - depending on which the invoicing may differ */ partnerTransactionType: string; /** * Subscribed service pricing model */ pricingModel: string; /** * Product description */ products: outputs.OneSubsription.GetSubscriptionsSubscriptionSubscribedServiceProduct[]; /** * Subscribed service program type */ programType: string; /** * Subscribed service promotion type */ promoType: string; /** * Subscribed service quantity */ quantity: string; /** * Subscribed service status */ status: string; /** * Term value in Months */ termValue: string; /** * Term value UOM */ termValueUom: string; /** * Represents the date when the last service of the subscription ends */ timeEnd: string; /** * Represents the date when the first service of the subscription was activated */ timeStart: string; /** * Subscribed service total value */ totalValue: string; /** * Subscribed service used amount */ usedAmount: string; } interface GetSubscriptionsSubscriptionSubscribedServiceCommitmentService { /** * Commitment available amount */ availableAmount: string; /** * Funded Allocation line value example: 12000.00 */ fundedAllocationValue: string; /** * Commitment line net amount */ lineNetAmount: string; /** * Subscribed service quantity */ quantity: string; /** * Represents the date when the last service of the subscription ends */ timeEnd: string; /** * Represents the date when the first service of the subscription was activated */ timeStart: string; } interface GetSubscriptionsSubscriptionSubscribedServiceProduct { /** * Product name */ name: string; /** * Product part numner */ partNumber: string; /** * Product provisioning group */ provisioningGroup: string; /** * Unit of measure */ unitOfMeasure: string; } } export declare namespace Ons { interface GetNotificationTopicsFilter { /** * A filter to only return resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetNotificationTopicsNotificationTopic { /** * The endpoint for managing subscriptions or publishing messages to the topic. */ apiEndpoint: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the topic. */ description: string; /** * For optimistic concurrency control. See `if-match`. */ etag: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to only return resources that match the given id exactly. */ id: string; /** * A filter to only return resources that match the given name exactly. */ name: string; /** * A unique short topic Id. This is used only for SMS subscriptions. */ shortTopicId: string; /** * Filter returned list by specified lifecycle state. This parameter is case-insensitive. */ state: string; /** * The time the topic was created. */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId: string; } interface GetSubscriptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSubscriptionsSubscription { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The time when this suscription was created. */ createdTime: string; /** * 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"}` */ definedTags: { [key: string]: string; }; deliveryPolicies: outputs.Ons.GetSubscriptionsSubscriptionDeliveryPolicy[]; /** * A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol. Avoid entering confidential information. */ endpoint: string; /** * For optimistic concurrency control. See `if-match`. */ etag: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription. */ id: string; /** * The protocol used for the subscription. */ protocol: string; /** * The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE. */ state: string; /** * Return all subscriptions that are subscribed to the given topic OCID. Either this query parameter or the compartmentId query parameter must be set. */ topicId: string; } interface GetSubscriptionsSubscriptionDeliveryPolicy { backoffRetryPolicies: outputs.Ons.GetSubscriptionsSubscriptionDeliveryPolicyBackoffRetryPolicy[]; } interface GetSubscriptionsSubscriptionDeliveryPolicyBackoffRetryPolicy { /** * The maximum retry duration in milliseconds. */ maxRetryDuration: number; /** * The type of delivery policy. Default value: EXPONENTIAL. */ policyType: string; } } export declare namespace Opa { interface GetOpaInstanceAttachment { /** * * If role == `PARENT`, the attached instance was created by this service instance * * If role == `CHILD`, this instance was created from attached instance on behalf of a user */ isImplicit: boolean; /** * The OCID of the target instance (which could be any other Oracle Cloud Infrastructure PaaS/SaaS resource), to which this instance is attached. */ targetId: string; /** * The dataplane instance URL of the attached instance */ targetInstanceUrl: string; /** * The role of the target attachment. * * `PARENT` - The target instance is the parent of this attachment. * * `CHILD` - The target instance is the child of this attachment. */ targetRole: string; /** * The type of the target instance, such as "FUSION". */ targetServiceType: string; } interface GetOpaInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetOpaInstancesOpaInstanceCollection { items: outputs.Opa.GetOpaInstancesOpaInstanceCollectionItem[]; } interface GetOpaInstancesOpaInstanceCollectionItem { /** * A list of associated attachments to other services */ attachments: outputs.Opa.GetOpaInstancesOpaInstanceCollectionItemAttachment[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The entitlement used for billing purposes */ consumptionModel: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of the Process Automation instance. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * unique OpaInstance identifier */ id: string; idcsAt: string; /** * This property specifies the name of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain. */ identityAppDisplayName: string; /** * This property specifies the GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user role mappings to grant access to this OPA instance for users within the identity domain. */ identityAppGuid: string; /** * This property specifies the OPC Service Instance GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain. */ identityAppOpcServiceInstanceGuid: string; /** * This property specifies the domain url of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain. */ identityDomainUrl: string; /** * OPA Instance URL */ instanceUrl: string; /** * indicates if breakGlass is enabled for the opa instance. */ isBreakglassEnabled: boolean; /** * MeteringType Identifier */ meteringType: string; /** * Shape of the instance. */ shapeName: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time when OpaInstance was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the OpaInstance was updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetOpaInstancesOpaInstanceCollectionItemAttachment { /** * * If role == `PARENT`, the attached instance was created by this service instance * * If role == `CHILD`, this instance was created from attached instance on behalf of a user */ isImplicit: boolean; /** * The OCID of the target instance (which could be any other Oracle Cloud Infrastructure PaaS/SaaS resource), to which this instance is attached. */ targetId: string; /** * The dataplane instance URL of the attached instance */ targetInstanceUrl: string; /** * The role of the target attachment. * * `PARENT` - The target instance is the parent of this attachment. * * `CHILD` - The target instance is the child of this attachment. */ targetRole: string; /** * The type of the target instance, such as "FUSION". */ targetServiceType: string; } interface OpaInstanceAttachment { /** * * If role == `PARENT`, the attached instance was created by this service instance * * If role == `CHILD`, this instance was created from attached instance on behalf of a user */ isImplicit: boolean; /** * The OCID of the target instance (which could be any other Oracle Cloud Infrastructure PaaS/SaaS resource), to which this instance is attached. */ targetId: string; /** * The dataplane instance URL of the attached instance */ targetInstanceUrl: string; /** * The role of the target attachment. * * `PARENT` - The target instance is the parent of this attachment. * * `CHILD` - The target instance is the child of this attachment. */ targetRole: string; /** * The type of the target instance, such as "FUSION". */ targetServiceType: string; } } export declare namespace Opensearch { interface ClusterCertificateConfig { /** * (Updatable) Specifies whether the certificate to be used in cluster is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service. */ clusterCertificateMode: string; /** * (Updatable) Specifies whether the certificate to be used in dashboard is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service. */ dashboardCertificateMode: string; /** * (Updatable) certificate to be used for OpenSearch cluster api communication */ openSearchApiCertificateId: string; /** * (Updatable) certificate to be used for OpenSearch dashboard api communication */ openSearchDashboardCertificateId: string; } interface ClusterLoadBalancerConfig { /** * (Updatable) Maximum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service. */ loadBalancerMaxBandwidthInMbps: number; /** * (Updatable) Minimum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service. */ loadBalancerMinBandwidthInMbps: number; /** * (Updatable) Load balancer service for OpenSearch and OpenDashboard load balancer. Default value is LOAD_BALANCER. */ loadBalancerServiceType: string; } interface ClusterMaintenanceDetails { /** * End time of the maintenance activity */ endTime: string; /** * (Updatable) The Email IDs given by the customer to get notified about maintenance activities */ notificationEmailIds: string[]; /** * Start time of the maintenance activity */ startTime: string; /** * The current state of the cluster. */ state: string; } interface ClusterOutboundClusterConfig { /** * (Updatable) Flag to indicate whether outbound cluster configuration is enabled */ isEnabled: boolean; /** * (Updatable) List of outbound clusters to be connected to the inbound cluster */ outboundClusters: outputs.Opensearch.ClusterOutboundClusterConfigOutboundCluster[]; } interface ClusterOutboundClusterConfigOutboundCluster { /** * (Updatable) Name of the Outbound cluster. Avoid entering confidential information. */ displayName: string; /** * (Updatable) Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable */ isSkipUnavailable: boolean; /** * (Updatable) Mode for the cross cluster connection */ mode: string; /** * (Updatable) Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent. */ pingSchedule: string; /** * (Updatable) OCID of the Outbound cluster */ seedClusterId: string; } interface ClusterReverseConnectionEndpoint { /** * The IP addresses of the endpoint in customer VCN */ customerIp: string; /** * The NAT IP addresses of the endpoint in service VCN */ natIp: string; } interface ClusterSecuritySamlConfig { /** * The backend role of admins who have all permissions like local master user */ adminBackendRole: string; /** * The unique name for a identity provider entity */ idpEntityId: string; /** * The content of identity provider metadata */ idpMetadataContent: string; /** * A flag determine whether SAML is enabled */ isEnabled: boolean; /** * The endpoint of opendashboard */ opendashboardUrl: string; /** * The roles key is sued to get backend roles from SAML assertion */ rolesKey: string; /** * The subject key is used to get username from SAML assertion. By default, it is NameID */ subjectKey: string; } interface GetOpensearchClusterCertificateConfig { /** * Specifies whether the certificate to be used in cluster is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service. */ clusterCertificateMode: string; /** * Specifies whether the certificate to be used in dashboard is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service. */ dashboardCertificateMode: string; /** * certificate to be used for OpenSearch cluster api communication */ openSearchApiCertificateId: string; /** * certificate to be used for OpenSearch dashboard api communication */ openSearchDashboardCertificateId: string; } interface GetOpensearchClusterLoadBalancerConfig { /** * Maximum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service. */ loadBalancerMaxBandwidthInMbps: number; /** * Minimum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service. */ loadBalancerMinBandwidthInMbps: number; /** * Load balancer service for OpenSearch and OpenDashboard load balancer. Default value is LOAD_BALANCER. */ loadBalancerServiceType: string; } interface GetOpensearchClusterMaintenanceDetail { /** * End time of the maintenance activity */ endTime: string; /** * The Email Ids given the by customer to get notified about maintenance activities */ notificationEmailIds: string[]; /** * Start time of the maintenance activity */ startTime: string; /** * The current state of the cluster. */ state: string; } interface GetOpensearchClusterOutboundClusterConfig { /** * Flag to indicate whether outbound cluster configuration is enabled */ isEnabled: boolean; /** * List of outbound clusters to be connected to the inbound cluster */ outboundClusters: outputs.Opensearch.GetOpensearchClusterOutboundClusterConfigOutboundCluster[]; } interface GetOpensearchClusterOutboundClusterConfigOutboundCluster { /** * Name of the Outbound cluster. Avoid entering confidential information. */ displayName: string; /** * Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable */ isSkipUnavailable: boolean; /** * Mode for the cross cluster connection */ mode: string; /** * Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent. */ pingSchedule: string; /** * OCID of the Outbound cluster */ seedClusterId: string; } interface GetOpensearchClusterPipelineReverseConnectionEndpoint { /** * The fully qualified domain name of the customerIp in the customer VCN */ customerFqdn: string; /** * The IPv4 address in the customer VCN */ customerIp: string; } interface GetOpensearchClusterPipelinesFilter { name: string; regex?: boolean; values: string[]; } interface GetOpensearchClusterPipelinesOpensearchClusterPipelineCollection { items: outputs.Opensearch.GetOpensearchClusterPipelinesOpensearchClusterPipelineCollectionItem[]; } interface GetOpensearchClusterPipelinesOpensearchClusterPipelineCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \. */ dataPrepperConfigurationBody: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * unique OpensearchClusterPipeline identifier */ id: string; /** * The amount of memory in GB, for each pipeline node. */ memoryGb: number; /** * The number of nodes configured for the pipeline. */ nodeCount: number; /** * The pipeline node shape. */ nodeShape: string; /** * The OCID of the NSG where the pipeline private endpoint vnic will be attached. */ nsgId: string; /** * The number of OCPUs configured for each pipeline node. */ ocpuCount: number; opcDryRun: boolean; /** * The fully qualified domain name (FQDN) for the cluster's API endpoint. */ opensearchPipelineFqdn: string; /** * The pipeline's private IP address. */ opensearchPipelinePrivateIp: string; /** * The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \. */ pipelineConfigurationBody: string; /** * The current state of the pipeline. */ pipelineMode: string; /** * The customer IP and the corresponding fully qualified domain name that the pipeline will connect to. */ reverseConnectionEndpoints: outputs.Opensearch.GetOpensearchClusterPipelinesOpensearchClusterPipelineCollectionItemReverseConnectionEndpoint[]; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * The OCID for the compartment where the pipeline's subnet is located. */ subnetCompartmentId: string; /** * The OCID of the pipeline's subnet. */ subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cluster pipeline was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The amount of time in milliseconds since the pipeline was updated. */ timeUpdated: string; /** * The OCID for the compartment where the pipeline's VCN is located. */ vcnCompartmentId: string; /** * The OCID of the pipeline's VCN. */ vcnId: string; } interface GetOpensearchClusterPipelinesOpensearchClusterPipelineCollectionItemReverseConnectionEndpoint { /** * The fully qualified domain name of the customerIp in the customer VCN */ customerFqdn: string; /** * The IPv4 address in the customer VCN */ customerIp: string; } interface GetOpensearchClusterReverseConnectionEndpoint { /** * The IP addresses of the endpoint in customer VCN */ customerIp: string; /** * The NAT IP addresses of the endpoint in service VCN */ natIp: string; } interface GetOpensearchClusterSecuritySamlConfig { adminBackendRole: string; idpEntityId: string; idpMetadataContent: string; /** * Flag to indicate whether outbound cluster configuration is enabled */ isEnabled: boolean; opendashboardUrl: string; rolesKey: string; subjectKey: string; } interface GetOpensearchClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetOpensearchClustersOpensearchClusterCollection { items: outputs.Opensearch.GetOpensearchClustersOpensearchClusterCollectionItem[]; } interface GetOpensearchClustersOpensearchClusterCollectionItem { /** * The availability domains to distribute the cluser nodes across. */ availabilityDomains: string[]; /** * Custom certificate config for customer provided certs. */ certificateConfigs: outputs.Opensearch.GetOpensearchClustersOpensearchClusterCollectionItemCertificateConfig[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; configureOutboundClusterTrigger: number; /** * The number of coordinator nodes configured for the cluster. */ coordinatorNodeCount: number; /** * The amount of memory in GB, for the cluster's coordinator nodes. */ coordinatorNodeHostMemoryGb: number; /** * The number of OCPUs configured for the cluster's coordinator nodes. */ coordinatorNodeHostOcpuCount: number; /** * The node shape for the cluster's coordinator nodes. */ coordinatorNodeHostShape: string; /** * The instance type for the cluster's coordinator nodes. */ coordinatorNodeHostType: string; /** * The number of data nodes configured for the cluster. */ dataNodeCount: number; /** * The bare metal shape for the cluster's data nodes. */ dataNodeHostBareMetalShape: string; /** * The amount of memory in GB, for the cluster's data nodes. */ dataNodeHostMemoryGb: number; /** * The number of OCPUs configured for the cluster's data nodes. */ dataNodeHostOcpuCount: number; /** * The node shape for the cluster's data nodes. */ dataNodeHostShape: string; /** * The instance type for the cluster's data nodes. */ dataNodeHostType: string; /** * The amount of storage in GB, to configure per node for the cluster's data nodes. */ dataNodeStorageGb: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The fully qualified domain name (FQDN) for the cluster's API endpoint. */ fqdn: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * unique OpensearchCluster identifier */ id: string; /** * List of inbound clusters for which this cluster is an outbound cluster */ inboundClusterIds: string[]; /** * Additional information about the current lifecycle state of the cluster. */ lifecycleDetails: string; /** * This config is used to choose the load balancer service and bandwidth for OpenSearch and OpenDashboard load balancers. */ loadBalancerConfigs: outputs.Opensearch.GetOpensearchClustersOpensearchClusterCollectionItemLoadBalancerConfig[]; /** * Details for the maintenance activity. */ maintenanceDetails: outputs.Opensearch.GetOpensearchClustersOpensearchClusterCollectionItemMaintenanceDetail[]; /** * The number of master nodes configured for the cluster. */ masterNodeCount: number; /** * The bare metal shape for the cluster's master nodes. */ masterNodeHostBareMetalShape: string; /** * The amount of memory in GB, for the cluster's master nodes. */ masterNodeHostMemoryGb: number; /** * The number of OCPUs configured for cluster's master nodes. */ masterNodeHostOcpuCount: number; /** * The node shape for the cluster's master nodes. */ masterNodeHostShape: string; /** * The instance type for the cluster's master nodes. */ masterNodeHostType: string; /** * The number of ML nodes configured for the cluster. */ mlNodeCount: number; /** * The amount of memory in GB, for the cluster's ML nodes. */ mlNodeHostMemoryGb: number; /** * The number of OCPUs configured for the cluster's ML nodes. */ mlNodeHostOcpuCount: number; /** * The node shape for the cluster's ML nodes. */ mlNodeHostShape: string; /** * The instance type for the cluster's ML nodes. */ mlNodeHostType: string; /** * The amount of storage in GB, to configure per node for the cluster's ML nodes. */ mlNodeStorageGb: number; /** * The OCID of the NSG where the private endpoint vnic will be attached. */ nsgId: string; /** * The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint. */ opendashboardFqdn: string; /** * The number of OpenSearch Dashboard nodes configured for the cluster. */ opendashboardNodeCount: number; /** * The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes. */ opendashboardNodeHostMemoryGb: number; /** * The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes. */ opendashboardNodeHostOcpuCount: number; /** * The node shape for the cluster's OpenSearch Dashboard nodes. */ opendashboardNodeHostShape: string; /** * The private IP address for the cluster's OpenSearch Dashboard. */ opendashboardPrivateIp: string; /** * The fully qualified domain name (FQDN) for the cluster's API endpoint. */ opensearchFqdn: string; /** * The cluster's private IP address. */ opensearchPrivateIp: string; /** * This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster) */ outboundClusterConfigs: outputs.Opensearch.GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfig[]; /** * The customer IP addresses of the endpoint in customer VCN */ reverseConnectionEndpointCustomerIps: string[]; /** * The list of reverse connection endpoints. */ reverseConnectionEndpoints: outputs.Opensearch.GetOpensearchClustersOpensearchClusterCollectionItemReverseConnectionEndpoint[]; /** * The number of search nodes configured for the cluster. */ searchNodeCount: number; /** * The amount of memory in GB, for the cluster's search nodes. */ searchNodeHostMemoryGb: number; /** * The number of OCPUs configured for the cluster's search nodes. */ searchNodeHostOcpuCount: number; /** * The node shape for the cluster's search nodes. */ searchNodeHostShape: string; /** * The instance type for the cluster's search nodes. */ searchNodeHostType: string; /** * The amount of storage in GB, to configure per node for the cluster's search nodes. */ searchNodeStorageGb: number; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The name of the master user that are used to manage security config */ securityMasterUserName: string; /** * The password hash of the master user that are used to manage security config */ securityMasterUserPasswordHash: string; /** * The security mode of the cluster. */ securityMode: string; securitySamlConfigs: outputs.Opensearch.GetOpensearchClustersOpensearchClusterCollectionItemSecuritySamlConfig[]; /** * The software version the cluster is running. */ softwareVersion: string; /** * A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState. */ state: string; /** * The OCID for the compartment where the cluster's subnet is located. */ subnetCompartmentId: string; /** * The OCID of the cluster's subnet. */ subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The amount of time in milliseconds since the cluster was created. */ timeCreated: string; /** * The amount of time in milliseconds since the cluster was updated. */ timeDeleted: string; /** * The amount of time in milliseconds since the cluster was updated. */ timeUpdated: string; /** * The size in GB of the cluster's total storage. */ totalStorageGb: number; upgradeMajorVersionTrigger: number; /** * The OCID for the compartment where the cluster's VCN is located. */ vcnCompartmentId: string; /** * The OCID of the cluster's VCN. */ vcnId: string; } interface GetOpensearchClustersOpensearchClusterCollectionItemCertificateConfig { /** * Specifies whether the certificate to be used in cluster is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service. */ clusterCertificateMode: string; /** * Specifies whether the certificate to be used in dashboard is managed by OpenSearch or Oracle Cloud Infrastructure Certificates service. */ dashboardCertificateMode: string; /** * certificate to be used for OpenSearch cluster api communication */ openSearchApiCertificateId: string; /** * certificate to be used for OpenSearch dashboard api communication */ openSearchDashboardCertificateId: string; } interface GetOpensearchClustersOpensearchClusterCollectionItemLoadBalancerConfig { /** * Maximum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service. */ loadBalancerMaxBandwidthInMbps: number; /** * Minimum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service. */ loadBalancerMinBandwidthInMbps: number; /** * Load balancer service for OpenSearch and OpenDashboard load balancer. Default value is LOAD_BALANCER. */ loadBalancerServiceType: string; } interface GetOpensearchClustersOpensearchClusterCollectionItemMaintenanceDetail { /** * End time of the maintenance activity */ endTime: string; /** * The Email Ids given the by customer to get notified about maintenance activities */ notificationEmailIds: string[]; /** * Start time of the maintenance activity */ startTime: string; /** * A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState. */ state: string; } interface GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfig { /** * Flag to indicate whether outbound cluster configuration is enabled */ isEnabled: boolean; /** * List of outbound clusters to be connected to the inbound cluster */ outboundClusters: outputs.Opensearch.GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfigOutboundCluster[]; } interface GetOpensearchClustersOpensearchClusterCollectionItemOutboundClusterConfigOutboundCluster { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable */ isSkipUnavailable: boolean; /** * Mode for the cross cluster connection */ mode: string; /** * Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent. */ pingSchedule: string; /** * OCID of the Outbound cluster */ seedClusterId: string; } interface GetOpensearchClustersOpensearchClusterCollectionItemReverseConnectionEndpoint { /** * The IP addresses of the endpoint in customer VCN */ customerIp: string; /** * The NAT IP addresses of the endpoint in service VCN */ natIp: string; } interface GetOpensearchClustersOpensearchClusterCollectionItemSecuritySamlConfig { adminBackendRole: string; idpEntityId: string; idpMetadataContent: string; /** * Flag to indicate whether outbound cluster configuration is enabled */ isEnabled: boolean; opendashboardUrl: string; rolesKey: string; subjectKey: string; } interface GetOpensearchVersionItem { /** * The version of OpenSearch. */ version: string; } interface GetOpensearchVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetOpensearchVersionsOpensearchVersionsCollection { /** * A list of OpenSearch versions. */ items: outputs.Opensearch.GetOpensearchVersionsOpensearchVersionsCollectionItem[]; } interface GetOpensearchVersionsOpensearchVersionsCollectionItem { /** * The version of OpenSearch. */ version: string; } interface OpensearchClusterPipelineReverseConnectionEndpoint { /** * (Updatable) The fully qualified domain name of the customerIp in the customer VCN */ customerFqdn: string; /** * (Updatable) The IPv4 address in the customer VCN */ customerIp: string; } } export declare namespace OperatorAccessControl { interface GetAccessRequestApproverDetail { /** * The action done by the approver. */ approvalAction: string; /** * Additional message specified by the approver of the request. */ approvalAdditionalMessage: string; /** * Comment specified by the approver of the request. */ approvalComment: string; /** * The userId of the approver. */ approverId: string; /** * Time for when the access request should start that is authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeApprovedForAccess: string; /** * Time when the access request was authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeOfAuthorization: string; } interface GetAccessRequestExtensionApproverDetail { /** * The action done by the approver. */ approvalAction: string; /** * Additional message specified by the approver of the request. */ approvalAdditionalMessage: string; /** * Comment specified by the approver of the request. */ approvalComment: string; /** * The userId of the approver. */ approverId: string; /** * Time for when the access request should start that is authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeApprovedForAccess: string; /** * Time when the access request was authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeOfAuthorization: string; } interface GetAccessRequestHistoryItem { /** * List of operator actions for which approvals were requested by the operator. */ actionsLists: string[]; /** * Reason or description about the cause of change. */ description: string; /** * Duration for approval of request or extension depending on the type of action. */ duration: number; /** * Whether the access request was automatically approved. */ isAutoApproved: boolean; /** * The current state of the AccessRequest. */ state: string; /** * Time when the respective action happened in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeOfAction: string; /** * Approver who modified the access request. */ userId: string; } interface GetAccessRequestsAccessRequestCollection { items: outputs.OperatorAccessControl.GetAccessRequestsAccessRequestCollectionItem[]; } interface GetAccessRequestsAccessRequestCollectionItem { /** * Summary comment by the operator creating the access request. */ accessReasonSummary: string; /** * List of operator actions for which approval is sought by the operator user. */ actionRequestsLists: string[]; /** * The last recent Comment entered by the approver of the request. */ approverComment: string; /** * Contains the user ids who have approved the accessRequest for extension. */ approverDetails: outputs.OperatorAccessControl.GetAccessRequestsAccessRequestCollectionItemApproverDetail[]; /** * Specifies the type of auditing to be enabled. There are two levels of auditing: command-level and keystroke-level. By default, auditing is enabled at the command level i.e., each command issued by the operator is audited. When keystroke-level is chosen, in addition to command level logging, key strokes are also logged. */ auditTypes: string[]; /** * The comment entered by the operator while closing the request. */ closureComment: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. */ definedTags: { [key: string]: string; }; /** * Duration in hours for which access is sought on the target resource. */ duration: number; /** * Duration in hours for which extension access is sought on the target resource. */ extendDuration: number; /** * Contains the user ids who have approved the accessRequest for extension. */ extensionApproverDetails: outputs.OperatorAccessControl.GetAccessRequestsAccessRequestCollectionItemExtensionApproverDetail[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. */ freeformTags: { [key: string]: string; }; /** * The OCID of the access request. */ id: string; /** * Whether the access request was automatically approved. */ isAutoApproved: boolean; /** * Whether the access request was requested for Validate Assignment. */ isValidateAssignment: boolean; /** * more in detail about the lifeCycleState. */ lifecycleDetails: string; /** * Number of approvers who have authorized an access request. */ numberOfApprovers: number; /** * Number of approvers required to approve an access request. */ numberOfApproversRequired: number; /** * Number of approvers who have authorized an access request for extension. */ numberOfExtensionApprovers: number; /** * Additional message specific to the access request that can be specified by the approver at the time of approval. */ opctlAdditionalMessage: string; /** * The OCID of the operator control governing the target resource. */ opctlId: string; /** * Name of the Operator control governing the target resource. */ opctlName: string; /** * A unique identifier associated with the operator who raised the request. This identifier can not be used directly to identify the operator. You need to provide this identifier if you would like Oracle to provide additional information about the operator action within Oracle tenancy. */ operatorId: string; /** * Summary reason for which the operator is requesting access on the target resource. */ reason: string; /** * This is an automatic identifier generated by the system which is easier for human comprehension. */ requestId: string; /** * The OCID of the target resource associated with the access request. The operator raises an access request to get approval to access the target resource. */ resourceId: string; /** * A filter to return only resources that match the given ResourceName. */ resourceName: string; /** * A filter to return only lists of resources that match the entire given service type. */ resourceType: string; /** * Priority assigned to the access request by the operator */ severity: string; /** * A filter to return only resources whose lifecycleState matches the given AccessRequest lifecycleState. */ state: string; /** * The subresources requested for approval. */ subResourceLists: string[]; /** * System message that will be displayed to the operator at login to the target resource. */ systemMessage: string; /** * Time when the access request was created in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeOfCreation: string; /** * Time when the access request was last modified in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeOfModification: string; /** * The time when access request is scheduled to be approved in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeOfUserCreation: string; /** * Time in future when the user for the access request needs to be created in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeRequestedForFutureAccess: string; /** * The OCID of the user that last modified the access request. */ userId: string; /** * The OCID of the workflow associated with the access request. This is needed if you want to contact Oracle Support for a stuck access request or for an access request that encounters an internal error. */ workflowIds: string[]; } interface GetAccessRequestsAccessRequestCollectionItemApproverDetail { /** * The action done by the approver. */ approvalAction: string; /** * Additional message specified by the approver of the request. */ approvalAdditionalMessage: string; /** * Comment specified by the approver of the request. */ approvalComment: string; /** * The userId of the approver. */ approverId: string; /** * Time for when the access request should start that is authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeApprovedForAccess: string; /** * Time when the access request was authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeOfAuthorization: string; } interface GetAccessRequestsAccessRequestCollectionItemExtensionApproverDetail { /** * The action done by the approver. */ approvalAction: string; /** * Additional message specified by the approver of the request. */ approvalAdditionalMessage: string; /** * Comment specified by the approver of the request. */ approvalComment: string; /** * The userId of the approver. */ approverId: string; /** * Time for when the access request should start that is authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeApprovedForAccess: string; /** * Time when the access request was authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeOfAuthorization: string; } interface GetAccessRequestsFilter { name: string; regex?: boolean; values: string[]; } interface GetActionProperty { /** * Name of the property */ name: string; /** * value of the property */ value: string; } interface GetActionsFilter { /** * A filter to return only resources that match the entire display name given. */ name: string; regex?: boolean; values: string[]; } interface GetActionsOperatorActionCollection { items: outputs.OperatorAccessControl.GetActionsOperatorActionCollectionItem[]; } interface GetActionsOperatorActionCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId?: string; /** * Name of the infrastructure layer associated with the operator action. */ component: string; /** * Display Name of the operator action. */ customerDisplayName: string; /** * Description of the operator action in terms of associated risk profile, and characteristics of the operating system commands made available to the operator under this operator action. */ description: string; /** * Unique Oracle assigned identifier for the operator action. */ id: string; /** * A filter to return only resources that match the entire display name given. */ name: string; /** * Fine grained properties associated with the operator control. */ properties: outputs.OperatorAccessControl.GetActionsOperatorActionCollectionItemProperty[]; /** * A filter to return only lists of resources that match the entire given service type. */ resourceType: string; /** * A filter to return only resources whose lifecycleState matches the given OperatorAction lifecycleState. */ state?: string; } interface GetActionsOperatorActionCollectionItemProperty { /** * A filter to return only resources that match the entire display name given. */ name: string; /** * value of the property */ value: string; } interface GetControlAssignmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetControlAssignmentsOperatorControlAssignmentCollection { items: outputs.OperatorAccessControl.GetControlAssignmentsOperatorControlAssignmentCollectionItem[]; } interface GetControlAssignmentsOperatorControlAssignmentCollectionItem { /** * The OCID of the user who created this operator control assignment. */ assignerId: string; /** * Comment about the assignment of the operator control to this target resource. */ comment: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. */ definedTags: { [key: string]: string; }; /** * description containing reason for releasing of OperatorControl. */ detachmentDescription: string; /** * The code identifying the error occurred during Assignment operation. */ errorCode: number; /** * The message describing the error occurred during Assignment operation. */ errorMessage: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. */ freeformTags: { [key: string]: string; }; /** * The OCID of the operator control assignment. */ id: string; /** * The boolean if true would autoApprove during maintenance. */ isAutoApproveDuringMaintenance: boolean; /** * Whether the assignment is a default assignment. */ isDefaultAssignment: boolean; /** * If set, then the target resource is always governed by the operator control. */ isEnforcedAlways: boolean; /** * If set, then the hypervisor audit logs will be forwarded to the relevant remote syslog server */ isHypervisorLogForwarded: boolean; /** * If set indicates that the audit logs are being forwarded to the relevant remote logging server */ isLogForwarded: boolean; /** * More in detail about the lifeCycleState. */ lifecycleDetails: string; /** * Name of the operator control name associated. */ opControlName: string; /** * The OCID of the operator control. */ operatorControlId: string; /** * The address of the remote syslog server where the audit logs are being forwarded to. Address in host or IP format. */ remoteSyslogServerAddress: string; /** * The CA certificate of the remote syslog server. */ remoteSyslogServerCaCert: string; /** * The listening port of the remote syslog server. The port range is 0 - 65535. Only TCP supported. */ remoteSyslogServerPort: number; /** * The OCID of the compartment that contains the target resource. */ resourceCompartmentId: string; /** * The OCID of the target resource. */ resourceId: string; /** * A filter to return only resources that match the given ResourceName. */ resourceName: string; /** * A filter to return only lists of resources that match the entire given service type. */ resourceType: string; /** * A filter to return only resources whose lifecycleState matches the given OperatorControlAssignment lifecycleState. */ state: string; /** * The time at which the target resource will be brought under the governance of the operator control expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeAssignmentFrom: string; /** * The time at which the target resource will leave the governance of the operator control expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeAssignmentTo: string; /** * Time when the operator control assignment is created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeOfAssignment: string; /** * Time on which the operator control assignment was deleted in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeOfDeletion: string; /** * User id who released the operatorControl. */ unassignerId: string; validateAssignmentTrigger: number; } interface GetControlsFilter { name: string; regex?: boolean; values: string[]; } interface GetControlsOperatorControlCollection { items: outputs.OperatorAccessControl.GetControlsOperatorControlCollectionItem[]; } interface GetControlsOperatorControlCollectionItem { /** * List of operator actions that need explicit approval. Any operator action not in the pre-approved list will require explicit approval. Access requests associated with a resource governed by this operator control will be require explicit approval if the access request contains any operator action in this list. */ approvalRequiredOpActionLists: string[]; /** * List of user groups who can approve an access request associated with a target resource under the governance of this operator control. */ approverGroupsLists: string[]; /** * List of users who can approve an access request associated with a target resource under the governance of this operator control. */ approversLists: string[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. */ definedTags: { [key: string]: string; }; /** * Description of operator control. */ description: string; /** * List of emailId. */ emailIdLists: string[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. */ freeformTags: { [key: string]: string; }; /** * The OCID of the operator control. */ id: string; /** * Whether the operator control is a default Operator Control. */ isDefaultOperatorControl: boolean; /** * Whether all the operator actions have been pre-approved. If yes, all access requests associated with a resource governed by this operator control will be auto-approved. */ isFullyPreApproved: boolean; /** * Description associated with the latest modification of the operator control. */ lastModifiedInfo: string; /** * The OCID of the Oracle Cloud Infrastructure Notification topic to publish messages related to this operator control. */ notificationTopicId: string; /** * Number of approvers required to approve an access request. */ numberOfApprovers: number; /** * Name of the operator control. The name must be unique. */ operatorControlName: string; /** * List of pre-approved operator actions. Access requests associated with a resource governed by this operator control will be automatically approved if the access request only contain operator actions in the pre-approved list. */ preApprovedOpActionLists: string[]; /** * A filter to return only lists of resources that match the entire given service type. */ resourceType: string; /** * A filter to return only resources whose lifecycleState matches the given OperatorControl lifecycleState. */ state: string; /** * System message that would be displayed to the operator users on accessing the target resource under the governance of this operator control. */ systemMessage: string; /** * Time when the operator control was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeOfCreation: string; /** * Time when deleted expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z'. Note a deleted operator control still stays in the system, so that you can still audit operator actions associated with access requests raised on target resources governed by the deleted operator control. */ timeOfDeletion: string; /** * Time when the operator control was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeOfModification: string; } } export declare namespace Opsi { interface ChargebackPlanPlanCustomItem { /** * (Updatable) Indicates whether the chargeback plan customization item can be customized. */ isCustomizable: boolean; /** * (Updatable) Name of chargeback plan customization item. Example items for Exadata Insights Chargeback are statistic, percentile, infrastructureCost, additionalServerCost etc. */ name: string; /** * (Updatable) Value of chargeback plan customization item. */ value: string; } interface DatabaseInsightConnectionCredentialDetails { /** * Credential source name that had been added in Management Agent wallet. This value is only required when Credential set by CREDENTIALS_BY_SOURCE and is optional properties for ther others. */ credentialSourceName?: string; /** * Credential type. */ credentialType: string; /** * The credential [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) stored in management agent. */ namedCredentialId: string; /** * The secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) mapping to the database credentials. */ passwordSecretId?: string; /** * database user role. */ role: string; /** * database user name. */ userName?: string; } interface DatabaseInsightConnectionDetails { /** * Name of the listener host that will be used to create the connect string to the database. */ hostName: string; /** * List of hosts and port for private endpoint accessed database resource. */ hosts: outputs.Opsi.DatabaseInsightConnectionDetailsHost[]; /** * Listener port number used for connection requests. */ port: number; /** * Protocol used for connection requests for private endpoint accssed database resource. */ protocol: string; /** * Database service name used for connection requests. */ serviceName: string; } interface DatabaseInsightConnectionDetailsHost { /** * Host IP used for connection requests for Cloud DB resource. */ hostIp: string; /** * Listener port number used for connection requests for rivate endpoint accessed db resource. */ port: number; } interface DatabaseInsightCredentialDetails { /** * Credential source name that had been added in Management Agent wallet. This value is only required when credential set by CREDENTIALS_BY_SOURCE and is optional properties for the others. */ credentialSourceName?: string; /** * CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database. */ credentialType: string; /** * The credential [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) stored in the Management Agent to connect the Autonomous Database. */ namedCredentialId?: string; /** * The secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) mapping to the database credentials. */ passwordSecretId?: string; /** * database user role. */ role: string; /** * database user name. */ userName?: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database keystore contents are stored. This is used for TCPS support in BM/VM/ExaCS cases. */ walletSecretId?: string; } interface ExadataInsightChargebackPlanDetail { /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of OPSI Chargeback plan resource. */ planId: string; /** * Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION. */ planType: string; /** * The date and time the chargeback plan was enabled on the resource, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeEnabled: string; } interface ExadataInsightMemberVmClusterDetail { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint */ dbmPrivateEndpointId: string; /** * The autonomous databases that belong to the Autonomous VM Cluster */ memberAutonomousDetails: outputs.Opsi.ExadataInsightMemberVmClusterDetailMemberAutonomousDetail[]; /** * The databases that belong to the VM Cluster */ memberDatabaseDetails: outputs.Opsi.ExadataInsightMemberVmClusterDetailMemberDatabaseDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OPSI private endpoint */ opsiPrivateEndpointId: string; /** * Exadata VMCluster type */ vmClusterType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM Cluster. */ vmclusterId: string; } interface ExadataInsightMemberVmClusterDetailMemberAutonomousDetail { /** * (Updatable) Compartment Identifier of database */ compartmentId: string; /** * User credential details to connect to the database. */ connectionCredentialDetails: outputs.Opsi.ExadataInsightMemberVmClusterDetailMemberAutonomousDetailConnectionCredentialDetails; /** * Connection details to connect to the database. HostName, protocol, and port should be specified. */ connectionDetails: outputs.Opsi.ExadataInsightMemberVmClusterDetailMemberAutonomousDetailConnectionDetails; /** * User credential details to connect to the database. */ credentialDetails: outputs.Opsi.ExadataInsightMemberVmClusterDetailMemberAutonomousDetailCredentialDetails; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ databaseId: string; /** * Oracle Cloud Infrastructure database resource type */ databaseResourceType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Database Deployment Type */ deploymentType: string; /** * Source of the database entity. */ entitySource: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Flag is to identify if advanced features for autonomous database is enabled or not */ isAdvancedFeaturesEnabled: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent */ managementAgentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OPSI private endpoint */ opsiPrivateEndpointId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface ExadataInsightMemberVmClusterDetailMemberAutonomousDetailConnectionCredentialDetails { /** * Credential source name that had been added in Management Agent wallet. This value is only required when Credential set by CREDENTIALS_BY_SOURCE and is optional properties for ther others. */ credentialSourceName: string; /** * CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database. */ credentialType: string; /** * The credential [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) stored in management agent. */ namedCredentialId: string; /** * The secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) mapping to the database credentials. */ passwordSecretId: string; /** * database user role. */ role: string; /** * database user name. */ userName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database keystore contents are stored. This is used for TCPS support in BM/VM/ExaCS cases. */ walletSecretId: string; } interface ExadataInsightMemberVmClusterDetailMemberAutonomousDetailConnectionDetails { /** * Name of the listener host that will be used to create the connect string to the database. */ hostName: string; /** * Listener port number used for connection requests. */ port: number; /** * Protocol used for connection requests. */ protocol: string; /** * Database service name used for connection requests. */ serviceName: string; } interface ExadataInsightMemberVmClusterDetailMemberAutonomousDetailCredentialDetails { /** * Credential source name that had been added in Management Agent wallet. This value is only required when Credential set by CREDENTIALS_BY_SOURCE and is optional properties for ther others. */ credentialSourceName: string; /** * CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database. */ credentialType: string; /** * The credential [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) stored in management agent. */ namedCredentialId: string; /** * The secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) mapping to the database credentials. */ passwordSecretId: string; /** * database user role. */ role: string; /** * database user name. */ userName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database keystore contents are stored. This is used for TCPS support in BM/VM/ExaCS cases. */ walletSecretId: string; } interface ExadataInsightMemberVmClusterDetailMemberDatabaseDetail { /** * (Updatable) Compartment Identifier of database */ compartmentId: string; /** * User credential details to connect to the database. */ connectionCredentialDetails: outputs.Opsi.ExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionCredentialDetails; /** * Connection details to connect to the database. HostName, protocol, and port should be specified. */ connectionDetails: outputs.Opsi.ExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionDetails; /** * User credential details to connect to the database. */ credentialDetails: outputs.Opsi.ExadataInsightMemberVmClusterDetailMemberDatabaseDetailCredentialDetails; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database. */ databaseId: string; /** * Oracle Cloud Infrastructure database resource type */ databaseResourceType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint */ dbmPrivateEndpointId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Database Deployment Type (EXACS will be supported in the future) */ deploymentType: string; /** * Source of the database entity. */ entitySource: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent */ managementAgentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OPSI private endpoint */ opsiPrivateEndpointId: string; /** * Database service name used for connection requests. */ serviceName: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface ExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionCredentialDetails { /** * Credential source name that had been added in Management Agent wallet. This value is only required when Credential set by CREDENTIALS_BY_SOURCE and is optional properties for ther others. */ credentialSourceName: string; /** * CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database. */ credentialType: string; /** * The credential [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) stored in management agent. */ namedCredentialId: string; /** * The secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) mapping to the database credentials. */ passwordSecretId: string; /** * database user role. */ role: string; /** * database user name. */ userName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database keystore contents are stored. This is used for TCPS support in BM/VM/ExaCS cases. */ walletSecretId: string; } interface ExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionDetails { /** * Name of the listener host that will be used to create the connect string to the database. */ hostName: string; /** * List of hosts and port for private endpoint accessed database resource. */ hosts: outputs.Opsi.ExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionDetailsHost[]; /** * Listener port number used for connection requests. */ port: number; /** * Protocol used for connection requests for private endpoint accssed database resource. */ protocol: string; /** * Database service name used for connection requests. */ serviceName: string; } interface ExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionDetailsHost { /** * Host IP used for connection requests for Cloud DB resource. */ hostIp: string; /** * Listener port number used for connection requests for rivate endpoint accessed db resource. */ port: number; } interface ExadataInsightMemberVmClusterDetailMemberDatabaseDetailCredentialDetails { /** * Credential source name that had been added in Management Agent wallet. This value is only required when Credential set by CREDENTIALS_BY_SOURCE and is optional properties for ther others. */ credentialSourceName: string; /** * CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database. */ credentialType: string; /** * The credential [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) stored in management agent. */ namedCredentialId: string; /** * The secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) mapping to the database credentials. */ passwordSecretId: string; /** * database user role. */ role: string; /** * database user name. */ userName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database keystore contents are stored. This is used for TCPS support in BM/VM/ExaCS cases. */ walletSecretId: string; } interface GetAwrHubAwrSnapshotItem { /** * DatabaseId of the Source database for which AWR Data will be uploaded to AWR Hub. */ awrSourceDatabaseId: string; /** * The total number of errors. */ errorCount: string; /** * The database instance number. */ instanceNumber: number; /** * The identifier of the snapshot. */ snapshotIdentifier: number; /** * The timestamp of the database startup. */ timeDbStartup: string; /** * The start time of the snapshot. */ timeSnapshotBegin: string; /** * The end time of the snapshot. */ timeSnapshotEnd: string; } interface GetAwrHubAwrSnapshotsAwrSnapshotCollection { /** * A list of AWR snapshot summary data. */ items: outputs.Opsi.GetAwrHubAwrSnapshotsAwrSnapshotCollectionItem[]; } interface GetAwrHubAwrSnapshotsAwrSnapshotCollectionItem { /** * A list of AWR snapshot summary data. */ items: outputs.Opsi.GetAwrHubAwrSnapshotsAwrSnapshotCollectionItemItem[]; } interface GetAwrHubAwrSnapshotsAwrSnapshotCollectionItemItem { /** * DatabaseId of the Source database for which AWR Data will be uploaded to AWR Hub. */ awrSourceDatabaseId: string; /** * The total number of errors. */ errorCount: string; /** * The database instance number. */ instanceNumber: number; /** * The identifier of the snapshot. */ snapshotIdentifier: number; /** * The timestamp of the database startup. */ timeDbStartup: string; /** * The start time of the snapshot. */ timeSnapshotBegin: string; /** * The end time of the snapshot. */ timeSnapshotEnd: string; } interface GetAwrHubAwrSnapshotsFilter { name: string; regex?: boolean; values: string[]; } interface GetAwrHubAwrSourcesSummaryItem { /** * Unique Awr Hub identifier */ awrHubId: string; /** * DatabaseId of the Source database for which AWR Data will be uploaded to AWR Hub. */ awrSourceDatabaseId: string; /** * Number of hours since last AWR snapshots import happened from the Source database. */ hoursSinceLastImport: number; /** * The maximum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. */ maxSnapshotIdentifier: number; /** * The minimum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. */ minSnapshotIdentifier: number; /** * Name for an Awr source database */ name: string; /** * Number of AWR snapshots uploaded from the Source database. */ snapshotsUploaded: number; /** * The time at which the earliest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string */ timeFirstSnapshotGenerated: string; /** * The time at which the latest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string */ timeLastSnapshotGenerated: string; } interface GetAwrHubSourcesAwrHubSourceSummaryCollection { items: outputs.Opsi.GetAwrHubSourcesAwrHubSourceSummaryCollectionItem[]; } interface GetAwrHubSourcesAwrHubSourceSummaryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database id. */ associatedOpsiId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database id. */ associatedResourceId: string; /** * Unique Awr Hub identifier */ awrHubId: string; /** * The shorted string of the Awr Hub source database identifier. */ awrHubOpsiSourceId: string; /** * DatabaseId of the Source database for which AWR Data will be uploaded to AWR Hub. */ awrSourceDatabaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Number of hours since last AWR snapshots import happened from the Source database. */ hoursSinceLastImport: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Awr Hub source database. */ id: string; /** * This is `true` if the source databse is registered with a Awr Hub, otherwise `false` */ isRegisteredWithAwrHub: boolean; /** * The maximum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. */ maxSnapshotIdentifier: number; /** * The minimum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. */ minSnapshotIdentifier: number; /** * Awr Hub source database name */ name: string; /** * Opsi Mailbox URL based on the Awr Hub and Awr Hub source. */ sourceMailBoxUrl: string; /** * Lifecycle states */ state: string; /** * Resource Status */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time at which the resource was first created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time at which the earliest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string */ timeFirstSnapshotGenerated: string; /** * The time at which the latest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string */ timeLastSnapshotGenerated: string; /** * The time at which the resource was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * source type of the database */ type: string; } interface GetAwrHubSourcesFilter { /** * Awr Hub source database name */ name: string; regex?: boolean; values: string[]; } interface GetAwrHubsAwrHubSummaryCollection { items: outputs.Opsi.GetAwrHubsAwrHubSummaryCollectionItem[]; } interface GetAwrHubsAwrHubSummaryCollectionItem { /** * Mailbox URL required for AWR hub and AWR source setup. */ awrMailboxUrl: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Dst Time Zone Version of the AWR Hub */ hubDstTimezoneVersion: string; /** * Unique Awr Hub identifier */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Object Storage Bucket Name */ objectStorageBucketName: string; /** * Unique Operations Insights Warehouse identifier */ operationsInsightsWarehouseId: string; /** * Lifecycle states */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time at which the resource was first created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time at which the resource was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetAwrHubsFilter { name: string; regex?: boolean; values: string[]; } interface GetChargebackPlanPlanCustomItem { /** * Indicates whether the chargeback plan customization item can be customized. */ isCustomizable: boolean; /** * Name of chargeback plan customization item. Example items for Exadata Insights Chargeback are statistic, percentile, infrastructureCost, additionalServerCost etc. */ name: string; /** * Value of chargeback plan customization item. */ value: string; } interface GetChargebackPlansChargebackPlanCollection { items: outputs.Opsi.GetChargebackPlansChargebackPlanCollectionItem[]; } interface GetChargebackPlansChargebackPlanCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Source of the chargeback plan. */ entitySource: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of OPSI Chargeback plan resource. */ id: string; /** * Indicates whether the chargeback plan customization item can be customized. */ isCustomizable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Chargeback Plan category of the chargeback entity. It can be OOB, or CUSTOM. */ planCategory: string; /** * List of chargeback plan customizations. */ planCustomItems: outputs.Opsi.GetChargebackPlansChargebackPlanCollectionItemPlanCustomItem[]; /** * Description of OPSI Chargeback Plan. */ planDescription: string; /** * Name for the OPSI Chargeback plan. */ planName: string; /** * Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION. */ planType: string; /** * Chargeback Plan lifecycle states */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the chargeback plan was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The time chargeback plan was updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetChargebackPlansChargebackPlanCollectionItemPlanCustomItem { /** * Indicates whether the chargeback plan customization item can be customized. */ isCustomizable: boolean; /** * Name of chargeback plan customization item. Example items for Exadata Insights Chargeback are statistic, percentile, infrastructureCost, additionalServerCost etc. */ name: string; /** * Value of chargeback plan customization item. */ value: string; } interface GetChargebackPlansFilter { /** * Name of chargeback plan customization item. Example items for Exadata Insights Chargeback are statistic, percentile, infrastructureCost, additionalServerCost etc. */ name: string; regex?: boolean; values: string[]; } interface GetDatabaseInsightConnectionCredentialDetail { /** * Credential source name that had been added in Management Agent wallet. This is supplied in the External Database Service. */ credentialSourceName: string; /** * CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database. CREDENTIALS_BY_NAMED_CREDS is supplied by Management Agent service to connect for Macs Managed Cloud Database or Autonomous Database. */ credentialType: string; /** * The credential [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) stored in management agent. */ namedCredentialId: string; /** * The secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) mapping to the database credentials. */ passwordSecretId: string; /** * database user role. */ role: string; /** * database user name. */ userName: string; } interface GetDatabaseInsightConnectionDetail { /** * Name of the listener host that will be used to create the connect string to the database. */ hostName: string; /** * List of hosts and port for private endpoint accessed database resource. */ hosts: outputs.Opsi.GetDatabaseInsightConnectionDetailHost[]; /** * Listener port number used for connection requests. */ port: number; /** * Protocol used for connection requests for private endpoint accssed database resource. */ protocol: string; /** * Database service name used for connection requests. */ serviceName: string; } interface GetDatabaseInsightConnectionDetailHost { /** * Host IP used for connection requests for Cloud DB resource. */ hostIp: string; /** * Listener port number used for connection requests. */ port: number; } interface GetDatabaseInsightCredentialDetail { /** * Credential source name that had been added in Management Agent wallet. This is supplied in the External Database Service. */ credentialSourceName: string; /** * CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database. CREDENTIALS_BY_NAMED_CREDS is supplied by Management Agent service to connect for Macs Managed Cloud Database or Autonomous Database. */ credentialType: string; /** * The credential [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) stored in management agent. */ namedCredentialId: string; /** * The secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) mapping to the database credentials. */ passwordSecretId: string; /** * database user role. */ role: string; /** * database user name. */ userName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database keystore contents are stored. */ walletSecretId: string; } interface GetDatabaseInsightsDatabaseInsightsCollection { items: outputs.Opsi.GetDatabaseInsightsDatabaseInsightsCollectionItem[]; } interface GetDatabaseInsightsDatabaseInsightsCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * User credential details to connect to the database. */ connectionCredentialDetails: outputs.Opsi.GetDatabaseInsightsDatabaseInsightsCollectionItemConnectionCredentialDetail[]; /** * Connection details to connect to the database. HostName, protocol, and port should be specified. */ connectionDetails: outputs.Opsi.GetDatabaseInsightsDatabaseInsightsCollectionItemConnectionDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of External Database Connector */ connectorId: string; /** * User credential details to connect to the database. */ credentialDetails: outputs.Opsi.GetDatabaseInsightsDatabaseInsightsCollectionItemCredentialDetail[]; /** * A message describing the status of the database connection of this resource. For example, it can be used to provide actionable information about the permission and content validity of the database connection. */ databaseConnectionStatusDetails: string; /** * (Required when entity_source=EXTERNAL_MYSQL_DATABASE_SYSTEM) (Updatable) The DBM owned database connector [OCID](https://www.terraform.io/iaas/database-management/doc/view-connector-details.html) mapping to the database credentials and connection details. */ databaseConnectorId: string; /** * Display name of database */ databaseDisplayName: string; /** * Optional list of database [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity. */ databaseId: string; /** * Name of database */ databaseName: string; /** * Oracle Cloud Infrastructure database resource type */ databaseResourceType: string; /** * Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. */ databaseType: string; /** * The version of the database. */ databaseVersion: string; dbmPrivateEndpointId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; deploymentType: string; /** * Unique Enterprise Manager bridge identifier */ enterpriseManagerBridgeId: string; /** * Enterprise Manager Entity Display Name */ enterpriseManagerEntityDisplayName: string; /** * Enterprise Manager Entity Unique Identifier */ enterpriseManagerEntityIdentifier: string; /** * Enterprise Manager Entity Name */ enterpriseManagerEntityName: string; /** * Enterprise Manager Entity Type */ enterpriseManagerEntityType: string; /** * Enterprise Manager Unqiue Identifier */ enterpriseManagerIdentifier: string; /** * Source of the database entity. */ entitySource: string; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource. */ exadataInsightId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Optional list of database insight resource [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * Flag is to identify if advanced features for autonomous database is enabled or not */ isAdvancedFeaturesEnabled: boolean; /** * Specifies if MYSQL DB System has heatwave cluster attached. */ isHeatWaveClusterAttached: boolean; /** * Specifies if MYSQL DB System is highly available. */ isHighlyAvailable: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; managementAgentId: string; /** * Unique Operations Insights PrivateEndpoint identifier */ opsiPrivateEndpointId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM Cluster or DB System ID, depending on which configuration the resource belongs to. */ parentId: string; /** * Processor count. This is the OCPU count for Autonomous Database and CPU core count for other database types. */ processorCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Infrastructure. */ rootId: string; /** * Database service name used for connection requests. */ serviceName: string; /** * Lifecycle states */ state: string; /** * Resource Status */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the database insight was first enabled. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the database insight was updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetDatabaseInsightsDatabaseInsightsCollectionItemConnectionCredentialDetail { /** * Credential source name that had been added in Management Agent wallet. This value is only required when Credential set by CREDENTIALS_BY_SOURCE and is optional properties for the others. */ credentialSourceName: string; /** * CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database. CREDENTIALS_BY_NAMED_CREDS is supplied by Management Agent service to connect for Macs Managed Cloud Database or Autonomous Database. */ credentialType: string; /** * The credential [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) stored in management agent. */ namedCredentialId: string; /** * The secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) mapping to the database credentials. */ passwordSecretId: string; /** * database user role. */ role: string; /** * database user name. */ userName: string; } interface GetDatabaseInsightsDatabaseInsightsCollectionItemConnectionDetail { /** * Name of the listener host that will be used to create the connect string to the database. */ hostName: string; /** * List of hosts and port for private endpoint accessed database resource. */ hosts: outputs.Opsi.GetDatabaseInsightsDatabaseInsightsCollectionItemConnectionDetailHost[]; /** * Listener port number used for connection requests. */ port: number; /** * Protocol used for connection requests for private endpoint accssed database resource. */ protocol: string; /** * Database service name used for connection requests. */ serviceName: string; } interface GetDatabaseInsightsDatabaseInsightsCollectionItemConnectionDetailHost { /** * Host IP used for connection requests for Cloud DB resource. */ hostIp: string; /** * Listener port number used for connection requests. */ port: number; } interface GetDatabaseInsightsDatabaseInsightsCollectionItemCredentialDetail { /** * Credential source name that had been added in Management Agent wallet. This value is only required when Credential set by CREDENTIALS_BY_SOURCE and is optional properties for the others. */ credentialSourceName: string; /** * CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database. CREDENTIALS_BY_NAMED_CREDS is supplied by Management Agent service to connect for Macs Managed Cloud Database or Autonomous Database. */ credentialType: string; /** * The credential [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) stored in management agent. */ namedCredentialId: string; /** * The secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) mapping to the database credentials. */ passwordSecretId: string; /** * database user role. */ role: string; /** * database user name. */ userName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Secret where the database keystore contents are stored. */ walletSecretId: string; } interface GetDatabaseInsightsFilter { name: string; regex?: boolean; values: string[]; } interface GetEnterpriseManagerBridgesEnterpriseManagerBridgeCollection { items: outputs.Opsi.GetEnterpriseManagerBridgesEnterpriseManagerBridgeCollectionItem[]; } interface GetEnterpriseManagerBridgesEnterpriseManagerBridgeCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of Enterprise Manager Bridge */ description: string; /** * A filter to return only resources that match the entire display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique Enterprise Manager bridge identifier */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Object Storage Bucket Name */ objectStorageBucketName: string; /** * A message describing status of the object storage bucket of this resource. For example, it can be used to provide actionable information about the permission and content validity of the bucket. */ objectStorageBucketStatusDetails: string; /** * Object Storage Namespace Name */ objectStorageNamespaceName: string; /** * Lifecycle states */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the Enterprise Manager bridge was first created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Enterprise Manager bridge was updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetEnterpriseManagerBridgesFilter { name: string; regex?: boolean; values: string[]; } interface GetExadataInsightChargebackPlanDetail { /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of OPSI Chargeback plan resource. */ planId: string; /** * Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION. */ planType: string; /** * The date and time the chargeback plan was enabled on the resource, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeEnabled: string; } interface GetExadataInsightMemberVmClusterDetail { /** * Compartment identifier of the Exadata insight resource */ compartmentId: string; dbmPrivateEndpointId: string; memberAutonomousDetails: outputs.Opsi.GetExadataInsightMemberVmClusterDetailMemberAutonomousDetail[]; memberDatabaseDetails: outputs.Opsi.GetExadataInsightMemberVmClusterDetailMemberDatabaseDetail[]; opsiPrivateEndpointId: string; vmClusterType: string; vmclusterId: string; } interface GetExadataInsightMemberVmClusterDetailMemberAutonomousDetail { /** * Compartment identifier of the Exadata insight resource */ compartmentId: string; connectionCredentialDetails: outputs.Opsi.GetExadataInsightMemberVmClusterDetailMemberAutonomousDetailConnectionCredentialDetail[]; connectionDetails: outputs.Opsi.GetExadataInsightMemberVmClusterDetailMemberAutonomousDetailConnectionDetail[]; credentialDetails: outputs.Opsi.GetExadataInsightMemberVmClusterDetailMemberAutonomousDetailCredentialDetail[]; databaseId: string; databaseResourceType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; deploymentType: string; /** * Source of the Exadata system. */ entitySource: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; isAdvancedFeaturesEnabled: boolean; managementAgentId: string; opsiPrivateEndpointId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetExadataInsightMemberVmClusterDetailMemberAutonomousDetailConnectionCredentialDetail { credentialSourceName: string; credentialType: string; namedCredentialId: string; passwordSecretId: string; role: string; userName: string; walletSecretId: string; } interface GetExadataInsightMemberVmClusterDetailMemberAutonomousDetailConnectionDetail { hostName: string; port: number; protocol: string; serviceName: string; } interface GetExadataInsightMemberVmClusterDetailMemberAutonomousDetailCredentialDetail { credentialSourceName: string; credentialType: string; namedCredentialId: string; passwordSecretId: string; role: string; userName: string; walletSecretId: string; } interface GetExadataInsightMemberVmClusterDetailMemberDatabaseDetail { /** * Compartment identifier of the Exadata insight resource */ compartmentId: string; connectionCredentialDetails: outputs.Opsi.GetExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionCredentialDetail[]; connectionDetails: outputs.Opsi.GetExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionDetail[]; credentialDetails: outputs.Opsi.GetExadataInsightMemberVmClusterDetailMemberDatabaseDetailCredentialDetail[]; databaseId: string; databaseResourceType: string; dbmPrivateEndpointId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; deploymentType: string; /** * Source of the Exadata system. */ entitySource: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; managementAgentId: string; opsiPrivateEndpointId: string; serviceName: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionCredentialDetail { credentialSourceName: string; credentialType: string; namedCredentialId: string; passwordSecretId: string; role: string; userName: string; walletSecretId: string; } interface GetExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionDetail { hostName: string; hosts: outputs.Opsi.GetExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionDetailHost[]; port: number; protocol: string; serviceName: string; } interface GetExadataInsightMemberVmClusterDetailMemberDatabaseDetailConnectionDetailHost { hostIp: string; port: number; } interface GetExadataInsightMemberVmClusterDetailMemberDatabaseDetailCredentialDetail { credentialSourceName: string; credentialType: string; namedCredentialId: string; passwordSecretId: string; role: string; userName: string; walletSecretId: string; } interface GetExadataInsightsExadataInsightSummaryCollection { items: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItem[]; } interface GetExadataInsightsExadataInsightSummaryCollectionItem { /** * Object containing chargeback plan details */ chargebackPlanDetails: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemChargebackPlanDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Unique Enterprise Manager bridge identifier */ enterpriseManagerBridgeId: string; /** * Enterprise Manager Entity Display Name */ enterpriseManagerEntityDisplayName: string; /** * Enterprise Manager Entity Unique Identifier */ enterpriseManagerEntityIdentifier: string; /** * Enterprise Manager Entity Name */ enterpriseManagerEntityName: string; /** * Enterprise Manager Entity Type */ enterpriseManagerEntityType: string; /** * Enterprise Manager Unique Identifier */ enterpriseManagerIdentifier: string; /** * Source of the Exadata system. */ entitySource: string; /** * The user-friendly name for the Exadata system. The name does not have to be unique. */ exadataDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Infrastructure. */ exadataInfraId: string; /** * Oracle Cloud Infrastructure exadata infrastructure resource type */ exadataInfraResourceType: string; /** * The Exadata system name. If the Exadata systems managed by Enterprise Manager, the name is unique amongst the Exadata systems managed by the same Enterprise Manager. */ exadataName: string; /** * Exadata rack type. */ exadataRackType: string; /** * The shape of the Exadata Infrastructure. */ exadataShape: string; /** * Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. */ exadataType: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Optional list of Exadata insight resource [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * Set to true to enable automatic enablement and disablement of related targets from Enterprise Manager. New resources (e.g. Database Insights) will be placed in the same compartment as the related Exadata Insight. This should be always set true when using terraform, when it is set to false member associations may be missing from the application. */ isAutoSyncEnabled: boolean; /** * true if virtualization is used in the Exadata system */ isVirtualizedExadata: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; memberVmClusterDetails: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetail[]; /** * Lifecycle states */ state: string; /** * Resource Status */ status: string; /** * A message describing the status of the Exadata Resource. For example, it can be used to provide actionable information about the policies needed to access the Exadata Resource. */ statusDetails: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the Exadata insight was first enabled. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Exadata insight was updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetExadataInsightsExadataInsightSummaryCollectionItemChargebackPlanDetail { /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of OPSI Chargeback plan resource. */ planId: string; /** * Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION. */ planType: string; /** * The date and time the chargeback plan was enabled on the resource, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeEnabled: string; } interface GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; dbmPrivateEndpointId: string; memberAutonomousDetails: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberAutonomousDetail[]; memberDatabaseDetails: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberDatabaseDetail[]; opsiPrivateEndpointId: string; vmClusterType: string; vmclusterId: string; } interface GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberAutonomousDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; connectionCredentialDetails: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberAutonomousDetailConnectionCredentialDetail[]; connectionDetails: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberAutonomousDetailConnectionDetail[]; credentialDetails: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberAutonomousDetailCredentialDetail[]; databaseId: string; databaseResourceType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; deploymentType: string; /** * Source of the Exadata system. */ entitySource: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; isAdvancedFeaturesEnabled: boolean; managementAgentId: string; opsiPrivateEndpointId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberAutonomousDetailConnectionCredentialDetail { credentialSourceName: string; credentialType: string; namedCredentialId: string; passwordSecretId: string; role: string; userName: string; walletSecretId: string; } interface GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberAutonomousDetailConnectionDetail { hostName: string; port: number; protocol: string; serviceName: string; } interface GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberAutonomousDetailCredentialDetail { credentialSourceName: string; credentialType: string; namedCredentialId: string; passwordSecretId: string; role: string; userName: string; walletSecretId: string; } interface GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberDatabaseDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; connectionCredentialDetails: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberDatabaseDetailConnectionCredentialDetail[]; connectionDetails: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberDatabaseDetailConnectionDetail[]; credentialDetails: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberDatabaseDetailCredentialDetail[]; databaseId: string; databaseResourceType: string; dbmPrivateEndpointId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; deploymentType: string; /** * Source of the Exadata system. */ entitySource: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; managementAgentId: string; opsiPrivateEndpointId: string; serviceName: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberDatabaseDetailConnectionCredentialDetail { credentialSourceName: string; credentialType: string; namedCredentialId: string; passwordSecretId: string; role: string; userName: string; walletSecretId: string; } interface GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberDatabaseDetailConnectionDetail { hostName: string; hosts: outputs.Opsi.GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberDatabaseDetailConnectionDetailHost[]; port: number; protocol: string; serviceName: string; } interface GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberDatabaseDetailConnectionDetailHost { hostIp: string; port: number; } interface GetExadataInsightsExadataInsightSummaryCollectionItemMemberVmClusterDetailMemberDatabaseDetailCredentialDetail { credentialSourceName: string; credentialType: string; namedCredentialId: string; passwordSecretId: string; role: string; userName: string; walletSecretId: string; } interface GetExadataInsightsFilter { name: string; regex?: boolean; values: string[]; } interface GetHostInsightsFilter { name: string; regex?: boolean; values: string[]; } interface GetHostInsightsHostInsightSummaryCollection { items: outputs.Opsi.GetHostInsightsHostInsightSummaryCollectionItem[]; } interface GetHostInsightsHostInsightSummaryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Compute Instance */ computeId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Unique Enterprise Manager bridge identifier */ enterpriseManagerBridgeId: string; /** * Enterprise Manager Entity Display Name */ enterpriseManagerEntityDisplayName: string; /** * Enterprise Manager Entity Unique Identifier */ enterpriseManagerEntityIdentifier: string; /** * Enterprise Manager Entity Name */ enterpriseManagerEntityName: string; /** * Enterprise Manager Entity Type */ enterpriseManagerEntityType: string; /** * Enterprise Manager Unique Identifier */ enterpriseManagerIdentifier: string; /** * Source of the host entity. */ entitySource: string; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource. */ exadataInsightId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The user-friendly name for the host. The name does not have to be unique. */ hostDisplayName: string; /** * The host name. The host name is unique amongst the hosts managed by the same management agent. */ hostName: string; /** * Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST */ hostType: string; /** * Optional list of host insight resource [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent */ managementAgentId: string; /** * Platform name. */ platformName: string; /** * Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX]. */ platformType: string; /** * Platform version. */ platformVersion: string; /** * Processor count. This is the OCPU count for Autonomous Database and CPU core count for other database types. */ processorCount: number; /** * Lifecycle states */ state: string; /** * Resource Status */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the host insight was first enabled. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the host insight was updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetImportableAgentEntitiesItem { /** * Source of the importable agent entity. */ entitySource: string; /** * The host name. The host name is unique amongst the hosts managed by the same management agent. */ hostName: string; /** * The [Display Name](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Display) of the Management Agent */ managementAgentDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent */ managementAgentId: string; /** * Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX]. */ platformType: string; } interface GetImportableAgentEntityItem { /** * Source of the importable agent entity. */ entitySource: string; /** * The host name. The host name is unique amongst the hosts managed by the same management agent. */ hostName: string; /** * The [Display Name](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Display) of the Management Agent */ managementAgentDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent */ managementAgentId: string; /** * Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX]. */ platformType: string; } interface GetImportableComputeEntitiesItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [Display Name](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Display) of the Compute Instance */ computeDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Compute Instance */ computeId: string; /** * Source of the importable agent entity. */ entitySource: string; /** * The host name. The host name is unique amongst the hosts managed by the same management agent. */ hostName: string; /** * Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX]. */ platformType: string; } interface GetImportableComputeEntityItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [Display Name](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Display) of the Compute Instance */ computeDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Compute Instance */ computeId: string; /** * Source of the importable agent entity. */ entitySource: string; /** * The host name. The host name is unique amongst the hosts managed by the same management agent. */ hostName: string; /** * Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS]. */ platformType: string; } interface GetNewsReportContentType { /** * Supported resources for actionable insights content type. */ actionableInsightsResources: string[]; /** * Supported resources for capacity planning content type. */ capacityPlanningResources: string[]; /** * Supported resources for SQL insights - fleet analysis content type. */ sqlInsightsFleetAnalysisResources: string[]; /** * Supported resources for SQL insights - performance degradation content type. */ sqlInsightsPerformanceDegradationResources: string[]; /** * Supported resources for SQL insights - plan changes content type. */ sqlInsightsPlanChangesResources: string[]; /** * Supported resources for SQL insights - top databases content type. */ sqlInsightsTopDatabasesResources: string[]; /** * Supported resources for SQL insights - top SQL by insights content type. */ sqlInsightsTopSqlByInsightsResources: string[]; /** * Supported resources for SQL insights - top SQL content type. */ sqlInsightsTopSqlResources: string[]; } interface GetNewsReportsFilter { /** * The news report name. */ name: string; regex?: boolean; values: string[]; } interface GetNewsReportsNewsReportCollection { items: outputs.Opsi.GetNewsReportsNewsReportCollectionItem[]; } interface GetNewsReportsNewsReportCollectionItem { /** * A flag to consider the resources within a given compartment and all sub-compartments. */ areChildCompartmentsIncluded: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Content types that the news report can handle. */ contentTypes: outputs.Opsi.GetNewsReportsNewsReportCollectionItemContentType[]; /** * Day of the week in which the news report will be sent if the frequency is set to WEEKLY. */ dayOfWeek: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The description of the news report. */ description: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the news report resource. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Language of the news report. */ locale: string; /** * Match rule used for tag filters. */ matchRule: string; /** * The news report name. */ name: string; /** * News report frequency. */ newsFrequency: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ONS topic. */ onsTopicId: string; /** * Lifecycle states */ state: string; /** * Resource Status */ status: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * List of tag filters; each filter composed by a namespace, key, and value. Example for defined tags - '.='. Example for freeform tags - '='. */ tagFilters: string[]; /** * The time the the news report was first enabled. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the news report was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetNewsReportsNewsReportCollectionItemContentType { /** * Supported resources for actionable insights content type. */ actionableInsightsResources: string[]; /** * Supported resources for capacity planning content type. */ capacityPlanningResources: string[]; /** * Supported resources for SQL insights - fleet analysis content type. */ sqlInsightsFleetAnalysisResources: string[]; /** * Supported resources for SQL insights - performance degradation content type. */ sqlInsightsPerformanceDegradationResources: string[]; /** * Supported resources for SQL insights - plan changes content type. */ sqlInsightsPlanChangesResources: string[]; /** * Supported resources for SQL insights - top databases content type. */ sqlInsightsTopDatabasesResources: string[]; /** * Supported resources for SQL insights - top SQL by insights content type. */ sqlInsightsTopSqlByInsightsResources: string[]; /** * Supported resources for SQL insights - top SQL content type. */ sqlInsightsTopSqlResources: string[]; } interface GetOperationsInsightsPrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetOperationsInsightsPrivateEndpointsOperationsInsightsPrivateEndpointCollection { items: outputs.Opsi.GetOperationsInsightsPrivateEndpointsOperationsInsightsPrivateEndpointCollectionItem[]; } interface GetOperationsInsightsPrivateEndpointsOperationsInsightsPrivateEndpointCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The description of the private endpoint. */ description: string; /** * A filter to return only resources that match the entire display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Private service accessed database. */ id: string; /** * The option to filter OPSI private endpoints that can used for RAC. Should be used along with vcnId query parameter. */ isUsedForRacDbs: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * The OCIDs of the network security groups that the private endpoint belongs to. */ nsgIds: string[]; /** * A message describing the status of the private endpoint connection of this resource. For example, it can be used to provide actionable information about the validity of the private endpoint connection. */ privateEndpointStatusDetails: string; /** * The private IP addresses assigned to the private endpoint. All IP addresses will be concatenated if it is RAC DBs. */ privateIp: string; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * Lifecycle states */ state: string; /** * The OCID of the subnet. */ subnetId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the private endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetOperationsInsightsWarehouseUsersFilter { /** * Username for schema which would have access to AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. */ name: string; regex?: boolean; values: string[]; } interface GetOperationsInsightsWarehouseUsersOperationsInsightsWarehouseUserSummaryCollection { items: outputs.Opsi.GetOperationsInsightsWarehouseUsersOperationsInsightsWarehouseUserSummaryCollectionItem[]; } interface GetOperationsInsightsWarehouseUsersOperationsInsightsWarehouseUserSummaryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * User provided connection password for the AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. */ connectionPassword: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique Operations Insights Warehouse User identifier */ id: string; /** * Indicate whether user has access to AWR data. */ isAwrDataAccess: boolean; /** * Indicate whether user has access to EM data. */ isEmDataAccess: boolean; /** * Indicate whether user has access to OPSI data. */ isOpsiDataAccess: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Username for schema which would have access to AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. */ name: string; /** * Unique Operations Insights Warehouse identifier */ operationsInsightsWarehouseId: string; /** * Lifecycle states */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time at which the resource was first created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time at which the resource was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetOperationsInsightsWarehousesFilter { name: string; regex?: boolean; values: string[]; } interface GetOperationsInsightsWarehousesOperationsInsightsWarehouseSummaryCollection { items: outputs.Opsi.GetOperationsInsightsWarehousesOperationsInsightsWarehouseSummaryCollectionItem[]; } interface GetOperationsInsightsWarehousesOperationsInsightsWarehouseSummaryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The compute model for the OPSI warehouse ADW (OCPU or ECPU) */ computeModel: string; /** * Number of CPUs allocated to OPSI Warehouse ADW. */ cpuAllocated: number; /** * Number of OCPUs used by OPSI Warehouse ADW. Can be fractional. */ cpuUsed: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name. */ displayName: string; /** * OCID of the dynamic group created for the warehouse */ dynamicGroupId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique Ops Insights Warehouse identifier */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Tenancy Identifier of Ops Insights service */ operationsInsightsTenancyId: string; /** * Lifecycle states */ state: string; /** * Storage allocated to OPSI Warehouse ADW. */ storageAllocatedInGbs: number; /** * Storage by OPSI Warehouse ADW in GB. */ storageUsedInGbs: number; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time at which the resource was first created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time at which the ADW wallet was last rotated for the Ops Insights Warehouse. An RFC3339 formatted datetime string */ timeLastWalletRotated: string; /** * The time at which the resource was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetOpsiConfigurationConfigItem { /** * List of contexts in Operations Insights where this configuration item is applicable. */ applicableContexts: string[]; /** * Type of configuration item. */ configItemType: string; /** * Value of configuration item. */ defaultValue: string; /** * Configuration item metadata. */ metadatas: outputs.Opsi.GetOpsiConfigurationConfigItemMetadata[]; /** * Name of configuration item. */ name: string; /** * Value of configuration item. */ value: string; } interface GetOpsiConfigurationConfigItemMetadata { /** * Type of configuration item. */ configItemType: string; /** * Data type of configuration item. Examples: STRING, BOOLEAN, NUMBER */ dataType: string; /** * Description of OPSI configuration. */ description: string; /** * User-friendly display name for the OPSI configuration. The name does not have to be unique. */ displayName: string; /** * Unit details of configuration item. */ unitDetails: outputs.Opsi.GetOpsiConfigurationConfigItemMetadataUnitDetail[]; /** * Allowed value details of configuration item, to validate what value can be assigned to a configuration item. */ valueInputDetails: outputs.Opsi.GetOpsiConfigurationConfigItemMetadataValueInputDetail[]; } interface GetOpsiConfigurationConfigItemMetadataUnitDetail { /** * User-friendly display name for the OPSI configuration. The name does not have to be unique. */ displayName: string; /** * Unit of configuration item. */ unit: string; } interface GetOpsiConfigurationConfigItemMetadataValueInputDetail { /** * Allowed value type of configuration item. */ allowedValueType: string; /** * Maximum value limit for the configuration item. */ maxValue: string; /** * Minimum value limit for the configuration item. */ minValue: string; /** * Allowed values to pick for the configuration item. */ possibleValues: string[]; } interface GetOpsiConfigurationConfigurationItemConfigItem { /** * List of contexts in Operations Insights where this configuration item is applicable. */ applicableContexts: string[]; /** * Type of configuration item. */ configItemType: string; /** * Value of configuration item. */ defaultValue: string; /** * Configuration item metadata. */ metadatas: outputs.Opsi.GetOpsiConfigurationConfigurationItemConfigItemMetadata[]; /** * A filter to return only configuration items that match the entire name. */ name: string; /** * Value of configuration item. */ value: string; /** * Source configuration from where the value is taken for a configuration item. */ valueSourceConfig: string; } interface GetOpsiConfigurationConfigurationItemConfigItemMetadata { /** * Type of configuration item. */ configItemType: string; /** * Data type of configuration item. Examples: STRING, BOOLEAN, NUMBER */ dataType: string; /** * Description of configuration item . */ description: string; /** * User-friendly display name for the configuration item unit. */ displayName: string; /** * Unit details of configuration item. */ unitDetails: outputs.Opsi.GetOpsiConfigurationConfigurationItemConfigItemMetadataUnitDetail[]; /** * Allowed value details of configuration item, to validate what value can be assigned to a configuration item. */ valueInputDetails: outputs.Opsi.GetOpsiConfigurationConfigurationItemConfigItemMetadataValueInputDetail[]; } interface GetOpsiConfigurationConfigurationItemConfigItemMetadataUnitDetail { /** * User-friendly display name for the configuration item unit. */ displayName: string; /** * Unit of configuration item. */ unit: string; } interface GetOpsiConfigurationConfigurationItemConfigItemMetadataValueInputDetail { /** * Allowed value type of configuration item. */ allowedValueType: string; /** * Maximum value limit for the configuration item. */ maxValue: string; /** * Minimum value limit for the configuration item. */ minValue: string; /** * Allowed values to pick for the configuration item. */ possibleValues: string[]; } interface GetOpsiConfigurationsFilter { /** * Name of configuration item. */ name: string; regex?: boolean; values: string[]; } interface GetOpsiConfigurationsOpsiConfigurationsCollection { items: outputs.Opsi.GetOpsiConfigurationsOpsiConfigurationsCollectionItem[]; } interface GetOpsiConfigurationsOpsiConfigurationsCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; configItemCustomStatuses: string[]; configItemFields: string[]; /** * Array of configuration item summary objects. */ configItems: outputs.Opsi.GetOpsiConfigurationsOpsiConfigurationsCollectionItemConfigItem[]; configItemsApplicableContexts: string[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of OPSI configuration. */ description: string; /** * Filter to return based on resources that match the entire display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of OPSI configuration resource. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; opsiConfigFields: string[]; /** * Filter to return based on configuration type of OPSI configuration. */ opsiConfigType: string; /** * Filter to return based on Lifecycle state of OPSI configuration. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time at which the resource was first created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time at which the resource was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetOpsiConfigurationsOpsiConfigurationsCollectionItemConfigItem { /** * List of contexts in Operations Insights where this configuration item is applicable. */ applicableContexts: string[]; /** * Type of configuration item. */ configItemType: string; /** * Value of configuration item. */ defaultValue: string; /** * Configuration item metadata. */ metadatas: outputs.Opsi.GetOpsiConfigurationsOpsiConfigurationsCollectionItemConfigItemMetadata[]; /** * Name of configuration item. */ name: string; /** * Value of configuration item. */ value: string; } interface GetOpsiConfigurationsOpsiConfigurationsCollectionItemConfigItemMetadata { /** * Type of configuration item. */ configItemType: string; /** * Data type of configuration item. Examples: STRING, BOOLEAN, NUMBER */ dataType: string; /** * Description of OPSI configuration. */ description: string; /** * Filter to return based on resources that match the entire display name. */ displayName: string; /** * Unit details of configuration item. */ unitDetails: outputs.Opsi.GetOpsiConfigurationsOpsiConfigurationsCollectionItemConfigItemMetadataUnitDetail[]; /** * Allowed value details of configuration item, to validate what value can be assigned to a configuration item. */ valueInputDetails: outputs.Opsi.GetOpsiConfigurationsOpsiConfigurationsCollectionItemConfigItemMetadataValueInputDetail[]; } interface GetOpsiConfigurationsOpsiConfigurationsCollectionItemConfigItemMetadataUnitDetail { /** * Filter to return based on resources that match the entire display name. */ displayName: string; /** * Unit of configuration item. */ unit: string; } interface GetOpsiConfigurationsOpsiConfigurationsCollectionItemConfigItemMetadataValueInputDetail { /** * Allowed value type of configuration item. */ allowedValueType: string; /** * Maximum value limit for the configuration item. */ maxValue: string; /** * Minimum value limit for the configuration item. */ minValue: string; /** * Allowed values to pick for the configuration item. */ possibleValues: string[]; } interface NewsReportContentTypes { /** * (Updatable) Supported resources for actionable insights content type. */ actionableInsightsResources: string[]; /** * (Updatable) Supported resources for capacity planning content type. */ capacityPlanningResources: string[]; /** * (Updatable) Supported resources for SQL insights - fleet analysis content type. */ sqlInsightsFleetAnalysisResources: string[]; /** * (Updatable) Supported resources for SQL insights - performance degradation content type. */ sqlInsightsPerformanceDegradationResources: string[]; /** * (Updatable) Supported resources for SQL insights - plan changes content type. */ sqlInsightsPlanChangesResources: string[]; /** * (Updatable) Supported resources for SQL insights - top databases content type. */ sqlInsightsTopDatabasesResources: string[]; /** * (Updatable) Supported resources for SQL insights - top SQL by insights content type. */ sqlInsightsTopSqlByInsightsResources: string[]; /** * (Updatable) Supported resources for SQL insights - top SQL content type. */ sqlInsightsTopSqlResources: string[]; } interface OpsiConfigurationConfigItem { /** * List of contexts in Operations Insights where this configuration item is applicable. */ applicableContexts: string[]; /** * (Updatable) Type of configuration item. */ configItemType: string; /** * Value of configuration item. */ defaultValue: string; /** * Configuration item metadata. */ metadatas: outputs.Opsi.OpsiConfigurationConfigItemMetadata[]; /** * (Updatable) Name of configuration item. */ name: string; /** * (Updatable) Value of configuration item. */ value: string; } interface OpsiConfigurationConfigItemMetadata { /** * Type of configuration item. */ configItemType: string; /** * Data type of configuration item. Examples: STRING, BOOLEAN, NUMBER */ dataType: string; /** * (Updatable) Description of OPSI configuration. */ description: string; /** * (Updatable) User-friendly display name for the OPSI configuration. The name does not have to be unique. */ displayName: string; /** * Unit details of configuration item. */ unitDetails: outputs.Opsi.OpsiConfigurationConfigItemMetadataUnitDetail[]; /** * Allowed value details of configuration item, to validate what value can be assigned to a configuration item. */ valueInputDetails: outputs.Opsi.OpsiConfigurationConfigItemMetadataValueInputDetail[]; } interface OpsiConfigurationConfigItemMetadataUnitDetail { /** * (Updatable) User-friendly display name for the OPSI configuration. The name does not have to be unique. */ displayName: string; /** * Unit of configuration item. */ unit: string; } interface OpsiConfigurationConfigItemMetadataValueInputDetail { /** * Allowed value type of configuration item. */ allowedValueType: string; /** * Maximum value limit for the configuration item. */ maxValue: string; /** * Minimum value limit for the configuration item. */ minValue: string; /** * Allowed values to pick for the configuration item. */ possibleValues: string[]; } } export declare namespace Optimizer { interface GetCategoriesCategoryCollection { items: outputs.Optimizer.GetCategoriesCategoryCollectionItem[]; } interface GetCategoriesCategoryCollectionItem { /** * The OCID of the compartment. */ compartmentId: string; /** * The name associated with the compartment. */ compartmentName: string; /** * Text describing the category. */ description: string; /** * The estimated cost savings, in dollars, for the category. */ estimatedCostSaving: number; /** * Additional metadata key/value pairs for the category. */ extendedMetadata: { [key: string]: string; }; /** * The unique OCID of the category. */ id: string; /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * An array of `RecommendationCount` objects grouped by the level of importance assigned to the recommendation. */ recommendationCounts: outputs.Optimizer.GetCategoriesCategoryCollectionItemRecommendationCount[]; /** * An array of `ResourceCount` objects grouped by the status of the recommendation. */ resourceCounts: outputs.Optimizer.GetCategoriesCategoryCollectionItemResourceCount[]; /** * A filter that returns results that match the lifecycle state specified. */ state: string; /** * The date and time the category details were created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the category details were last updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetCategoriesCategoryCollectionItemRecommendationCount { /** * The count of resources. */ count: number; /** * The level of importance assigned to the recommendation. */ importance: string; } interface GetCategoriesCategoryCollectionItemResourceCount { /** * The count of resources. */ count: number; /** * The recommendation status of the resource. */ status: string; } interface GetCategoriesFilter { /** * Optional. A filter that returns results that match the name specified. */ name: string; regex?: boolean; values: string[]; } interface GetCategoryRecommendationCount { /** * The count of resources. */ count: number; /** * The level of importance assigned to the recommendation. */ importance: string; } interface GetCategoryResourceCount { /** * The count of resources. */ count: number; /** * The recommendation status of the resource. */ status: string; } interface GetEnrollmentStatusesEnrollmentStatusCollection { items: outputs.Optimizer.GetEnrollmentStatusesEnrollmentStatusCollectionItem[]; } interface GetEnrollmentStatusesEnrollmentStatusCollectionItem { /** * The OCID of the compartment. */ compartmentId: string; enrollmentStatusId: string; /** * The OCID of the enrollment status. */ id: string; /** * A filter that returns results that match the lifecycle state specified. */ state: string; /** * A filter that returns results that match the Cloud Advisor enrollment status specified. */ status: string; /** * The reason for the enrollment status of the tenancy. */ statusReason: string; /** * The date and time the enrollment status was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the enrollment status was last updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetEnrollmentStatusesFilter { name: string; regex?: boolean; values: string[]; } interface GetHistoriesFilter { /** * Optional. A filter that returns results that match the name specified. */ name: string; regex?: boolean; values: string[]; } interface GetHistoriesHistoryCollection { /** * A collection of history summaries. */ items: outputs.Optimizer.GetHistoriesHistoryCollectionItem[]; } interface GetHistoriesHistoryCollectionItem { /** * Details about the recommended action. */ actions: outputs.Optimizer.GetHistoriesHistoryCollectionItemAction[]; /** * The unique OCID associated with the category. */ categoryId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * The name assigned to the compartment. */ compartmentName: string; /** * The estimated cost savings, in dollars, for the resource action. */ estimatedCostSaving: number; /** * Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. */ extendedMetadata: { [key: string]: string; }; /** * The unique OCID associated with the recommendation history. */ id: string; /** * Custom metadata key/value pairs for the resource action. */ metadata: { [key: string]: string; }; /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * The unique OCID associated with the recommendation. */ recommendationId: string; /** * Optional. A filter that returns results that match the recommendation name specified. */ recommendationName: string; /** * The unique OCID associated with the resource action. */ resourceActionId: string; /** * The unique OCID associated with the resource. */ resourceId: string; /** * Optional. A filter that returns results that match the resource type specified. */ resourceType: string; /** * A filter that returns results that match the lifecycle state specified. */ state: string; /** * A filter that returns recommendations that match the status specified. */ status: string; /** * The date and time the recommendation history was created, in the format defined by RFC3339. */ timeCreated: string; } interface GetHistoriesHistoryCollectionItemAction { /** * Text describing the recommended action. */ description: string; /** * The status of the resource action. */ type: string; /** * The URL path to documentation that explains how to perform the action. */ url: string; } interface GetProfileLevelItem { /** * The default aggregation interval (in days) for profiles using this profile level. */ defaultInterval: number; /** * The metrics that will be evaluated by profiles using this profile level. */ metrics: outputs.Optimizer.GetProfileLevelItemMetric[]; /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * Optional. A filter that returns results that match the recommendation name specified. */ recommendationName: string; /** * The date and time the category details were created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the category details were last updated, in the format defined by RFC3339. */ timeUpdated: string; /** * An array of aggregation intervals (in days) allowed for profiles using this profile level. */ validIntervals: number[]; } interface GetProfileLevelItemMetric { /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * The name of the statistic (e.g., `p95`). */ statistic: string; /** * Optional. The metric value that the recommendation will target. */ target: number; /** * The threshold that must be crossed for the recommendation to appear. */ threshold: number; } interface GetProfileLevelsConfiguration { /** * The list of tags specified in the current profile override. */ items: outputs.Optimizer.GetProfileLevelsConfigurationItem[]; } interface GetProfileLevelsConfigurationItem { /** * The pre-defined profile level. */ level: string; /** * The unique OCID of the recommendation. */ recommendationId: string; } interface GetProfileLevelsFilter { /** * Optional. A filter that returns results that match the name specified. */ name: string; regex?: boolean; values: string[]; } interface GetProfileLevelsProfileLevelCollection { /** * A collection of profile levels. */ items: outputs.Optimizer.GetProfileLevelsProfileLevelCollectionItem[]; } interface GetProfileLevelsProfileLevelCollectionItem { /** * The default aggregation interval (in days) for profiles using this profile level. */ defaultInterval: number; /** * The metrics that will be evaluated by profiles using this profile level. */ metrics: outputs.Optimizer.GetProfileLevelsProfileLevelCollectionItemMetric[]; /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * Optional. A filter that returns results that match the recommendation name specified. */ recommendationName: string; /** * The date and time the category details were created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the category details were last updated, in the format defined by RFC3339. */ timeUpdated: string; /** * An array of aggregation intervals (in days) allowed for profiles using this profile level. */ validIntervals: number[]; } interface GetProfileLevelsProfileLevelCollectionItemMetric { /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * The name of the statistic (e.g., `p95`). */ statistic: string; /** * Optional. The metric value that the recommendation will target. */ target: number; /** * The threshold that must be crossed for the recommendation to appear. */ threshold: number; } interface GetProfileTargetCompartment { /** * The list of tags specified in the current profile override. */ items: string[]; } interface GetProfileTargetTag { /** * The list of tags specified in the current profile override. */ items: outputs.Optimizer.GetProfileTargetTagItem[]; } interface GetProfileTargetTagItem { /** * The name you use to refer to the tag, also known as the tag key. */ tagDefinitionName: string; /** * The name of the tag namespace. */ tagNamespaceName: string; /** * Specifies which tag value types in the `tagValues` field result in overrides of the recommendation criteria. */ tagValueType: string; /** * The list of tag values. The tag value is the value that the user applying the tag adds to the tag key. */ tagValues: string[]; } interface GetProfilesFilter { /** * Optional. A filter that returns results that match the name specified. */ name: string; regex?: boolean; values: string[]; } interface GetProfilesProfileCollection { /** * The list of tags specified in the current profile override. */ items: outputs.Optimizer.GetProfilesProfileCollectionItem[]; } interface GetProfilesProfileCollectionItem { /** * The time period over which to collect data for the recommendations, measured in number of days. */ aggregationIntervalInDays: number; /** * The OCID of the compartment. */ compartmentId: string; /** * 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: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Text describing the profile. Avoid entering confidential information. */ description: string; /** * Simple key-value pair applied without any predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The unique OCID of the profile. */ id: string; /** * A list of configuration levels for each recommendation. */ levelsConfigurations: outputs.Optimizer.GetProfilesProfileCollectionItemLevelsConfiguration[]; /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * A filter that returns results that match the lifecycle state specified. */ state: string; systemTags: { [key: string]: string; }; /** * Optional. The compartments specified in the profile override for a recommendation. */ targetCompartments: outputs.Optimizer.GetProfilesProfileCollectionItemTargetCompartment[]; /** * Optional. The tags specified in the profile override for a recommendation. */ targetTags: outputs.Optimizer.GetProfilesProfileCollectionItemTargetTag[]; /** * The date and time the profile was created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time the profile was last updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetProfilesProfileCollectionItemLevelsConfiguration { /** * The list of tags specified in the current profile override. */ items: outputs.Optimizer.GetProfilesProfileCollectionItemLevelsConfigurationItem[]; } interface GetProfilesProfileCollectionItemLevelsConfigurationItem { /** * The pre-defined profile level. */ level: string; /** * The unique OCID of the recommendation. */ recommendationId: string; } interface GetProfilesProfileCollectionItemTargetCompartment { /** * The list of tags specified in the current profile override. */ items: string[]; } interface GetProfilesProfileCollectionItemTargetTag { /** * The list of tags specified in the current profile override. */ items: outputs.Optimizer.GetProfilesProfileCollectionItemTargetTagItem[]; } interface GetProfilesProfileCollectionItemTargetTagItem { /** * The name you use to refer to the tag, also known as the tag key. */ tagDefinitionName: string; /** * The name of the tag namespace. */ tagNamespaceName: string; /** * Specifies which tag value types in the `tagValues` field result in overrides of the recommendation criteria. */ tagValueType: string; /** * The list of tag values. The tag value is the value that the user applying the tag adds to the tag key. */ tagValues: string[]; } interface GetRecommendationResourceCount { /** * The count of resources. */ count: number; /** * The current status of the recommendation. */ status: string; } interface GetRecommendationStrategiesFilter { /** * Optional. A filter that returns results that match the name specified. */ name: string; regex?: boolean; values: string[]; } interface GetRecommendationStrategiesRecommendationStrategyCollection { /** * A collection of recommendation strategy summaries. */ items: outputs.Optimizer.GetRecommendationStrategiesRecommendationStrategyCollectionItem[]; } interface GetRecommendationStrategiesRecommendationStrategyCollectionItem { /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * The list of strategies used. */ strategies: outputs.Optimizer.GetRecommendationStrategiesRecommendationStrategyCollectionItemStrategy[]; } interface GetRecommendationStrategiesRecommendationStrategyCollectionItemStrategy { /** * Whether this is the default recommendation strategy. */ isDefault: boolean; /** * The list of strategies for the parameters. */ parametersDefinitions: outputs.Optimizer.GetRecommendationStrategiesRecommendationStrategyCollectionItemStrategyParametersDefinition[]; /** * The name of the strategy. */ strategyName: string; } interface GetRecommendationStrategiesRecommendationStrategyCollectionItemStrategyParametersDefinition { /** * A default value used for the strategy parameter. */ defaultValues: any[]; /** * Text describing the strategy parameter. */ description: string; /** * Whether this parameter is required. */ isRequired: boolean; /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * The list of possible values used for these strategy parameters. */ possibleValues: any[]; /** * The type of strategy parameter. */ type: string; } interface GetRecommendationStrategyItem { /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * The list of strategies used. */ strategies: outputs.Optimizer.GetRecommendationStrategyItemStrategy[]; } interface GetRecommendationStrategyItemStrategy { /** * Whether this is the default recommendation strategy. */ isDefault: boolean; /** * The list of strategies for the parameters. */ parametersDefinitions: outputs.Optimizer.GetRecommendationStrategyItemStrategyParametersDefinition[]; /** * The name of the strategy. */ strategyName: string; } interface GetRecommendationStrategyItemStrategyParametersDefinition { /** * A default value used for the strategy parameter. */ defaultValues: any[]; /** * Text describing the strategy parameter. */ description: string; /** * Whether this parameter is required. */ isRequired: boolean; /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * The list of possible values used for these strategy parameters. */ possibleValues: any[]; /** * The type of strategy parameter. */ type: string; } interface GetRecommendationSupportedLevel { /** * The list of supported levels. */ items: outputs.Optimizer.GetRecommendationSupportedLevelItem[]; } interface GetRecommendationSupportedLevelItem { /** * The name of the profile level. */ name: string; } interface GetRecommendationsFilter { /** * Optional. A filter that returns results that match the name specified. */ name: string; regex?: boolean; values: string[]; } interface GetRecommendationsRecommendationCollection { /** * The list of supported levels. */ items: outputs.Optimizer.GetRecommendationsRecommendationCollectionItem[]; } interface GetRecommendationsRecommendationCollectionItem { /** * The unique OCID associated with the category. */ categoryId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * Text describing the recommendation. */ description: string; /** * The estimated cost savings, in dollars, for the recommendation. */ estimatedCostSaving: number; /** * Additional metadata key/value pairs for the recommendation. */ extendedMetadata: { [key: string]: string; }; /** * The unique OCID associated with the recommendation. */ id: string; /** * The level of importance assigned to the recommendation. */ importance: string; /** * Optional. A filter that returns results that match the name specified. */ name: string; recommendationId: string; /** * An array of `ResourceCount` objects grouped by the status of the resource actions. */ resourceCounts: outputs.Optimizer.GetRecommendationsRecommendationCollectionItemResourceCount[]; /** * A filter that returns results that match the lifecycle state specified. */ state: string; /** * A filter that returns recommendations that match the status specified. */ status: string; /** * Optional. The profile levels supported by a recommendation. For example, profile level values could be `Low`, `Medium`, and `High`. Not all recommendations support this field. */ supportedLevels: outputs.Optimizer.GetRecommendationsRecommendationCollectionItemSupportedLevel[]; /** * The date and time the recommendation details were created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time that the recommendation entered its current status. The format is defined by RFC3339. */ timeStatusBegin: string; /** * The date and time the current status will change. The format is defined by RFC3339. */ timeStatusEnd: string; /** * The date and time the recommendation details were last updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetRecommendationsRecommendationCollectionItemResourceCount { /** * The count of resources. */ count: number; /** * A filter that returns recommendations that match the status specified. */ status: string; } interface GetRecommendationsRecommendationCollectionItemSupportedLevel { /** * The list of supported levels. */ items: outputs.Optimizer.GetRecommendationsRecommendationCollectionItemSupportedLevelItem[]; } interface GetRecommendationsRecommendationCollectionItemSupportedLevelItem { /** * Optional. A filter that returns results that match the name specified. */ name: string; } interface GetResourceActionAction { /** * Text describing the recommended action. */ description: string; /** * The status of the resource action. */ type: string; /** * The URL path to documentation that explains how to perform the action. */ url: string; } interface GetResourceActionsFilter { /** * Optional. A filter that returns results that match the name specified. */ name: string; regex?: boolean; values: string[]; } interface GetResourceActionsResourceActionCollection { items: outputs.Optimizer.GetResourceActionsResourceActionCollectionItem[]; } interface GetResourceActionsResourceActionCollectionItem { /** * Details about the recommended action. */ actions: outputs.Optimizer.GetResourceActionsResourceActionCollectionItemAction[]; /** * The unique OCID associated with the category. */ categoryId: string; /** * The OCID of the compartment. */ compartmentId: string; /** * The name associated with the compartment. */ compartmentName: string; /** * The estimated cost savings, in dollars, for the resource action. */ estimatedCostSaving: number; /** * Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. */ extendedMetadata: { [key: string]: string; }; /** * The unique OCID associated with the resource action. */ id: string; /** * Custom metadata key/value pairs for the resource action. */ metadata: { [key: string]: string; }; /** * Optional. A filter that returns results that match the name specified. */ name: string; /** * The unique OCID associated with the recommendation. */ recommendationId: string; resourceActionId: string; /** * The unique OCID associated with the resource. */ resourceId: string; /** * Optional. A filter that returns results that match the resource type specified. */ resourceType: string; /** * A filter that returns results that match the lifecycle state specified. */ state: string; /** * A filter that returns recommendations that match the status specified. */ status: string; /** * The date and time the resource action details were created, in the format defined by RFC3339. */ timeCreated: string; /** * The date and time that the resource action entered its current status. The format is defined by RFC3339. */ timeStatusBegin: string; /** * The date and time the current status will change. The format is defined by RFC3339. */ timeStatusEnd: string; /** * The date and time the resource action details were last updated, in the format defined by RFC3339. */ timeUpdated: string; } interface GetResourceActionsResourceActionCollectionItemAction { /** * Text describing the recommended action. */ description: string; /** * The status of the resource action. */ type: string; /** * The URL path to documentation that explains how to perform the action. */ url: string; } interface ProfileLevelsConfiguration { /** * (Updatable) The array of configuration levels. */ items: outputs.Optimizer.ProfileLevelsConfigurationItem[]; } interface ProfileLevelsConfigurationItem { /** * (Updatable) The pre-defined profile level. */ level: string; /** * (Updatable) The unique OCID of the recommendation. */ recommendationId: string; } interface ProfileTargetCompartments { /** * (Updatable) The list of OCIDs attached to the compartments specified in the current profile override. */ items: string[]; } interface ProfileTargetTags { /** * (Updatable) The list of tags specified in the current profile override. */ items: outputs.Optimizer.ProfileTargetTagsItem[]; } interface ProfileTargetTagsItem { /** * (Updatable) The name you use to refer to the tag, also known as the tag key. */ tagDefinitionName: string; /** * (Updatable) The name of the tag namespace. */ tagNamespaceName: string; /** * (Updatable) Specifies which tag value types in the `tagValues` field result in overrides of the recommendation criteria. * * When the value for this field is `ANY`, the `tagValues` field should be empty, which enforces overrides to the recommendation for resources with any tag values attached to them. * * When the value for this field value is `VALUE`, the `tagValues` field must include a specific value or list of values. Overrides to the recommendation criteria only occur for resources that match the values in the `tagValues` fields. */ tagValueType: string; /** * (Updatable) The list of tag values. The tag value is the value that the user applying the tag adds to the tag key. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ tagValues: string[]; } interface RecommendationResourceCount { /** * The count of resources. */ count: number; /** * (Updatable) The status of the recommendation. */ status: string; } interface RecommendationSupportedLevel { /** * The list of supported levels. */ items: outputs.Optimizer.RecommendationSupportedLevelItem[]; } interface RecommendationSupportedLevelItem { /** * The name of the profile level. */ name: string; } interface ResourceActionAction { /** * Text describing the recommended action. */ description: string; /** * The status of the resource action. */ type: string; /** * The URL path to documentation that explains how to perform the action. */ url: string; } } export declare namespace OsManagementHub { interface DynamicSetInstallPackagesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface DynamicSetMatchingRule { /** * (Updatable) The list of managed instance architectures. */ architectures: string[]; /** * (Updatable) The list of managed instance display names. */ displayNames: string[]; /** * (Updatable) Indicates if the managed instance needs to be rebooted. */ isRebootRequired: boolean; /** * (Updatable) The list of managed instance locations. */ locations: string[]; /** * (Updatable) The list of managed instance group IDs. */ managedInstanceGroupIds: string[]; /** * (Updatable) The list of managed instance ids. */ managedInstanceIds: string[]; /** * (Updatable) The list of managed instance OS families. */ osFamilies: string[]; /** * (Updatable) The list of managed instance OS names. */ osNames: string[]; /** * (Updatable) The list of managed instance statuses. */ statuses: string[]; /** * (Updatable) The list of the managed instance tags. */ tags: outputs.OsManagementHub.DynamicSetMatchingRuleTag[]; } interface DynamicSetMatchingRuleTag { /** * (Updatable) The key of the tag. */ key: string; /** * (Updatable) The namespace of the tag. */ namespace: string; /** * (Updatable) The type of the tag. Common values include `defined` or `freeform`. */ type: string; /** * (Updatable) The value associated with the tag key. */ value: string; } interface DynamicSetRebootManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface DynamicSetRemovePackagesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface DynamicSetTargetCompartment { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * (Updatable) Indicates if the child compartments are included in the matching rule. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ doesIncludeChildren: boolean; } interface DynamicSetUpdatePackagesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface EventData { /** * Provides additional information for the work request associated with an event. */ additionalDetails: outputs.OsManagementHub.EventDataAdditionalDetail[]; /** * The actions used to attempt fixing the error. */ attemptedResolutions: string[]; /** * Provides information collected for the exploit attempt event. */ contents: outputs.OsManagementHub.EventDataContent[]; /** * The commands executed by the agent that caused the error. */ errorCause: string; /** * The output log of the error. */ errorLog: string; /** * Brief description on how this error is categorized. */ errorSummary: string; /** * Number of times the event has occurred. */ eventCount: number; /** * Fingerprint of the event. */ eventFingerprint: string; /** * Health state of the management station */ healthState: string; /** * Type of management station operation. */ operationType: string; /** * Reason for the event. */ reason: string; /** * Reboot status for the current event */ rebootStatus: string; /** * The log output after the resolutions. */ resolutionLog: string; /** * Indicates if the event succeeded. */ resolutionStatus: string; /** * Status of the management station operation. */ status: string; /** * The date and time that the event first occurred. */ timeFirstOccurred: string; } interface EventDataAdditionalDetail { /** * List of CVEs in the exploit. */ exploitCves: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that triggered the event, such as scheduled job id. */ initiatorId: string; /** * Kernel event vmcore details */ vmcores: outputs.OsManagementHub.EventDataAdditionalDetailVmcore[]; /** * List of all work request [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the event. */ workRequestIds: string[]; } interface EventDataAdditionalDetailVmcore { /** * Kernel vmcore backtrace. */ backtrace: string; /** * Kernel vmcore component. */ component: string; } interface EventDataContent { /** * Crash content availability status: * * 'NOT_AVAILABLE' indicates the content is not available on the instance nor in the service * * 'AVAILABLE_ON_INSTANCE' indicates the content is only available on the instance. * * 'AVAILABLE_ON_SERVICE' indicates the content is only available on the service. * * 'AVAILABLE_ON_INSTANCE_AND_SERVICE' indicates the content is available both on the instance and the service * * 'AVAILABLE_ON_INSTANCE_UPLOAD_IN_PROGRESS' indicates the content is available on the instance and its upload to the service is in progress. */ contentAvailability: string; /** * Location of the Kernel event content. */ contentLocation: string; /** * The content of the exploit detection log. */ exploitDetectionLogContent: string; /** * The location of the exploit detection log within object storage. */ exploitObjectStoreLocation: string; /** * Size of the event content. */ size: number; /** * Event type: * * `KERNEL_OOPS` - Used to identify a kernel panic condition event * * `KERNEL_CRASH` - Used to identify an internal fatal kernel error that cannot be safely recovered from * * `EXPLOIT_ATTEMPT` - Used to identify a known exploit detection as identified by Ksplice * * `SOFTWARE_UPDATE` - Software updates - Packages * * `KSPLICE_UPDATE` - Ksplice updates * * `SOFTWARE_SOURCE` - Software source * * `AGENT` - Agent * * `MANAGEMENT_STATION` - Management Station * * `SYSADMIN` - Used to identify attempts on fixing agent errors on the instance * * `REBOOT` - Reboot */ type: string; } interface EventSystemDetail { /** * Architecture type. */ architecture: string; /** * Version of the Ksplice effective kernel. */ kspliceEffectiveKernelVersion: string; /** * Operating system type. */ osFamily: string; /** * Release of the kernel. */ osKernelRelease: string; /** * Version of the kernel. */ osKernelVersion: string; /** * Name of the operating system. */ osName: string; /** * Version of the operating system. */ osSystemVersion: string; } interface GetDynamicSetManagedInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetDynamicSetManagedInstancesManagedInstanceCollection { /** * List of managed instances. */ items: outputs.OsManagementHub.GetDynamicSetManagedInstancesManagedInstanceCollectionItem[]; } interface GetDynamicSetManagedInstancesManagedInstanceCollectionItem { /** * The version of osmh-agent running on the managed instance */ agentVersion: string; /** * The CPU architecture type of the managed instance. */ architecture: string; /** * Settings for the Autonomous Linux service. */ autonomousSettings: outputs.OsManagementHub.GetDynamicSetManagedInstancesManagedInstanceCollectionItemAutonomousSetting[]; /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * User-specified description of the managed instance. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; /** * Indicates whether Autonomous Linux manages this instance. */ isManagedByAutonomousLinux: boolean; /** * Whether this managed instance is acting as an on-premises management station. */ isManagementStation: boolean; /** * Indicates whether a reboot is required to complete installation of updates. */ isRebootRequired: boolean; /** * Id and name of a resource to simplify the display for the user. */ lifecycleEnvironments: outputs.OsManagementHub.GetDynamicSetManagedInstancesManagedInstanceCollectionItemLifecycleEnvironment[]; /** * Id and name of a resource to simplify the display for the user. */ lifecycleStages: outputs.OsManagementHub.GetDynamicSetManagedInstancesManagedInstanceCollectionItemLifecycleStage[]; /** * The location of the managed instance. */ location: string; /** * Id and name of a resource to simplify the display for the user. */ managedInstanceGroups: outputs.OsManagementHub.GetDynamicSetManagedInstancesManagedInstanceCollectionItemManagedInstanceGroup[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. */ notificationTopicId: string; /** * The operating system type of the managed instance. */ osFamily: string; /** * Current status of the managed instance. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenancy this managed instance resides in. */ tenancyId: string; /** * Time that the instance last booted (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeLastBoot: string; /** * Number of updates available for installation. */ updatesAvailable: number; } interface GetDynamicSetManagedInstancesManagedInstanceCollectionItemAutonomousSetting { /** * Indicates whether Autonomous Linux will collect crash files. This setting can be changed by the user. */ isDataCollectionAuthorized: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the restricted scheduled job associated with this instance. This value cannot be deleted by the user. */ scheduledJobId: string; } interface GetDynamicSetManagedInstancesManagedInstanceCollectionItemLifecycleEnvironment { /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; } interface GetDynamicSetManagedInstancesManagedInstanceCollectionItemLifecycleStage { /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; } interface GetDynamicSetManagedInstancesManagedInstanceCollectionItemManagedInstanceGroup { /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; } interface GetDynamicSetMatchingRule { /** * The list of managed instance architectures. */ architectures: string[]; /** * The list of managed instance display names. */ displayNames: string[]; /** * Indicates if the managed instance needs to be rebooted. */ isRebootRequired: boolean; /** * The list of managed instance locations. */ locations: string[]; /** * The list of managed instance group IDs. */ managedInstanceGroupIds: string[]; /** * The list of managed instance ids. */ managedInstanceIds: string[]; /** * The list of managed instance OS families. */ osFamilies: string[]; /** * The list of managed instance OS names. */ osNames: string[]; /** * The list of managed instance statuses. */ statuses: string[]; /** * The list of the managed instance tags. */ tags: outputs.OsManagementHub.GetDynamicSetMatchingRuleTag[]; } interface GetDynamicSetMatchingRuleTag { /** * The key of the tag. */ key: string; /** * The namespace of the tag. */ namespace: string; /** * The type of the tag. Common values include `defined` or `freeform`. */ type: string; /** * The value associated with the tag key. */ value: string; } interface GetDynamicSetTargetCompartment { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Indicates if the child compartments are included in the matching rule. */ doesIncludeChildren: boolean; } interface GetDynamicSetsDynamicSetCollection { items: outputs.OsManagementHub.GetDynamicSetsDynamicSetCollectionItem[]; } interface GetDynamicSetsDynamicSetCollectionItem { /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * User-specified description for the dynamic set. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. */ id: string; /** * Include either any or all attributes. */ matchType: string; /** * An object that defines the set of rules that identifies the target instances in a dynamic set. */ matchingRules: outputs.OsManagementHub.GetDynamicSetsDynamicSetCollectionItemMatchingRule[]; /** * Number of scheduled jobs currently targeting this dynamic set. */ scheduledJobCount: string; /** * The current state of the event. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The list of compartment details. */ targetCompartments: outputs.OsManagementHub.GetDynamicSetsDynamicSetCollectionItemTargetCompartment[]; /** * The date and time the dynamic set was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * The date and time the dynamic set was last updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeUpdated: string; } interface GetDynamicSetsDynamicSetCollectionItemMatchingRule { /** * The list of managed instance architectures. */ architectures: string[]; /** * The list of managed instance display names. */ displayNames: string[]; /** * Indicates if the managed instance needs to be rebooted. */ isRebootRequired: boolean; /** * The list of managed instance locations. */ locations: string[]; /** * The list of managed instance group IDs. */ managedInstanceGroupIds: string[]; /** * The list of managed instance ids. */ managedInstanceIds: string[]; /** * The list of managed instance OS families. */ osFamilies: string[]; /** * The list of managed instance OS names. */ osNames: string[]; /** * The list of managed instance statuses. */ statuses: string[]; /** * The list of the managed instance tags. */ tags: outputs.OsManagementHub.GetDynamicSetsDynamicSetCollectionItemMatchingRuleTag[]; } interface GetDynamicSetsDynamicSetCollectionItemMatchingRuleTag { /** * The key of the tag. */ key: string; /** * The namespace of the tag. */ namespace: string; /** * The type of the tag. Common values include `defined` or `freeform`. */ type: string; /** * The value associated with the tag key. */ value: string; } interface GetDynamicSetsDynamicSetCollectionItemTargetCompartment { /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * Indicates if the child compartments are included in the matching rule. */ doesIncludeChildren: boolean; } interface GetDynamicSetsFilter { name: string; regex?: boolean; values: string[]; } interface GetEntitlementsEntitlementCollection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment. */ compartmentId: string; /** * A filter to return entitlements that match the given customer support identifier (CSI). */ csi: string; /** * List of entitlements. */ items: outputs.OsManagementHub.GetEntitlementsEntitlementCollectionItem[]; } interface GetEntitlementsEntitlementCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment. */ compartmentId: string; /** * A filter to return entitlements that match the given customer support identifier (CSI). */ csi: string; /** * A filter to return only resources that match the given vendor name. */ vendorName: string; } interface GetEntitlementsFilter { name: string; regex?: boolean; values: string[]; } interface GetErrataErratumCollection { items: outputs.OsManagementHub.GetErrataErratumCollectionItem[]; } interface GetErrataErratumCollectionItem { /** * The severity for a security advisory, otherwise, null. */ advisorySeverity: string; /** * The advisory type of the erratum. */ advisoryType: string; /** * Type of the erratum. This property is deprecated and it will be removed in a future API release. Please refer to the advisoryType property instead. */ classificationType: string; /** * Software source description. */ description: string; /** * Information specifying from where the erratum was release. */ from: string; /** * The erratum name (such as ELSA-2023-34678). */ name: string; /** * The OS families the package belongs to. */ osFamilies: string[]; /** * List of packages affected by this erratum. */ packages: outputs.OsManagementHub.GetErrataErratumCollectionItemPackage[]; /** * Information describing how to find more information about. the erratum. */ references: string; /** * List of CVEs applicable to this erratum. */ relatedCves: string[]; /** * List of repository identifiers. */ repositories: string[]; /** * Information describing how the erratum can be resolved. */ solution: string; /** * Summary description of the erratum. */ synopsis: string; /** * The date and time the erratum was issued (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeIssued: string; /** * The date and time the erratum was updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeUpdated: string; } interface GetErrataErratumCollectionItemPackage { /** * The architecture for which this software was built. */ architecture: string; /** * Checksum of the package. */ checksum: string; /** * Type of the checksum. */ checksumType: string; /** * Software source name. */ displayName: string; /** * Indicates whether this package is the latest version. */ isLatest: boolean; /** * The erratum name (such as ELSA-2023-34678). */ name: string; /** * The OS families the package belongs to. */ osFamilies: string[]; /** * List of software sources that provide the software package. This property is deprecated and it will be removed in a future API release. */ softwareSources: outputs.OsManagementHub.GetErrataErratumCollectionItemPackageSoftwareSource[]; /** * Type of the package. */ type: string; /** * Version of the package. */ version: string; } interface GetErrataErratumCollectionItemPackageSoftwareSource { /** * Software source description. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetErrataFilter { /** * The erratum name (such as ELSA-2023-34678). */ name: string; regex?: boolean; values: string[]; } interface GetErratumPackage { /** * The architecture for which this software was built. */ architecture: string; /** * Checksum of the package. */ checksum: string; /** * Type of the checksum. */ checksumType: string; /** * Software source name. */ displayName: string; /** * Indicates whether this package is the latest version. */ isLatest: boolean; /** * The erratum name (such as ELSA-2023-34678). */ name: string; /** * The OS families the package belongs to. */ osFamilies: string[]; /** * List of software sources that provide the software package. This property is deprecated and it will be removed in a future API release. */ softwareSources: outputs.OsManagementHub.GetErratumPackageSoftwareSource[]; /** * Type of the package. */ type: string; /** * Version of the package. */ version: string; } interface GetErratumPackageSoftwareSource { /** * Software source description. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetEventData { /** * Provides additional information for the work request associated with an event. */ additionalDetails: outputs.OsManagementHub.GetEventDataAdditionalDetail[]; /** * The actions used to attempt fixing the error. */ attemptedResolutions: string[]; /** * Provides information collected for the exploit attempt event. */ contents: outputs.OsManagementHub.GetEventDataContent[]; /** * The commands executed by the agent that caused the error. */ errorCause: string; /** * The output log of the error. */ errorLog: string; /** * Brief description on how this error is categorized. */ errorSummary: string; /** * Number of times the event has occurred. */ eventCount: number; /** * Fingerprint of the event. */ eventFingerprint: string; /** * Health state of the management station */ healthState: string; /** * Type of management station operation. */ operationType: string; /** * Reason for the event. */ reason: string; /** * Reboot status for the current event */ rebootStatus: string; /** * The log output after the resolutions. */ resolutionLog: string; /** * Indicates if the event succeeded. */ resolutionStatus: string; /** * Status of the management station operation. */ status: string; /** * The date and time that the event first occurred. */ timeFirstOccurred: string; } interface GetEventDataAdditionalDetail { /** * List of CVEs in the exploit. */ exploitCves: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that triggered the event, such as scheduled job id. */ initiatorId: string; /** * Kernel event vmcore details */ vmcores: outputs.OsManagementHub.GetEventDataAdditionalDetailVmcore[]; /** * List of all work request [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the event. */ workRequestIds: string[]; } interface GetEventDataAdditionalDetailVmcore { /** * Kernel vmcore backtrace. */ backtrace: string; /** * Kernel vmcore component. */ component: string; } interface GetEventDataContent { /** * Crash content availability status: * * 'NOT_AVAILABLE' indicates the content is not available on the instance nor in the service * * 'AVAILABLE_ON_INSTANCE' indicates the content is only available on the instance. * * 'AVAILABLE_ON_SERVICE' indicates the content is only available on the service. * * 'AVAILABLE_ON_INSTANCE_AND_SERVICE' indicates the content is available both on the instance and the service * * 'AVAILABLE_ON_INSTANCE_UPLOAD_IN_PROGRESS' indicates the content is available on the instance and its upload to the service is in progress. */ contentAvailability: string; /** * Location of the Kernel event content. */ contentLocation: string; /** * The content of the exploit detection log. */ exploitDetectionLogContent: string; /** * The location of the exploit detection log within object storage. */ exploitObjectStoreLocation: string; /** * Size of the event content. */ size: number; /** * Event type: * * `KERNEL_OOPS` - Used to identify a kernel panic condition event * * `KERNEL_CRASH` - Used to identify an internal fatal kernel error that cannot be safely recovered from * * `EXPLOIT_ATTEMPT` - Used to identify a known exploit detection as identified by Ksplice * * `SOFTWARE_UPDATE` - Software updates - Packages * * `KSPLICE_UPDATE` - Ksplice updates * * `SOFTWARE_SOURCE` - Software source * * `AGENT` - Agent * * `MANAGEMENT_STATION` - Management Station * * `SYSADMIN` - Used to identify attempts on fixing agent errors on the instance * * `REBOOT` - Reboot */ type: string; } interface GetEventSystemDetail { /** * Architecture type. */ architecture: string; /** * Version of the Ksplice effective kernel. */ kspliceEffectiveKernelVersion: string; /** * Operating system type. */ osFamily: string; /** * Release of the kernel. */ osKernelRelease: string; /** * Version of the kernel. */ osKernelVersion: string; /** * Name of the operating system. */ osName: string; /** * Version of the operating system. */ osSystemVersion: string; } interface GetEventsEventCollection { items: outputs.OsManagementHub.GetEventsEventCollectionItem[]; } interface GetEventsEventCollectionItem { /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * Provides additional information for a management station event. */ datas: outputs.OsManagementHub.GetEventsEventCollectionItemData[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Details of an event. */ eventDetails: string; eventId: string; /** * A filter to return only events whose summary matches the given value. */ eventSummary: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the event. */ id: string; /** * Indicates whether to list only resources managed by the Autonomous Linux service. */ isManagedByAutonomousLinux: boolean; /** * Describes the current state of the event in more detail. For example, the message can provide actionable information for a resource in the 'FAILED' state. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. This filter returns resources associated with the specified resource. */ resourceId: string; /** * A filter to return only events that match the state provided. The state value is case-insensitive. */ state: string; /** * Provides information about the system architecture and operating system. */ systemDetails: outputs.OsManagementHub.GetEventsEventCollectionItemSystemDetail[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Event was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time that the event occurred. */ timeOccurred: string; /** * The date and time that the event was updated (in [RFC 3339](https://tools.ietf.org/html/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * A filter to return only resources whose type matches the given value. */ type: string; } interface GetEventsEventCollectionItemData { /** * Provides additional information for the work request associated with an event. */ additionalDetails: outputs.OsManagementHub.GetEventsEventCollectionItemDataAdditionalDetail[]; /** * The actions used to attempt fixing the error. */ attemptedResolutions: string[]; /** * Provides information collected for the exploit attempt event. */ contents: outputs.OsManagementHub.GetEventsEventCollectionItemDataContent[]; /** * The commands executed by the agent that caused the error. */ errorCause: string; /** * The output log of the error. */ errorLog: string; /** * Brief description on how this error is categorized. */ errorSummary: string; /** * Number of times the event has occurred. */ eventCount: number; /** * The eventFingerprint of the KernelEventData. */ eventFingerprint: string; /** * Health state of the management station */ healthState: string; /** * Type of management station operation. */ operationType: string; /** * Reason for the event. */ reason: string; /** * Reboot status for the current event */ rebootStatus: string; /** * The log output after the resolutions. */ resolutionLog: string; /** * Indicates if the event succeeded. */ resolutionStatus: string; /** * Status of the management station operation. */ status: string; /** * The date and time that the event first occurred. */ timeFirstOccurred: string; } interface GetEventsEventCollectionItemDataAdditionalDetail { /** * List of CVEs in the exploit. */ exploitCves: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that triggered the event, such as scheduled job id. */ initiatorId: string; /** * Kernel event vmcore details */ vmcores: outputs.OsManagementHub.GetEventsEventCollectionItemDataAdditionalDetailVmcore[]; /** * List of all work request [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the event. */ workRequestIds: string[]; } interface GetEventsEventCollectionItemDataAdditionalDetailVmcore { /** * Kernel vmcore backtrace. */ backtrace: string; /** * Kernel vmcore component. */ component: string; } interface GetEventsEventCollectionItemDataContent { /** * Crash content availability status: * * 'NOT_AVAILABLE' indicates the content is not available on the instance nor in the service * * 'AVAILABLE_ON_INSTANCE' indicates the content is only available on the instance. * * 'AVAILABLE_ON_SERVICE' indicates the content is only available on the service. * * 'AVAILABLE_ON_INSTANCE_AND_SERVICE' indicates the content is available both on the instance and the service * * 'AVAILABLE_ON_INSTANCE_UPLOAD_IN_PROGRESS' indicates the content is available on the instance and its upload to the service is in progress. */ contentAvailability: string; /** * Location of the Kernel event content. */ contentLocation: string; /** * The content of the exploit detection log. */ exploitDetectionLogContent: string; /** * The location of the exploit detection log within object storage. */ exploitObjectStoreLocation: string; /** * Size of the event content. */ size: number; /** * A filter to return only resources whose type matches the given value. */ type: string; } interface GetEventsEventCollectionItemSystemDetail { /** * Architecture type. */ architecture: string; /** * Version of the Ksplice effective kernel. */ kspliceEffectiveKernelVersion: string; /** * Operating system type. */ osFamily: string; /** * Release of the kernel. */ osKernelRelease: string; /** * Version of the kernel. */ osKernelVersion: string; /** * Name of the operating system. */ osName: string; /** * Version of the operating system. */ osSystemVersion: string; } interface GetEventsFilter { name: string; regex?: boolean; values: string[]; } interface GetLifecycleEnvironmentManagedInstanceId { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetLifecycleEnvironmentStage { /** * The CPU architecture of the managed instances in the lifecycle stage. */ archType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the lifecycle stage. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Software source name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment. */ lifecycleEnvironmentId: string; /** * The location of managed instances associated with the lifecycle stage. */ location: string; /** * The list of managed instances associated with the lifecycle stage. */ managedInstanceIds: outputs.OsManagementHub.GetLifecycleEnvironmentStageManagedInstanceId[]; /** * The operating system of the managed instances in the lifecycle stage. */ osFamily: string; /** * User-specified rank for the lifecycle stage. Rank determines the hierarchy of the lifecycle stages within the lifecycle environment. */ rank: number; /** * Provides identifying information for the specified software source. */ softwareSourceIds: outputs.OsManagementHub.GetLifecycleEnvironmentStageSoftwareSourceId[]; /** * The current state of the lifecycle environment. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the lifecycle environment was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * The time the lifecycle environment was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * The vendor of the operating system used by the managed instances in the lifecycle environment. */ vendorName: string; } interface GetLifecycleEnvironmentStageManagedInstanceId { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetLifecycleEnvironmentStageSoftwareSourceId { /** * Software source description. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetLifecycleEnvironmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetLifecycleEnvironmentsLifecycleEnvironmentCollection { items: outputs.OsManagementHub.GetLifecycleEnvironmentsLifecycleEnvironmentCollectionItem[]; } interface GetLifecycleEnvironmentsLifecycleEnvironmentCollectionItem { /** * A filter to return only profiles that match the given archType. */ archType: string; /** * (Updatable) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * A filter to return only resources whose location matches the given value. */ location: string; /** * A filter to return only resources that match the given operating system family. */ osFamily: string; /** * User-specified list of lifecycle stages used within the lifecycle environment. */ stages: outputs.OsManagementHub.GetLifecycleEnvironmentsLifecycleEnvironmentCollectionItemStage[]; /** * A filter to return only the lifecycle environments that match the display name given. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the lifecycle environment was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * The time the lifecycle environment was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * The vendor of the operating system used by the managed instances in the lifecycle environment. */ vendorName: string; } interface GetLifecycleEnvironmentsLifecycleEnvironmentCollectionItemStage { /** * A filter to return only profiles that match the given archType. */ archType: string; /** * (Updatable) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return resources that match the given display names. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; lifecycleEnvironmentDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment. */ lifecycleEnvironmentId: string; /** * A filter to return only resources whose location matches the given value. */ location: string; managedInstances: number; /** * A filter to return only resources that match the given operating system family. */ osFamily: string; /** * User-specified rank for the lifecycle stage. Rank determines the hierarchy of the lifecycle stages within the lifecycle environment. */ rank: number; /** * Provides identifying information for the specified software source. */ softwareSourceIds: outputs.OsManagementHub.GetLifecycleEnvironmentsLifecycleEnvironmentCollectionItemStageSoftwareSourceId[]; /** * A filter to return only the lifecycle environments that match the display name given. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the lifecycle environment was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * The time the lifecycle environment was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * The vendor of the operating system used by the managed instances in the lifecycle environment. */ vendorName: string; } interface GetLifecycleEnvironmentsLifecycleEnvironmentCollectionItemStageSoftwareSourceId { /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetLifecycleStageManagedInstanceId { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetLifecycleStageSoftwareSourceId { /** * Software source description. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetLifecycleStagesFilter { name: string; regex?: boolean; values: string[]; } interface GetLifecycleStagesLifecycleStageCollection { items: outputs.OsManagementHub.GetLifecycleStagesLifecycleStageCollectionItem[]; } interface GetLifecycleStagesLifecycleStageCollectionItem { /** * A filter to return only profiles that match the given archType. */ archType: string; /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return resources that match the given display names. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; lifecycleEnvironmentDisplayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment that contains the lifecycle stage. */ lifecycleEnvironmentId: string; /** * A filter to return only resources whose location matches the given value. */ location: string; managedInstances: number; /** * A filter to return only resources that match the given operating system family. */ osFamily: string; /** * User-specified rank for the lifecycle stage. Rank determines the hierarchy of the lifecycle stages within the lifecycle environment. */ rank: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. This filter returns resources associated with this software source. */ softwareSourceIds: outputs.OsManagementHub.GetLifecycleStagesLifecycleStageCollectionItemSoftwareSourceId[]; /** * A filter to return only lifecycle stages whose lifecycle state matches the given lifecycle state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the lifecycle stage was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * The time the lifecycle stage was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * The vendor of the operating system used by the managed instances in the lifecycle stage. */ vendorName: string; } interface GetLifecycleStagesLifecycleStageCollectionItemSoftwareSourceId { /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagedInstanceAutonomousSetting { /** * Indicates whether Autonomous Linux will collect crash files. This setting can be changed by the user. */ isDataCollectionAuthorized: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the restricted scheduled job associated with this instance. This value cannot be deleted by the user. */ scheduledJobId: string; } interface GetManagedInstanceAvailablePackagesAvailablePackageCollection { /** * List of available packages. */ items: outputs.OsManagementHub.GetManagedInstanceAvailablePackagesAvailablePackageCollectionItem[]; } interface GetManagedInstanceAvailablePackagesAvailablePackageCollectionItem { /** * The architecture for which this package was built. */ architecture: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * Unique identifier for the package. */ name: string; /** * Status of the software package. */ packageClassification: string; /** * List of software sources that provide the software package. */ softwareSources: outputs.OsManagementHub.GetManagedInstanceAvailablePackagesAvailablePackageCollectionItemSoftwareSource[]; /** * Type of the package. */ type: string; /** * Version of the installed package. */ version: string; } interface GetManagedInstanceAvailablePackagesAvailablePackageCollectionItemSoftwareSource { /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagedInstanceAvailablePackagesFilter { /** * Unique identifier for the package. */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceAvailableSoftwareSourcesAvailableSoftwareSourceCollection { /** * List of available software sources. */ items: outputs.OsManagementHub.GetManagedInstanceAvailableSoftwareSourcesAvailableSoftwareSourceCollectionItem[]; } interface GetManagedInstanceAvailableSoftwareSourcesAvailableSoftwareSourceCollectionItem { /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagedInstanceAvailableSoftwareSourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceAvailableWindowsUpdatesAvailableWindowsUpdateCollection { /** * List of available Windows updates. */ items: outputs.OsManagementHub.GetManagedInstanceAvailableWindowsUpdatesAvailableWindowsUpdateCollectionItem[]; } interface GetManagedInstanceAvailableWindowsUpdatesAvailableWindowsUpdateCollectionItem { /** * Indicates whether the update can be installed using the service. */ installable: string; /** * Indicates whether a reboot is required to complete the installation of this update. */ isRebootRequiredForInstallation: boolean; /** * A filter based on the unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed' */ name: string; /** * Unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed' */ updateId: string; /** * The type of Windows update. */ updateType: string; } interface GetManagedInstanceAvailableWindowsUpdatesFilter { /** * A filter based on the unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed' */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceErrataFilter { /** * The assigned erratum name. It's unique and not changeable. Example: `ELSA-2020-5804` */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceErrataManagedInstanceErratumSummaryCollection { /** * List of errata. */ items: outputs.OsManagementHub.GetManagedInstanceErrataManagedInstanceErratumSummaryCollectionItem[]; } interface GetManagedInstanceErrataManagedInstanceErratumSummaryCollectionItem { /** * The advisory type of the erratum. */ advisoryType: string; /** * The assigned erratum name. It's unique and not changeable. Example: `ELSA-2020-5804` */ name: string; /** * The list of packages affected by this erratum. */ packages: outputs.OsManagementHub.GetManagedInstanceErrataManagedInstanceErratumSummaryCollectionItemPackage[]; /** * The list of CVEs applicable to this erratum. */ relatedCves: string[]; /** * A summary description of the erratum. */ synopsis: string; /** * The date and time the package was issued by a providing erratum (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeIssued: string; } interface GetManagedInstanceErrataManagedInstanceErratumSummaryCollectionItemPackage { /** * The CPU architecture type for which this package was built. */ architecture: string; /** * Full package name in NERVA format. This value should be unique. */ displayName: string; /** * The assigned erratum name. It's unique and not changeable. Example: `ELSA-2020-5804` */ name: string; /** * Type of the package. */ type: string; /** * The version of the software package. */ version: string; } interface GetManagedInstanceGroupAutonomousSetting { /** * Indicates whether Autonomous Linux will collect crash files. This setting can be changed by the user. */ isDataCollectionAuthorized: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the restricted scheduled job associated with this instance. This value cannot be deleted by the user. */ scheduledJobId: string; } interface GetManagedInstanceGroupAvailableModulesFilter { /** * The resource name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceGroupAvailableModulesManagedInstanceGroupAvailableModuleCollection { /** * List of available modules. */ items: outputs.OsManagementHub.GetManagedInstanceGroupAvailableModulesManagedInstanceGroupAvailableModuleCollectionItem[]; } interface GetManagedInstanceGroupAvailableModulesManagedInstanceGroupAvailableModuleCollectionItem { /** * The resource name. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides the module. */ softwareSourceId: string; } interface GetManagedInstanceGroupAvailablePackagesFilter { /** * Unique identifier for the package. Note that this is not an OCID. */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceGroupAvailablePackagesManagedInstanceGroupAvailablePackageCollection { /** * List of available packages. */ items: outputs.OsManagementHub.GetManagedInstanceGroupAvailablePackagesManagedInstanceGroupAvailablePackageCollectionItem[]; } interface GetManagedInstanceGroupAvailablePackagesManagedInstanceGroupAvailablePackageCollectionItem { /** * The architecture for which this package was built. */ architecture: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * Indicates whether to list only the latest versions of packages, module streams, and stream profiles. */ isLatest: boolean; /** * Unique identifier for the package. Note that this is not an OCID. */ name: string; /** * List of software sources that provide the software package. */ softwareSources: outputs.OsManagementHub.GetManagedInstanceGroupAvailablePackagesManagedInstanceGroupAvailablePackageCollectionItemSoftwareSource[]; /** * Type of the package. */ type: string; /** * Version of the available package. */ version: string; } interface GetManagedInstanceGroupAvailablePackagesManagedInstanceGroupAvailablePackageCollectionItemSoftwareSource { /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagedInstanceGroupAvailableSoftwareSourcesAvailableSoftwareSourceCollection { /** * List of available software sources. */ items: outputs.OsManagementHub.GetManagedInstanceGroupAvailableSoftwareSourcesAvailableSoftwareSourceCollectionItem[]; } interface GetManagedInstanceGroupAvailableSoftwareSourcesAvailableSoftwareSourceCollectionItem { /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagedInstanceGroupAvailableSoftwareSourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceGroupInstalledPackagesFilter { /** * The name of the package that is installed on the managed instance group. */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceGroupInstalledPackagesManagedInstanceGroupInstalledPackageCollection { /** * List of installed packages. */ items: outputs.OsManagementHub.GetManagedInstanceGroupInstalledPackagesManagedInstanceGroupInstalledPackageCollectionItem[]; } interface GetManagedInstanceGroupInstalledPackagesManagedInstanceGroupInstalledPackageCollectionItem { /** * The architecture of the package that is installed on the managed instance group. */ architecture: string; /** * The name of the package that is installed on the managed instance group. */ name: string; } interface GetManagedInstanceGroupManagedInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceGroupManagedInstancesManagedInstanceCollection { /** * List of managed instances. */ items: outputs.OsManagementHub.GetManagedInstanceGroupManagedInstancesManagedInstanceCollectionItem[]; } interface GetManagedInstanceGroupManagedInstancesManagedInstanceCollectionItem { /** * The version of osmh-agent running on the managed instance */ agentVersion: string; /** * The CPU architecture type of the managed instance. */ architecture: string; /** * Settings for the Autonomous Linux service. */ autonomousSettings: outputs.OsManagementHub.GetManagedInstanceGroupManagedInstancesManagedInstanceCollectionItemAutonomousSetting[]; /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * User-specified description of the managed instance. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; /** * Indicates whether Autonomous Linux manages this instance. */ isManagedByAutonomousLinux: boolean; /** * Whether this managed instance is acting as an on-premises management station. */ isManagementStation: boolean; /** * Indicates whether a reboot is required to complete installation of updates. */ isRebootRequired: boolean; /** * Id and name of a resource to simplify the display for the user. */ lifecycleEnvironments: outputs.OsManagementHub.GetManagedInstanceGroupManagedInstancesManagedInstanceCollectionItemLifecycleEnvironment[]; /** * Id and name of a resource to simplify the display for the user. */ lifecycleStages: outputs.OsManagementHub.GetManagedInstanceGroupManagedInstancesManagedInstanceCollectionItemLifecycleStage[]; /** * The location of the managed instance. */ location: string; /** * Id and name of a resource to simplify the display for the user. */ managedInstanceGroups: outputs.OsManagementHub.GetManagedInstanceGroupManagedInstancesManagedInstanceCollectionItemManagedInstanceGroup[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. */ notificationTopicId: string; /** * The operating system type of the managed instance. */ osFamily: string; /** * Current status of the managed instance. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenancy this managed instance resides in. */ tenancyId: string; /** * Time that the instance last booted (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeLastBoot: string; /** * Number of updates available for installation. */ updatesAvailable: number; } interface GetManagedInstanceGroupManagedInstancesManagedInstanceCollectionItemAutonomousSetting { /** * Indicates whether Autonomous Linux will collect crash files. This setting can be changed by the user. */ isDataCollectionAuthorized: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the restricted scheduled job associated with this instance. This value cannot be deleted by the user. */ scheduledJobId: string; } interface GetManagedInstanceGroupManagedInstancesManagedInstanceCollectionItemLifecycleEnvironment { /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; } interface GetManagedInstanceGroupManagedInstancesManagedInstanceCollectionItemLifecycleStage { /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; } interface GetManagedInstanceGroupManagedInstancesManagedInstanceCollectionItemManagedInstanceGroup { /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; } interface GetManagedInstanceGroupModulesFilter { /** * The resource name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceGroupModulesManagedInstanceGroupModuleCollection { /** * List of module streams. */ items: outputs.OsManagementHub.GetManagedInstanceGroupModulesManagedInstanceGroupModuleCollectionItem[]; } interface GetManagedInstanceGroupModulesManagedInstanceGroupModuleCollectionItem { /** * The name of the module stream that is enabled for the group. */ enabledStream: string; /** * The list of installed profiles under the currently enabled module stream. */ installedProfiles: string[]; /** * The resource name. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides this module stream. */ softwareSourceId: string; } interface GetManagedInstanceGroupSoftwareSource { /** * Software source description. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagedInstanceGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceGroupsManagedInstanceGroupCollection { items: outputs.OsManagementHub.GetManagedInstanceGroupsManagedInstanceGroupCollectionItem[]; } interface GetManagedInstanceGroupsManagedInstanceGroupCollectionItem { /** * A filter to return only profiles that match the given archType. */ archType: string; /** * Settings for the Autonomous Linux service. */ autonomousSettings: outputs.OsManagementHub.GetManagedInstanceGroupsManagedInstanceGroupCollectionItemAutonomousSetting[]; /** * (Updatable) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether to list only resources managed by the Autonomous Linux service. */ isManagedByAutonomousLinux: boolean; /** * A filter to return only resources whose location matches the given value. */ location: string; /** * The number of managed instances in the group. */ managedInstanceCount: number; /** * The list of managed instance [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) attached to the managed instance group. */ managedInstanceIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. */ notificationTopicId: string; /** * A filter to return only resources that match the given operating system family. */ osFamily: string; /** * The number of scheduled jobs pending against the managed instance group. */ pendingJobCount: number; /** * The list of software source [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that the managed instance group will use. */ softwareSourceIds: string[]; /** * The list of software sources that the managed instance group will use. */ softwareSources: outputs.OsManagementHub.GetManagedInstanceGroupsManagedInstanceGroupCollectionItemSoftwareSource[]; /** * A filter to return only managed instance groups that are in the specified state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the managed instance group was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * The time the managed instance group was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * The vendor of the operating system used by the managed instances in the group. */ vendorName: string; } interface GetManagedInstanceGroupsManagedInstanceGroupCollectionItemAutonomousSetting { /** * Indicates whether Autonomous Linux will collect crash files. This setting can be changed by the user. */ isDataCollectionAuthorized: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the restricted scheduled job associated with this instance. This value cannot be deleted by the user. */ scheduledJobId: string; } interface GetManagedInstanceGroupsManagedInstanceGroupCollectionItemSoftwareSource { /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagedInstanceInstalledPackagesFilter { /** * Unique identifier for the package. */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceInstalledPackagesInstalledPackageCollection { /** * List of installed packages. */ items: outputs.OsManagementHub.GetManagedInstanceInstalledPackagesInstalledPackageCollectionItem[]; } interface GetManagedInstanceInstalledPackagesInstalledPackageCollectionItem { /** * The architecture for which this package was built. */ architecture: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * Unique identifier for the package. */ name: string; /** * Status of the software package. */ packageClassification: string; /** * List of software sources that provide the software package. */ softwareSources: outputs.OsManagementHub.GetManagedInstanceInstalledPackagesInstalledPackageCollectionItemSoftwareSource[]; /** * The date and time the package was installed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeInstalled: string; /** * The date and time the package was issued by a providing erratum (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeIssued: string; /** * Type of the package. */ type: string; /** * Version of the installed package. */ version: string; } interface GetManagedInstanceInstalledPackagesInstalledPackageCollectionItemSoftwareSource { /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagedInstanceInstalledWindowsUpdatesFilter { /** * A filter based on the unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed' */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceInstalledWindowsUpdatesInstalledWindowsUpdateCollection { /** * List of installed Windows updates. */ items: outputs.OsManagementHub.GetManagedInstanceInstalledWindowsUpdatesInstalledWindowsUpdateCollectionItem[]; } interface GetManagedInstanceInstalledWindowsUpdatesInstalledWindowsUpdateCollectionItem { /** * A filter based on the unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed' */ name: string; /** * Unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed' */ updateId: string; /** * The type of Windows update. */ updateType: string; } interface GetManagedInstanceLifecycleEnvironment { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetManagedInstanceLifecycleStage { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetManagedInstanceManagedInstanceGroup { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetManagedInstanceModulesFilter { /** * The resource name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceModulesManagedInstanceModuleCollection { /** * List of module streams. */ items: outputs.OsManagementHub.GetManagedInstanceModulesManagedInstanceModuleCollectionItem[]; } interface GetManagedInstanceModulesManagedInstanceModuleCollectionItem { /** * List of streams that are active in the module. */ activeStreams: string[]; /** * List of streams that are disabled in the module. */ disabledStreams: string[]; /** * The stream that is enabled in the module. */ enabledStream: string; /** * List of installed profiles in the enabled stream of the module. */ installedProfiles: string[]; /** * The resource name. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides this module and the associated streams. */ softwareSourceId: string; } interface GetManagedInstanceSnapsFilter { /** * The resource name. */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceSnapsSnapCollection { /** * The list of snaps. */ items: outputs.OsManagementHub.GetManagedInstanceSnapsSnapCollectionItem[]; } interface GetManagedInstanceSnapsSnapCollectionItem { /** * The description of of snap. */ description: string; /** * The resource name. */ name: string; /** * The publisher of the snap. */ publisher: string; /** * The revision number of the snap channel. */ revision: string; /** * The snap's store url. */ storeUrl: string; /** * The date and time of the snap's last refresh in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format. */ timeRefreshed: string; /** * The track this snap is following. */ tracking: string; /** * The version of the snap. */ version: string; } interface GetManagedInstanceSoftwareSource { /** * Software source description. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagedInstanceUpdatablePackagesFilter { /** * Unique identifier for the package. */ name: string; regex?: boolean; values: string[]; } interface GetManagedInstanceUpdatablePackagesUpdatablePackageCollection { /** * List of updatable packages. */ items: outputs.OsManagementHub.GetManagedInstanceUpdatablePackagesUpdatablePackageCollectionItem[]; } interface GetManagedInstanceUpdatablePackagesUpdatablePackageCollectionItem { /** * The advisory severity. */ advisorySeverity: string; /** * The architecture for which this package was built. */ architecture: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * List of errata applicable to this update. */ erratas: string[]; /** * The version of the package that is currently installed on the instance. */ installedVersion: string; /** * Unique identifier for the package. */ name: string; /** * Status of the software package. */ packageClassification: string; /** * List of CVEs applicable to this erratum. */ relatedCves: string[]; /** * List of software sources that provide the software package. */ softwareSources: outputs.OsManagementHub.GetManagedInstanceUpdatablePackagesUpdatablePackageCollectionItemSoftwareSource[]; /** * Type of the package. */ type: string; /** * The type of update. */ updateType: string; /** * Version of the installed package. */ version: string; } interface GetManagedInstanceUpdatablePackagesUpdatablePackageCollectionItemSoftwareSource { /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagedInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedInstancesManagedInstanceCollection { items: outputs.OsManagementHub.GetManagedInstancesManagedInstanceCollectionItem[]; } interface GetManagedInstancesManagedInstanceCollectionItem { /** * A filter to return only managed instances with the specified version of osmh-agent running. */ agentVersion: string; /** * The CPU architecture type of the managed instance. */ architecture: string; /** * Controls whether OSMH manages software sources for this instance. This defaults to false for Ubuntu and Windows instances. */ areSourcesManaged: boolean; /** * Settings for the Autonomous Linux service. */ autonomousSettings: outputs.OsManagementHub.GetManagedInstancesManagedInstanceCollectionItemAutonomousSetting[]; /** * Number of bug fix type updates available for installation. */ bugUpdatesAvailable: number; /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * Number of enhancement type updates available for installation. */ enhancementUpdatesAvailable: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Number of packages installed on the instance. */ installedPackages: number; /** * Number of Windows updates installed on the instance. */ installedWindowsUpdates: number; /** * Indicates whether to list only resources managed by the Autonomous Linux service. */ isManagedByAutonomousLinux: boolean; /** * A filter to return only managed instances that are acting as management stations. */ isManagementStation: boolean; /** * A filter to return only managed instances that require a reboot to install updates. */ isRebootRequired: boolean; /** * The ksplice effective kernel version. */ kspliceEffectiveKernelVersion: string; /** * A filter to return only managed instances in a specific lifecycle environment. */ lifecycleEnvironments: outputs.OsManagementHub.GetManagedInstancesManagedInstanceCollectionItemLifecycleEnvironment[]; /** * A filter to return only managed instances that are associated with the specified lifecycle environment. */ lifecycleStages: outputs.OsManagementHub.GetManagedInstancesManagedInstanceCollectionItemLifecycleStage[]; /** * A filter to return only resources whose location matches the given value. */ location: string; /** * Id and name of a resource to simplify the display for the user. */ managedInstanceGroups: outputs.OsManagementHub.GetManagedInstancesManagedInstanceCollectionItemManagedInstanceGroup[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. This filter returns resources associated with this managed instance. */ managedInstanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. */ notificationTopicId: string; /** * A filter to return only resources that match the given operating system family. */ osFamily: string; /** * Operating system kernel version. */ osKernelVersion: string; /** * Operating system name. */ osName: string; /** * Operating system version. */ osVersion: string; /** * Number of non-classified (other) updates available for installation. */ otherUpdatesAvailable: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station for the instance to use as primary management station. */ primaryManagementStationId: string; /** * A multi filter to return only managed instances that match the given profile ids. */ profile: string; /** * The version of the profile that was used to register this instance with the service. */ profileVersion: string; /** * Number of scheduled jobs associated with this instance. */ scheduledJobCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station for the instance to use as secondary management station. */ secondaryManagementStationId: string; /** * Number of security type updates available for installation. */ securityUpdatesAvailable: number; /** * The list of software sources currently attached to the managed instance. */ softwareSources: outputs.OsManagementHub.GetManagedInstancesManagedInstanceCollectionItemSoftwareSource[]; /** * A filter to return only managed instances whose status matches the status provided. */ status: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenancy that the managed instance resides in. */ tenancyId: string; /** * The date and time the instance was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * Time that the instance last booted (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeLastBoot: string; /** * Time that the instance last checked in with the service (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeLastCheckin: string; /** * The date and time the instance's software information was last refreshed (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeLastSoftwareRefresh: string; /** * The date and time the instance was last updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeUpdated: string; /** * Number of updates available for installation. */ updatesAvailable: number; /** * Number of work requests associated with this instance. */ workRequestCount: number; } interface GetManagedInstancesManagedInstanceCollectionItemAutonomousSetting { /** * Indicates whether Autonomous Linux will collect crash files. This setting can be changed by the user. */ isDataCollectionAuthorized: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the restricted scheduled job associated with this instance. This value cannot be deleted by the user. */ scheduledJobId: string; } interface GetManagedInstancesManagedInstanceCollectionItemLifecycleEnvironment { /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetManagedInstancesManagedInstanceCollectionItemLifecycleStage { /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetManagedInstancesManagedInstanceCollectionItemManagedInstanceGroup { /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetManagedInstancesManagedInstanceCollectionItemSoftwareSource { /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetManagementStationHealth { /** * Explanation of the health status. */ description: string; /** * The current state of the management station. */ state: string; } interface GetManagementStationMirror { /** * Path to the data volume on the management station where software source mirrors are stored. */ directory: string; /** * When enabled, the SSL certificate is verified whenever an instance installs or updates a package from a software source that is mirrored on the management station. */ isSslverifyEnabled: boolean; /** * Listening port used for the proxy. */ port: string; /** * Path to the SSL cerfificate. */ sslcert: string; /** * Default mirror listening port for https. */ sslport: string; } interface GetManagementStationMirrorSyncStatus { /** * Total number of software sources that failed to sync. */ failed: number; /** * Total number of software sources that are queued for sync. */ queued: number; /** * Total number of software sources that successfully synced. */ synced: number; /** * Total number of software sources currently syncing. */ syncing: number; /** * Total number of software sources that have not yet been synced. */ unsynced: number; } interface GetManagementStationMirrorsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagementStationMirrorsMirrorsCollection { /** * List of mirrors */ items: outputs.OsManagementHub.GetManagementStationMirrorsMirrorsCollectionItem[]; } interface GetManagementStationMirrorsMirrorsCollectionItem { /** * The architecture type supported by the software source. */ archType: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * The current log from the management station plugin. */ log: string; /** * The OS family of the software source. */ osFamily: string; /** * The number of packages within the mirrored software source. */ packageCount: number; /** * A decimal number representing the percentage of the software source that has been synced. */ percentage: number; /** * The size the mirrored software source in bytes. */ size: string; /** * Current state of the software source mirror. */ state: string; /** * Time that the software source was last synced (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeLastSynced: string; /** * Type of software source. */ type: string; } interface GetManagementStationPeerManagementStation { /** * User-friendly name for the management station. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station. */ id: string; } interface GetManagementStationProxy { /** * The URL the proxy will forward to. */ forward: string; /** * List of hosts. */ hosts: string[]; /** * Indicates if the proxy should be enabled or disabled. Default is enabled. */ isEnabled: boolean; /** * Listening port used for the proxy. */ port: string; } interface GetManagementStationsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagementStationsManagementStationCollection { items: outputs.OsManagementHub.GetManagementStationsManagementStationCollectionItem[]; } interface GetManagementStationsManagementStationCollectionItem { /** * The architecture type. */ archType: string; /** * (Updatable) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Explanation of the health status. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter that returns information for management stations in the specified health state. */ healthState: string; /** * Hostname of the management station. */ hostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station. A filter that returns information about the specified management station. */ id: string; /** * A filter to return only resources whose location matches the given value. */ location: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. This filter returns resources associated with this managed instance. */ managedInstanceId: string; /** * A decimal number representing the amount of mirror capacity used by the sync. */ mirrorCapacity: number; /** * The operating system family. */ osFamily: string; /** * A decimal number representing the progress of the current mirror sync. */ overallPercentage: number; /** * Current state of the mirror sync for the management station. */ overallState: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the registration profile used for the management station. */ profileId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job for the mirror sync. */ scheduledJobId: string; /** * A filter that returns information for management stations in the specified state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; timeNextExecution?: string; } interface GetProfileAvailableSoftwareSourcesAvailableSoftwareSourceCollection { /** * List of available software sources. */ items: outputs.OsManagementHub.GetProfileAvailableSoftwareSourcesAvailableSoftwareSourceCollectionItem[]; } interface GetProfileAvailableSoftwareSourcesAvailableSoftwareSourceCollectionItem { /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Type of the software source. */ softwareSourceType: string; } interface GetProfileAvailableSoftwareSourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetProfileLifecycleEnvironment { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetProfileLifecycleStage { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetProfileManagedInstanceGroup { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetProfileSoftwareSource { /** * Software source description. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetProfileVersionLifecycleEnvironment { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetProfileVersionLifecycleStage { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetProfileVersionManagedInstanceGroup { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetProfileVersionSoftwareSource { /** * Software source description. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetProfilesFilter { name: string; regex?: boolean; values: string[]; } interface GetProfilesProfileCollection { items: outputs.OsManagementHub.GetProfilesProfileCollectionItem[]; } interface GetProfilesProfileCollectionItem { /** * A filter to return only profiles that match the given archType. */ archType: string; /** * (Updatable) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * A filter to return only default profiles. */ isDefaultProfile: boolean; /** * A filter to return only service-provided profiles. */ isServiceProvidedProfile: boolean; /** * Provides identifying information for the specified lifecycle environment. */ lifecycleEnvironments: outputs.OsManagementHub.GetProfilesProfileCollectionItemLifecycleEnvironment[]; lifecycleStageId: string; /** * Provides identifying information for the specified lifecycle stage. */ lifecycleStages: outputs.OsManagementHub.GetProfilesProfileCollectionItemLifecycleStage[]; managedInstanceGroupId: string; /** * Provides identifying information for the specified managed instance group. */ managedInstanceGroups: outputs.OsManagementHub.GetProfilesProfileCollectionItemManagedInstanceGroup[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station to associate with an instance once registered. Management stations are only used by non-OCI instances. */ managementStationId: string; /** * A filter to return only resources that match the given operating system family. */ osFamily: string; /** * A filter to return registration profiles that match the given profile type. */ profileType: string; /** * The version of the registration profile. */ profileVersion: string; /** * A filter to return profiles that match the given instance type. */ registrationType: string; softwareSourceIds: string[]; /** * The list of software sources that the registration profile will use. */ softwareSources: outputs.OsManagementHub.GetProfilesProfileCollectionItemSoftwareSource[]; /** * A filter to return only registration profiles in the given state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the registration profile was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * The time the registration profile was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * A filter to return only resources that match the given vendor name. */ vendorName: string; } interface GetProfilesProfileCollectionItemLifecycleEnvironment { /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetProfilesProfileCollectionItemLifecycleStage { /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetProfilesProfileCollectionItemManagedInstanceGroup { /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface GetProfilesProfileCollectionItemSoftwareSource { /** * Software source description. */ description: string; /** * A filter to return resources that match the given display names. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetScheduledJobOperation { /** * Provides the information used to install a snap. */ installSnapDetails: outputs.OsManagementHub.GetScheduledJobOperationInstallSnapDetail[]; /** * The set of changes to make to the state of the modules, streams, and profiles on the managed target. */ manageModuleStreamsDetails: outputs.OsManagementHub.GetScheduledJobOperationManageModuleStreamsDetail[]; /** * The type of operation this scheduled job performs. */ operationType: string; /** * The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages. */ packageNames: string[]; /** * The number of minutes the service waits for the reboot to complete. If the instance doesn't reboot within the timeout, the service marks the reboot job as failed. */ rebootTimeoutInMins: number; /** * Provides the information used to remove a snap. */ removeSnapDetails: outputs.OsManagementHub.GetScheduledJobOperationRemoveSnapDetail[]; /** * The software source [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This parameter only applies when the scheduled job is for attaching or detaching software sources. */ softwareSourceIds: string[]; /** * Provides the information used to update a module stream. */ switchModuleStreamsDetails: outputs.OsManagementHub.GetScheduledJobOperationSwitchModuleStreamsDetail[]; /** * Provides the information used to switch a snap channel. */ switchSnapChannelDetails: outputs.OsManagementHub.GetScheduledJobOperationSwitchSnapChannelDetail[]; /** * Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'. */ windowsUpdateNames: string[]; } interface GetScheduledJobOperationInstallSnapDetail { /** * The channel to switch to (e.g. stable, edge, beta, candidate, or a custom channel). */ channel: string; /** * If false, allows installing snaps not signed by the Snap Store. E.g., snaps from local file. Use with caution. */ isSigned: boolean; /** * The confinement mode for the snap. */ mode: string; /** * The name of the snap. */ name: string; /** * The revision to remove. Note: This option cannot be used when removing multiple snaps. */ revision: string; } interface GetScheduledJobOperationManageModuleStreamsDetail { /** * The set of module streams to disable. */ disables: outputs.OsManagementHub.GetScheduledJobOperationManageModuleStreamsDetailDisable[]; /** * The set of module streams to enable. */ enables: outputs.OsManagementHub.GetScheduledJobOperationManageModuleStreamsDetailEnable[]; /** * The set of module stream profiles to install. */ installs: outputs.OsManagementHub.GetScheduledJobOperationManageModuleStreamsDetailInstall[]; /** * The set of module stream profiles to remove. */ removes: outputs.OsManagementHub.GetScheduledJobOperationManageModuleStreamsDetailRemove[]; } interface GetScheduledJobOperationManageModuleStreamsDetailDisable { /** * The name of a module. */ moduleName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface GetScheduledJobOperationManageModuleStreamsDetailEnable { /** * The name of a module. */ moduleName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface GetScheduledJobOperationManageModuleStreamsDetailInstall { /** * The name of a module. */ moduleName: string; /** * The name of a profile of the specified module stream. */ profileName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface GetScheduledJobOperationManageModuleStreamsDetailRemove { /** * The name of a module. */ moduleName: string; /** * The name of a profile of the specified module stream. */ profileName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface GetScheduledJobOperationRemoveSnapDetail { /** * The name of the snap. */ name: string; /** * The revision to remove. Note: This option cannot be used when removing multiple snaps. */ revision: string; } interface GetScheduledJobOperationSwitchModuleStreamsDetail { /** * The name of a module. */ moduleName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface GetScheduledJobOperationSwitchSnapChannelDetail { /** * The channel to switch to (e.g. stable, edge, beta, candidate, or a custom channel). */ channel: string; /** * The name of the snap. */ name: string; } interface GetScheduledJobsFilter { /** * The name of the snap. */ name: string; regex?: boolean; values: string[]; } interface GetScheduledJobsScheduledJobCollection { items: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItem[]; } interface GetScheduledJobsScheduledJobCollectionItem { /** * (Updatable) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * User-specified description for the scheduled job. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The dynamic set [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target. therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds. */ dynamicSetIds: string[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job. A filter to return the specified job. */ id: string; /** * Indicates whether to list only resources managed by the Autonomous Linux service. */ isManagedByAutonomousLinux: boolean; /** * A filter to return only restricted scheduled jobs. */ isRestricted: boolean; /** * Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) (root compartment). */ isSubcompartmentIncluded: boolean; /** * The lifecycle stage [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, managedCompartmentIds, and dynamicSetIds. */ lifecycleStageIds: string[]; /** * The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty. */ locations: string[]; /** * The compartment [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds. */ managedCompartmentIds: string[]; /** * The managed instance group [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds. */ managedInstanceGroupIds: string[]; /** * The managed instance [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds. */ managedInstanceIds: string[]; /** * The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following: * * UPDATE_PACKAGES * * UPDATE_ALL * * UPDATE_SECURITY * * UPDATE_BUGFIX * * UPDATE_ENHANCEMENT * * UPDATE_OTHER * * UPDATE_KSPLICE_USERSPACE * * UPDATE_KSPLICE_KERNEL */ operations: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItemOperation[]; /** * The frequency schedule for a recurring scheduled job in the [RFC5535](https://www.rfc-editor.org/rfc/rfc5535) format. Currently, only FREQ/INTERVAL/BYMONTHDAY/BYDAY/BYSETPOS/BYMONTH/BYHOUR/BYMINUTE/BYSECOND rules are supported. In FREQ, only YEARLY, MONTHLY, WEEKLY, DAILY", HOURLY are supported. */ recurringRule: string; /** * The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries. */ retryIntervals: number[]; /** * A filter to return only scheduled jobs of the given scheduling type (one-time or recurring). */ scheduleType: string; /** * A filter to return only scheduled jobs currently in the given state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time this scheduled job was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * The time of the last execution of this scheduled job (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeLastExecution: string; /** * The time of the next execution of this scheduled job (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeNextExecution: string; /** * The time this scheduled job was updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the work request that will be rerun. */ workRequestId: string; /** * The list of work request [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this scheduled job. */ workRequestIds: string[]; } interface GetScheduledJobsScheduledJobCollectionItemOperation { /** * Provides the information used to install a snap. */ installSnapDetails: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItemOperationInstallSnapDetail[]; /** * The set of changes to make to the state of the modules, streams, and profiles on the managed target. */ manageModuleStreamsDetails: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItemOperationManageModuleStreamsDetail[]; /** * A filter to return only scheduled jobs with the given operation type. */ operationType: string; /** * The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages. */ packageNames: string[]; /** * The number of minutes the service waits for the reboot to complete. If the instance doesn't reboot within the timeout, the service marks the reboot job as failed. */ rebootTimeoutInMins: number; /** * Provides the information used to remove a snap. */ removeSnapDetails: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItemOperationRemoveSnapDetail[]; /** * The software source [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This parameter only applies when the scheduled job is for attaching or detaching software sources. */ softwareSourceIds: string[]; /** * Provides the information used to update a module stream. */ switchModuleStreamsDetails: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItemOperationSwitchModuleStreamsDetail[]; /** * Provides the information used to switch a snap channel. */ switchSnapChannelDetails: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItemOperationSwitchSnapChannelDetail[]; /** * Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'. */ windowsUpdateNames: string[]; } interface GetScheduledJobsScheduledJobCollectionItemOperationInstallSnapDetail { /** * The channel to switch to (e.g. stable, edge, beta, candidate, or a custom channel). */ channel: string; /** * If false, allows installing snaps not signed by the Snap Store. E.g., snaps from local file. Use with caution. */ isSigned: boolean; /** * The confinement mode for the snap. */ mode: string; /** * The name of the snap. */ name: string; /** * The revision to remove. Note: This option cannot be used when removing multiple snaps. */ revision: string; } interface GetScheduledJobsScheduledJobCollectionItemOperationManageModuleStreamsDetail { /** * The set of module streams to disable. */ disables: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItemOperationManageModuleStreamsDetailDisable[]; /** * The set of module streams to enable. */ enables: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItemOperationManageModuleStreamsDetailEnable[]; /** * The set of module stream profiles to install. */ installs: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItemOperationManageModuleStreamsDetailInstall[]; /** * The set of module stream profiles to remove. */ removes: outputs.OsManagementHub.GetScheduledJobsScheduledJobCollectionItemOperationManageModuleStreamsDetailRemove[]; } interface GetScheduledJobsScheduledJobCollectionItemOperationManageModuleStreamsDetailDisable { /** * The name of a module. */ moduleName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface GetScheduledJobsScheduledJobCollectionItemOperationManageModuleStreamsDetailEnable { /** * The name of a module. */ moduleName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface GetScheduledJobsScheduledJobCollectionItemOperationManageModuleStreamsDetailInstall { /** * The name of a module. */ moduleName: string; /** * The name of a profile of the specified module stream. */ profileName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface GetScheduledJobsScheduledJobCollectionItemOperationManageModuleStreamsDetailRemove { /** * The name of a module. */ moduleName: string; /** * The name of a profile of the specified module stream. */ profileName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface GetScheduledJobsScheduledJobCollectionItemOperationRemoveSnapDetail { /** * The name of the snap. */ name: string; /** * The revision to remove. Note: This option cannot be used when removing multiple snaps. */ revision: string; } interface GetScheduledJobsScheduledJobCollectionItemOperationSwitchModuleStreamsDetail { /** * The name of a module. */ moduleName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface GetScheduledJobsScheduledJobCollectionItemOperationSwitchSnapChannelDetail { /** * The channel to switch to (e.g. stable, edge, beta, candidate, or a custom channel). */ channel: string; /** * The name of the snap. */ name: string; } interface GetSoftwarePackageDependency { /** * The software package's dependency. */ dependency: string; /** * The modifier for the dependency. */ dependencyModifier: string; /** * The type of the dependency. */ dependencyType: string; } interface GetSoftwarePackageFile { /** * Checksum of the file. */ checksum: string; /** * Type of the checksum. */ checksumType: string; /** * File path. */ path: string; /** * Size of the package in bytes. */ sizeInBytes: string; /** * The date and time the file was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * Type of the package. */ type: string; } interface GetSoftwarePackageSoftwareSource { /** * Software source description. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetSoftwarePackageSoftwareSourceFilter { name: string; regex?: boolean; values: string[]; } interface GetSoftwarePackageSoftwareSourceSoftwareSourceCollection { /** * List of software sources. */ items: outputs.OsManagementHub.GetSoftwarePackageSoftwareSourceSoftwareSourceCollectionItem[]; } interface GetSoftwarePackageSoftwareSourceSoftwareSourceCollectionItem { /** * A filter to return only instances whose architecture type matches the given architecture. */ archType: string; /** * The availability of the software source in a non-OCI environment for a tenancy. */ availability: string; /** * The availability of the software source in an Oracle Cloud Infrastructure environment for a tenancy. */ availabilityAtOci: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This parameter is required and returns only resources contained within the specified compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of the software source. For custom software sources, this is user-specified. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; /** * Indicates whether the software source is required for the Autonomous Linux service. */ isMandatoryForAutonomousLinux: boolean; /** * Indicates if this software source can be mirrored to a management station. */ isMirrorSyncAllowed: boolean; /** * A filter to return only resources that match the given operating system family. */ osFamily: string; /** * Number of packages the software source contains. */ packageCount: string; /** * The repository ID for the software source. */ repoId: string; /** * The size of the software source in bytes (B). */ size: number; /** * Identifies how the versioned custom software source was created. */ softwareSourceSubType: string; /** * The type of the software source. */ softwareSourceType: string; /** * The version to assign to this custom software source. */ softwareSourceVersion: string; /** * A filter to return only software sources whose state matches the given state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the software source was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * The date and time the software source was updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeUpdated: string; /** * URL for the repository. For vendor software sources, this is the URL to the regional yum server. For custom software sources, this is 'custom/'. */ url: string; /** * Name of the vendor providing the software source. */ vendorName: string; /** * List of vendor software sources that are used for the basis of the versioned custom software source. */ vendorSoftwareSources: outputs.OsManagementHub.GetSoftwarePackageSoftwareSourceSoftwareSourceCollectionItemVendorSoftwareSource[]; } interface GetSoftwarePackageSoftwareSourceSoftwareSourceCollectionItemVendorSoftwareSource { /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; } interface GetSoftwarePackagesFilter { /** * Unique identifier for the package. Note that this is not an OCID. */ name: string; regex?: boolean; values: string[]; } interface GetSoftwarePackagesSoftwarePackageCollection { items: outputs.OsManagementHub.GetSoftwarePackagesSoftwarePackageCollectionItem[]; } interface GetSoftwarePackagesSoftwarePackageCollectionItem { /** * A filter to return software packages that match the given architecture. */ architecture: string; /** * Checksum of the file. */ checksum: string; /** * Type of the checksum. */ checksumType: string; /** * List of dependencies for the software package. */ dependencies: outputs.OsManagementHub.GetSoftwarePackagesSoftwarePackageCollectionItemDependency[]; /** * Software source description. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * List of files for the software package. */ files: outputs.OsManagementHub.GetSoftwarePackagesSoftwarePackageCollectionItemFile[]; /** * Indicates whether to list only the latest versions of packages, module streams, and stream profiles. */ isLatest: boolean; /** * The date and time the package was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ lastModifiedDate: string; /** * Unique identifier for the package. Note that this is not an OCID. */ name: string; /** * The OS families the package belongs to. */ osFamilies: string[]; /** * Size of the package in bytes. */ sizeInBytes: string; /** * List of software sources that provide the software package. This property is deprecated and it will be removed in a future API release. */ softwareSources: outputs.OsManagementHub.GetSoftwarePackagesSoftwarePackageCollectionItemSoftwareSource[]; /** * Type of the package. */ type: string; /** * A filter to return software packages that match the given version. */ version: string; } interface GetSoftwarePackagesSoftwarePackageCollectionItemDependency { /** * The software package's dependency. */ dependency: string; /** * The modifier for the dependency. */ dependencyModifier: string; /** * The type of the dependency. */ dependencyType: string; } interface GetSoftwarePackagesSoftwarePackageCollectionItemFile { /** * Checksum of the file. */ checksum: string; /** * Type of the checksum. */ checksumType: string; /** * File path. */ path: string; /** * Size of the package in bytes. */ sizeInBytes: string; /** * The date and time the file was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * Type of the package. */ type: string; } interface GetSoftwarePackagesSoftwarePackageCollectionItemSoftwareSource { /** * Software source description. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetSoftwareSourceAvailableSoftwarePackagesFilter { /** * Unique identifier for the package. Note that this is not an OCID. */ name: string; regex?: boolean; values: string[]; } interface GetSoftwareSourceAvailableSoftwarePackagesSoftwarePackageCollection { /** * List of software packages. */ items: outputs.OsManagementHub.GetSoftwareSourceAvailableSoftwarePackagesSoftwarePackageCollectionItem[]; } interface GetSoftwareSourceAvailableSoftwarePackagesSoftwarePackageCollectionItem { /** * The architecture for which this software was built. */ architecture: string; /** * Checksum of the package. */ checksum: string; /** * Type of the checksum. */ checksumType: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * Indicates whether to list only the latest versions of packages, module streams, and stream profiles. */ isLatest: boolean; /** * The date and time the package was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ lastModifiedDate: string; /** * Unique identifier for the package. Note that this is not an OCID. */ name: string; /** * The OS families the package belongs to. */ osFamilies: string[]; /** * List of software sources that provide the software package. This property is deprecated and it will be removed in a future API release. */ softwareSources: outputs.OsManagementHub.GetSoftwareSourceAvailableSoftwarePackagesSoftwarePackageCollectionItemSoftwareSource[]; /** * Type of the package. */ type: string; /** * Version of the package. */ version: string; } interface GetSoftwareSourceAvailableSoftwarePackagesSoftwarePackageCollectionItemSoftwareSource { /** * Software source description. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetSoftwareSourceCustomSoftwareSourceFilter { /** * The list of module stream/profile filters. */ moduleStreamProfileFilters: outputs.OsManagementHub.GetSoftwareSourceCustomSoftwareSourceFilterModuleStreamProfileFilter[]; /** * The list of package filters. */ packageFilters: outputs.OsManagementHub.GetSoftwareSourceCustomSoftwareSourceFilterPackageFilter[]; /** * The list of group filters. */ packageGroupFilters: outputs.OsManagementHub.GetSoftwareSourceCustomSoftwareSourceFilterPackageGroupFilter[]; } interface GetSoftwareSourceCustomSoftwareSourceFilterModuleStreamProfileFilter { /** * The type of the filter. */ filterType: string; /** * Module name. */ moduleName: string; /** * Profile name. */ profileName: string; /** * Stream name. */ streamName: string; } interface GetSoftwareSourceCustomSoftwareSourceFilterPackageFilter { /** * The type of the filter. */ filterType: string; /** * The package name. */ packageName: string; /** * The package name pattern. */ packageNamePattern: string; /** * The package version, which is denoted by 'version-release', or 'epoch:version-release'. */ packageVersion: string; } interface GetSoftwareSourceCustomSoftwareSourceFilterPackageGroupFilter { /** * The type of the filter. */ filterType: string; /** * List of package group names. */ packageGroups: string[]; } interface GetSoftwareSourceModuleStreamProfilesFilter { /** * The name of the entity to be queried. */ name: string; regex?: boolean; values: string[]; } interface GetSoftwareSourceModuleStreamProfilesModuleStreamProfileCollection { items: outputs.OsManagementHub.GetSoftwareSourceModuleStreamProfilesModuleStreamProfileCollectionItem[]; } interface GetSoftwareSourceModuleStreamProfilesModuleStreamProfileCollectionItem { /** * A description of the contents of the module stream profile. */ description: string; /** * Indicates if this profile is the default for its module stream. */ isDefault: boolean; /** * The name of a module. This parameter is required if a streamName is specified. */ moduleName: string; /** * The name of the entity to be queried. */ name: string; /** * A list of packages that constitute the profile. Each element in the list is the name of a package. The name is suitable to use as an argument to other OS Management Hub APIs that interact directly with packages. */ packages: string[]; /** * The name of the module stream. This parameter is required if a profile name is specified. */ streamName: string; } interface GetSoftwareSourceModuleStreamsFilter { /** * The name of the entity to be queried. */ name: string; regex?: boolean; values: string[]; } interface GetSoftwareSourceModuleStreamsModuleStreamCollection { items: outputs.OsManagementHub.GetSoftwareSourceModuleStreamsModuleStreamCollectionItem[]; } interface GetSoftwareSourceModuleStreamsModuleStreamCollectionItem { /** * The architecture for which the packages in this module stream were built. */ archType: string; /** * A description of the contents of the module stream. */ description: string; /** * Indicates if this stream is the default for its module. */ isDefault: boolean; /** * Indicates whether to list only the latest versions of packages, module streams, and stream profiles. */ isLatest: boolean; /** * The name of a module. This parameter is required if a streamName is specified. */ moduleName: string; /** * The name of the entity to be queried. */ name: string; /** * A list of packages that are contained by the stream. Each element in the list is the name of a package. The name is suitable to use as an argument to other OS Management Hub APIs that interact directly with packages. */ packages: string[]; /** * A list of profiles that are part of the stream. Each element in the list is the name of a profile. The name is suitable to use as an argument to other OS Management Hub APIs that interact directly with module stream profiles. However, it is not URL encoded. */ profiles: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ softwareSourceId: string; } interface GetSoftwareSourcePackageGroupsFilter { /** * The name of the entity to be queried. */ name: string; regex?: boolean; values: string[]; } interface GetSoftwareSourcePackageGroupsPackageGroupCollection { items: outputs.OsManagementHub.GetSoftwareSourcePackageGroupsPackageGroupCollectionItem[]; } interface GetSoftwareSourcePackageGroupsPackageGroupCollectionItem { /** * Description of the package group. */ description: string; /** * Indicates the order to display category or environment. */ displayOrder: number; /** * A filter to return only package groups of the specified type. */ groupType: string; /** * Package group identifier. */ id: string; /** * Indicates if this package group is the default. */ isDefault: boolean; /** * Indicates if this package group is visible to users. */ isUserVisible: boolean; /** * The name of the entity to be queried. */ name: string; /** * The list of packages in the package group. */ packages: string[]; /** * The repository IDs of the package group's repositories. */ repositories: string[]; } interface GetSoftwareSourceSoftwarePackageDependency { /** * The software package's dependency. */ dependency: string; /** * The modifier for the dependency. */ dependencyModifier: string; /** * The type of the dependency. */ dependencyType: string; } interface GetSoftwareSourceSoftwarePackageFile { /** * Checksum of the file. */ checksum: string; /** * Type of the checksum. */ checksumType: string; /** * File path. */ path: string; /** * Size of the package in bytes. */ sizeInBytes: string; /** * The date and time the file was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * Type of the package. */ type: string; } interface GetSoftwareSourceSoftwarePackageSoftwareSource { /** * Software source description. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetSoftwareSourceSoftwarePackagesFilter { /** * Unique identifier for the package. Note that this is not an OCID. */ name: string; regex?: boolean; values: string[]; } interface GetSoftwareSourceSoftwarePackagesSoftwarePackageCollection { items: outputs.OsManagementHub.GetSoftwareSourceSoftwarePackagesSoftwarePackageCollectionItem[]; } interface GetSoftwareSourceSoftwarePackagesSoftwarePackageCollectionItem { /** * The architecture for which this software was built */ architecture: string; /** * Checksum of the file. */ checksum: string; /** * Type of the checksum. */ checksumType: string; /** * List of dependencies for the software package. */ dependencies: outputs.OsManagementHub.GetSoftwareSourceSoftwarePackagesSoftwarePackageCollectionItemDependency[]; /** * Software source description. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * List of files for the software package. */ files: outputs.OsManagementHub.GetSoftwareSourceSoftwarePackagesSoftwarePackageCollectionItemFile[]; /** * Indicates whether to list only the latest versions of packages, module streams, and stream profiles. */ isLatest: boolean; /** * The date and time the package was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ lastModifiedDate: string; /** * Unique identifier for the package. Note that this is not an OCID. */ name: string; /** * The OS families the package belongs to. */ osFamilies: string[]; /** * Size of the package in bytes. */ sizeInBytes: string; /** * List of software sources that provide the software package. This property is deprecated and it will be removed in a future API release. */ softwareSources: outputs.OsManagementHub.GetSoftwareSourceSoftwarePackagesSoftwarePackageCollectionItemSoftwareSource[]; /** * Type of the package. */ type: string; /** * Version of the package. */ version: string; } interface GetSoftwareSourceSoftwarePackagesSoftwarePackageCollectionItemDependency { /** * The software package's dependency. */ dependency: string; /** * The modifier for the dependency. */ dependencyModifier: string; /** * The type of the dependency. */ dependencyType: string; } interface GetSoftwareSourceSoftwarePackagesSoftwarePackageCollectionItemFile { /** * Checksum of the file. */ checksum: string; /** * Type of the checksum. */ checksumType: string; /** * File path. */ path: string; /** * Size of the package in bytes. */ sizeInBytes: string; /** * The date and time the file was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * Type of the package. */ type: string; } interface GetSoftwareSourceSoftwarePackagesSoftwarePackageCollectionItemSoftwareSource { /** * Software source description. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface GetSoftwareSourceVendorSoftwareSource { /** * User-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; } interface GetSoftwareSourceVendorsFilter { /** * The name of the entity to be queried. */ name: string; regex?: boolean; values: string[]; } interface GetSoftwareSourceVendorsSoftwareSourceVendorCollection { /** * List of software source vendors. */ items: outputs.OsManagementHub.GetSoftwareSourceVendorsSoftwareSourceVendorCollectionItem[]; } interface GetSoftwareSourceVendorsSoftwareSourceVendorCollectionItem { /** * List of corresponding architecture types. */ archTypes: string[]; /** * The name of the entity to be queried. */ name: string; /** * List of corresponding operating system families. */ osFamilies: string[]; } interface GetSoftwareSourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetSoftwareSourcesSoftwareSourceCollection { items: outputs.OsManagementHub.GetSoftwareSourcesSoftwareSourceCollectionItem[]; } interface GetSoftwareSourcesSoftwareSourceCollectionItem { /** * A filter to return only instances whose architecture type matches the given architecture. */ archType: string; /** * The availability of the software source in a non-OCI environment for a tenancy. */ availability: string; /** * The availability of the software source in an Oracle Cloud Infrastructure environment for a tenancy. */ availabilityAtOci: string; /** * (Updatable) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * User-specified description for the software source. */ description: string; /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; /** * Indicates whether the software source is mandatory for the Autonomous Linux service. */ isMandatoryForAutonomousLinux: boolean; /** * A filter to return software sources which can be synced to a management station. */ isMirrorSyncAllowed: boolean; /** * A filter to return only resources that match the given operating system family. */ osFamily: string; /** * Number of packages the software source contains. */ packageCount: string; /** * The repository ID for the software source. */ repoId: string; /** * The size of the software source in bytes (B). */ size: number; /** * Identifies how the versioned custom software source was created. */ softwareSourceSubType: string; /** * The type of the software source. */ softwareSourceType: string; /** * The version to assign to this custom software source. */ softwareSourceVersion: string; /** * A filter to return only software sources whose state matches the given state. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the software source was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; timeUpdated: string; /** * URL for the repository. For vendor software sources, this is the URL to the regional yum server. For custom software sources, this is 'custom/'. */ url: string; /** * A filter to return only resources that match the given vendor name. */ vendorName: string; /** * List of vendor software sources that are used for the basis of the versioned custom software source. */ vendorSoftwareSources: outputs.OsManagementHub.GetSoftwareSourcesSoftwareSourceCollectionItemVendorSoftwareSource[]; } interface GetSoftwareSourcesSoftwareSourceCollectionItemVendorSoftwareSource { /** * A filter to return resources that match the given user-friendly name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. */ id: string; } interface GetWindowsUpdatesFilter { /** * A filter based on the unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed' */ name: string; regex?: boolean; values: string[]; } interface GetWindowsUpdatesWindowsUpdateCollection { items: outputs.OsManagementHub.GetWindowsUpdatesWindowsUpdateCollectionItem[]; } interface GetWindowsUpdatesWindowsUpdateCollectionItem { /** * Description of the update. */ description: string; /** * Indicates whether the update can be installed using the service. */ installable: string; /** * List of requirements for installing the update on the managed instance. */ installationRequirements: string[]; /** * Indicates whether a reboot is required to complete the installation of this update. */ isRebootRequiredForInstallation: boolean; /** * List of the Microsoft Knowledge Base Article Ids related to this Windows Update. */ kbArticleIds: string[]; /** * A filter based on the unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed' */ name: string; /** * size of the package in bytes */ sizeInBytes: string; /** * Unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed' */ updateId: string; /** * The type of Windows update. */ updateType: string; } interface LifecycleEnvironmentManagedInstanceId { /** * (Updatable) A user-friendly name for the lifecycle environment. Does not have to be unique and you can change the name later. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface LifecycleEnvironmentStage { /** * The CPU architecture of the managed instances in the lifecycle environment. */ archType: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the lifecycle stage. */ compartmentId: string; /** * (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"}` */ definedTags: { [key: string]: string; }; /** * (Updatable) A user-friendly name for the lifecycle stage. Does not have to be unique and you can change the name later. Avoid entering confidential information. */ displayName: string; /** * (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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment that contains the lifecycle stage. */ lifecycleEnvironmentId: string; /** * The location of managed instances attached to the lifecycle environment. If no location is provided, the default is 'ON_PREMISE.' */ location: string; /** * The list of managed instances associated with the lifecycle stage. */ managedInstanceIds: outputs.OsManagementHub.LifecycleEnvironmentStageManagedInstanceId[]; /** * The operating system of the managed instances in the lifecycle environment. */ osFamily: string; /** * User-specified rank for the lifecycle stage. Rank determines the hierarchy of the lifecycle stages within the lifecycle environment. */ rank: number; /** * Provides identifying information for the specified software source. */ softwareSourceIds: outputs.OsManagementHub.LifecycleEnvironmentStageSoftwareSourceId[]; /** * The current state of the lifecycle environment. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the lifecycle environment was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeCreated: string; /** * The time the lifecycle environment was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). */ timeModified: string; /** * The vendor of the operating system used by the managed instances in the lifecycle environment. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vendorName: string; } interface LifecycleEnvironmentStageManagedInstanceId { /** * (Updatable) A user-friendly name for the lifecycle environment. Does not have to be unique and you can change the name later. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface LifecycleEnvironmentStageSoftwareSourceId { /** * (Updatable) User-specified information about the lifecycle environment. Avoid entering confidential information. */ description: string; /** * (Updatable) A user-friendly name for the lifecycle environment. Does not have to be unique and you can change the name later. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface LifecycleStageAttachManagedInstancesManagementManagedInstanceDetails { /** * The list of managed instance OCIDs to be attached/detached. */ managedInstances: string[]; /** * Provides the name and description of the job. */ workRequestDetails: outputs.OsManagementHub.LifecycleStageAttachManagedInstancesManagementManagedInstanceDetailsWorkRequestDetails; } interface LifecycleStageAttachManagedInstancesManagementManagedInstanceDetailsWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface LifecycleStageDetachManagedInstancesManagementManagedInstanceDetails { /** * The list of managed instance OCIDs to be attached/detached. */ managedInstances: string[]; /** * Provides the name and description of the job. */ workRequestDetails: outputs.OsManagementHub.LifecycleStageDetachManagedInstancesManagementManagedInstanceDetailsWorkRequestDetails; } interface LifecycleStageDetachManagedInstancesManagementManagedInstanceDetailsWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface LifecycleStagePromoteSoftwareSourceManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface LifecycleStageRebootManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceAttachSoftwareSourcesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceAutonomousSettings { /** * (Updatable) Indicates whether Autonomous Linux will collect crash files. */ isDataCollectionAuthorized: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the restricted scheduled job associated with this instance. This value cannot be deleted by the user. */ scheduledJobId: string; } interface ManagedInstanceDetachSoftwareSourcesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceGroupAttachManagedInstancesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceGroupAttachSoftwareSourcesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceGroupAutonomousSettings { /** * (Updatable) Indicates whether Autonomous Linux will collect crash files. */ isDataCollectionAuthorized: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the restricted scheduled job associated with this instance. This value cannot be deleted by the user. */ scheduledJobId: string; } interface ManagedInstanceGroupDetachSoftwareSourcesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceGroupInstallPackagesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceGroupInstallWindowsUpdatesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceGroupManageModuleStreamsManagementDisable { /** * The name of a module. */ moduleName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface ManagedInstanceGroupManageModuleStreamsManagementEnable { /** * The name of a module. */ moduleName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface ManagedInstanceGroupManageModuleStreamsManagementInstall { /** * The name of a module. */ moduleName: string; /** * The name of a profile of the specified module stream. */ profileName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface ManagedInstanceGroupManageModuleStreamsManagementRemove { /** * The name of a module. */ moduleName: string; /** * The name of a profile of the specified module stream. */ profileName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * The name of a stream of the specified module. */ streamName: string; } interface ManagedInstanceGroupManageModuleStreamsManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceGroupRebootManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceGroupRemovePackagesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceGroupSoftwareSource { /** * (Updatable) User-specified description of the managed instance group. Avoid entering confidential information. */ description: string; /** * (Updatable) A user-friendly name for the managed instance group. Does not have to be unique and you can change the name later. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface ManagedInstanceGroupUpdateAllPackagesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceInstallPackagesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceInstallSnapsManagementSnapDetail { /** * The snap channel to install from (e.g. stable, 1.2/edge, beta, candidate, or a custom channel). */ channel: string; /** * If false, allows installing snaps not signed by the Snap Store. E.g., snaps from local file. Use with caution. */ isSigned: boolean; /** * The confinement mode for the snap. */ mode: string; /** * The name of the snap to install. */ name: string; /** * The snap revision to install. */ revision: string; } interface ManagedInstanceInstallSnapsManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceInstallWindowsUpdatesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceLifecycleEnvironment { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface ManagedInstanceLifecycleStage { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface ManagedInstanceManagedInstanceGroup { /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface ManagedInstanceRebootManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceRemovePackagesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceRemoveSnapsManagementSnapDetail { /** * The name of the snap to remove. */ name: string; /** * The revision to remove. Note: This option cannot be used when removing multiple snaps. */ revision: string; } interface ManagedInstanceRemoveSnapsManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceSoftwareSource { /** * (Updatable) User-specified description of the managed instance. Avoid entering confidential information. */ description: string; /** * Software source name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface ManagedInstanceSwitchSnapChannelManagementSnapDetails { /** * The channel to switch to (e.g. stable, edge, beta, candidate, or a custom channel). */ channel: string; /** * The name of the snap. */ name: string; } interface ManagedInstanceSwitchSnapChannelManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstanceUpdatePackagesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstancesInstallWindowsUpdatesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagedInstancesUpdatePackagesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagementStationAssociateManagedInstancesManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ displayName: string; } interface ManagementStationHealth { /** * (Updatable) User-specified description of the management station. Avoid entering confidential information. */ description: string; /** * The current state of the management station. */ state: string; } interface ManagementStationMirror { /** * (Updatable) Path to the data volume on the management station where software source mirrors are stored. */ directory: string; /** * (Updatable) When enabled, the SSL certificate is verified whenever an instance installs or updates a package from a software source that is mirrored on the management station. */ isSslverifyEnabled: boolean; /** * (Updatable) Default mirror listening port for http. */ port: string; /** * (Updatable) Path to the SSL cerfificate. */ sslcert: string; /** * (Updatable) Default mirror listening port for https. */ sslport: string; } interface ManagementStationMirrorSyncStatus { /** * Total number of software sources that failed to sync. */ failed: number; /** * Total number of software sources that are queued for sync. */ queued: number; /** * Total number of software sources that successfully synced. */ synced: number; /** * Total number of software sources currently syncing. */ syncing: number; /** * Total number of software sources that have not yet been synced. */ unsynced: number; } interface ManagementStationPeerManagementStation { /** * (Updatable) User-friendly name for the management station. Does not have to be unique and you can change the name later. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station. */ id: string; } interface ManagementStationProxy { /** * (Updatable) The URL the proxy will forward to. */ forward: string; /** * (Updatable) List of hosts. */ hosts: string[]; /** * (Updatable) Indicates if the proxy should be enabled or disabled. Default is enabled. */ isEnabled: boolean; /** * (Updatable) Listening port used for the proxy. */ port: string; } interface ProfileLifecycleEnvironment { /** * (Updatable) A user-friendly name. Must be unique and you can change the name later. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface ProfileLifecycleStage { /** * (Updatable) A user-friendly name. Must be unique and you can change the name later. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface ProfileManagedInstanceGroup { /** * (Updatable) A user-friendly name. Must be unique and you can change the name later. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; } interface ProfileSoftwareSource { /** * (Updatable) User-specified description of the registration profile. */ description: string; /** * (Updatable) A user-friendly name. Must be unique and you can change the name later. Avoid entering confidential information. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. */ id: string; /** * Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. */ isMandatoryForAutonomousLinux: boolean; /** * Type of the software source. */ softwareSourceType: string; } interface ScheduledJobOperation { /** * (Updatable) Provides the information used to install a snap. */ installSnapDetails: outputs.OsManagementHub.ScheduledJobOperationInstallSnapDetails; /** * (Updatable) The set of changes to make to the state of the modules, streams, and profiles on the managed target. */ manageModuleStreamsDetails: outputs.OsManagementHub.ScheduledJobOperationManageModuleStreamsDetails; /** * (Updatable) The type of operation this scheduled job performs. */ operationType: string; /** * (Updatable) The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages. */ packageNames: string[]; /** * (Updatable) The number of minutes the service waits for the reboot to complete. If the instance doesn't reboot within the timeout, the service marks the reboot job as failed. */ rebootTimeoutInMins: number; /** * (Updatable) Provides the information used to remove a snap. */ removeSnapDetails: outputs.OsManagementHub.ScheduledJobOperationRemoveSnapDetails; /** * (Updatable) The software source [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This parameter only applies when the scheduled job is for attaching or detaching software sources. */ softwareSourceIds: string[]; /** * (Updatable) Provides the information used to update a module stream. */ switchModuleStreamsDetails: outputs.OsManagementHub.ScheduledJobOperationSwitchModuleStreamsDetails; /** * (Updatable) Provides the information used to switch a snap channel. */ switchSnapChannelDetails: outputs.OsManagementHub.ScheduledJobOperationSwitchSnapChannelDetails; /** * (Updatable) Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'. */ windowsUpdateNames: string[]; } interface ScheduledJobOperationInstallSnapDetails { /** * (Updatable) The snap channel to install from (e.g. stable, 1.2/edge, beta, candidate, or a custom channel). */ channel: string; /** * (Updatable) If false, allows installing snaps not signed by the Snap Store. E.g., snaps from local file. Use with caution. */ isSigned: boolean; /** * (Updatable) The confinement mode for the snap. */ mode: string; /** * (Updatable) The name of the snap to install. */ name: string; /** * (Updatable) The snap revision to install. */ revision: string; } interface ScheduledJobOperationManageModuleStreamsDetails { /** * (Updatable) The set of module streams to disable. */ disables: outputs.OsManagementHub.ScheduledJobOperationManageModuleStreamsDetailsDisable[]; /** * (Updatable) The set of module streams to enable. */ enables: outputs.OsManagementHub.ScheduledJobOperationManageModuleStreamsDetailsEnable[]; /** * (Updatable) The set of module stream profiles to install. */ installs: outputs.OsManagementHub.ScheduledJobOperationManageModuleStreamsDetailsInstall[]; /** * (Updatable) The set of module stream profiles to remove. */ removes: outputs.OsManagementHub.ScheduledJobOperationManageModuleStreamsDetailsRemove[]; } interface ScheduledJobOperationManageModuleStreamsDetailsDisable { /** * (Updatable) The name of a module. */ moduleName: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * (Updatable) The name of a stream of the specified module. */ streamName: string; } interface ScheduledJobOperationManageModuleStreamsDetailsEnable { /** * (Updatable) The name of a module. */ moduleName: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * (Updatable) The name of a stream of the specified module. */ streamName: string; } interface ScheduledJobOperationManageModuleStreamsDetailsInstall { /** * (Updatable) The name of a module. */ moduleName: string; /** * (Updatable) The name of a profile of the specified module stream. */ profileName: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * (Updatable) The name of a stream of the specified module. */ streamName: string; } interface ScheduledJobOperationManageModuleStreamsDetailsRemove { /** * (Updatable) The name of a module. */ moduleName: string; /** * (Updatable) The name of a profile of the specified module stream. */ profileName: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * (Updatable) The name of a stream of the specified module. */ streamName: string; } interface ScheduledJobOperationRemoveSnapDetails { /** * (Updatable) The name of the snap to remove. */ name: string; /** * (Updatable) The revision to remove. Note: This option cannot be used when removing multiple snaps. */ revision: string; } interface ScheduledJobOperationSwitchModuleStreamsDetails { /** * (Updatable) The name of a module. */ moduleName: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. */ softwareSourceId: string; /** * (Updatable) The name of a stream of the specified module. */ streamName: string; } interface ScheduledJobOperationSwitchSnapChannelDetails { /** * (Updatable) The channel to switch to (e.g. stable, edge, beta, candidate, or a custom channel). */ channel: string; /** * (Updatable) The name of the snap. */ name: string; } interface SoftwareSourceChangeAvailabilityManagementSoftwareSourceAvailability { /** * Availability of the software source to instances in private data centers or third-party clouds. */ availability: string; /** * Availability of the software source to Oracle Cloud Infrastructure instances. */ availabilityAtOci: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the vendor software source. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ softwareSourceId: string; } interface SoftwareSourceCustomSoftwareSourceFilter { /** * (Updatable) The list of module stream/profile filters. */ moduleStreamProfileFilters: outputs.OsManagementHub.SoftwareSourceCustomSoftwareSourceFilterModuleStreamProfileFilter[]; /** * (Updatable) The list of package filters. */ packageFilters: outputs.OsManagementHub.SoftwareSourceCustomSoftwareSourceFilterPackageFilter[]; /** * (Updatable) The list of group filters. */ packageGroupFilters: outputs.OsManagementHub.SoftwareSourceCustomSoftwareSourceFilterPackageGroupFilter[]; } interface SoftwareSourceCustomSoftwareSourceFilterModuleStreamProfileFilter { /** * (Updatable) The type of the filter. */ filterType: string; /** * (Updatable) Module name. */ moduleName: string; /** * (Updatable) Profile name. */ profileName: string; /** * (Updatable) Stream name. */ streamName: string; } interface SoftwareSourceCustomSoftwareSourceFilterPackageFilter { /** * (Updatable) The type of the filter. */ filterType: string; /** * (Updatable) The package name. */ packageName: string; /** * (Updatable) The package name pattern. */ packageNamePattern: string; /** * (Updatable) The package version, which is denoted by 'version-release', or 'epoch:version-release'. */ packageVersion: string; } interface SoftwareSourceCustomSoftwareSourceFilterPackageGroupFilter { /** * (Updatable) The type of the filter. */ filterType: string; /** * (Updatable) List of package group names. */ packageGroups: string[]; } interface SoftwareSourceVendorSoftwareSource { /** * (Updatable) User-friendly name. */ displayName: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ id: string; } interface WorkRequestRerunManagementWorkRequestDetails { /** * User-specified information about the job. Avoid entering confidential information. */ description: string; /** * A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. */ displayName: string; } } export declare namespace OspGateway { interface AddressActionVerificationAddress { /** * Address identifier. */ addressKey: string; /** * Name of the city. */ city: string; /** * Name of the customer company. */ companyName: string; /** * Contributor class of the customer company. */ contributorClass: string; /** * Country of the address. */ country: string; /** * County of the address. */ county: string; /** * Department name of the customer company. */ departmentName: string; /** * Contact person email address. */ emailAddress: string; /** * First name of the contact person. */ firstName: string; /** * Internal number of the customer company. */ internalNumber: string; /** * Job title of the contact person. */ jobTitle: string; /** * Last name of the contact person. */ lastName: string; /** * Address line 1. */ line1: string; /** * Address line 2. */ line2: string; /** * Address line 3. */ line3: string; /** * Address line 4. */ line4: string; /** * Middle name of the contact person. */ middleName: string; /** * Municipal Inscription. */ municipalInscription: string; /** * Phone country code of the contact person. */ phoneCountryCode: string; /** * Phone number of the contact person. */ phoneNumber: string; /** * Post code of the address. */ postalCode: string; /** * Province of the address. */ province: string; /** * State of the address. */ state: string; /** * State Inscription. */ stateInscription: string; /** * Street name of the address. */ streetName: string; /** * Street number of the address. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ streetNumber: string; } interface GetAddressRuleAddress { /** * Tax type rule fields */ fields: outputs.OspGateway.GetAddressRuleAddressField[]; /** * Third party validation. */ thirdPartyValidation: string; } interface GetAddressRuleAddressField { /** * Format information */ formats: outputs.OspGateway.GetAddressRuleAddressFieldFormat[]; /** * The given field is requeired or not */ isRequired: boolean; /** * Label information */ labels: outputs.OspGateway.GetAddressRuleAddressFieldLabel[]; /** * Locale code (rfc4646 format) of a forced language (e.g.: jp addresses require jp always) */ language: string; /** * User friendly name */ name: string; } interface GetAddressRuleAddressFieldFormat { /** * English translation of the label (for reference only - translation is not provided) */ example: string; /** * Value */ value: string; } interface GetAddressRuleAddressFieldLabel { /** * English translation of the label (for reference only - translation is not provided) */ example: string; /** * Value */ value: string; } interface GetAddressRuleContact { /** * Tax type rule fields */ fields: outputs.OspGateway.GetAddressRuleContactField[]; } interface GetAddressRuleContactField { /** * Format information */ formats: outputs.OspGateway.GetAddressRuleContactFieldFormat[]; /** * The given field is requeired or not */ isRequired: boolean; /** * Label information */ labels: outputs.OspGateway.GetAddressRuleContactFieldLabel[]; /** * Locale code (rfc4646 format) of a forced language (e.g.: jp addresses require jp always) */ language: string; /** * User friendly name */ name: string; } interface GetAddressRuleContactFieldFormat { /** * English translation of the label (for reference only - translation is not provided) */ example: string; /** * Value */ value: string; } interface GetAddressRuleContactFieldLabel { /** * English translation of the label (for reference only - translation is not provided) */ example: string; /** * Value */ value: string; } interface GetAddressRuleTax { /** * Tax type rule fields */ fields: outputs.OspGateway.GetAddressRuleTaxField[]; /** * Label value pair for allowed values. Used for GIRO */ valueSets: outputs.OspGateway.GetAddressRuleTaxValueSet[]; } interface GetAddressRuleTaxField { /** * Format information */ formats: outputs.OspGateway.GetAddressRuleTaxFieldFormat[]; /** * The given field is requeired or not */ isRequired: boolean; /** * Label information */ labels: outputs.OspGateway.GetAddressRuleTaxFieldLabel[]; /** * Locale code (rfc4646 format) of a forced language (e.g.: jp addresses require jp always) */ language: string; /** * User friendly name */ name: string; } interface GetAddressRuleTaxFieldFormat { /** * English translation of the label (for reference only - translation is not provided) */ example: string; /** * Value */ value: string; } interface GetAddressRuleTaxFieldLabel { /** * English translation of the label (for reference only - translation is not provided) */ example: string; /** * Value */ value: string; } interface GetAddressRuleTaxValueSet { /** * User friendly name */ name: string; /** * Value */ value: string; } interface GetInvoiceBillToAddress { /** * Address line 1 */ addressLine1: string; /** * Address line 2 */ addressLine2: string; /** * Address line 3 */ addressLine3: string; /** * Address line 4 */ addressLine4: string; /** * Name of the city */ city: string; /** * Name of the customer company */ companyName: string; /** * Name of the contact person */ contactName: string; /** * Country details model */ countries: outputs.OspGateway.GetInvoiceBillToAddressCountry[]; /** * County name */ county: string; /** * ZIP no */ postalCode: string; /** * Name of the province */ province: string; /** * Name of the state */ state: string; /** * Street name */ streetName: string; /** * House no */ streetNumber: string; } interface GetInvoiceBillToAddressCountry { /** * Country code in ISO-3166-1 3-letter format */ ascii3countryCode: string; /** * Country code in ISO-3166-1 2-letter format */ countryCode: string; /** * Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table */ countryId: number; /** * Name of the country */ countryName: string; /** * Language identifier */ languageId: number; } interface GetInvoiceCurrency { /** * Currency code */ currencyCode: string; /** * Currency symbol */ currencySymbol: string; /** * Name of the currency */ name: string; /** * Round decimal point */ roundDecimalPoint: number; /** * USD conversion rate of the currency */ usdConversion: number; } interface GetInvoiceLastPaymentDetail { /** * Account number of the card owner */ accountNumber: string; /** * Amount that paid */ amountPaid: number; /** * Echeck card type */ cardType: string; /** * Credit card type */ creditCardType: string; /** * Last four routing digits of the card */ echeckRouting: string; /** * Last four digits of the card */ lastDigits: string; /** * Name on the credit card */ nameOnCard: string; /** * example */ paidBy: string; /** * Payment method */ paymentMethod: string; /** * The id (email address) of the paypal payment */ paypalId: string; /** * paypal payment reference */ paypalReference: string; /** * Routing number of the echeck card */ routingNumber: string; /** * Expired date of the credit card */ timeExpiration: string; /** * Paid the invoice on this day */ timePaidOn: string; } interface GetInvoicesFilter { /** * Name of the currency */ name: string; regex?: boolean; values: string[]; } interface GetInvoicesInvoiceCollection { items: outputs.OspGateway.GetInvoicesInvoiceCollectionItem[]; } interface GetInvoicesInvoiceCollectionItem { /** * Address details model */ billToAddresses: outputs.OspGateway.GetInvoicesInvoiceCollectionItemBillToAddress[]; /** * Currency details model */ currencies: outputs.OspGateway.GetInvoicesInvoiceCollectionItemCurrency[]; /** * Transaction identifier */ internalInvoiceId: string; /** * Total amount of invoice */ invoiceAmount: number; /** * Invoice amount adjust */ invoiceAmountAdjusted: number; /** * Invoice amount applied */ invoiceAmountApplied: number; /** * Invoice amount credit */ invoiceAmountCredited: number; /** * Balance of invoice */ invoiceAmountDue: number; invoiceAmountInDispute: number; /** * The invoice query param (not unique). */ invoiceId: string; /** * Invoice external reference */ invoiceNumber: string; /** * Invoice PO number */ invoicePoNumber: string; /** * Invoice reference number */ invoiceRefNumber: string; /** * Invoice status */ invoiceStatus: string; /** * Type of invoice */ invoiceType: string; /** * Is credit card payment eligible */ isCreditCardPayable: boolean; /** * Is pdf download access allowed */ isDisplayDownloadPdf: boolean; isDisplayViewPdf: boolean; isPaid: boolean; /** * Whether invoice can be payed */ isPayable: boolean; isPaymentFailed: boolean; /** * Is emailing pdf allowed */ isPdfEmailAvailable: boolean; /** * Payment related details */ lastPaymentDetails: outputs.OspGateway.GetInvoicesInvoiceCollectionItemLastPaymentDetail[]; partyName: string; /** * Payment terms */ paymentTerms: string; /** * Preferred Email on the invoice */ preferredEmail: string; /** * List of subscription identifiers */ subscriptionIds: string[]; /** * Tax of invoice amount */ tax: number; /** * Date of invoice */ timeInvoice: string; /** * Due date of invoice */ timeInvoiceDue: string; } interface GetInvoicesInvoiceCollectionItemBillToAddress { /** * Address line 1 */ addressLine1: string; /** * Address line 2 */ addressLine2: string; /** * Address line 3 */ addressLine3: string; /** * Address line 4 */ addressLine4: string; /** * Name of the city */ city: string; /** * Name of the customer company */ companyName: string; /** * Name of the contact person */ contactName: string; /** * Country details model */ countries: outputs.OspGateway.GetInvoicesInvoiceCollectionItemBillToAddressCountry[]; /** * County name */ county: string; /** * ZIP no */ postalCode: string; /** * Name of the province */ province: string; /** * Name of the state */ state: string; /** * Street name */ streetName: string; /** * House no */ streetNumber: string; } interface GetInvoicesInvoiceCollectionItemBillToAddressCountry { /** * Country code in ISO-3166-1 3-letter format */ ascii3countryCode: string; /** * Country code in ISO-3166-1 2-letter format */ countryCode: string; /** * Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table */ countryId: number; /** * Name of the country */ countryName: string; /** * Language identifier */ languageId: number; } interface GetInvoicesInvoiceCollectionItemCurrency { /** * Currency code */ currencyCode: string; /** * Currency symbol */ currencySymbol: string; /** * Name of the currency */ name: string; /** * Round decimal point */ roundDecimalPoint: number; /** * USD conversion rate of the currency */ usdConversion: number; } interface GetInvoicesInvoiceCollectionItemLastPaymentDetail { /** * Account number of the card owner */ accountNumber: string; /** * Amount that paid */ amountPaid: number; /** * Echeck card type */ cardType: string; /** * Credit card type */ creditCardType: string; /** * Last four routing digits of the card */ echeckRouting: string; /** * Last four digits of the card */ lastDigits: string; /** * Name on the credit card */ nameOnCard: string; /** * example */ paidBy: string; /** * Payment method */ paymentMethod: string; /** * The id (email address) of the paypal payment */ paypalId: string; /** * paypal payment reference */ paypalReference: string; /** * Routing number of the echeck card */ routingNumber: string; /** * Expired date of the credit card */ timeExpiration: string; /** * Paid the invoice on this day */ timePaidOn: string; } interface GetInvoicesInvoiceLineItem { /** * Currency details model */ currencies: outputs.OspGateway.GetInvoicesInvoiceLineItemCurrency[]; /** * Unit price of the ordered product */ netUnitPrice: number; /** * Product of the item */ orderNo: string; /** * Part number */ partNumber: string; /** * Product of the item */ product: string; /** * Quantity of the ordered product */ quantity: number; /** * End date */ timeEnd: string; /** * Start date */ timeStart: string; /** * Total price of the ordered product (Net unit price x quantity) */ totalPrice: number; } interface GetInvoicesInvoiceLineItemCurrency { /** * Currency code */ currencyCode: string; /** * Currency symbol */ currencySymbol: string; /** * Name of the currency */ name: string; /** * Round decimal point */ roundDecimalPoint: number; /** * USD conversion rate of the currency */ usdConversion: number; } interface GetInvoicesInvoiceLinesFilter { /** * Name of the currency */ name: string; regex?: boolean; values: string[]; } interface GetInvoicesInvoiceLinesInvoiceLineCollection { /** * Invoice line list elements */ items: outputs.OspGateway.GetInvoicesInvoiceLinesInvoiceLineCollectionItem[]; } interface GetInvoicesInvoiceLinesInvoiceLineCollectionItem { /** * Currency details model */ currencies: outputs.OspGateway.GetInvoicesInvoiceLinesInvoiceLineCollectionItemCurrency[]; /** * Unit price of the ordered product */ netUnitPrice: number; /** * Product of the item */ orderNo: string; /** * Part number */ partNumber: string; /** * Product of the item */ product: string; /** * Quantity of the ordered product */ quantity: number; /** * End date */ timeEnd: string; /** * Start date */ timeStart: string; /** * Total price of the ordered product (Net unit price x quantity) */ totalPrice: number; } interface GetInvoicesInvoiceLinesInvoiceLineCollectionItemCurrency { /** * Currency code */ currencyCode: string; /** * Currency symbol */ currencySymbol: string; /** * Name of the currency */ name: string; /** * Round decimal point */ roundDecimalPoint: number; /** * USD conversion rate of the currency */ usdConversion: number; } interface GetSubscriptionBillingAddress { /** * Address identifier. */ addressKey: string; /** * Name of the city. */ city: string; /** * Name of the customer company. */ companyName: string; /** * Contributor class of the customer company. */ contributorClass: string; /** * Country of the address. */ country: string; /** * County of the address. */ county: string; /** * Department name of the customer company. */ departmentName: string; /** * The email address of the paypal user. */ emailAddress: string; /** * First name of the paypal user. */ firstName: string; /** * Internal number of the customer company. */ internalNumber: string; /** * Job title of the contact person. */ jobTitle: string; /** * Last name of the paypal user. */ lastName: string; /** * Address line 1. */ line1: string; /** * Address line 2. */ line2: string; /** * Address line 3. */ line3: string; /** * Address line 4. */ line4: string; /** * Middle name of the contact person. */ middleName: string; /** * Municipal Inscription. */ municipalInscription: string; /** * Phone country code of the contact person. */ phoneCountryCode: string; /** * Phone number of the contact person. */ phoneNumber: string; /** * Post code of the address. */ postalCode: string; /** * Province of the address. */ province: string; /** * State of the address. */ state: string; /** * State Inscription. */ stateInscription: string; /** * Street name of the address. */ streetName: string; /** * Street number of the address. */ streetNumber: string; } interface GetSubscriptionPaymentGateway { /** * Merchant details. */ merchantDefinedDatas: outputs.OspGateway.GetSubscriptionPaymentGatewayMerchantDefinedData[]; } interface GetSubscriptionPaymentGatewayMerchantDefinedData { /** * Cloud account name. */ cloudAccountName: string; /** * Promotion type code. */ promoType: string; } interface GetSubscriptionPaymentOption { /** * Credit card type. */ creditCardType: string; /** * The email address of the paypal user. */ emailAddress: string; /** * Agreement id for the paypal account. */ extBillingAgreementId: string; /** * First name of the paypal user. */ firstName: string; /** * Last four digits of the card. */ lastDigits: string; /** * Last name of the paypal user. */ lastName: string; /** * Name on the credit card. */ nameOnCard: string; /** * Payment method */ paymentMethod: string; /** * Expired date of the credit card. */ timeExpiration: string; /** * Wallet instrument internal id. */ walletInstrumentId: string; /** * Wallet transaction id. */ walletTransactionId: string; } interface GetSubscriptionSubscription { /** * Account type. */ accountType: string; /** * Bill to customer Account id. */ billToCustAccountId: string; /** * Address details model. */ billingAddresses: outputs.OspGateway.GetSubscriptionSubscriptionBillingAddress[]; /** * Currency code */ currencyCode: string; /** * GSI Subscription external code. */ gsiOrgCode: string; /** * Subscription id identifier (OCID). */ id: string; /** * Corporate conversion allowed status */ isCorporateConversionAllowed: boolean; /** * Payment intension. */ isIntentToPay: boolean; /** * Language short code (en, de, hu, etc) */ languageCode: string; /** * GSI organization external identifier. */ organizationId: string; /** * Payment gateway details. */ paymentGateways: outputs.OspGateway.GetSubscriptionSubscriptionPaymentGateway[]; /** * Payment option list of a subscription. */ paymentOptions: outputs.OspGateway.GetSubscriptionSubscriptionPaymentOption[]; /** * Subscription plan type. */ planType: string; /** * Ship to customer account role. */ shipToCustAcctRoleId: string; /** * Ship to customer account site address id. */ shipToCustAcctSiteId: string; /** * Subscription plan number. */ subscriptionPlanNumber: string; /** * Tax details. */ taxInfos: outputs.OspGateway.GetSubscriptionSubscriptionTaxInfo[]; /** * Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE */ timePersonalToCorporateConv: string; /** * Date of upgrade/conversion when planType changed from FREE_TIER to PAYG */ timePlanUpgrade: string; /** * Start date of the subscription. */ timeStart: string; /** * Status of the upgrade. */ upgradeState: string; /** * This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError) */ upgradeStateDetails: string; } interface GetSubscriptionSubscriptionBillingAddress { /** * Address identifier. */ addressKey: string; /** * Name of the city. */ city: string; /** * Name of the customer company. */ companyName: string; /** * Contributor class of the customer company. */ contributorClass: string; /** * Country of the address. */ country: string; /** * County of the address. */ county: string; /** * Department name of the customer company. */ departmentName: string; /** * The email address of the paypal user. */ emailAddress: string; /** * First name of the paypal user. */ firstName: string; /** * Internal number of the customer company. */ internalNumber: string; /** * Job title of the contact person. */ jobTitle: string; /** * Last name of the paypal user. */ lastName: string; /** * Address line 1. */ line1: string; /** * Address line 2. */ line2: string; /** * Address line 3. */ line3: string; /** * Address line 4. */ line4: string; /** * Middle name of the contact person. */ middleName: string; /** * Municipal Inscription. */ municipalInscription: string; /** * Phone country code of the contact person. */ phoneCountryCode: string; /** * Phone number of the contact person. */ phoneNumber: string; /** * Post code of the address. */ postalCode: string; /** * Province of the address. */ province: string; /** * State of the address. */ state: string; /** * State Inscription. */ stateInscription: string; /** * Street name of the address. */ streetName: string; /** * Street number of the address. */ streetNumber: string; } interface GetSubscriptionSubscriptionPaymentGateway { /** * Merchant details. */ merchantDefinedDatas: outputs.OspGateway.GetSubscriptionSubscriptionPaymentGatewayMerchantDefinedData[]; } interface GetSubscriptionSubscriptionPaymentGatewayMerchantDefinedData { /** * Cloud account name. */ cloudAccountName: string; /** * Promotion type code. */ promoType: string; } interface GetSubscriptionSubscriptionPaymentOption { /** * Credit card type. */ creditCardType: string; /** * The email address of the paypal user. */ emailAddress: string; /** * Agreement id for the paypal account. */ extBillingAgreementId: string; /** * First name of the paypal user. */ firstName: string; /** * Last four digits of the card. */ lastDigits: string; /** * Last name of the paypal user. */ lastName: string; /** * Name on the credit card. */ nameOnCard: string; /** * Payment method */ paymentMethod: string; /** * Expired date of the credit card. */ timeExpiration: string; /** * Wallet instrument internal id. */ walletInstrumentId: string; /** * Wallet transaction id. */ walletTransactionId: string; } interface GetSubscriptionSubscriptionTaxInfo { /** * Tax exemption reason code. */ noTaxReasonCode: string; /** * Tax exemption reason description. */ noTaxReasonCodeDetails: string; /** * Brazilian companies' CNPJ number. */ taxCnpj: string; /** * Tay payer identifier. */ taxPayerId: string; /** * Tax registration number. */ taxRegNumber: string; } interface GetSubscriptionTaxInfo { /** * Companies' GIRO code */ giro: string; /** * Tax exemption reason code. */ noTaxReasonCode: string; /** * Tax exemption reason description. */ noTaxReasonCodeDetails: string; /** * Brazilian companies' CNPJ number. */ taxCnpj: string; /** * Tay payer identifier. */ taxPayerId: string; /** * Tax registration number. */ taxRegNumber: string; } interface GetSubscriptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSubscriptionsSubscriptionCollection { items: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItem[]; } interface GetSubscriptionsSubscriptionCollectionItem { /** * Account type. */ accountType: string; /** * Bill to customer Account id. */ billToCustAccountId: string; /** * Address details model. */ billingAddresses: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemBillingAddress[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Currency code */ currencyCode: string; email: string; /** * GSI Subscription external code. */ gsiOrgCode: string; /** * Subscription id identifier (OCID). */ id: string; /** * Corporate conversion allowed status */ isCorporateConversionAllowed: boolean; /** * Payment intension. */ isIntentToPay: boolean; /** * Language short code (en, de, hu, etc) */ languageCode: string; /** * GSI organization external identifier. */ organizationId: string; /** * The home region's public name of the logged in user. */ ospHomeRegion: string; /** * Payment gateway details. */ paymentGateways: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemPaymentGateway[]; /** * Payment option list of a subscription. */ paymentOptions: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemPaymentOption[]; /** * Subscription plan type. */ planType: string; /** * Ship to customer account role. */ shipToCustAcctRoleId: string; /** * Ship to customer account site address id. */ shipToCustAcctSiteId: string; subscriptionId: string; /** * Subscription plan number. */ subscriptionPlanNumber: string; subscriptions: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemSubscription[]; /** * Tax details. */ taxInfos: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemTaxInfo[]; /** * Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE */ timePersonalToCorporateConv: string; /** * Date of upgrade/conversion when planType changed from FREE_TIER to PAYG */ timePlanUpgrade: string; /** * Start date of the subscription. */ timeStart: string; /** * Status of the upgrade. */ upgradeState: string; /** * This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError) */ upgradeStateDetails: string; } interface GetSubscriptionsSubscriptionCollectionItemBillingAddress { /** * Address identifier. */ addressKey: string; /** * Name of the city. */ city: string; /** * Name of the customer company. */ companyName: string; /** * Contributor class of the customer company. */ contributorClass: string; /** * Country of the address. */ country: string; /** * County of the address. */ county: string; /** * Department name of the customer company. */ departmentName: string; /** * The email address of the paypal user. */ emailAddress: string; /** * First name of the paypal user. */ firstName: string; /** * Internal number of the customer company. */ internalNumber: string; /** * Job title of the contact person. */ jobTitle: string; /** * Last name of the paypal user. */ lastName: string; /** * Address line 1. */ line1: string; /** * Address line 2. */ line2: string; /** * Address line 3. */ line3: string; /** * Address line 4. */ line4: string; /** * Middle name of the contact person. */ middleName: string; /** * Municipal Inscription. */ municipalInscription: string; /** * Phone country code of the contact person. */ phoneCountryCode: string; /** * Phone number of the contact person. */ phoneNumber: string; /** * Post code of the address. */ postalCode: string; /** * Province of the address. */ province: string; /** * State of the address. */ state: string; /** * State Inscription. */ stateInscription: string; /** * Street name of the address. */ streetName: string; /** * Street number of the address. */ streetNumber: string; } interface GetSubscriptionsSubscriptionCollectionItemPaymentGateway { /** * Merchant details. */ merchantDefinedDatas: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemPaymentGatewayMerchantDefinedData[]; } interface GetSubscriptionsSubscriptionCollectionItemPaymentGatewayMerchantDefinedData { /** * Cloud account name. */ cloudAccountName: string; /** * Promotion type code. */ promoType: string; } interface GetSubscriptionsSubscriptionCollectionItemPaymentOption { /** * Credit card type. */ creditCardType: string; /** * The email address of the paypal user. */ emailAddress: string; /** * Agreement id for the paypal account. */ extBillingAgreementId: string; /** * First name of the paypal user. */ firstName: string; /** * Last four digits of the card. */ lastDigits: string; /** * Last name of the paypal user. */ lastName: string; /** * Name on the credit card. */ nameOnCard: string; /** * Payment method */ paymentMethod: string; /** * Expired date of the credit card. */ timeExpiration: string; /** * Wallet instrument internal id. */ walletInstrumentId: string; /** * Wallet transaction id. */ walletTransactionId: string; } interface GetSubscriptionsSubscriptionCollectionItemSubscription { /** * Account type. */ accountType: string; /** * Bill to customer Account id. */ billToCustAccountId: string; /** * Address details model. */ billingAddresses: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemSubscriptionBillingAddress[]; /** * Currency code */ currencyCode: string; /** * GSI Subscription external code. */ gsiOrgCode: string; /** * Subscription id identifier (OCID). */ id: string; /** * Corporate conversion allowed status */ isCorporateConversionAllowed: boolean; /** * Payment intension. */ isIntentToPay: boolean; /** * Language short code (en, de, hu, etc) */ languageCode: string; /** * GSI organization external identifier. */ organizationId: string; /** * Payment gateway details. */ paymentGateways: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemSubscriptionPaymentGateway[]; /** * Payment option list of a subscription. */ paymentOptions: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemSubscriptionPaymentOption[]; /** * Subscription plan type. */ planType: string; /** * Ship to customer account role. */ shipToCustAcctRoleId: string; /** * Ship to customer account site address id. */ shipToCustAcctSiteId: string; /** * Subscription plan number. */ subscriptionPlanNumber: string; /** * Tax details. */ taxInfos: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemSubscriptionTaxInfo[]; /** * Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE */ timePersonalToCorporateConv: string; /** * Date of upgrade/conversion when planType changed from FREE_TIER to PAYG */ timePlanUpgrade: string; /** * Start date of the subscription. */ timeStart: string; /** * Status of the upgrade. */ upgradeState: string; /** * This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError) */ upgradeStateDetails: string; } interface GetSubscriptionsSubscriptionCollectionItemSubscriptionBillingAddress { /** * Address identifier. */ addressKey: string; /** * Name of the city. */ city: string; /** * Name of the customer company. */ companyName: string; /** * Contributor class of the customer company. */ contributorClass: string; /** * Country of the address. */ country: string; /** * County of the address. */ county: string; /** * Department name of the customer company. */ departmentName: string; /** * The email address of the paypal user. */ emailAddress: string; /** * First name of the paypal user. */ firstName: string; /** * Internal number of the customer company. */ internalNumber: string; /** * Job title of the contact person. */ jobTitle: string; /** * Last name of the paypal user. */ lastName: string; /** * Address line 1. */ line1: string; /** * Address line 2. */ line2: string; /** * Address line 3. */ line3: string; /** * Address line 4. */ line4: string; /** * Middle name of the contact person. */ middleName: string; /** * Municipal Inscription. */ municipalInscription: string; /** * Phone country code of the contact person. */ phoneCountryCode: string; /** * Phone number of the contact person. */ phoneNumber: string; /** * Post code of the address. */ postalCode: string; /** * Province of the address. */ province: string; /** * State of the address. */ state: string; /** * State Inscription. */ stateInscription: string; /** * Street name of the address. */ streetName: string; /** * Street number of the address. */ streetNumber: string; } interface GetSubscriptionsSubscriptionCollectionItemSubscriptionPaymentGateway { /** * Merchant details. */ merchantDefinedDatas: outputs.OspGateway.GetSubscriptionsSubscriptionCollectionItemSubscriptionPaymentGatewayMerchantDefinedData[]; } interface GetSubscriptionsSubscriptionCollectionItemSubscriptionPaymentGatewayMerchantDefinedData { /** * Cloud account name. */ cloudAccountName: string; /** * Promotion type code. */ promoType: string; } interface GetSubscriptionsSubscriptionCollectionItemSubscriptionPaymentOption { /** * Credit card type. */ creditCardType: string; /** * The email address of the paypal user. */ emailAddress: string; /** * Agreement id for the paypal account. */ extBillingAgreementId: string; /** * First name of the paypal user. */ firstName: string; /** * Last four digits of the card. */ lastDigits: string; /** * Last name of the paypal user. */ lastName: string; /** * Name on the credit card. */ nameOnCard: string; /** * Payment method */ paymentMethod: string; /** * Expired date of the credit card. */ timeExpiration: string; /** * Wallet instrument internal id. */ walletInstrumentId: string; /** * Wallet transaction id. */ walletTransactionId: string; } interface GetSubscriptionsSubscriptionCollectionItemSubscriptionTaxInfo { /** * Tax exemption reason code. */ noTaxReasonCode: string; /** * Tax exemption reason description. */ noTaxReasonCodeDetails: string; /** * Brazilian companies' CNPJ number. */ taxCnpj: string; /** * Tay payer identifier. */ taxPayerId: string; /** * Tax registration number. */ taxRegNumber: string; } interface GetSubscriptionsSubscriptionCollectionItemTaxInfo { /** * Companies' GIRO code */ giro: string; /** * Tax exemption reason code. */ noTaxReasonCode: string; /** * Tax exemption reason description. */ noTaxReasonCodeDetails: string; /** * Brazilian companies' CNPJ number. */ taxCnpj: string; /** * Tay payer identifier. */ taxPayerId: string; /** * Tax registration number. */ taxRegNumber: string; } interface SubscriptionBillingAddress { /** * Address identifier. */ addressKey: string; /** * Name of the city. */ city: string; /** * Name of the customer company. */ companyName: string; /** * Contributor class of the customer company. */ contributorClass: string; /** * Country of the address. */ country: string; /** * County of the address. */ county: string; /** * Department name of the customer company. */ departmentName: string; /** * The email address of the paypal user. */ emailAddress: string; /** * First name of the paypal user. */ firstName: string; /** * Internal number of the customer company. */ internalNumber: string; /** * Job title of the contact person. */ jobTitle: string; /** * Last name of the paypal user. */ lastName: string; /** * Address line 1. */ line1: string; /** * Address line 2. */ line2: string; /** * Address line 3. */ line3: string; /** * Address line 4. */ line4: string; /** * Middle name of the contact person. */ middleName: string; /** * Municipal Inscription. */ municipalInscription: string; /** * Phone country code of the contact person. */ phoneCountryCode: string; /** * Phone number of the contact person. */ phoneNumber: string; /** * Post code of the address. */ postalCode: string; /** * Province of the address. */ province: string; /** * State of the address. */ state: string; /** * State Inscription. */ stateInscription: string; /** * Street name of the address. */ streetName: string; /** * Street number of the address. */ streetNumber: string; } interface SubscriptionPaymentGateway { /** * Merchant details. */ merchantDefinedDatas: outputs.OspGateway.SubscriptionPaymentGatewayMerchantDefinedData[]; } interface SubscriptionPaymentGatewayMerchantDefinedData { /** * Cloud account name. */ cloudAccountName: string; /** * Promotion type code. */ promoType: string; } interface SubscriptionPaymentOption { /** * Credit card type. */ creditCardType: string; /** * The email address of the paypal user. */ emailAddress: string; /** * Agreement id for the paypal account. */ extBillingAgreementId: string; /** * First name of the paypal user. */ firstName: string; /** * Last four digits of the card. */ lastDigits: string; /** * Last name of the paypal user. */ lastName: string; /** * Name on the credit card. */ nameOnCard: string; /** * Payment method */ paymentMethod: string; /** * Expired date of the credit card. */ timeExpiration: string; /** * Wallet instrument internal id. */ walletInstrumentId: string; /** * Wallet transaction id. */ walletTransactionId: string; } interface SubscriptionSubscription { /** * (Updatable) Account type. */ accountType: string; /** * (Updatable) Bill to customer Account id. */ billToCustAccountId: string; /** * (Updatable) Address details model. */ billingAddresses?: outputs.OspGateway.SubscriptionSubscriptionBillingAddress[]; /** * (Updatable) Currency code */ currencyCode: string; /** * (Updatable) GSI Subscription external code. */ gsiOrgCode: string; /** * (Updatable) Subscription id identifier (OCID). */ id: string; /** * (Updatable) Corporate conversion allowed status */ isCorporateConversionAllowed: boolean; /** * (Updatable) Payment intension. */ isIntentToPay: boolean; /** * (Updatable) Language short code (en, de, hu, etc) */ languageCode: string; /** * (Updatable) GSI organization external identifier. */ organizationId: string; /** * (Updatable) Payment gateway details. */ paymentGateway: outputs.OspGateway.SubscriptionSubscriptionPaymentGateway; /** * (Updatable) Payment option list of a subscription. */ paymentOptions: outputs.OspGateway.SubscriptionSubscriptionPaymentOption[]; /** * (Updatable) Subscription plan type. */ planType: string; /** * (Updatable) Ship to customer account role. */ shipToCustAcctRoleId: string; /** * (Updatable) Ship to customer account site address id. */ shipToCustAcctSiteId: string; /** * (Updatable) Subscription plan number. */ subscriptionPlanNumber: string; /** * (Updatable) Tax details. */ taxInfo: outputs.OspGateway.SubscriptionSubscriptionTaxInfo; /** * (Updatable) Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE */ timePersonalToCorporateConv: string; /** * (Updatable) Date of upgrade/conversion when planType changed from FREE_TIER to PAYG */ timePlanUpgrade: string; /** * (Updatable) Start date of the subscription. */ timeStart: string; /** * (Updatable) Status of the upgrade. */ upgradeState: string; /** * (Updatable) This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError) */ upgradeStateDetails: string; } interface SubscriptionSubscriptionBillingAddress { /** * (Updatable) Address identifier. */ addressKey: string; /** * (Updatable) Name of the city. */ city: string; /** * (Updatable) Name of the customer company. */ companyName: string; /** * (Updatable) Contributor class of the customer company. */ contributorClass: string; /** * (Updatable) Country of the address. */ country: string; /** * (Updatable) County of the address. */ county: string; /** * (Updatable) Department name of the customer company. */ departmentName: string; /** * (Updatable) Contact person email address. */ emailAddress: string; /** * (Updatable) First name of the contact person. */ firstName: string; /** * (Updatable) Internal number of the customer company. */ internalNumber: string; /** * (Updatable) Job title of the contact person. */ jobTitle: string; /** * (Updatable) Last name of the contact person. */ lastName: string; /** * (Updatable) Address line 1. */ line1: string; /** * (Updatable) Address line 2. */ line2: string; /** * (Updatable) Address line 3. */ line3: string; /** * (Updatable) Address line 4. */ line4: string; /** * (Updatable) Middle name of the contact person. */ middleName: string; /** * (Updatable) Municipal Inscription. */ municipalInscription: string; /** * (Updatable) Phone country code of the contact person. */ phoneCountryCode: string; /** * (Updatable) Phone number of the contact person. */ phoneNumber: string; /** * (Updatable) Post code of the address. */ postalCode: string; /** * (Updatable) Province of the address. */ province: string; /** * (Updatable) State of the address. */ state: string; /** * (Updatable) State Inscription. */ stateInscription: string; /** * (Updatable) Street name of the address. */ streetName: string; /** * (Updatable) Street number of the address. */ streetNumber: string; } interface SubscriptionSubscriptionPaymentGateway { /** * (Updatable) Merchant details. */ merchantDefinedData: outputs.OspGateway.SubscriptionSubscriptionPaymentGatewayMerchantDefinedData; } interface SubscriptionSubscriptionPaymentGatewayMerchantDefinedData { /** * (Updatable) Cloud account name. */ cloudAccountName: string; /** * (Updatable) Promotion type code. */ promoType: string; } interface SubscriptionSubscriptionPaymentOption { /** * (Updatable) Credit card type. */ creditCardType: string; /** * (Updatable) The email address of the paypal user. */ emailAddress: string; /** * (Updatable) Agreement id for the paypal account. */ extBillingAgreementId: string; /** * (Updatable) First name of the paypal user. */ firstName: string; /** * (Updatable) Last four digits of the card. */ lastDigits: string; /** * (Updatable) Last name of the paypal user. */ lastName: string; /** * (Updatable) Name on the credit card. */ nameOnCard: string; /** * (Updatable) Payment method */ paymentMethod: string; /** * (Updatable) Expired date of the credit card. */ timeExpiration: string; /** * (Updatable) Wallet instrument internal id. */ walletInstrumentId: string; /** * (Updatable) Wallet transaction id. */ walletTransactionId: string; } interface SubscriptionSubscriptionTaxInfo { /** * (Updatable) Tax exemption reason code. */ noTaxReasonCode: string; /** * (Updatable) Tax exemption reason description. */ noTaxReasonCodeDetails: string; /** * (Updatable) Brazilian companies' CNPJ number. */ taxCnpj: string; /** * (Updatable) Tay payer identifier. */ taxPayerId: string; /** * (Updatable) Tax registration number. */ taxRegNumber: string; } interface SubscriptionTaxInfo { /** * Companies' GIRO code */ giro: string; /** * Tax exemption reason code. */ noTaxReasonCode: string; /** * Tax exemption reason description. */ noTaxReasonCodeDetails: string; /** * Brazilian companies' CNPJ number. */ taxCnpj: string; /** * Tay payer identifier. */ taxPayerId: string; /** * Tax registration number. */ taxRegNumber: string; } } export declare namespace OsubBillingSchedule { interface GetBillingScheduleBillingSchedule { /** * Billing schedule line net amount */ amount: string; /** * Indicates the associated AR Customer transaction id a unique identifier existing on AR. */ arCustomerTransactionId: string; /** * Indicates the associated AR Invoice Number */ arInvoiceNumber: string; /** * Billing frequency */ billingFrequency: string; /** * Billing schedule invoice status */ invoiceStatus: string; /** * Billing schedule net unit price */ netUnitPrice: string; /** * Order number associated with the Subscribed Service */ orderNumber: string; /** * Product description */ products: outputs.OsubBillingSchedule.GetBillingScheduleBillingScheduleProduct[]; /** * Billing schedule quantity */ quantity: string; /** * Billing schedule end date */ timeEnd: string; /** * Billing schedule invoicing date */ timeInvoicing: string; /** * Billing schedule start date */ timeStart: string; } interface GetBillingScheduleBillingScheduleProduct { /** * Product name */ name: string; /** * Indicates the associated AR Invoice Number */ partNumber: string; } interface GetBillingScheduleFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } } export declare namespace OsubOrganizationSubscription { interface GetOrganizationSubscriptionsFilter { /** * Currency name */ name: string; regex?: boolean; values: string[]; } interface GetOrganizationSubscriptionsSubscription { /** * Currency details */ currencies: outputs.OsubOrganizationSubscription.GetOrganizationSubscriptionsSubscriptionCurrency[]; /** * SPM internal Subscription ID */ id: string; /** * Customer friendly service name provided by PRG */ serviceName: string; /** * Status of the plan */ status: string; /** * Represents the date when the last service of the subscription ends */ timeEnd: string; /** * Represents the date when the first service of the subscription was activated */ timeStart: string; /** * Total aggregate TCLV of all lines for the subscription including expired, active, and signed */ totalValue: string; /** * Subscription Type i.e. IAAS,SAAS,PAAS */ type: string; } interface GetOrganizationSubscriptionsSubscriptionCurrency { /** * Currency Code */ isoCode: string; /** * Currency name */ name: string; /** * Standard Precision of the Currency */ stdPrecision: string; } } export declare namespace OsubSubscription { interface GetCommitmentsCommitment { /** * Commitment available amount */ availableAmount: string; /** * Funded Allocation line value example: 12000.00 */ fundedAllocationValue: string; /** * SPM internal Commitment ID */ id: string; /** * Commitment quantity */ quantity: string; /** * Commitment end date */ timeEnd: string; /** * Commitment start date */ timeStart: string; /** * Commitment used amount */ usedAmount: string; } interface GetCommitmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetRatecardsFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } interface GetRatecardsRateCard { /** * Currency details */ currencies: outputs.OsubSubscription.GetRatecardsRateCardCurrency[]; /** * Rate card discretionary discount percentage */ discretionaryDiscountPercentage: string; /** * Rate card price tier flag */ isTier: boolean; /** * Rate card tier net unit price */ netUnitPrice: string; /** * Rate card tier overage price */ overagePrice: string; /** * Product description */ products: outputs.OsubSubscription.GetRatecardsRateCardProduct[]; /** * List of tiered rate card prices */ rateCardTiers: outputs.OsubSubscription.GetRatecardsRateCardRateCardTier[]; /** * Rate card end date */ timeEnd: string; /** * Rate card start date */ timeStart: string; } interface GetRatecardsRateCardCurrency { /** * Currency Code */ isoCode: string; /** * Product name */ name: string; /** * Standard Precision of the Currency */ stdPrecision: string; } interface GetRatecardsRateCardProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * This param is used to get the rate card(s) filterd by the partNumber */ partNumber: string; /** * Product category */ productCategory: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of measure */ unitOfMeasure: string; } interface GetRatecardsRateCardRateCardTier { /** * Rate card tier net unit price */ netUnitPrice: string; /** * Rate card tier overage price */ overagePrice: string; /** * Rate card tier quantity range */ upToQuantity: string; } interface GetSubscriptionsFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } interface GetSubscriptionsSubscription { /** * Currency details */ currencies: outputs.OsubSubscription.GetSubscriptionsSubscriptionCurrency[]; /** * Customer friendly service name provided by PRG */ serviceName: string; /** * Subscribed service status */ status: string; /** * List of Subscribed Services of the plan */ subscribedServices: outputs.OsubSubscription.GetSubscriptionsSubscriptionSubscribedService[]; /** * Represents the date when the last service of the subscription ends */ timeEnd: string; /** * Represents the date when the first service of the subscription was activated */ timeStart: string; } interface GetSubscriptionsSubscriptionCurrency { /** * Currency Code */ isoCode: string; /** * Product name */ name: string; /** * Standard Precision of the Currency */ stdPrecision: string; } interface GetSubscriptionsSubscriptionSubscribedService { /** * Booking Opportunity Number of Subscribed Service */ bookingOptyNumber: string; /** * List of Commitment services of a line */ commitmentServices: outputs.OsubSubscription.GetSubscriptionsSubscriptionSubscribedServiceCommitmentService[]; /** * Subscribed service CSI number */ csi: string; /** * Subscribed service data center region */ dataCenterRegion: string; /** * Funded Allocation line value example: 12000.00 */ fundedAllocationValue: string; /** * SPM internal Subscribed Service ID */ id: string; /** * Subscribed service intent to pay flag */ isIntentToPay: boolean; /** * Subscribed service net unit price */ netUnitPrice: string; /** * Subscribed service operation type */ operationType: string; /** * Sales Order Number associated to the subscribed service */ orderNumber: string; /** * This field contains the name of the partner to which the subscription belongs - depending on which the invoicing may differ */ partnerTransactionType: string; /** * Subscribed service pricing model */ pricingModel: string; /** * Product description */ products: outputs.OsubSubscription.GetSubscriptionsSubscriptionSubscribedServiceProduct[]; /** * Subscribed service program type */ programType: string; /** * Subscribed service promotion type */ promoType: string; /** * Subscribed service quantity */ quantity: string; /** * Subscribed service status */ status: string; /** * Term value in Months */ termValue: string; /** * Term value UOM */ termValueUom: string; /** * Represents the date when the last service of the subscription ends */ timeEnd: string; /** * Represents the date when the first service of the subscription was activated */ timeStart: string; /** * Subscribed service total value */ totalValue: string; } interface GetSubscriptionsSubscriptionSubscribedServiceCommitmentService { /** * Commitment available amount */ availableAmount: string; /** * Funded Allocation line value example: 12000.00 */ fundedAllocationValue: string; /** * Commitment line net amount */ lineNetAmount: string; /** * Subscribed service quantity */ quantity: string; /** * Represents the date when the last service of the subscription ends */ timeEnd: string; /** * Represents the date when the first service of the subscription was activated */ timeStart: string; } interface GetSubscriptionsSubscriptionSubscribedServiceProduct { /** * Product name */ name: string; /** * Product part numner */ partNumber: string; /** * Product provisioning group */ provisioningGroup: string; /** * Unit of measure */ unitOfMeasure: string; } } export declare namespace OsubUsage { interface GetCommitmentAggregatedsComputedUsageAggregated { /** * Aggregation of computed usages for the subscribed service. */ aggregatedComputedUsages: outputs.OsubUsage.GetCommitmentAggregatedsComputedUsageAggregatedAggregatedComputedUsage[]; /** * Currency code */ currencyCode: string; /** * Product part number for subscribed service line, called parent product. */ parentProducts: outputs.OsubUsage.GetCommitmentAggregatedsComputedUsageAggregatedParentProduct[]; /** * Subscribed service line parent id */ parentSubscribedServiceId: string; /** * Subscribed service asociated subscription plan number. */ planNumber: string; /** * Subscribed services pricing model */ pricingModel: string; /** * Inernal SPM Ratecard Id at line level */ rateCardId: string; /** * Subscription Id is an identifier associated to the service used for filter the Computed Usage in SPM. */ subscriptionId: string; /** * Subscribed services contract line end date, expressed in RFC 3339 timestamp format. */ timeEnd: string; /** * Subscribed services contract line start date, expressed in RFC 3339 timestamp format. */ timeStart: string; } interface GetCommitmentAggregatedsComputedUsageAggregatedAggregatedComputedUsage { /** * Sum of Computed Line Amount rounded */ cost: string; /** * Sum of Computed Line Amount unrounded */ costUnrounded: string; /** * Data Center Attribute as sent by MQS to SPM. */ dataCenter: string; /** * Net Unit Price for the product in consideration. */ netUnitPrice: string; /** * Product description */ products: outputs.OsubUsage.GetCommitmentAggregatedsComputedUsageAggregatedAggregatedComputedUsageProduct[]; /** * Total Quantity that was used for computation */ quantity: string; /** * Metered Service date , expressed in RFC 3339 timestamp format. */ timeMeteredOn: string; /** * Usage compute type in SPM. */ type: string; } interface GetCommitmentAggregatedsComputedUsageAggregatedAggregatedComputedUsageProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Measure */ unitOfMeasure: string; } interface GetCommitmentAggregatedsComputedUsageAggregatedParentProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Measure */ unitOfMeasure: string; } interface GetCommitmentAggregatedsFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } interface GetComputedUsageParentProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Messure */ unitOfMeasure: string; } interface GetComputedUsageProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Messure */ unitOfMeasure: string; } interface GetComputedUsagesComputedUsage { /** * Subscribed service commitmentId. */ commitmentServiceId: string; /** * SPM Internal compute records source . */ computeSource: string; computedUsageId: string; /** * Computed Line Amount not rounded */ cost: string; /** * Computed Line Amount rounded. */ costRounded: string; /** * Currency code */ currencyCode: string; /** * Data Center Attribute as sent by MQS to SPM. */ dataCenter: string; /** * SPM Internal computed usage Id , 32 character string */ id: string; /** * Invoicing status for the aggregated compute usage */ isInvoiced: boolean; /** * MQS Identfier send to SPM , SPM does not transform this attribute and is received as is. */ mqsMessageId: string; /** * Net Unit Price for the product in consideration, price actual. */ netUnitPrice: string; /** * SPM Internal Original usage Line number identifier in SPM coming from Metered Services entity. */ originalUsageNumber: string; /** * Product part number for subscribed service line, called parent product. */ parentProducts: outputs.OsubUsage.GetComputedUsagesComputedUsageParentProduct[]; /** * Subscribed service line parent id */ parentSubscribedServiceId: string; /** * Subscription plan number */ planNumber: string; /** * Product description */ products: outputs.OsubUsage.GetComputedUsagesComputedUsageProduct[]; /** * Total Quantity that was used for computation */ quantity: string; /** * Ratecard Id at subscribed service level */ rateCardId: string; /** * References the tier in the ratecard for that usage (OCI will be using the same reference to cross-reference for correctness on the usage csv report), comes from Entity OBSCNTR_IPT_PRODUCTTIER. */ rateCardTierdId: string; /** * Computed Usage created time, expressed in RFC 3339 timestamp format. */ timeCreated: string; /** * Metered Service date, expressed in RFC 3339 timestamp format. */ timeMeteredOn: string; /** * Usae computation date, expressed in RFC 3339 timestamp format. */ timeOfArrival: string; /** * Computed Usage updated time, expressed in RFC 3339 timestamp format. */ timeUpdated: string; /** * Usage compute type in SPM. */ type: string; /** * Unit of Messure */ unitOfMeasure: string; /** * SPM Internal usage Line number identifier in SPM coming from Metered Services entity. */ usageNumber: string; } interface GetComputedUsagesComputedUsageParentProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Messure */ unitOfMeasure: string; } interface GetComputedUsagesComputedUsageProduct { /** * Metered service billing category */ billingCategory: string; /** * Product name */ name: string; /** * Product part number */ partNumber: string; /** * Product category */ productCategory: string; /** * Product provisioning group */ provisioningGroup: string; /** * Rate card part type of Product */ ucmRateCardPartType: string; /** * Unit of Messure */ unitOfMeasure: string; } interface GetComputedUsagesFilter { /** * Product name */ name: string; regex?: boolean; values: string[]; } } export declare namespace Psql { interface BackupCopyStatus { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup in the source region */ backupId: string; /** * Region name of the remote region */ region: string; /** * The current state of the backup. */ state: string; /** * A message describing the current state of copy in more detail */ stateDetails: string; } interface BackupDbSystemDetail { /** * OCID of the configuration that was applied on the source dbSystem at the time when backup was taken. */ configId: string; /** * The major and minor versions of the database system software. */ dbVersion: string; /** * Type of the database system. */ systemType: string; } interface BackupSourceBackupDetails { /** * Backup ID of the COPY source type. */ sourceBackupId: string; /** * Backup Region of the COPY source type. */ sourceRegion: string; } interface ConfigurationConfigurationDetail { /** * List of ConfigParms object. */ items: outputs.Psql.ConfigurationConfigurationDetailItem[]; } interface ConfigurationConfigurationDetailItem { /** * Range or list of allowed values. */ allowedValues: string; /** * The configuration variable name. */ configKey: string; /** * Data type of the variable. */ dataType: string; /** * Default value for the configuration variable. */ defaultConfigValue: string; /** * (Updatable) Details about the configuration set. */ description: string; /** * Whether the value can be overridden or not. */ isOverridable: boolean; /** * If true, modifying this configuration value will require a restart of the database. */ isRestartRequired: boolean; /** * User-selected configuration variable value. */ overridenConfigValue: string; } interface ConfigurationDbConfigurationOverrides { /** * List of configuration overridden values. */ items: outputs.Psql.ConfigurationDbConfigurationOverridesItem[]; } interface ConfigurationDbConfigurationOverridesItem { /** * Configuration variable name. */ configKey: string; /** * User-selected variable value. */ overridenConfigValue: string; } interface DbSystemCredentials { /** * Details for the database system password. Password can be passed as `VaultSecretPasswordDetails` or `PlainTextPasswordDetails`. */ passwordDetails: outputs.Psql.DbSystemCredentialsPasswordDetails; /** * The database system administrator username. */ username: string; } interface DbSystemCredentialsPasswordDetails { /** * The database system password. */ password: string; /** * The password type. */ passwordType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret where the password is stored. */ secretId: string; /** * The secret version of the stored password. */ secretVersion: string; } interface DbSystemInstance { /** * Specifies the availability domain of AD-local storage. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. */ availabilityDomain: string; /** * (Updatable) A user-provided description of a database system. */ description: string; /** * (Updatable) A user-friendly display name for the database system. Avoid entering confidential information. */ displayName: string; /** * A unique identifier for the database instance node. Immutable on creation. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * (Updatable) The target state for the Db System. Could be set to `ACTIVE` or `INACTIVE`. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ state: string; /** * The date and time that the database system was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time that the database system was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface DbSystemInstancesDetail { /** * A user-provided description of the database instance node. */ description: string; /** * Display name of the database instance node. Avoid entering confidential information. */ displayName: string; /** * Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet. */ privateIp: string; } interface DbSystemKerberosAuthDetails { /** * Optional. List of Kerberos Credentials previously configured for the dbsystem. Currently supports only one entry. */ backupCredentials?: outputs.Psql.DbSystemKerberosAuthDetailsBackupCredential[]; /** * Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}. */ credentials?: outputs.Psql.DbSystemKerberosAuthDetailsCredential[]; /** * Specifies the management of Insight for the dbSystem. */ kind: string; } interface DbSystemKerberosAuthDetailsBackupCredential { /** * The OCID of the secret where the Kerberos keytab file is stored as base64 text. */ keytabSecretId?: string; /** * The secret version of the stored Kerberos keytab file. */ keytabSecretVersion?: string; /** * Kerberos realm name. https://docs.oracle.com/cd/E36784_01/html/E37126/kplanning-27.html Realm names can consist of any ASCII string. Usually, the realm name is the same as your DNS domain name except that the realm name is in uppercase. This convention helps differentiate problems with the Kerberos service from problems with the DNS namespace, while keeping a name that is familiar. You can use any string, but configuration and maintenance might then require more work. Use realm names that follow the standard Internet naming structure. */ realmName?: string; } interface DbSystemKerberosAuthDetailsCredential { /** * The OCID of the secret where the Kerberos keytab file is stored as base64 text. */ keytabSecretId?: string; /** * The secret version of the stored Kerberos keytab file. */ keytabSecretVersion?: string; /** * Kerberos realm name. https://docs.oracle.com/cd/E36784_01/html/E37126/kplanning-27.html Realm names can consist of any ASCII string. Usually, the realm name is the same as your DNS domain name except that the realm name is in uppercase. This convention helps differentiate problems with the Kerberos service from problems with the DNS namespace, while keeping a name that is familiar. You can use any string, but configuration and maintenance might then require more work. Use realm names that follow the standard Internet naming structure. */ realmName?: string; } interface DbSystemManagementPolicy { /** * (Updatable) PostgreSQL database system backup policy. */ backupPolicy: outputs.Psql.DbSystemManagementPolicyBackupPolicy; /** * (Updatable) The start of the maintenance window in UTC. * * This string is of the format: "{day-of-week} {time-of-day}". "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. */ maintenanceWindowStart: string; /** * (Updatable) Point-in-time recovery policy. */ pitrPolicy: outputs.Psql.DbSystemManagementPolicyPitrPolicy; } interface DbSystemManagementPolicyBackupPolicy { /** * (Updatable) Hour of the day when the backup starts. */ backupStart: string; /** * (Updatable) Backup copy details */ copyPolicy?: outputs.Psql.DbSystemManagementPolicyBackupPolicyCopyPolicy; /** * (Updatable) Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day. */ daysOfTheMonths: number[]; /** * (Updatable) The day of the week that the backup starts. */ daysOfTheWeeks: string[]; /** * (Updatable) The kind of backup policy. */ kind: string; /** * (Updatable) How many days the data should be stored after the database system deletion. */ retentionDays: number; } interface DbSystemManagementPolicyBackupPolicyCopyPolicy { /** * (Updatable) target compartment to place a new backup */ compartmentId: string; /** * (Updatable) List of region names of the remote region */ regions: string[]; /** * (Updatable) Retention period in days of the backup copy. */ retentionPeriod?: number; } interface DbSystemManagementPolicyPitrPolicy { /** * (Updatable) The kind of recovery policy. */ kind: string; /** * (Updatable) The number of days the database system retains backups required for point-in-time recovery. */ restoreDays: number; } interface DbSystemNetworkDetails { /** * (Updatable) Specifies if the reader endpoint is enabled on the dbSystem. */ isReaderEndpointEnabled?: boolean; /** * (Updatable) List of customer Network Security Group [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the database system. */ nsgIds: string[]; /** * Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet. */ primaryDbEndpointPrivateIp: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer subnet associated with the database system. */ subnetId: string; } interface DbSystemOdspInsightDetails { /** * (Updatable) Specifies the management of Insight for the dbSystem. */ kind: string; /** * (Updatable) List of ODSP Insight and their configurations. */ odspInsightLists?: outputs.Psql.DbSystemOdspInsightDetailsOdspInsightList[]; } interface DbSystemOdspInsightDetailsOdspInsightList { /** * (Updatable) Type of Insight collected for the database system. */ insightType: string; /** * (Updatable) Retention period for Insight data, in days. Current supported value is 7 days. the system default is 7 days. */ retentionPeriodInDays: number; } interface DbSystemPatchOperation { from?: string; /** * The operation can be one of these values: `INSERT`, `REMOVE`. */ operation: string; position?: string; selectedItem?: string; /** * In case of `INSERT`, selection is `instances`. In case of `REMOVE`, selection is `instances[?id == '${var.instance_id}']`. */ selection: string; /** * Specify instance details such as displayName, description or privateIp. Example: `{"displayName": "value"}`. */ value?: { [key: string]: string; }; } interface DbSystemReplicationConfig { /** * (Updatable) Specify if Recovery point objective (RPO) enforcement needs to be enabled on the database system. */ isRpoEnforced: boolean; /** * (Updatable) Specifies the Recovery point objective (RPO) in seconds that will be enforced, if the `isRpoEnforced` flag is true. */ rpoInSeconds: string; } interface DbSystemSource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system backup. */ backupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source database system which will be used to perform point-in-time recovery. */ dbSystemId: string; /** * Deprecated. Don't use. */ isHavingRestoreConfigOverrides: boolean; /** * The [OCID] of the primary database system. */ primaryDbSystemId?: string; /** * The source descriminator. */ sourceType: string; /** * The target point-in-time of the source database system that will be restored, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. * * Point-in-time recovery can only performed in granularity of seconds. Example: `2016-08-25T21:10:29Z` */ timeToRestore: string; } interface DbSystemStorageDetails { /** * Specifies the availability domain of AD-local storage. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. */ availabilityDomain?: string; /** * (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers [here](https://docs.oracle.com/en-us/iaas/Content/postgresql/performance-tiers.htm). */ iops: string; /** * Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. */ isRegionallyDurable: boolean; /** * Type of the database system. */ systemType: string; } interface GetBackupCopyStatus { /** * A unique identifier for the backup. */ backupId: string; /** * Region name of the remote region */ region: string; /** * The current state of the backup. */ state: string; /** * A message describing the current state of copy in more detail */ stateDetails: string; } interface GetBackupDbSystemDetail { /** * OCID of the configuration that was applied on the source dbSystem at the time when backup was taken. */ configId: string; /** * The major and minor versions of the database system software. */ dbVersion: string; /** * Type of the database system. */ systemType: string; } interface GetBackupSourceBackupDetail { /** * Backup ID of the COPY source type. */ sourceBackupId: string; /** * Backup Region of the COPY source type. */ sourceRegion: string; } interface GetBackupsBackupCollection { items: outputs.Psql.GetBackupsBackupCollectionItem[]; } interface GetBackupsBackupCollectionItem { /** * The size of the backup, in gigabytes. */ backupSize: number; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * List of status for Backup Copy */ copyStatuses: outputs.Psql.GetBackupsBackupCollectionItemCopyStatus[]; /** * Information about the database system associated with a backup. */ dbSystemDetails: outputs.Psql.GetBackupsBackupCollectionItemDbSystemDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup's source database system. */ dbSystemId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A description for the backup. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A unique identifier for the database system. */ id: string; /** * lastAcceptedRequestToken from MP. */ lastAcceptedRequestToken: string; /** * lastCompletedRequestToken from MP. */ lastCompletedRequestToken: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * Backup retention period in days. */ retentionPeriod: number; /** * Information about the Source Backup associated with a backup. */ sourceBackupDetails: outputs.Psql.GetBackupsBackupCollectionItemSourceBackupDetail[]; /** * Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location. */ sourceType: string; /** * A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the backup request was received, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreatedPrecise: string; /** * The date and time the backup was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetBackupsBackupCollectionItemCopyStatus { /** * A unique identifier for the backup. */ backupId: string; /** * Region name of the remote region */ region: string; /** * A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`. */ state: string; /** * A message describing the current state of copy in more detail */ stateDetails: string; } interface GetBackupsBackupCollectionItemDbSystemDetail { /** * OCID of the configuration that was applied on the source dbSystem at the time when backup was taken. */ configId: string; /** * The major and minor versions of the database system software. */ dbVersion: string; /** * Type of the database system. */ systemType: string; } interface GetBackupsBackupCollectionItemSourceBackupDetail { /** * Backup ID of the COPY source type. */ sourceBackupId: string; /** * Backup Region of the COPY source type. */ sourceRegion: string; } interface GetBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetConfigurationConfigurationDetail { /** * List of ConfigParms object. */ items: outputs.Psql.GetConfigurationConfigurationDetailItem[]; } interface GetConfigurationConfigurationDetailItem { /** * Range or list of allowed values. */ allowedValues: string; /** * The configuration variable name. */ configKey: string; /** * Data type of the variable. */ dataType: string; /** * Default value for the configuration variable. */ defaultConfigValue: string; /** * A description for the configuration. */ description: string; /** * Whether the value can be overridden or not. */ isOverridable: boolean; /** * If true, modifying this configuration value will require a restart of the database. */ isRestartRequired: boolean; /** * User-selected configuration variable value. */ overridenConfigValue: string; } interface GetConfigurationDbConfigurationOverride { /** * List of ConfigParms object. */ items: outputs.Psql.GetConfigurationDbConfigurationOverrideItem[]; } interface GetConfigurationDbConfigurationOverrideItem { /** * The configuration variable name. */ configKey: string; /** * User-selected configuration variable value. */ overridenConfigValue: string; } interface GetConfigurationsConfigurationCollection { /** * List of ConfigParms object. */ items: outputs.Psql.GetConfigurationsConfigurationCollectionItem[]; } interface GetConfigurationsConfigurationCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Indicates the collection of compatible shapes for this configuration. */ compatibleShapes: string[]; /** * A filter to return only resources if their `configType` matches the given `configType`. */ configType: string; /** * List of configuration details. */ configurationDetails: outputs.Psql.GetConfigurationsConfigurationCollectionItemConfigurationDetail[]; dbConfigurationOverrides: outputs.Psql.GetConfigurationsConfigurationCollectionItemDbConfigurationOverride[]; /** * Version of the PostgreSQL database, such as 14.9. */ dbVersion: string; /** * The Default configuration used for this configuration. */ defaultConfigId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A description for the configuration. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A unique identifier for the configuration. Immutable on creation. */ id: string; /** * The instance memory size in GBs for the configuration. */ instanceMemorySizeInGbs: number; /** * The instance ocpu count for the configuration. */ instanceOcpuCount: number; /** * Whether the configuration supports flexible shapes. */ isFlexible: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * The compute name of the shape for the configuration. */ shape: string; /** * A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time that the configuration was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetConfigurationsConfigurationCollectionItemConfigurationDetail { /** * List of ConfigParms object. */ items: outputs.Psql.GetConfigurationsConfigurationCollectionItemConfigurationDetailItem[]; } interface GetConfigurationsConfigurationCollectionItemConfigurationDetailItem { /** * Range or list of allowed values. */ allowedValues: string; /** * The configuration variable name. */ configKey: string; /** * Data type of the variable. */ dataType: string; /** * Default value for the configuration variable. */ defaultConfigValue: string; /** * A description for the configuration. */ description: string; /** * Whether the value can be overridden or not. */ isOverridable: boolean; /** * If true, modifying this configuration value will require a restart of the database. */ isRestartRequired: boolean; /** * User-selected configuration variable value. */ overridenConfigValue: string; } interface GetConfigurationsConfigurationCollectionItemDbConfigurationOverride { /** * List of ConfigParms object. */ items: outputs.Psql.GetConfigurationsConfigurationCollectionItemDbConfigurationOverrideItem[]; } interface GetConfigurationsConfigurationCollectionItemDbConfigurationOverrideItem { /** * The configuration variable name. */ configKey: string; /** * User-selected configuration variable value. */ overridenConfigValue: string; } interface GetConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbSystemConnectionDetailInstanceEndpoint { /** * Unique identifier of the database instance node. */ dbInstanceId: string; /** * Information about the database instance node endpoint. */ endpoints: outputs.Psql.GetDbSystemConnectionDetailInstanceEndpointEndpoint[]; } interface GetDbSystemConnectionDetailInstanceEndpointEndpoint { /** * The FQDN of the endpoint. */ fqdn: string; /** * The IP address of the endpoint. */ ipAddress: string; /** * The port address of the endpoint. */ port: number; } interface GetDbSystemConnectionDetailPrimaryDbEndpoint { /** * The FQDN of the endpoint. */ fqdn: string; /** * The IP address of the endpoint. */ ipAddress: string; /** * The port address of the endpoint. */ port: number; } interface GetDbSystemConnectionDetailReaderEndpoint { /** * The FQDN of the endpoint. */ fqdn: string; /** * The IP address of the endpoint. */ ipAddress: string; /** * The port address of the endpoint. */ port: number; } interface GetDbSystemCredential { passwordDetails: outputs.Psql.GetDbSystemCredentialPasswordDetail[]; username: string; } interface GetDbSystemCredentialPasswordDetail { password: string; passwordType: string; secretId: string; secretVersion: string; } interface GetDbSystemInstance { /** * Specifies the availability domain of AD-local storage. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. */ availabilityDomain: string; /** * Description of the database instance node. */ description: string; /** * A user-friendly display name for the database instance node. Avoid entering confidential information. */ displayName: string; /** * A unique identifier for the database instance node. Immutable on creation. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * The current state of the database system. */ state: string; /** * The date and time that the database system was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time that the database system was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetDbSystemInstancesDetail { /** * Description of the database instance node. */ description: string; /** * A user-friendly display name for the database instance node. Avoid entering confidential information. */ displayName: string; privateIp: string; } interface GetDbSystemKerberosAuthDetail { /** * Optional. List of Kerberos Credentials previously configured for the dbsystem. Currently supports only one entry. */ backupCredentials: outputs.Psql.GetDbSystemKerberosAuthDetailBackupCredential[]; /** * List of Kerberos Credentials to be configured for the dbsystem. Currently supports only one entry. */ credentials: outputs.Psql.GetDbSystemKerberosAuthDetailCredential[]; /** * Specifies the management of Insight for the dbSystem. */ kind: string; } interface GetDbSystemKerberosAuthDetailBackupCredential { /** * The OCID of the secret where the Kerberos keytab file is stored as base64 text. */ keytabSecretId: string; /** * The secret version of the stored Kerberos keytab file. */ keytabSecretVersion: string; /** * Kerberos realm name. https://docs.oracle.com/cd/E36784_01/html/E37126/kplanning-27.html Realm names can consist of any ASCII string. Usually, the realm name is the same as your DNS domain name except that the realm name is in uppercase. This convention helps differentiate problems with the Kerberos service from problems with the DNS namespace, while keeping a name that is familiar. You can use any string, but configuration and maintenance might then require more work. Use realm names that follow the standard Internet naming structure. */ realmName: string; } interface GetDbSystemKerberosAuthDetailCredential { /** * The OCID of the secret where the Kerberos keytab file is stored as base64 text. */ keytabSecretId: string; /** * The secret version of the stored Kerberos keytab file. */ keytabSecretVersion: string; /** * Kerberos realm name. https://docs.oracle.com/cd/E36784_01/html/E37126/kplanning-27.html Realm names can consist of any ASCII string. Usually, the realm name is the same as your DNS domain name except that the realm name is in uppercase. This convention helps differentiate problems with the Kerberos service from problems with the DNS namespace, while keeping a name that is familiar. You can use any string, but configuration and maintenance might then require more work. Use realm names that follow the standard Internet naming structure. */ realmName: string; } interface GetDbSystemManagementPolicy { /** * PostgreSQL database system backup policy. */ backupPolicies: outputs.Psql.GetDbSystemManagementPolicyBackupPolicy[]; /** * The start of the maintenance window. */ maintenanceWindowStart: string; /** * Point-in-time recovery policy. */ pitrPolicies: outputs.Psql.GetDbSystemManagementPolicyPitrPolicy[]; } interface GetDbSystemManagementPolicyBackupPolicy { /** * Hour of the day when the backup starts. */ backupStart: string; /** * Backup copy details */ copyPolicies: outputs.Psql.GetDbSystemManagementPolicyBackupPolicyCopyPolicy[]; /** * Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day. */ daysOfTheMonths: number[]; /** * The day of the week that the backup starts. */ daysOfTheWeeks: string[]; /** * Specifies the management of Insight for the dbSystem. */ kind: string; /** * How many days the data should be stored after the database system deletion. */ retentionDays: number; } interface GetDbSystemManagementPolicyBackupPolicyCopyPolicy { /** * target compartment to place a new backup */ compartmentId: string; /** * List of region names of the remote region */ regions: string[]; /** * Retention period in days of the backup copy. */ retentionPeriod: number; } interface GetDbSystemManagementPolicyPitrPolicy { /** * Specifies the management of Insight for the dbSystem. */ kind: string; /** * The number of days the database system retains backups required for point-in-time recovery. */ restoreDays: number; } interface GetDbSystemNetworkDetail { /** * Specifies if the reader endpoint is enabled on the dbSystem. */ isReaderEndpointEnabled: boolean; /** * List of customer Network Security Group [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the database system. */ nsgIds: string[]; /** * Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet. */ primaryDbEndpointPrivateIp: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer subnet associated with the database system. */ subnetId: string; } interface GetDbSystemOdspInsightDetail { /** * Specifies the management of Insight for the dbSystem. */ kind: string; /** * List of ODSP Insight and their configurations. */ odspInsightLists: outputs.Psql.GetDbSystemOdspInsightDetailOdspInsightList[]; } interface GetDbSystemOdspInsightDetailOdspInsightList { /** * Type of Insight collected for the database system. */ insightType: string; /** * Retention period for Insight data, in days. Current supported value is 7 days. the system default is 7 days. */ retentionPeriodInDays: number; } interface GetDbSystemPatchOperation { from: string; operation: string; position: string; selectedItem: string; selection: string; value: { [key: string]: string; }; } interface GetDbSystemPitrDetailRecoveryTimeWindow { /** * Latest timestamp in the PITR window to which the database can be restored. Timestamps later than this are not recoverable. The value must be an [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp. Example: `2016-08-25T21:10:29Z` */ timeRecoveryWindowEnd: string; /** * Earliest timestamp in the PITR window to which the database can be restored. Timestamps earlier than this are not recoverable. The value must be an [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp. Example: `2016-08-25T21:10:29Z` */ timeRecoveryWindowStart: string; } interface GetDbSystemReplicasDbSystemReplicaCollection { /** * List of replica database systems. */ items: outputs.Psql.GetDbSystemReplicasDbSystemReplicaCollectionItem[]; } interface GetDbSystemReplicasDbSystemReplicaCollectionItem { /** * A unique identifier for the replica database system. */ id: string; /** * Region name of the replica database system region. Example: `us-phoenix-1` */ region: string; } interface GetDbSystemReplicasFilter { name: string; regex?: boolean; values: string[]; } interface GetDbSystemReplicationConfig { /** * Specifies if Recovery point objective (RPO) enforcement is enabled on the database system. */ isRpoEnforced: boolean; /** * Specifies the Recovery point objective (RPO) in seconds that will be enforced, if the `isRpoEnforced` flag is true. */ rpoInSeconds: string; } interface GetDbSystemSource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system backup. */ backupId: string; /** * A unique identifier for the database system. */ dbSystemId: string; /** * Deprecated. Don't use. */ isHavingRestoreConfigOverrides: boolean; /** * The [OCID] of the primary database system. */ primaryDbSystemId: string; /** * The source descriminator. */ sourceType: string; /** * The target point-in-time of the source database system that will be restored, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. */ timeToRestore: string; } interface GetDbSystemStorageDetail { /** * Specifies the availability domain of AD-local storage. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. */ availabilityDomain: string; /** * Guaranteed input/output storage requests per second (IOPS) available to the database system. */ iops: string; /** * Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. */ isRegionallyDurable: boolean; /** * Type of the database system. */ systemType: string; } interface GetDbSystemsDbSystemCollection { items: outputs.Psql.GetDbSystemsDbSystemCollectionItem[]; } interface GetDbSystemsDbSystemCollectionItem { /** * The database system administrator username. */ adminUsername: string; applyChangeModeToStandAlone: string; applyConfig: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration associated with the database system. */ configId: string; /** * List of Kerberos Credentials to be configured for the dbsystem. Currently supports only one entry. */ credentials: outputs.Psql.GetDbSystemsDbSystemCollectionItemCredential[]; /** * The major and minor versions of the database system software. */ dbVersion: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of the database instance node. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A unique identifier for the database system. */ id: string; /** * Count of instances, or nodes, in the database system. */ instanceCount: number; /** * The total amount of memory available to each database instance node, in gigabytes. */ instanceMemorySizeInGbs: number; /** * The total number of OCPUs available to each database instance node. */ instanceOcpuCount: number; /** * The list of instances, or nodes, in the database system. */ instances: outputs.Psql.GetDbSystemsDbSystemCollectionItemInstance[]; instancesDetails: outputs.Psql.GetDbSystemsDbSystemCollectionItemInstancesDetail[]; /** * Kerberos Authentication details for the database system. */ kerberosAuthDetails: outputs.Psql.GetDbSystemsDbSystemCollectionItemKerberosAuthDetail[]; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * PostgreSQL database system management policy. */ managementPolicies: outputs.Psql.GetDbSystemsDbSystemCollectionItemManagementPolicy[]; /** * Network details for the database system. */ networkDetails: outputs.Psql.GetDbSystemsDbSystemCollectionItemNetworkDetail[]; /** * ODSP Insight details for the database system. */ odspInsightDetails: outputs.Psql.GetDbSystemsDbSystemCollectionItemOdspInsightDetail[]; patchOperations: outputs.Psql.GetDbSystemsDbSystemCollectionItemPatchOperation[]; /** * Replication configuration that is applicable on database systems with the PRIMARY_DB_SYSTEM role. */ replicationConfigs: outputs.Psql.GetDbSystemsDbSystemCollectionItemReplicationConfig[]; /** * The name of the shape for the database instance. Example: `VM.Standard.E4.Flex` */ shape: string; /** * The source of the database system. */ sources: outputs.Psql.GetDbSystemsDbSystemCollectionItemSource[]; /** * A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`. */ state: string; /** * Storage details of the database system. */ storageDetails: outputs.Psql.GetDbSystemsDbSystemCollectionItemStorageDetail[]; /** * A filter to return only DbSystem resources if their `systemRole` matches the given value. */ systemRole: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Type of the database system. */ systemType: string; /** * The date and time that the database system was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time that the database system was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetDbSystemsDbSystemCollectionItemCredential { passwordDetails: outputs.Psql.GetDbSystemsDbSystemCollectionItemCredentialPasswordDetail[]; username: string; } interface GetDbSystemsDbSystemCollectionItemCredentialPasswordDetail { password: string; passwordType: string; secretId: string; secretVersion: string; } interface GetDbSystemsDbSystemCollectionItemInstance { /** * Specifies the availability domain of AD-local storage. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. */ availabilityDomain: string; /** * Description of the database instance node. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * A unique identifier for the database system. */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`. */ state: string; /** * The date and time that the database system was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time that the database system was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetDbSystemsDbSystemCollectionItemInstancesDetail { /** * Description of the database instance node. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; privateIp: string; } interface GetDbSystemsDbSystemCollectionItemKerberosAuthDetail { /** * Optional. List of Kerberos Credentials previously configured for the dbsystem. Currently supports only one entry. */ backupCredentials: outputs.Psql.GetDbSystemsDbSystemCollectionItemKerberosAuthDetailBackupCredential[]; /** * List of Kerberos Credentials to be configured for the dbsystem. Currently supports only one entry. */ credentials: outputs.Psql.GetDbSystemsDbSystemCollectionItemKerberosAuthDetailCredential[]; /** * Specifies the management of Insight for the dbSystem. */ kind: string; } interface GetDbSystemsDbSystemCollectionItemKerberosAuthDetailBackupCredential { /** * The OCID of the secret where the Kerberos keytab file is stored as base64 text. */ keytabSecretId: string; /** * The secret version of the stored Kerberos keytab file. */ keytabSecretVersion: string; /** * Kerberos realm name. https://docs.oracle.com/cd/E36784_01/html/E37126/kplanning-27.html Realm names can consist of any ASCII string. Usually, the realm name is the same as your DNS domain name except that the realm name is in uppercase. This convention helps differentiate problems with the Kerberos service from problems with the DNS namespace, while keeping a name that is familiar. You can use any string, but configuration and maintenance might then require more work. Use realm names that follow the standard Internet naming structure. */ realmName: string; } interface GetDbSystemsDbSystemCollectionItemKerberosAuthDetailCredential { /** * The OCID of the secret where the Kerberos keytab file is stored as base64 text. */ keytabSecretId: string; /** * The secret version of the stored Kerberos keytab file. */ keytabSecretVersion: string; /** * Kerberos realm name. https://docs.oracle.com/cd/E36784_01/html/E37126/kplanning-27.html Realm names can consist of any ASCII string. Usually, the realm name is the same as your DNS domain name except that the realm name is in uppercase. This convention helps differentiate problems with the Kerberos service from problems with the DNS namespace, while keeping a name that is familiar. You can use any string, but configuration and maintenance might then require more work. Use realm names that follow the standard Internet naming structure. */ realmName: string; } interface GetDbSystemsDbSystemCollectionItemManagementPolicy { /** * PostgreSQL database system backup policy. */ backupPolicies: outputs.Psql.GetDbSystemsDbSystemCollectionItemManagementPolicyBackupPolicy[]; /** * The start of the maintenance window. */ maintenanceWindowStart: string; /** * Point-in-time recovery policy. */ pitrPolicies: outputs.Psql.GetDbSystemsDbSystemCollectionItemManagementPolicyPitrPolicy[]; } interface GetDbSystemsDbSystemCollectionItemManagementPolicyBackupPolicy { /** * Hour of the day when the backup starts. */ backupStart: string; /** * Backup copy details */ copyPolicies: outputs.Psql.GetDbSystemsDbSystemCollectionItemManagementPolicyBackupPolicyCopyPolicy[]; /** * Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day. */ daysOfTheMonths: number[]; /** * The day of the week that the backup starts. */ daysOfTheWeeks: string[]; /** * Specifies the management of Insight for the dbSystem. */ kind: string; /** * How many days the data should be stored after the database system deletion. */ retentionDays: number; } interface GetDbSystemsDbSystemCollectionItemManagementPolicyBackupPolicyCopyPolicy { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * List of region names of the remote region */ regions: string[]; /** * Retention period in days of the backup copy. */ retentionPeriod: number; } interface GetDbSystemsDbSystemCollectionItemManagementPolicyPitrPolicy { /** * Specifies the management of Insight for the dbSystem. */ kind: string; /** * The number of days the database system retains backups required for point-in-time recovery. */ restoreDays: number; } interface GetDbSystemsDbSystemCollectionItemNetworkDetail { /** * Specifies if the reader endpoint is enabled on the dbSystem. */ isReaderEndpointEnabled: boolean; /** * List of customer Network Security Group [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with the database system. */ nsgIds: string[]; /** * Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet. */ primaryDbEndpointPrivateIp: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer subnet associated with the database system. */ subnetId: string; } interface GetDbSystemsDbSystemCollectionItemOdspInsightDetail { /** * Specifies the management of Insight for the dbSystem. */ kind: string; /** * List of ODSP Insight and their configurations. */ odspInsightLists: outputs.Psql.GetDbSystemsDbSystemCollectionItemOdspInsightDetailOdspInsightList[]; } interface GetDbSystemsDbSystemCollectionItemOdspInsightDetailOdspInsightList { /** * Type of Insight collected for the database system. */ insightType: string; /** * Retention period for Insight data, in days. Current supported value is 7 days. the system default is 7 days. */ retentionPeriodInDays: number; } interface GetDbSystemsDbSystemCollectionItemPatchOperation { from: string; operation: string; position: string; selectedItem: string; selection: string; value: { [key: string]: string; }; } interface GetDbSystemsDbSystemCollectionItemReplicationConfig { /** * Specifies if Recovery point objective (RPO) enforcement is enabled on the database system. */ isRpoEnforced: boolean; /** * Specifies the Recovery point objective (RPO) in seconds that will be enforced, if the `isRpoEnforced` flag is true. */ rpoInSeconds: string; } interface GetDbSystemsDbSystemCollectionItemSource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the database system backup. */ backupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source database system which will be used to perform point-in-time recovery. */ dbSystemId: string; /** * Deprecated. Don't use. */ isHavingRestoreConfigOverrides: boolean; /** * The [OCID] of the primary database system. */ primaryDbSystemId: string; /** * The source descriminator. */ sourceType: string; /** * The target point-in-time of the source database system that will be restored, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. */ timeToRestore: string; } interface GetDbSystemsDbSystemCollectionItemStorageDetail { /** * Specifies the availability domain of AD-local storage. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. */ availabilityDomain: string; /** * Guaranteed input/output storage requests per second (IOPS) available to the database system. */ iops: string; /** * Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. */ isRegionallyDurable: boolean; /** * Type of the database system. */ systemType: string; } interface GetDbSystemsFilter { name: string; regex?: boolean; values: string[]; } interface GetDefaultConfigurationConfigurationDetail { /** * List of ConfigParms object. */ items: outputs.Psql.GetDefaultConfigurationConfigurationDetailItem[]; } interface GetDefaultConfigurationConfigurationDetailItem { /** * Range or list of allowed values. */ allowedValues: string; /** * The configuration variable name. */ configKey: string; /** * Data type of the variable. */ dataType: string; /** * Default value for the variable. */ defaultConfigValue: string; /** * A description for the configuration. */ description: string; /** * Whether the value can be overridden or not. */ isOverridable: boolean; /** * If true, modifying this configuration value will require a restart. */ isRestartRequired: boolean; } interface GetDefaultConfigurationsDefaultConfigurationCollection { /** * List of ConfigParms object. */ items: outputs.Psql.GetDefaultConfigurationsDefaultConfigurationCollectionItem[]; } interface GetDefaultConfigurationsDefaultConfigurationCollectionItem { /** * Indicates the collection of compatible shapes for this configuration. */ compatibleShapes: string[]; /** * List of default configuration values for databases. */ configurationDetails: outputs.Psql.GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetail[]; /** * Version of the PostgreSQL database, such as 14.9. */ dbVersion: string; /** * A description for the configuration. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * A unique identifier for the configuration. */ id: string; /** * The instance memory size in GBs for the configuration. */ instanceMemorySizeInGbs: number; /** * The instance ocpu count for the configuration. */ instanceOcpuCount: number; /** * True if the configuration supports flexible shapes, false otherwise. */ isFlexible: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecycleDetails: string; /** * The compute name of the shape for the configuration. */ shape: string; /** * A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`. */ state: string; /** * The date and time that the configuration was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetail { /** * List of ConfigParms object. */ items: outputs.Psql.GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetailItem[]; } interface GetDefaultConfigurationsDefaultConfigurationCollectionItemConfigurationDetailItem { /** * Range or list of allowed values. */ allowedValues: string; /** * The configuration variable name. */ configKey: string; /** * Data type of the variable. */ dataType: string; /** * Default value for the variable. */ defaultConfigValue: string; /** * A description for the configuration. */ description: string; /** * Whether the value can be overridden or not. */ isOverridable: boolean; /** * If true, modifying this configuration value will require a restart. */ isRestartRequired: boolean; } interface GetDefaultConfigurationsFilter { name: string; regex?: boolean; values: string[]; } interface GetInsightCapabilitiesFilter { /** * Name of the filter parameter. */ name: string; regex?: boolean; /** * Allowed values for enum-based filters. */ values: string[]; } interface GetInsightCapabilitiesInsightCapabilityCollection { /** * PostgreSQL insight capabilities list. */ items: outputs.Psql.GetInsightCapabilitiesInsightCapabilityCollectionItem[]; } interface GetInsightCapabilitiesInsightCapabilityCollectionItem { /** * Supported insight data types for this insight type. */ dataTypeCapabilities: outputs.Psql.GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapability[]; /** * Human-readable description of the insight type. */ description: string; /** * Echo of the requested insight type. */ insightType: string; } interface GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapability { /** * Describes the response data format returned for an insight type. */ dataContracts: outputs.Psql.GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityDataContract[]; /** * Indicates whether a time range is required for the insight. */ dateTimeRangeSupports: outputs.Psql.GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityDateTimeRangeSupport[]; /** * Human-readable description of the insight type. */ description: string; /** * Supported filters for this insight data type. */ filters: outputs.Psql.GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityFilter[]; /** * Describes time granularity behavior for time-series Insight. */ granularities: outputs.Psql.GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityGranularity[]; /** * Insight data type identifier (for example, AAS_TIME_SERIES). */ insightDataType: string; /** * Defines limits applicable to an insight type. */ limits: outputs.Psql.GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityLimit[]; /** * Describes pagination support for an insight type. */ paginations: outputs.Psql.GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityPagination[]; /** * Describes sorting support for an insight type. */ sortings: outputs.Psql.GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilitySorting[]; } interface GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityDataContract { /** * Indicates the structure of the insight data payload. */ kind: string; /** * Optional unit associated with numeric values. */ unit: string; } interface GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityDateTimeRangeSupport { /** * Indicates whether start and end time parameters are required. */ isRequired: boolean; } interface GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityFilter { /** * Indicates whether partial matching is supported. */ canUsePartialMatch: boolean; /** * Name of the filter parameter. */ name: string; /** * Granularity selection strategy. */ type: string; /** * Allowed values for enum-based filters. */ values: string[]; } interface GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityGranularity { /** * Maximum supported granularity in seconds. */ maxSeconds: number; /** * Minimum supported granularity in seconds. */ minSeconds: number; /** * Granularity selection strategy. */ type: string; } interface GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityLimit { /** * Maximum number of rows returned. */ maxRows: number; /** * Maximum allowed time range in days. */ maxTimeRangeDays: number; } interface GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilityPagination { /** * Default number of items per page. */ defaultLimit: number; /** * Indicates whether sorting is supported. */ isSupported: boolean; /** * Maximum number of items per page. */ maxLimit: number; } interface GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilitySorting { /** * Default sorting behavior for an insight type. */ defaultSorts: outputs.Psql.GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilitySortingDefaultSort[]; /** * Fields that can be used for sorting. */ fields: string[]; /** * Indicates whether sorting is supported. */ isSupported: boolean; } interface GetInsightCapabilitiesInsightCapabilityCollectionItemDataTypeCapabilitySortingDefaultSort { /** * Default field used for sorting. */ field: string; /** * Default sort order. */ order: string; } interface GetShapesFilter { name: string; regex?: boolean; values: string[]; } interface GetShapesShapeCollection { /** * List of supported shapes. */ items: outputs.Psql.GetShapesShapeCollectionItem[]; } interface GetShapesShapeCollectionItem { /** * A filter to return the feature by the shape name. */ id: string; /** * Indicates if the shape is a flex shape. */ isFlexible: boolean; /** * The amount of memory in gigabytes. */ memorySizeInGbs: number; /** * The number of OCPUs. */ ocpuCount: number; /** * The name of the Compute VM shape. Example: `VM.Standard.E4.Flex` */ shape: string; /** * Options for the the shape memory */ shapeMemoryOptions: outputs.Psql.GetShapesShapeCollectionItemShapeMemoryOption[]; /** * Options for the the shape OCPU */ shapeOcpuOptions: outputs.Psql.GetShapesShapeCollectionItemShapeOcpuOption[]; } interface GetShapesShapeCollectionItemShapeMemoryOption { /** * Default per OCPU configuration in GBs */ defaultPerOcpuInGbs: number; /** * Maximum Memory configuration in GBs */ maxInGbs: number; /** * Maximum Memory configuration per OCPU in GBs */ maxPerOcpuInGbs: number; /** * Minimum Memory configuration in GBs */ minInGbs: number; /** * Minimum Memory configuration per OCPU in GBs */ minPerOcpuInGbs: number; } interface GetShapesShapeCollectionItemShapeOcpuOption { /** * Maximum OCPU configuration */ max: number; /** * Minimum OCPU configuration */ min: number; } } export declare namespace Queue { interface GetConsumerGroupsConsumerGroupCollection { items: outputs.Queue.GetConsumerGroupsConsumerGroupCollectionItem[]; } interface GetConsumerGroupsConsumerGroupCollectionItem { /** * The filter used by the consumer group. Only messages matching the filter will be available by consumers of the consumer group. An empty value means that all messages will be available in the group. The primary consumer group cannot have any filter. */ consumerGroupFilter: string; /** * The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. If the value isn't set, it will be using the value defined at the queue level. */ deadLetterQueueDeliveryCount: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The unique consumer group identifier. */ id: string; isEnabled: boolean; /** * Any additional details about the current state of the consumer group. */ lifecycleDetails: string; /** * The unique queue identifier. */ queueId: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time that the consumer group was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` */ timeCreated: string; /** * The time that the consumer group was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` */ timeUpdated: string; } interface GetConsumerGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetQueueCapability { /** * (Applicable when type=CONSUMER_GROUPS) Specifies if the primary consumer group should be automatically enabled after adding the capability. */ isPrimaryConsumerGroupEnabled: boolean; /** * (Applicable when type=CONSUMER_GROUPS) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. If the value isn't set, it will be using the value defined at the queue level. */ primaryConsumerGroupDeadLetterQueueDeliveryCount: number; /** * (Applicable when type=CONSUMER_GROUPS) Name of the primary consumer group. If omitted, it will be named "Primary Consumer Group". */ primaryConsumerGroupDisplayName: string; /** * (Applicable when type=CONSUMER_GROUPS) The primary consumer group cannot have any filter hence this field will always be empty. An empty value means that all messages will be available in the primary consumer group. */ primaryConsumerGroupFilter: string; /** * The type of the capability. Could be CONSUMER_GROUPS and/or LARGE_MESSAGES */ type: string; } interface GetQueuesFilter { name: string; regex?: boolean; values: string[]; } interface GetQueuesQueueCollection { items: outputs.Queue.GetQueuesQueueCollectionItem[]; } interface GetQueuesQueueCollectionItem { /** * The list of capabilities enabled on the queue */ capabilities: string[]; /** * The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources. */ channelConsumptionLimit: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom encryption key to be used to encrypt messages content. */ customEncryptionKeyId: string; /** * The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. */ deadLetterQueueDeliveryCount: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The unique queue identifier. */ id: string; /** * Any additional details about the current state of the queue. */ lifecycleDetails: string; /** * The endpoint to use to consume or publish messages in the queue. */ messagesEndpoint: string; purgeTrigger: number; purgeType: string; /** * The retention period of the messages in the queue, in seconds. */ retentionInSeconds: number; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time that the queue was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` */ timeCreated: string; /** * The time that the queue was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` */ timeUpdated: string; /** * The default polling timeout of the messages in the queue, in seconds. */ timeoutInSeconds: number; /** * The default visibility timeout of the messages consumed from the queue, in seconds. */ visibilityInSeconds: number; } interface QueueCapability { /** * (Updatable) Specifies if the primary consumer group should be automatically enabled after adding the capability. */ isPrimaryConsumerGroupEnabled: boolean; /** * (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used. If the value isn't set, it will be using the value defined at the queue level. */ primaryConsumerGroupDeadLetterQueueDeliveryCount: number; /** * (Updatable) Name of the primary consumer group. If omitted, it will be named "Primary Consumer Group". */ primaryConsumerGroupDisplayName: string; /** * The primary consumer group cannot have any filter hence this field will always be empty. An empty value means that all messages will be available in the primary consumer group. */ primaryConsumerGroupFilter: string; /** * (Updatable) The type of the capability. Could be CONSUMER_GROUPS and/or LARGE_MESSAGES */ type: string; } } export declare namespace RecoveryMod { interface GetProtectedDatabaseMetric { /** * The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database. */ backupSpaceEstimateInGbs: number; /** * Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used. */ backupSpaceUsedInGbs: number; /** * Number of seconds backups are currently retained for this database. */ currentRetentionPeriodInSeconds: number; /** * The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs. */ dbSizeInGbs: number; /** * The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. */ isRedoLogsEnabled: boolean; /** * Number of days of redo/archive to be applied to recover database. */ minimumRecoveryNeededInDays: number; /** * The maximum number of days to retain backups for a protected database. */ retentionPeriodInDays: number; /** * This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped. */ unprotectedWindowInSeconds: number; } interface GetProtectedDatabaseRecoveryServiceSubnet { /** * Recovery Service Subnet Identifier. */ recoveryServiceSubnetId: string; /** * The current state of the Protected Database. */ state: string; } interface GetProtectedDatabasesFilter { name: string; regex?: boolean; values: string[]; } interface GetProtectedDatabasesProtectedDatabaseCollection { items: outputs.RecoveryMod.GetProtectedDatabasesProtectedDatabaseCollectionItem[]; } interface GetProtectedDatabasesProtectedDatabaseCollectionItem { /** * The compartment OCID. */ compartmentId: string; /** * The OCID of the protected database. */ databaseId: string; /** * The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L - 500GB to 1TB, XL - 1TB to 5TB, XXL - Greater than 5TB. */ databaseSize: string; /** * The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name. */ dbUniqueName: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) */ definedTags: { [key: string]: string; }; deletionSchedule: string; /** * A filter to return only resources that match the entire 'displayname' given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Indicates the protection status of the database. */ health: string; /** * A message describing the current health of the protected database. */ healthDetails: string; /** * The protected database OCID. */ id: string; /** * Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database. */ isReadOnlyResource: boolean; /** * The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. For this to be effective, additional configuration is needed on client side. */ isRedoLogsShipped: boolean; /** * Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state. */ lifecycleDetails: string; /** * Backup performance and storage utilization metrics for the protected database. */ metrics: outputs.RecoveryMod.GetProtectedDatabasesProtectedDatabaseCollectionItemMetric[]; password: string; /** * An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy. */ policyLockedDateTime: string; /** * The protection policy OCID. */ protectionPolicyId: string; /** * List of recovery service subnet resources associated with the protected database. */ recoveryServiceSubnets: outputs.RecoveryMod.GetProtectedDatabasesProtectedDatabaseCollectionItemRecoveryServiceSubnet[]; /** * A filter to return only the resources that match the specified lifecycle state. */ state: string; /** * The OCID of the cloud service subscription to which the protected database is linked. */ subscriptionId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) */ systemTags: { [key: string]: string; }; /** * An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: '2020-05-22T21:10:29.600Z' */ timeUpdated: string; /** * The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service. */ vpcUserName: string; } interface GetProtectedDatabasesProtectedDatabaseCollectionItemMetric { /** * The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database. */ backupSpaceEstimateInGbs: number; /** * Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used. */ backupSpaceUsedInGbs: number; /** * Number of seconds backups are currently retained for this database. */ currentRetentionPeriodInSeconds: number; /** * The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs. */ dbSizeInGbs: number; /** * The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. */ isRedoLogsEnabled: boolean; /** * Number of days of redo/archive to be applied to recover database. */ minimumRecoveryNeededInDays: number; /** * The maximum number of days to retain backups for a protected database. */ retentionPeriodInDays: number; /** * This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped. */ unprotectedWindowInSeconds: number; } interface GetProtectedDatabasesProtectedDatabaseCollectionItemRecoveryServiceSubnet { /** * The recovery service subnet OCID. */ recoveryServiceSubnetId: string; /** * A filter to return only the resources that match the specified lifecycle state. */ state: string; } interface GetProtectionPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetProtectionPoliciesProtectionPolicyCollection { items: outputs.RecoveryMod.GetProtectionPoliciesProtectionPolicyCollectionItem[]; } interface GetProtectionPoliciesProtectionPolicyCollectionItem { /** * The maximum number of days to retain backups for a protected database. Specify a period ranging from a minimum 14 days to a maximum 95 days. For example, specify the value 55 if you want to retain backups for 55 days. */ backupRetentionPeriodInDays: number; /** * The compartment OCID. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire 'displayname' given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The protection policy OCID. */ id: string; /** * Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies. */ isPredefinedPolicy: boolean; /** * Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state. */ lifecycleDetails: string; /** * Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned. */ mustEnforceCloudLocality: boolean; /** * An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy. */ policyLockedDateTime: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) */ systemTags: { [key: string]: string; }; /** * An RFC3339 formatted datetime string that indicates the created time for the protection policy. For example: '2020-05-22T21:10:29.600Z'. */ timeCreated: string; /** * An RFC3339 formatted datetime string that indicates the updated time for the protection policy. For example: '2020-05-22T21:10:29.600Z'. */ timeUpdated: string; } interface GetRecoveryServiceSubnetsFilter { name: string; regex?: boolean; values: string[]; } interface GetRecoveryServiceSubnetsRecoveryServiceSubnetCollection { items: outputs.RecoveryMod.GetRecoveryServiceSubnetsRecoveryServiceSubnetCollectionItem[]; } interface GetRecoveryServiceSubnetsRecoveryServiceSubnetCollectionItem { /** * The compartment OCID. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire 'displayname' given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The recovery service subnet OCID. */ id: string; /** * Detailed description about the current lifecycle state of the recovery service subnet. For example, it can be used to provide actionable information for a resource in a Failed state */ lifecycleDetails: string; /** * A list of network security group (NSG) OCIDs that are associated with the Recovery Service subnet. You can specify a maximum of 5 unique OCIDs, which implies that you can associate a maximum of 5 NSGs to each Recovery Service subnet. Specify an empty array if you want to remove all the associated NSGs from a Recovery Service subnet. See [Network Security Groups](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/) for more information. */ nsgIds: string[]; /** * A filter to return only the resources that match the specified lifecycle state. */ state: string; /** * Deprecated. One of the subnets associated with the Recovery Service subnet. * * @deprecated The 'subnet_id' field has been deprecated. Please use 'subnets' instead. */ subnetId: string; /** * A list of OCIDs of all the subnets associated with the Recovery Service subnet. */ subnets: string[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}`. For more information, see [Resource Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm) */ systemTags: { [key: string]: string; }; /** * An RFC3339 formatted datetime string that indicates the last created time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'. */ timeCreated: string; /** * An RFC3339 formatted datetime string that indicates the last updated time for a recovery service subnet. For example: '2020-05-22T21:10:29.600Z'. */ timeUpdated: string; /** * The OCID of the virtual cloud network (VCN) associated with the recovery service subnet. */ vcnId: string; } interface ProtectedDatabaseMetric { /** * The estimated backup storage space, in gigabytes, required to meet the recovery window goal, including foot print and backups for the protected database. */ backupSpaceEstimateInGbs: number; /** * Backup storage space, in gigabytes, utilized by the protected database. Oracle charges for the total storage used. */ backupSpaceUsedInGbs: number; /** * Number of seconds backups are currently retained for this database. */ currentRetentionPeriodInSeconds: number; /** * The estimated space, in gigabytes, consumed by the protected database. The database size is based on the size of the data files in the catalog, and does not include archive logs. */ dbSizeInGbs: number; /** * The value TRUE indicates that the protected database is configured to use Real-time data protection, and redo-data is sent from the protected database to Recovery Service. Real-time data protection substantially reduces the window of potential data loss that exists between successive archived redo log backups. */ isRedoLogsEnabled: boolean; /** * Number of days of redo/archive to be applied to recover database. */ minimumRecoveryNeededInDays: number; /** * The maximum number of days to retain backups for a protected database. */ retentionPeriodInDays: number; /** * This is the time window when there is data loss exposure. The point after which recovery is impossible unless additional redo is available. This is the time we received the last backup or last redo-log shipped. */ unprotectedWindowInSeconds: number; } interface ProtectedDatabaseRecoveryServiceSubnet { /** * (Updatable) The recovery service subnet OCID. */ recoveryServiceSubnetId: string; /** * The current state of the Protected Database. */ state: string; } } export declare namespace Redis { interface GetOciCacheBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetOciCacheBackupsOciCacheBackupCollection { items: outputs.Redis.GetOciCacheBackupsOciCacheBackupCollectionItem[]; } interface GetOciCacheBackupsOciCacheBackupCollectionItem { /** * Backup size in GB. */ backupSizeInGbs: number; /** * Specifies whether the backup was created from a replica or primary node */ backupSource: string; /** * Backup Type. */ backupType: string; /** * The amount of memory allocated to the cluster, in gigabytes. */ clusterMemoryInGbs: number; /** * Specifies whether the cluster is sharded or non-sharded. */ clusterMode: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Backup description */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; exportToObjectStorageTrigger: number; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier that is immutable on creation */ id: string; /** * Backup retention period in days. */ retentionPeriodInDays: number; /** * The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED. */ shardCount: number; /** * The Oracle Cloud Infrastructure Cache engine version that the cluster is running. */ softwareVersion: string; /** * A filter to return the Oracle Cloud Infrastructure Cache Backup resources, whose source cluster ID matches with the given source cluster ID. */ sourceClusterId: string; /** * A filter to return the Oracle Cloud Infrastructure Cache Backup resources, whose lifecycle state matches with the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the backup was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * The date and time the backup was updated. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeUpdated: string; } interface GetOciCacheConfigSetConfigurationDetail { /** * List of ConfigurationInfo objects. */ items: outputs.Redis.GetOciCacheConfigSetConfigurationDetailItem[]; } interface GetOciCacheConfigSetConfigurationDetailItem { /** * Key is the configuration key. */ configKey: string; /** * Value of the configuration as a string. Can represent a string, boolean, or number. Example: "true", "42", or "someString". */ configValue: string; } interface GetOciCacheConfigSetsFilter { name: string; regex?: boolean; values: string[]; } interface GetOciCacheConfigSetsOciCacheConfigSetCollection { /** * List of ConfigurationInfo objects. */ items: outputs.Redis.GetOciCacheConfigSetsOciCacheConfigSetCollectionItem[]; } interface GetOciCacheConfigSetsOciCacheConfigSetCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * List of Oracle Cloud Infrastructure Cache Config Set Values. */ configurationDetails: outputs.Redis.GetOciCacheConfigSetsOciCacheConfigSetCollectionItemConfigurationDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the default Oracle Cloud Infrastructure Cache Config Set which the custom Oracle Cloud Infrastructure Cache Config Set is based upon. */ defaultConfigSetId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A description of the Oracle Cloud Infrastructure Cache Config Set. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique Oracle Cloud Infrastructure Cache Config Set identifier. */ id: string; /** * A filter to return the Oracle Cloud Infrastructure Cache Config Set resources, whose software version matches with the given software version. */ softwareVersion: string; /** * A filter to return the Oracle Cloud Infrastructure Cache Config Set resources, whose lifecycle state matches with the given lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Oracle Cloud Infrastructure Cache Config Set was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * The date and time the Oracle Cloud Infrastructure Cache Config Set was updated. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeUpdated: string; } interface GetOciCacheConfigSetsOciCacheConfigSetCollectionItemConfigurationDetail { /** * List of ConfigurationInfo objects. */ items: outputs.Redis.GetOciCacheConfigSetsOciCacheConfigSetCollectionItemConfigurationDetailItem[]; } interface GetOciCacheConfigSetsOciCacheConfigSetCollectionItemConfigurationDetailItem { /** * Key is the configuration key. */ configKey: string; /** * Value of the configuration as a string. Can represent a string, boolean, or number. Example: "true", "42", or "someString". */ configValue: string; } interface GetOciCacheDefaultConfigSetDefaultConfigurationDetail { /** * List of DefaultConfigurationInfo objects. */ items: outputs.Redis.GetOciCacheDefaultConfigSetDefaultConfigurationDetailItem[]; } interface GetOciCacheDefaultConfigSetDefaultConfigurationDetailItem { /** * Allowed values for the configuration setting. */ allowedValues: string; /** * The key of the configuration setting. */ configKey: string; /** * The data type of the configuration setting. */ dataType: string; /** * The default value for the configuration setting. */ defaultConfigValue: string; /** * Description of the Oracle Cloud Infrastructure Cache Default Config Set. */ description: string; /** * Indicates if the configuration is modifiable. */ isModifiable: boolean; } interface GetOciCacheDefaultConfigSetsFilter { name: string; regex?: boolean; values: string[]; } interface GetOciCacheDefaultConfigSetsOciCacheDefaultConfigSetCollection { /** * List of DefaultConfigurationInfo objects. */ items: outputs.Redis.GetOciCacheDefaultConfigSetsOciCacheDefaultConfigSetCollectionItem[]; } interface GetOciCacheDefaultConfigSetsOciCacheDefaultConfigSetCollectionItem { /** * List of Oracle Cloud Infrastructure Cache Default Config Set Values. */ defaultConfigurationDetails: outputs.Redis.GetOciCacheDefaultConfigSetsOciCacheDefaultConfigSetCollectionItemDefaultConfigurationDetail[]; /** * Description of the Oracle Cloud Infrastructure Cache Default Config Set. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Unique Oracle Cloud Infrastructure Cache Default Config Set identifier. */ id: string; /** * A filter to return the Oracle Cloud Infrastructure Cache Config Set resources, whose software version matches with the given software version. */ softwareVersion: string; /** * A filter to return the Oracle Cloud Infrastructure Cache Default Config Set resources, whose lifecycle state matches with the given lifecycle state. */ state: string; /** * The date and time the Oracle Cloud Infrastructure Cache Default Config Set was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeCreated: string; } interface GetOciCacheDefaultConfigSetsOciCacheDefaultConfigSetCollectionItemDefaultConfigurationDetail { /** * List of DefaultConfigurationInfo objects. */ items: outputs.Redis.GetOciCacheDefaultConfigSetsOciCacheDefaultConfigSetCollectionItemDefaultConfigurationDetailItem[]; } interface GetOciCacheDefaultConfigSetsOciCacheDefaultConfigSetCollectionItemDefaultConfigurationDetailItem { /** * Allowed values for the configuration setting. */ allowedValues: string; /** * The key of the configuration setting. */ configKey: string; /** * The data type of the configuration setting. */ dataType: string; /** * The default value for the configuration setting. */ defaultConfigValue: string; /** * Description of the Oracle Cloud Infrastructure Cache Default Config Set. */ description: string; /** * Indicates if the configuration is modifiable. */ isModifiable: boolean; } interface GetOciCacheEngineOptionsFilter { /** * Oracle Cloud Infrastructure Cache engine version friendly name */ name: string; regex?: boolean; values: string[]; } interface GetOciCacheEngineOptionsOciCacheEngineOptionsCollection { /** * List of Oracle Cloud Infrastructure Cache Engine Options */ items: outputs.Redis.GetOciCacheEngineOptionsOciCacheEngineOptionsCollectionItem[]; } interface GetOciCacheEngineOptionsOciCacheEngineOptionsCollectionItem { /** * List of available engine versions */ engineVersions: outputs.Redis.GetOciCacheEngineOptionsOciCacheEngineOptionsCollectionItemEngineVersion[]; } interface GetOciCacheEngineOptionsOciCacheEngineOptionsCollectionItemEngineVersion { /** * Oracle Cloud Infrastructure Cache engine version friendly name */ name: string; /** * Oracle Cloud Infrastructure Cache engine version */ version: string; } interface GetOciCacheUserAuthenticationMode { /** * This is Authentication Type of Oracle Cloud Infrastructure cache user */ authenticationType: string; /** * SHA-256 hashed passwords for Oracle Cloud Infrastructure Cache user,required if authenticationType is set to PASSWORD. */ hashedPasswords: string[]; } interface GetOciCacheUsersFilter { /** * A filter to return the resources that match with the given Oracle Cloud Infrastructure cache user name. */ name: string; regex?: boolean; values: string[]; } interface GetOciCacheUsersOciCacheUserCollection { items: outputs.Redis.GetOciCacheUsersOciCacheUserCollectionItem[]; } interface GetOciCacheUsersOciCacheUserCollectionItem { /** * This is Authentication Type of Oracle Cloud Infrastructure cache user */ authenticationType: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of Oracle Cloud Infrastructure cache user. */ description: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Oracle Cloud Infrastructure Cache user unique ID. */ id: string; /** * A filter to return the resources that match with the given Oracle Cloud Infrastructure cache user name. */ name: string; /** * A filter to return the resources, whose lifecycleState matches with the given lifecycleState. */ state: string; /** * Oracle Cloud Infrastructure Cache user status. ON enables and OFF disables the Oracle Cloud Infrastructure cache user to login to the cluster. */ status: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time, when the Oracle Cloud Infrastructure cache user was created. */ timeCreated: string; } interface GetRedisClusterImportFromObjectStorageDetail { /** * The Object Storage bucket name. */ bucket: string; /** * The Object Storage namespace name. */ namespace: string; /** * The list of objects to import from the specified bucket. */ objects: outputs.Redis.GetRedisClusterImportFromObjectStorageDetailObject[]; } interface GetRedisClusterImportFromObjectStorageDetailObject { /** * The name of the object in the bucket (for example, 'customerA/exports/backup_ocid/dump.rdb'). */ object: string; } interface GetRedisClusterNodeCollection { /** * Collection of node objects. */ items: outputs.Redis.GetRedisClusterNodeCollectionItem[]; } interface GetRedisClusterNodeCollectionItem { /** * A user-friendly name of a cluster node. */ displayName: string; /** * The fully qualified domain name (FQDN) of the API endpoint to access a specific node. */ privateEndpointFqdn: string; /** * The private IP address of the API endpoint to access a specific node. */ privateEndpointIpAddress: string; } interface GetRedisClusterNodesFilter { name: string; regex?: boolean; values: string[]; } interface GetRedisClusterNodesRedisNodeCollection { /** * The list of nodes in a cluster. */ items: outputs.Redis.GetRedisClusterNodesRedisNodeCollectionItem[]; } interface GetRedisClusterNodesRedisNodeCollectionItem { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The fully qualified domain name (FQDN) of the API endpoint to access a specific node. */ privateEndpointFqdn: string; /** * The private IP address of the API endpoint to access a specific node. */ privateEndpointIpAddress: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. */ redisClusterId: string; /** * The shard number to which the node belongs to. */ shardNumber: number; } interface GetRedisClustersFilter { name: string; regex?: boolean; values: string[]; } interface GetRedisClustersRedisClusterCollection { /** * Collection of node objects. */ items: outputs.Redis.GetRedisClustersRedisClusterCollectionItem[]; } interface GetRedisClustersRedisClusterCollectionItem { /** * The ID of the Oracle Cloud Infrastructure Cache Backup from which this cluster was created. */ backupId: string; /** * Specifies whether the cluster is sharded or non-sharded. */ clusterMode: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The private IP address of the API endpoint for sharded cluster discovery. */ discoveryEndpointIpAddress: string; /** * The fully qualified domain name (FQDN) of the API endpoint for sharded cluster discovery. */ discoveryFqdn: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. */ id: string; /** * Details for importing Oracle Cloud Infrastructure Cache data from Object Storage RDB file(s) during cluster creation. */ importFromObjectStorageDetails: outputs.Redis.GetRedisClustersRedisClusterCollectionItemImportFromObjectStorageDetail[]; /** * A message describing the current state in more detail. For example, the message might provide actionable information for a resource in `FAILED` state. */ lifecycleDetails: string; /** * The collection of cluster nodes. */ nodeCollections: outputs.Redis.GetRedisClustersRedisClusterCollectionItemNodeCollection[]; /** * The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED. */ nodeCount: number; /** * The amount of memory allocated to the cluster's nodes, in gigabytes. */ nodeMemoryInGbs: number; /** * A list of Network Security Group (NSG) [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this cluster. For more information, see [Using an NSG for Clusters](https://docs.cloud.oracle.com/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup). */ nsgIds: string[]; /** * The ID of the corresponding Oracle Cloud Infrastructure Cache Config Set for the cluster. */ ociCacheConfigSetId: string; /** * The private IP address of the API endpoint for the cluster's primary node. */ primaryEndpointIpAddress: string; /** * The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node. */ primaryFqdn: string; /** * The private IP address of the API endpoint for the cluster's replica nodes. */ replicasEndpointIpAddress: string; /** * The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes. */ replicasFqdn: string; /** * Security attributes for redis cluster 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED. */ shardCount: number; /** * The Oracle Cloud Infrastructure Cache engine version that the cluster is running. */ softwareVersion: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster's subnet. */ subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the cluster was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeCreated: string; /** * The date and time the cluster was updated. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. */ timeUpdated: string; } interface GetRedisClustersRedisClusterCollectionItemImportFromObjectStorageDetail { /** * The Object Storage bucket name. */ bucket: string; /** * The Object Storage namespace name. */ namespace: string; /** * The list of objects to import from the specified bucket. */ objects: outputs.Redis.GetRedisClustersRedisClusterCollectionItemImportFromObjectStorageDetailObject[]; } interface GetRedisClustersRedisClusterCollectionItemImportFromObjectStorageDetailObject { /** * The name of the object in the bucket (for example, 'customerA/exports/backup_ocid/dump.rdb'). */ object: string; } interface GetRedisClustersRedisClusterCollectionItemNodeCollection { /** * Collection of node objects. */ items: outputs.Redis.GetRedisClustersRedisClusterCollectionItemNodeCollectionItem[]; } interface GetRedisClustersRedisClusterCollectionItemNodeCollectionItem { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The fully qualified domain name (FQDN) of the API endpoint to access a specific node. */ privateEndpointFqdn: string; /** * The private IP address of the API endpoint to access a specific node. */ privateEndpointIpAddress: string; } interface OciCacheConfigSetConfigurationDetails { /** * List of ConfigurationInfo objects. */ items: outputs.Redis.OciCacheConfigSetConfigurationDetailsItem[]; } interface OciCacheConfigSetConfigurationDetailsItem { /** * Key is the configuration key. */ configKey: string; /** * Value of the configuration as a string. Can represent a string, boolean, or number. Example: "true", "42", or "someString". */ configValue: string; } interface OciCacheConfigSetlistAssociatedOciCacheClusterItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. */ id: string; } interface OciCacheUserAuthenticationMode { /** * (Updatable) This is Authentication Type of Oracle Cloud Infrastructure cache user */ authenticationType: string; /** * (Updatable) SHA-256 hashed passwords for Oracle Cloud Infrastructure Cache user,required if authenticationType is set to PASSWORD. */ hashedPasswords: string[]; } interface OciCacheUserGetRedisClusterOciCacheCluster { /** * OCID of the OciCacheCluster */ ociCacheClusterId: string; } interface RedisClusterGetOciCacheUserOciCacheUser { /** * OCID of the OciCacheUser */ ociCacheUserId: string; } interface RedisClusterImportFromObjectStorageDetails { /** * The Object Storage bucket name. */ bucket: string; /** * The Object Storage namespace name. */ namespace: string; /** * The list of objects to import from the specified bucket. */ objects: outputs.Redis.RedisClusterImportFromObjectStorageDetailsObject[]; } interface RedisClusterImportFromObjectStorageDetailsObject { /** * The name of the object in the bucket (for example, 'customerA/exports/backup_ocid/dump.rdb'). */ object: string; } interface RedisClusterNodeCollection { /** * Collection of node objects. */ items: outputs.Redis.RedisClusterNodeCollectionItem[]; } interface RedisClusterNodeCollectionItem { /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. */ displayName: string; /** * The fully qualified domain name (FQDN) of the API endpoint to access a specific node. */ privateEndpointFqdn: string; /** * The private IP address of the API endpoint to access a specific node. */ privateEndpointIpAddress: string; } } export declare namespace ResourceManager { interface GetPrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetPrivateEndpointsPrivateEndpointCollection { items: outputs.ResourceManager.GetPrivateEndpointsPrivateEndpointCollectionItem[]; } interface GetPrivateEndpointsPrivateEndpointCollectionItem { /** * A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of the private endpoint. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires `sortBy` set to `DISPLAYNAME`. Alternatively, when you know the resource OCID, use the related Get operation. */ displayName: string; /** * DNS zones to use for accessing private Git servers. For private Git server instructions, see [Private Git Server](https://docs.cloud.oracle.com/iaas/Content/ResourceManager/Tasks/private-endpoints.htm#private-git). Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: `abc.oraclevcn.com` */ dnsZones: string[]; /** * Free-form tags associated with the resource. Each tag is a 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. */ id: string; /** * When `true`, allows the private endpoint to be used with a configuration source provider. */ isUsedWithConfigurationSourceProvider: boolean; /** * The [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of [network security groups (NSGs)](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm) for the private endpoint. Order does not matter. */ nsgIdLists: string[]; /** * [Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm) 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-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` */ securityAttributes: { [key: string]: string; }; /** * The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager. */ sourceIps: string[]; /** * The current lifecycle state of the private endpoint. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint. */ subnetId: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: `2020-11-25T21:10:29.600Z` */ timeCreated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetStackConfigSource { /** * Specifies the `configSourceType` for uploading the Terraform configuration. Presently, the .zip file type (`ZIP_UPLOAD`) is the only supported `configSourceType`. */ configSourceType: string; /** * File path to the directory from which Terraform runs. If not specified, we use the root directory. */ workingDirectory: string; zipFileBase64encoded: string; } interface GetStacksFilter { name: string; regex?: boolean; values: string[]; } interface GetStacksStack { /** * The compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) on which to filter. */ compartmentId: string; /** * Location of the Terraform configuration. */ configSource: outputs.ResourceManager.GetStacksStackConfigSource; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * General description of the stack. */ description: string; /** * Display name on which to query. */ displayName: string; /** * Free-form tags associated with the resource. Each tag is a 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) on which to query for a stack. */ id: string; /** * A filter that returns only those resources that match the specified lifecycle state. The state value is case-insensitive. For more information about stack lifecycle states, see [Key Concepts](https://docs.cloud.oracle.com/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__StackStates). */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; /** * The version of Terraform specified for the stack. Example: `1.5.x` */ terraformVersion: string; /** * The date and time at which the stack was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` */ timeCreated: string; /** * Terraform variables associated with this resource. Maximum number of variables supported is 250. The maximum size of each variable, including both name and value, is 8192 bytes. Example: `{"CompartmentId": "compartment-id-value"}` */ variables: { [key: string]: string; }; } interface GetStacksStackConfigSource { /** * Specifies the `configSourceType` for uploading the Terraform configuration. Presently, the .zip file type (`ZIP_UPLOAD`) is the only supported `configSourceType`. */ configSourceType: string; /** * File path to the directory from which Terraform runs. If not specified, we use the root directory. */ workingDirectory: string; zipFileBase64encoded: string; } } export declare namespace ResourceScheduler { interface GetScheduleResource { /** * This is the resource OCID. */ id: string; /** * This is additional information that helps to identity the resource for the schedule. */ metadata: { [key: string]: string; }; /** * This is the user input parameters to use when acting on the resource. */ parameters: outputs.ResourceScheduler.GetScheduleResourceParameter[]; } interface GetScheduleResourceFilter { /** * This is the resource attribute on which the threshold is defined. */ attribute: string; /** * This is the condition for the filter in comparison to its creation time. */ condition: string; /** * This sets whether to include child compartments. */ shouldIncludeChildCompartments: boolean; /** * This is the HTTP request header value. */ values: outputs.ResourceScheduler.GetScheduleResourceFilterValue[]; } interface GetScheduleResourceFilterValue { /** * This is the namespace of the defined tag. */ namespace: string; /** * This is the key of the defined tag. */ tagKey: string; /** * This is the HTTP request header value. */ value: string; } interface GetScheduleResourceParameter { /** * This is the parameter type on which the input parameter is defined */ parameterType: string; /** * This is the HTTP request header value. */ values: string[]; } interface GetSchedulesFilter { name: string; regex?: boolean; values: string[]; } interface GetSchedulesScheduleCollection { items: outputs.ResourceScheduler.GetSchedulesScheduleCollectionItem[]; } interface GetSchedulesScheduleCollectionItem { /** * This is the action that will be executed by the schedule. */ action: string; /** * This is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. You need to at least provide either `compartmentId` or `scheduleId` or both. */ compartmentId: string; /** * These are 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"}` */ definedTags: { [key: string]: string; }; /** * This is the description of the schedule. */ description: string; /** * This is a filter to return only resources that match the given display name exactly. */ displayName: string; /** * These are 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"}` */ freeformTags: { [key: string]: string; }; /** * This is the resource OCID. */ id: string; /** * This is the status of the last work request. */ lastRunStatus: string; /** * IANA timezone identifier (e.g., 'America/New_York', 'UTC', 'Europe/London'). This determines the timezone context for evaluating the recurrence expression. */ localTimeZone: string; /** * This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. */ recurrenceDetails: string; /** * Type of recurrence of a schedule */ recurrenceType: string; /** * This is a list of resources filters. The schedule will be applied to resources matching all of them. */ resourceFilters: outputs.ResourceScheduler.GetSchedulesScheduleCollectionItemResourceFilter[]; /** * This is the list of resources to which the scheduled operation is applied. */ resources: outputs.ResourceScheduler.GetSchedulesScheduleCollectionItemResource[]; /** * This is a filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * These are system tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * This is the date and time the schedule was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * This is the date and time the schedule ends, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339) Example: `2016-08-25T21:10:29.600Z` */ timeEnds: string; /** * This is the date and time the schedule runs last time, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeLastRun: string; /** * This is the date and time the schedule run the next time, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeNextRun: string; /** * This is the date and time the schedule starts, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339) Example: `2016-08-25T21:10:29.600Z` */ timeStarts: string; /** * This is the date and time the schedule was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetSchedulesScheduleCollectionItemResource { /** * This is the resource OCID. */ id: string; /** * This is additional information that helps to identity the resource for the schedule. */ metadata: { [key: string]: string; }; /** * This is the user input parameters to use when acting on the resource. */ parameters: outputs.ResourceScheduler.GetSchedulesScheduleCollectionItemResourceParameter[]; } interface GetSchedulesScheduleCollectionItemResourceFilter { /** * This is the resource attribute on which the threshold is defined. */ attribute: string; /** * This is the condition for the filter in comparison to its creation time. */ condition: string; /** * This sets whether to include child compartments. */ shouldIncludeChildCompartments: boolean; /** * This is the HTTP request header value. */ values: outputs.ResourceScheduler.GetSchedulesScheduleCollectionItemResourceFilterValue[]; } interface GetSchedulesScheduleCollectionItemResourceFilterValue { /** * This is the namespace of the defined tag. */ namespace: string; /** * This is the key of the defined tag. */ tagKey: string; /** * This is the HTTP request header value. */ value: string; } interface GetSchedulesScheduleCollectionItemResourceParameter { /** * This is the parameter type on which the input parameter is defined */ parameterType: string; /** * This is the HTTP request header value. */ values: string[]; } interface ScheduleResource { /** * (Updatable) This is the resource OCID. */ id: string; /** * (Updatable) This is additional information that helps to identity the resource for the schedule. * { "id": "" "metadata": { "namespaceName": "sampleNamespace", "bucketName": "sampleBucket" } } */ metadata: { [key: string]: string; }; /** * (Updatable) This is the user input parameters to use when acting on the resource. * * { "parameters": [ { "parameterType": "BODY", "value": { "ip": "192.168.44.44", "memory": "1024", "syncedFolders": [ { "hostPath": "data/", "guestPath": "/var/www", "type": "default" } ], "forwardedPorts": [] } }, { "parameterType": "PATH", "value": { "compartmentId": "ocid1.compartment.oc1..xxxxx", "instanceId": "ocid1.vcn.oc1..yyyy" } }, { "parameterType": "QUERY", "value": { "limit": "10", "tenantId": "ocid1.tenant.oc1..zzzz" } }, { "parameterType": "HEADER", "value": { "token": "xxxx" } } ] } */ parameters: outputs.ResourceScheduler.ScheduleResourceParameter[]; } interface ScheduleResourceFilter { /** * (Updatable) This is the resource attribute on which the threshold is defined. We support 5 different types of attributes: `DEFINED_TAGS`, `COMPARTMENT_ID`, `TIME_CREATED`, `LIFECYCLE_STATE` and `RESOURCE_TYPE`. */ attribute: string; /** * This is the condition for the filter in comparison to its creation time. */ condition: string; /** * This sets whether to include child compartments. */ shouldIncludeChildCompartments: boolean; /** * (Updatable) This is a collection of resource filter values, different types of filter has different value format, see below: * * When `attribute="DEFINED_TAGS"`: */ values: outputs.ResourceScheduler.ScheduleResourceFilterValue[]; } interface ScheduleResourceFilterValue { /** * This is the namespace of the defined tag. */ namespace: string; /** * This is the key of the defined tag. */ tagKey: string; /** * This is the lifecycle state value used for filtering. */ value: string; } interface ScheduleResourceParameter { /** * (Updatable) This is the parameter type on which the input parameter is defined */ parameterType: string; /** * (Updatable) This is the HTTP request header value. * { "id": "" "metadata": { "namespaceName": "sampleNamespace", "bucketName": "sampleBucket" } } */ value: string; } } export declare namespace Sch { interface ConnectorSource { /** * (Updatable) The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type. For example, for `QueueSource`, the map lists the OCID of the selected queue. To find the parameters for a connector plugin, get the plugin using [GetConnectorPlugin](https://docs.cloud.oracle.com/iaas/api/#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin) and review its schema value. */ configMap: string; /** * (Updatable) The [read setting](https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm), which determines where in the stream to start moving data. For configuration instructions, see [Creating a Connector with a Streaming Source](https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm). */ cursor: outputs.Sch.ConnectorSourceCursor; /** * (Updatable) The type discriminator. */ kind: string; /** * (Updatable) The logs for this Logging source. */ logSources: outputs.Sch.ConnectorSourceLogSource[]; /** * (Updatable) One or more compartment-specific lists of metric namespaces to retrieve data from. */ monitoringSources: outputs.Sch.ConnectorSourceMonitoringSource[]; /** * (Updatable) The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, `QueueSource` indicates the Queue service. To find names of connector plugins, list the plugin using [ListConnectorPlugin](https://docs.cloud.oracle.com/iaas/api/#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins). */ pluginName: string; /** * The private endpoint metadata for the connector's source or target. */ privateEndpointMetadatas: outputs.Sch.ConnectorSourcePrivateEndpointMetadata[]; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; } interface ConnectorSourceCursor { /** * (Updatable) The type discriminator. */ kind: string; } interface ConnectorSourceLogSource { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the log source. */ compartmentId: string; /** * (Updatable) Identifier of the log group. Either `_Audit` or the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. Note: For the Notifications target, only `_Audit` is allowed. */ logGroupId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface ConnectorSourceMonitoringSource { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a compartment containing metric namespaces you want to use for the Monitoring source. */ compartmentId: string; /** * (Updatable) Discriminator for namespaces in the compartment-specific list. */ namespaceDetails: outputs.Sch.ConnectorSourceMonitoringSourceNamespaceDetails; } interface ConnectorSourceMonitoringSourceNamespaceDetails { /** * (Updatable) The type discriminator. */ kind: string; /** * (Updatable) The namespaces for the compartment-specific list. */ namespaces: outputs.Sch.ConnectorSourceMonitoringSourceNamespaceDetailsNamespace[]; } interface ConnectorSourceMonitoringSourceNamespaceDetailsNamespace { /** * (Updatable) The metrics to query for the specified metric namespace. */ metrics: outputs.Sch.ConnectorSourceMonitoringSourceNamespaceDetailsNamespaceMetrics; /** * (Updatable) The source service or application to use when querying for metric data points. Must begin with `oci_`. Example: `ociComputeagent` */ namespace: string; } interface ConnectorSourceMonitoringSourceNamespaceDetailsNamespaceMetrics { /** * (Updatable) The type discriminator. */ kind: string; } interface ConnectorSourcePrivateEndpointMetadata { /** * The reverse connection endpoint (RCE) IP address for DNS lookups. */ rceDnsProxyIpAddress: string; /** * The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet. */ rceTrafficIpAddress: string; } interface ConnectorTarget { /** * (Updatable) The batch rollover size in megabytes. */ batchRolloverSizeInMbs: number; /** * (Updatable) The batch rollover time in milliseconds. */ batchRolloverTimeInMs: number; /** * (Updatable) The batch rollover size in kilobytes. Only one size option can be specified: `batchSizeInKbs` or `batchSizeInNum`. */ batchSizeInKbs: number; /** * (Updatable) The batch rollover size in number of messages. Only one size option can be specified: `batchSizeInKbs` or `batchSizeInNum`. */ batchSizeInNum: number; /** * (Updatable) The batch rollover time in seconds. */ batchTimeInSec: number; /** * (Updatable) The name of the bucket. Valid characters are letters (upper or lower case), numbers, hyphens (-), underscores(_), and periods (.). Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information. Example: my-new-bucket1 */ bucket: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric. */ compartmentId: string; /** * (Updatable) List of dimension names and values. */ dimensions: outputs.Sch.ConnectorTargetDimension[]; /** * (Updatable) Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the connector source and the subscription protocol. Example: `true` */ enableFormattedMessaging: boolean; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function. */ functionId: string; /** * (Updatable) The type discriminator. */ kind: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Logging Analytics log group. */ logGroupId: string; /** * (Updatable) Identifier of the log source that you want to use for processing data received from the connector source. Applies to `StreamingSource` only. Equivalent to `name` at [LogAnalyticsSource](https://docs.cloud.oracle.com/iaas/api/#/en/logan-api-spec/latest/LogAnalyticsSource/). */ logSourceIdentifier: string; /** * (Updatable) The name of the metric. Example: `CpuUtilization` */ metric: string; /** * (Updatable) The namespace of the metric. Example: `ociComputeagent` */ metricNamespace: string; /** * (Updatable) The namespace. */ namespace: string; /** * (Updatable) The prefix of the objects. Avoid entering confidential information. */ objectNamePrefix: string; /** * The private endpoint metadata for the connector's source or target. */ privateEndpointMetadatas: outputs.Sch.ConnectorTargetPrivateEndpointMetadata[]; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId: string; } interface ConnectorTargetDimension { /** * (Updatable) Instructions for extracting the value corresponding to the specified dimension key: Either extract the value as-is (static) or derive the value from a path (evaluated). */ dimensionValue: outputs.Sch.ConnectorTargetDimensionDimensionValue; /** * (Updatable) Dimension key. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. Custom dimension keys are acceptable. Avoid entering confidential information. Due to use by Connector Hub, the following dimension names are reserved: `connectorId`, `connectorName`, `connectorSourceType`. For information on valid dimension keys and values, see [MetricDataDetails Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/MetricDataDetails). Example: `type` */ name: string; } interface ConnectorTargetDimensionDimensionValue { /** * (Updatable) The type of dimension value: static or evaluated. */ kind: string; /** * (Updatable) The location to use for deriving the dimension value (evaluated). The path must start with `logContent` in an acceptable notation style with supported [JMESPath selectors](https://jmespath.org/specification.html): expression with dot and index operator (`.` and `[]`). Example with dot notation: `logContent.data` Example with index notation: `logContent.data[0].content` For information on valid dimension keys and values, see [MetricDataDetails Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/MetricDataDetails). The returned value depends on the results of evaluation. If the evaluated value is valid, then the evaluated value is returned without double quotes. (Any front or trailing double quotes are trimmed before returning the value. For example, the evaluated value `"compartmentId"` is returned as `compartmentId`.) If the evaluated value is invalid, then the returned value is `SCH_EVAL_INVALID_VALUE`. If the evaluated value is empty, then the returned value is `SCH_EVAL_VALUE_EMPTY`. */ path: string; /** * (Updatable) The data extracted from the specified dimension value (passed as-is). Unicode characters only. For information on valid dimension keys and values, see [MetricDataDetails Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/MetricDataDetails). */ value: string; } interface ConnectorTargetPrivateEndpointMetadata { /** * The reverse connection endpoint (RCE) IP address for DNS lookups. */ rceDnsProxyIpAddress: string; /** * The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet. */ rceTrafficIpAddress: string; } interface ConnectorTask { /** * (Updatable) Size limit (kilobytes) for batch sent to invoke the function. */ batchSizeInKbs: number; /** * (Updatable) Time limit (seconds) for batch sent to invoke the function. */ batchTimeInSec: number; /** * (Updatable) A filter or mask to limit the source used in the flow defined by the connector. */ condition: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function to be used as a task. */ functionId: string; /** * (Updatable) The type descriminator. */ kind: string; /** * The private endpoint metadata for the connector's source or target. */ privateEndpointMetadatas: outputs.Sch.ConnectorTaskPrivateEndpointMetadata[]; } interface ConnectorTaskPrivateEndpointMetadata { /** * The reverse connection endpoint (RCE) IP address for DNS lookups. */ rceDnsProxyIpAddress: string; /** * The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet. */ rceTrafficIpAddress: string; } interface GetConnectorPluginsConnectorPluginCollection { items: outputs.Sch.GetConnectorPluginsConnectorPluginCollectionItem[]; } interface GetConnectorPluginsConnectorPluginCollectionItem { /** * A filter to return only resources that match the given display name exactly. Example: `exampleServiceConnector` */ displayName: string; /** * The estimated throughput range (LOW, MEDIUM, HIGH). */ estimatedThroughput: string; /** * The plugin type discriminator. */ kind: string; /** * The estimated maximum period of time the data will be kept at the source. The duration is specified as a string in ISO 8601 format (P1D for one day or P30D for thrity days). */ maxRetention: string; /** * A filter to return only resources that match the given connector plugin name ignoring case. Example: `QueueSource` */ name: string; /** * Gets the specified connector plugin configuration information in OpenAPI specification format. */ schema: string; /** * A filter to return only resources that match the given lifecycle state. Example: `ACTIVE` */ state: string; /** * The date and time when this plugin became available. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2023-09-09T21:10:29.600Z` */ timeCreated: string; } interface GetConnectorPluginsFilter { /** * A filter to return only resources that match the given connector plugin name ignoring case. Example: `QueueSource` */ name: string; regex?: boolean; values: string[]; } interface GetServiceConnectorSource { /** * The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type. For example, for `QueueSource`, the map lists the OCID of the selected queue. To find the parameters for a connector plugin, get the plugin using [GetConnectorPlugin](https://docs.cloud.oracle.com/iaas/api/#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin) and review its schema value. */ configMap: string; /** * The [read setting](https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm), which determines where in the stream to start moving data. For configuration instructions, see [Creating a Connector with a Streaming Source](https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm). */ cursors: outputs.Sch.GetServiceConnectorSourceCursor[]; /** * The type of dimension value: static or evaluated. */ kind: string; /** * The logs for this Logging source. */ logSources: outputs.Sch.GetServiceConnectorSourceLogSource[]; /** * One or more compartment-specific lists of metric namespaces to retrieve data from. */ monitoringSources: outputs.Sch.GetServiceConnectorSourceMonitoringSource[]; /** * The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, `QueueSource` indicates the Queue service. To find names of connector plugins, list the plugin using [ListConnectorPlugin](https://docs.cloud.oracle.com/iaas/api/#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins). */ pluginName: string; /** * The private endpoint metadata for the connector's source or target. */ privateEndpointMetadatas: outputs.Sch.GetServiceConnectorSourcePrivateEndpointMetadata[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; } interface GetServiceConnectorSourceCursor { /** * The type of dimension value: static or evaluated. */ kind: string; } interface GetServiceConnectorSourceLogSource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Logging Analytics log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetServiceConnectorSourceMonitoringSource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric. */ compartmentId: string; /** * Discriminator for namespaces in the compartment-specific list. */ namespaceDetails: outputs.Sch.GetServiceConnectorSourceMonitoringSourceNamespaceDetail[]; } interface GetServiceConnectorSourceMonitoringSourceNamespaceDetail { /** * The type of dimension value: static or evaluated. */ kind: string; /** * The namespaces for the compartment-specific list. */ namespaces: outputs.Sch.GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespace[]; } interface GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespace { /** * The metrics to query for the specified metric namespace. */ metrics: outputs.Sch.GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespaceMetric[]; /** * The namespace. */ namespace: string; } interface GetServiceConnectorSourceMonitoringSourceNamespaceDetailNamespaceMetric { /** * The type of dimension value: static or evaluated. */ kind: string; } interface GetServiceConnectorSourcePrivateEndpointMetadata { /** * The reverse connection endpoint (RCE) IP address for DNS lookups. */ rceDnsProxyIpAddress: string; /** * The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet. */ rceTrafficIpAddress: string; } interface GetServiceConnectorTarget { /** * The batch rollover size in megabytes. */ batchRolloverSizeInMbs: number; /** * The batch rollover time in milliseconds. */ batchRolloverTimeInMs: number; /** * Size limit (kilobytes) for batch sent to invoke the function. */ batchSizeInKbs: number; /** * The batch rollover size in number of messages. Only one size option can be specified: `batchSizeInKbs` or `batchSizeInNum`. */ batchSizeInNum: number; /** * Time limit (seconds) for batch sent to invoke the function. */ batchTimeInSec: number; /** * The name of the bucket. Valid characters are letters (upper or lower case), numbers, hyphens (-), underscores(_), and periods (.). Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information. Example: my-new-bucket1 */ bucket: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric. */ compartmentId: string; /** * List of dimension names and values. */ dimensions: outputs.Sch.GetServiceConnectorTargetDimension[]; /** * Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the connector source and the subscription protocol. Example: `true` */ enableFormattedMessaging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function to be used as a task. */ functionId: string; /** * The type of dimension value: static or evaluated. */ kind: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Logging Analytics log group. */ logGroupId: string; /** * Identifier of the log source that you want to use for processing data received from the connector source. Applies to `StreamingSource` only. Equivalent to `name` at [LogAnalyticsSource](https://docs.cloud.oracle.com/iaas/api/#/en/logan-api-spec/latest/LogAnalyticsSource/). */ logSourceIdentifier: string; /** * The name of the metric. Example: `CpuUtilization` */ metric: string; /** * The namespace of the metric. Example: `ociComputeagent` */ metricNamespace: string; /** * The namespace. */ namespace: string; /** * The prefix of the objects. Avoid entering confidential information. */ objectNamePrefix: string; /** * The private endpoint metadata for the connector's source or target. */ privateEndpointMetadatas: outputs.Sch.GetServiceConnectorTargetPrivateEndpointMetadata[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId: string; } interface GetServiceConnectorTargetDimension { /** * Instructions for extracting the value corresponding to the specified dimension key: Either extract the value as-is (static) or derive the value from a path (evaluated). */ dimensionValues: outputs.Sch.GetServiceConnectorTargetDimensionDimensionValue[]; /** * Dimension key. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. Custom dimension keys are acceptable. Avoid entering confidential information. Due to use by Connector Hub, the following dimension names are reserved: `connectorId`, `connectorName`, `connectorSourceType`. For information on valid dimension keys and values, see [MetricDataDetails Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/MetricDataDetails). Example: `type` */ name: string; } interface GetServiceConnectorTargetDimensionDimensionValue { /** * The type of dimension value: static or evaluated. */ kind: string; /** * The location to use for deriving the dimension value (evaluated). The path must start with `logContent` in an acceptable notation style with supported [JMESPath selectors](https://jmespath.org/specification.html): expression with dot and index operator (`.` and `[]`). Example with dot notation: `logContent.data` Example with index notation: `logContent.data[0].content` For information on valid dimension keys and values, see [MetricDataDetails Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/MetricDataDetails). The returned value depends on the results of evaluation. If the evaluated value is valid, then the evaluated value is returned without double quotes. (Any front or trailing double quotes are trimmed before returning the value. For example, the evaluated value `"compartmentId"` is returned as `compartmentId`.) If the evaluated value is invalid, then the returned value is `SCH_EVAL_INVALID_VALUE`. If the evaluated value is empty, then the returned value is `SCH_EVAL_VALUE_EMPTY`. */ path: string; /** * The data extracted from the specified dimension value (passed as-is). Unicode characters only. For information on valid dimension keys and values, see [MetricDataDetails Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/MetricDataDetails). */ value: string; } interface GetServiceConnectorTargetPrivateEndpointMetadata { /** * The reverse connection endpoint (RCE) IP address for DNS lookups. */ rceDnsProxyIpAddress: string; /** * The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet. */ rceTrafficIpAddress: string; } interface GetServiceConnectorTask { /** * Size limit (kilobytes) for batch sent to invoke the function. */ batchSizeInKbs: number; /** * Time limit (seconds) for batch sent to invoke the function. */ batchTimeInSec: number; /** * A filter or mask to limit the source used in the flow defined by the connector. */ condition: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function to be used as a task. */ functionId: string; /** * The type of dimension value: static or evaluated. */ kind: string; /** * The private endpoint metadata for the connector's source or target. */ privateEndpointMetadatas: outputs.Sch.GetServiceConnectorTaskPrivateEndpointMetadata[]; } interface GetServiceConnectorTaskPrivateEndpointMetadata { /** * The reverse connection endpoint (RCE) IP address for DNS lookups. */ rceDnsProxyIpAddress: string; /** * The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet. */ rceTrafficIpAddress: string; } interface GetServiceConnectorsFilter { /** * Dimension key. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. Custom dimension keys are acceptable. Avoid entering confidential information. Due to use by Connector Hub, the following dimension names are reserved: `connectorId`, `connectorName`, `connectorSourceType`. For information on valid dimension keys and values, see [MetricDataDetails Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/MetricDataDetails). Example: `type` */ name: string; regex?: boolean; values: string[]; } interface GetServiceConnectorsServiceConnectorCollection { items: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItem[]; } interface GetServiceConnectorsServiceConnectorCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this request. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The description of the resource. Avoid entering confidential information. */ description: string; /** * A filter to return only resources that match the given display name exactly. Example: `exampleServiceConnector` */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector. */ id: string; /** * A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a `FAILED` state. */ lifecycleDetails: string; /** * *Please note this property is deprecated and will be removed on January 27, 2026. Use `lifecycleDetails` instead.* A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a `FAILED` state. */ lifecyleDetails: string; sources: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemSource[]; /** * A filter to return only resources that match the given lifecycle state. Example: `ACTIVE` */ state: string; /** * 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}}` */ systemTags: { [key: string]: string; }; targets: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemTarget[]; /** * The list of tasks. */ tasks: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemTask[]; /** * The date and time when the connector was created. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time when the connector was updated. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z` */ timeUpdated: string; } interface GetServiceConnectorsServiceConnectorCollectionItemSource { /** * The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type. For example, for `QueueSource`, the map lists the OCID of the selected queue. To find the parameters for a connector plugin, get the plugin using [GetConnectorPlugin](https://docs.cloud.oracle.com/iaas/api/#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin) and review its schema value. */ configMap: string; /** * The [read setting](https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm), which determines where in the stream to start moving data. For configuration instructions, see [Creating a Connector with a Streaming Source](https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm). */ cursors: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemSourceCursor[]; /** * The type of dimension value: static or evaluated. */ kind: string; /** * The logs for this Logging source. */ logSources: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemSourceLogSource[]; /** * One or more compartment-specific lists of metric namespaces to retrieve data from. */ monitoringSources: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSource[]; /** * The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, `QueueSource` indicates the Queue service. To find names of connector plugins, list the plugin using [ListConnectorPlugin](https://docs.cloud.oracle.com/iaas/api/#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins). */ pluginName: string; /** * The private endpoint metadata for the connector's source or target. */ privateEndpointMetadatas: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemSourcePrivateEndpointMetadata[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; } interface GetServiceConnectorsServiceConnectorCollectionItemSourceCursor { /** * The type of dimension value: static or evaluated. */ kind: string; } interface GetServiceConnectorsServiceConnectorCollectionItemSourceLogSource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this request. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Logging Analytics log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; } interface GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSource { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this request. */ compartmentId: string; /** * Discriminator for namespaces in the compartment-specific list. */ namespaceDetails: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetail[]; } interface GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetail { /** * The type of dimension value: static or evaluated. */ kind: string; /** * The namespaces for the compartment-specific list. */ namespaces: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespace[]; } interface GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespace { /** * The metrics to query for the specified metric namespace. */ metrics: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespaceMetric[]; /** * The namespace. */ namespace: string; } interface GetServiceConnectorsServiceConnectorCollectionItemSourceMonitoringSourceNamespaceDetailNamespaceMetric { /** * The type of dimension value: static or evaluated. */ kind: string; } interface GetServiceConnectorsServiceConnectorCollectionItemSourcePrivateEndpointMetadata { /** * The reverse connection endpoint (RCE) IP address for DNS lookups. */ rceDnsProxyIpAddress: string; /** * The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet. */ rceTrafficIpAddress: string; } interface GetServiceConnectorsServiceConnectorCollectionItemTarget { /** * The batch rollover size in megabytes. */ batchRolloverSizeInMbs: number; /** * The batch rollover time in milliseconds. */ batchRolloverTimeInMs: number; /** * Size limit (kilobytes) for batch sent to invoke the function. */ batchSizeInKbs: number; /** * The batch rollover size in number of messages. Only one size option can be specified: `batchSizeInKbs` or `batchSizeInNum`. */ batchSizeInNum: number; /** * Time limit (seconds) for batch sent to invoke the function. */ batchTimeInSec: number; /** * The name of the bucket. Valid characters are letters (upper or lower case), numbers, hyphens (-), underscores(_), and periods (.). Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information. Example: my-new-bucket1 */ bucket: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this request. */ compartmentId: string; /** * List of dimension names and values. */ dimensions: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemTargetDimension[]; /** * Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the connector source and the subscription protocol. Example: `true` */ enableFormattedMessaging: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function to be used as a task. */ functionId: string; /** * The type of dimension value: static or evaluated. */ kind: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Logging Analytics log group. */ logGroupId: string; /** * Identifier of the log source that you want to use for processing data received from the connector source. Applies to `StreamingSource` only. Equivalent to `name` at [LogAnalyticsSource](https://docs.cloud.oracle.com/iaas/api/#/en/logan-api-spec/latest/LogAnalyticsSource/). */ logSourceIdentifier: string; /** * The name of the metric. Example: `CpuUtilization` */ metric: string; /** * The namespace of the metric. Example: `ociComputeagent` */ metricNamespace: string; /** * The namespace. */ namespace: string; /** * The prefix of the objects. Avoid entering confidential information. */ objectNamePrefix: string; /** * The private endpoint metadata for the connector's source or target. */ privateEndpointMetadatas: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemTargetPrivateEndpointMetadata[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. */ streamId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. */ topicId: string; } interface GetServiceConnectorsServiceConnectorCollectionItemTargetDimension { /** * Instructions for extracting the value corresponding to the specified dimension key: Either extract the value as-is (static) or derive the value from a path (evaluated). */ dimensionValues: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemTargetDimensionDimensionValue[]; /** * Dimension key. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. Custom dimension keys are acceptable. Avoid entering confidential information. Due to use by Connector Hub, the following dimension names are reserved: `connectorId`, `connectorName`, `connectorSourceType`. For information on valid dimension keys and values, see [MetricDataDetails Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/MetricDataDetails). Example: `type` */ name: string; } interface GetServiceConnectorsServiceConnectorCollectionItemTargetDimensionDimensionValue { /** * The type of dimension value: static or evaluated. */ kind: string; /** * The location to use for deriving the dimension value (evaluated). The path must start with `logContent` in an acceptable notation style with supported [JMESPath selectors](https://jmespath.org/specification.html): expression with dot and index operator (`.` and `[]`). Example with dot notation: `logContent.data` Example with index notation: `logContent.data[0].content` For information on valid dimension keys and values, see [MetricDataDetails Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/MetricDataDetails). The returned value depends on the results of evaluation. If the evaluated value is valid, then the evaluated value is returned without double quotes. (Any front or trailing double quotes are trimmed before returning the value. For example, the evaluated value `"compartmentId"` is returned as `compartmentId`.) If the evaluated value is invalid, then the returned value is `SCH_EVAL_INVALID_VALUE`. If the evaluated value is empty, then the returned value is `SCH_EVAL_VALUE_EMPTY`. */ path: string; /** * The data extracted from the specified dimension value (passed as-is). Unicode characters only. For information on valid dimension keys and values, see [MetricDataDetails Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/MetricDataDetails). */ value: string; } interface GetServiceConnectorsServiceConnectorCollectionItemTargetPrivateEndpointMetadata { /** * The reverse connection endpoint (RCE) IP address for DNS lookups. */ rceDnsProxyIpAddress: string; /** * The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet. */ rceTrafficIpAddress: string; } interface GetServiceConnectorsServiceConnectorCollectionItemTask { /** * Size limit (kilobytes) for batch sent to invoke the function. */ batchSizeInKbs: number; /** * Time limit (seconds) for batch sent to invoke the function. */ batchTimeInSec: number; /** * A filter or mask to limit the source used in the flow defined by the connector. */ condition: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function to be used as a task. */ functionId: string; /** * The type of dimension value: static or evaluated. */ kind: string; /** * The private endpoint metadata for the connector's source or target. */ privateEndpointMetadatas: outputs.Sch.GetServiceConnectorsServiceConnectorCollectionItemTaskPrivateEndpointMetadata[]; } interface GetServiceConnectorsServiceConnectorCollectionItemTaskPrivateEndpointMetadata { /** * The reverse connection endpoint (RCE) IP address for DNS lookups. */ rceDnsProxyIpAddress: string; /** * The reverse connection endpoint (RCE) IP address for primary flow of traffic in the subnet. */ rceTrafficIpAddress: string; } } export declare namespace Secrets { interface GetSecretbundleSecretBundleContent { /** * The base64-encoded content of the secret. */ content: string; /** * The formatting type of the secret contents. */ contentType: string; } interface GetSecretbundleVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSecretbundleVersionsSecretBundleVersion { /** * The OCID of the secret. */ secretId: string; /** * A list of possible rotation states for the secret bundle. */ stages: string[]; /** * The time when the secret bundle was created. */ timeCreated: string; /** * An optional property indicating when to delete the secret version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` */ timeOfDeletion: string; /** * An optional property indicating when the secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` */ timeOfExpiry: string; /** * The version name of the secret bundle, as provided when the secret was created or last rotated. */ versionName: string; /** * The version number of the secret. */ versionNumber: string; } } export declare namespace SecurityAttribute { interface GetSecurityAttributeNamespacesFilter { /** * A filter to return only resources that match the entire display name given. */ name: string; regex?: boolean; values: string[]; } interface GetSecurityAttributeNamespacesSecurityAttributeNamespace { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A description you create for the security attribute namespace to help you identify it. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the security attribute namespace. */ id: string; /** * Indicates whether the security attribute namespace is retired. See [Managing Security Attribute Namespaces](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm). */ isRetired: boolean; /** * Indicates possible modes the security attributes in this namespace can be set to. This is not accepted from the user. Currently the supported values are enforce and audit. */ modes: string[]; /** * A filter to return only resources that match the entire display name given. */ name: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Date and time the security attribute namespace was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetSecurityAttributeValidator { /** * Specifies the type of validation: a static value (no validation) or a list. */ validatorType: string; /** * The list of allowed values for a security attribute value. */ values: string[]; } interface GetSecurityAttributesFilter { /** * The name assigned to the security attribute during creation. This is the security attribute key. The name must be unique within the security attribute namespace and cannot be changed. */ name: string; regex?: boolean; /** * The list of allowed values for a security attribute value. */ values: string[]; } interface GetSecurityAttributesSecurityAttribute { /** * The OCID of the compartment that contains the security attribute definition. */ compartmentId: string; /** * The description you assign to the security attribute. */ description: string; /** * The OCID of the security attribute definition. */ id: string; /** * Indicates whether the security attribute is retired. See [Managing Security Attribute Namespaces](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm). */ isRetired: boolean; /** * The name assigned to the security attribute during creation. This is the security attribute key. The name must be unique within the security attribute namespace and cannot be changed. */ name: string; /** * The OCID of the security attribute namespace. */ securityAttributeNamespaceId: string; /** * The name of the security attribute namespace that contains the security attribute. */ securityAttributeNamespaceName: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Date and time the security attribute was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The data type of the security attribute. */ type: string; /** * Validates a security attribute value. Each validator performs validation steps in addition to the standard validation for security attribute values. For more information, see [Limits on Security Attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm). */ validators: outputs.SecurityAttribute.GetSecurityAttributesSecurityAttributeValidator[]; } interface GetSecurityAttributesSecurityAttributeValidator { /** * Specifies the type of validation: a static value (no validation) or a list. */ validatorType: string; /** * The list of allowed values for a security attribute value. */ values: string[]; } interface SecurityAttributeValidator { /** * (Updatable) Specifies the type of validation: a static value (no validation) or a list. */ validatorType: string; /** * (Updatable) The list of allowed values for a security attribute value. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ values: string[]; } } export declare namespace ServiceCatalog { interface GetAllApplicationsApplicationCollection { /** * Collection of service catalog applications. */ items: outputs.ServiceCatalog.GetAllApplicationsApplicationCollectionItem[]; } interface GetAllApplicationsApplicationCollectionItem { /** * Product categories that the application belongs to. */ categories: string[]; /** * Exact match name filter. */ displayName: string; /** * The unique identifier of the entity associated with service catalog. */ entityId: string; /** * The type of the application in the service catalog. */ entityType: string; /** * Indicates whether to show only featured resources. If this is set to `false` or is omitted, then all resources will be returned. */ isFeatured: boolean; /** * The model for uploaded binary data, like logos and images. */ logos: outputs.ServiceCatalog.GetAllApplicationsApplicationCollectionItemLogo[]; /** * Name of the package type. If multiple package types are provided, then any resource with one or more matching package types will be returned. */ packageType: string; /** * Summary of the pricing types available across all packages in the application. */ pricingType: string; /** * Summary details about the publisher of the resource. */ publishers: outputs.ServiceCatalog.GetAllApplicationsApplicationCollectionItemPublisher[]; /** * A short description of the application. */ shortDescription: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetAllApplicationsApplicationCollectionItemLogo { /** * The content URL of the uploaded data. */ contentUrl: string; /** * Exact match name filter. */ displayName: string; /** * The MIME type of the uploaded data. */ mimeType: string; } interface GetAllApplicationsApplicationCollectionItemPublisher { /** * Exact match name filter. */ displayName: string; /** * The unique identifier for the publisher. */ id: string; } interface GetAllApplicationsFilter { name: string; regex?: boolean; values: string[]; } interface GetPrivateApplicationLogo { /** * The content URL of the uploaded data. */ contentUrl: string; /** * The name used to refer to the uploaded data. */ displayName: string; /** * The MIME type of the uploaded data. */ mimeType: string; } interface GetPrivateApplicationPackageDetail { /** * Type of packages within this private application. */ packageType: string; version: string; zipFileBase64encoded: string; } interface GetPrivateApplicationPackagesFilter { name: string; regex?: boolean; values: string[]; } interface GetPrivateApplicationPackagesPrivateApplicationPackageCollection { items: outputs.ServiceCatalog.GetPrivateApplicationPackagesPrivateApplicationPackageCollectionItem[]; } interface GetPrivateApplicationPackagesPrivateApplicationPackageCollectionItem { /** * The content URL of the terraform configuration. */ contentUrl: string; /** * Exact match name filter. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private application package. */ id: string; /** * The MIME type of the terraform configuration. */ mimeType: string; /** * Name of the package type. If multiple package types are provided, then any resource with one or more matching package types will be returned. */ packageType: string; /** * The unique identifier for the private application. */ privateApplicationId: string; /** * The date and time the private application package was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2021-05-27T21:10:29.600Z` */ timeCreated: string; /** * The package version. */ version: string; } interface GetPrivateApplicationsFilter { name: string; regex?: boolean; values: string[]; } interface GetPrivateApplicationsPrivateApplicationCollection { items: outputs.ServiceCatalog.GetPrivateApplicationsPrivateApplicationCollectionItem[]; } interface GetPrivateApplicationsPrivateApplicationCollectionItem { /** * The unique identifier for the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Exact match name filter. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The unique identifier for the private application in Marketplace. */ id: string; logoFileBase64encoded: string; /** * The model for uploaded binary data, like logos and images. */ logos: outputs.ServiceCatalog.GetPrivateApplicationsPrivateApplicationCollectionItemLogo[]; /** * A long description of the private application. */ longDescription: string; packageDetails: outputs.ServiceCatalog.GetPrivateApplicationsPrivateApplicationCollectionItemPackageDetail[]; /** * Type of packages within this private application. */ packageType: string; /** * A short description of the private application. */ shortDescription: string; /** * The lifecycle state of the private application. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the private application was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2021-05-26T21:10:29.600Z` */ timeCreated: string; /** * The date and time the private application was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2021-12-10T05:10:29.721Z` */ timeUpdated: string; } interface GetPrivateApplicationsPrivateApplicationCollectionItemLogo { /** * The content URL of the uploaded data. */ contentUrl: string; /** * Exact match name filter. */ displayName: string; /** * The MIME type of the uploaded data. */ mimeType: string; } interface GetPrivateApplicationsPrivateApplicationCollectionItemPackageDetail { /** * Type of packages within this private application. */ packageType: string; version: string; zipFileBase64encoded: string; } interface GetServiceCatalogAssociationsFilter { name: string; regex?: boolean; values: string[]; } interface GetServiceCatalogAssociationsServiceCatalogAssociationCollection { items: outputs.ServiceCatalog.GetServiceCatalogAssociationsServiceCatalogAssociationCollectionItem[]; } interface GetServiceCatalogAssociationsServiceCatalogAssociationCollectionItem { /** * The unique identifier of the entity associated with service catalog. */ entityId: string; /** * The type of the application in the service catalog. */ entityType: string; /** * Identifier of the association. */ id: string; /** * The unique identifier for the service catalog. */ serviceCatalogId: string; /** * Timestamp of when the resource was associated with service catalog. */ timeCreated: string; } interface GetServiceCatalogsFilter { name: string; regex?: boolean; values: string[]; } interface GetServiceCatalogsServiceCatalogCollection { items: outputs.ServiceCatalog.GetServiceCatalogsServiceCatalogCollectionItem[]; } interface GetServiceCatalogsServiceCatalogCollectionItem { /** * The unique identifier for the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Exact match name filter. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The unique identifier for the Service catalog. */ id: string; /** * The lifecycle state of the service catalog. */ state: string; /** * Status of the service catalog, use as a filter to filter out all active catalogs. */ status: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the service catalog was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2021-05-26T21:10:29.600Z` */ timeCreated: string; /** * The date and time the service catalog was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2021-12-10T05:10:29.721Z` */ timeUpdated: string; } interface PrivateApplicationLogo { /** * The content URL of the uploaded data. */ contentUrl: string; /** * (Updatable) The name of the private application. */ displayName: string; /** * The MIME type of the uploaded data. */ mimeType: string; } interface PrivateApplicationPackageDetails { /** * The package's type. */ packageType: string; /** * The package version. */ version: string; /** * Base-64 payload of the Terraform zip package. */ zipFileBase64encoded: string; } } export declare namespace ServiceManagerProxy { interface GetServiceEnvironmentServiceDefinition { /** * Display name of the service. For example, "Oracle Retail Order Management Cloud Service". */ displayName: string; /** * Short display name of the service. For example, "Retail Order Management". */ shortDisplayName: string; /** * The service definition type. For example, a service definition type "RGBUOROMS" would be for the service "Oracle Retail Order Management Cloud Service". */ type: string; } interface GetServiceEnvironmentServiceEnvironmentEndpoint { /** * Description of the environment link */ description: string; /** * Service environment endpoint type. */ environmentType: string; /** * Service environment instance URL. */ url: string; } interface GetServiceEnvironmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetServiceEnvironmentsServiceEnvironmentCollection { items: outputs.ServiceManagerProxy.GetServiceEnvironmentsServiceEnvironmentCollectionItem[]; } interface GetServiceEnvironmentsServiceEnvironmentCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the compartment. */ compartmentId: string; /** * The URL for the console. */ consoleUrl: string; definedTags: { [key: string]: string; }; freeformTags: { [key: string]: string; }; /** * Unqiue identifier for the entitlement related to the environment. */ id: string; /** * Details for a service definition. */ serviceDefinitions: outputs.ServiceManagerProxy.GetServiceEnvironmentsServiceEnvironmentCollectionItemServiceDefinition[]; /** * Array of service environment end points. */ serviceEnvironmentEndpoints: outputs.ServiceManagerProxy.GetServiceEnvironmentsServiceEnvironmentCollectionItemServiceEnvironmentEndpoint[]; /** * Status of the entitlement registration for the service. */ status: string; /** * The unique subscription ID associated with the service environment ID. */ subscriptionId: string; } interface GetServiceEnvironmentsServiceEnvironmentCollectionItemServiceDefinition { /** * The display name of the resource. */ displayName: string; /** * Short display name of the service. For example, "Retail Order Management". */ shortDisplayName: string; /** * The service definition type. For example, a service definition type "RGBUOROMS" would be for the service "Oracle Retail Order Management Cloud Service". */ type: string; } interface GetServiceEnvironmentsServiceEnvironmentCollectionItemServiceEnvironmentEndpoint { /** * Description of the environment link */ description: string; /** * Service environment endpoint type. */ environmentType: string; /** * Service environment instance URL. */ url: string; } } export declare namespace StackMonitoring { interface ConfigAdditionalConfigurations { /** * (Updatable) Key/Value pair of Property */ propertiesMap?: { [key: string]: string; }; } interface ConfigDynamicGroup { /** * (Updatable) Identity domain name */ domain?: string; /** * (Updatable) Name of dynamic Group */ name?: string; /** * (Updatable) Assignment of dynamic group in context of Stack Monitoring service. It describes the purpose of dynamic groups in Stack Monitoring. */ stackMonitoringAssignment?: string; } interface ConfigUserGroup { /** * (Updatable) Identity domain name */ domain?: string; /** * (Updatable) Name of user Group */ name?: string; /** * (Updatable) Role assigned to user group in context of Stack Monitoring service. Access role can be for example: ADMINISTRATOR, OPERATOR, VIEWER, any other access role */ stackMonitoringRole?: string; } interface DiscoveryJobDiscoveryDetails { /** * The OCID of Management Agent */ agentId: string; /** * List of DiscoveryJob Credential Details. */ credentials?: outputs.StackMonitoring.DiscoveryJobDiscoveryDetailsCredentials; /** * License edition of the monitored resource. */ license: string; /** * Property Details */ properties: outputs.StackMonitoring.DiscoveryJobDiscoveryDetailsProperties; /** * The Name of resource type */ resourceName: string; /** * Resource Type. */ resourceType: string; /** * Property Details */ tags?: outputs.StackMonitoring.DiscoveryJobDiscoveryDetailsTags; } interface DiscoveryJobDiscoveryDetailsCredentials { /** * List of DiscoveryJob credentials. */ items: outputs.StackMonitoring.DiscoveryJobDiscoveryDetailsCredentialsItem[]; } interface DiscoveryJobDiscoveryDetailsCredentialsItem { /** * Name of Credential */ credentialName: string; /** * Name of Credential Type */ credentialType: string; /** * Property Details */ properties: outputs.StackMonitoring.DiscoveryJobDiscoveryDetailsCredentialsItemProperties; } interface DiscoveryJobDiscoveryDetailsCredentialsItemProperties { /** * Key/Value pair of Property */ propertiesMap?: { [key: string]: string; }; } interface DiscoveryJobDiscoveryDetailsProperties { /** * Key/Value pair of Property */ propertiesMap?: { [key: string]: string; }; } interface DiscoveryJobDiscoveryDetailsTags { /** * Key/Value pair of Property */ propertiesMap?: { [key: string]: string; }; } interface GetBaselineableMetricsBaselineableMetricSummaryCollection { items: outputs.StackMonitoring.GetBaselineableMetricsBaselineableMetricSummaryCollectionItem[]; } interface GetBaselineableMetricsBaselineableMetricSummaryCollectionItem { /** * metric column name */ column: string; /** * The ID of the compartment in which data is listed. */ compartmentId: string; /** * Created user id */ createdBy: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID of the metric */ id: string; /** * Is the baseline enabled metric defined out of box by Oracle or by end-user */ isOutOfBox: boolean; /** * last Updated user id */ lastUpdatedBy: string; /** * Metric Name */ name: string; /** * namespace of the metric */ namespace: string; /** * Resource Group */ resourceGroup: string; /** * Resource Type */ resourceType: string; /** * The current lifecycle state of the metric extension */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * OCID of the tenancy */ tenancyId: string; /** * creation date */ timeCreated: string; /** * last updated time */ timeLastUpdated: string; } interface GetBaselineableMetricsEvaluateDataPoint { /** * if the value is anomaly or not 0 indicates not an anomaly -1 indicates value is below the threshold +1 indicates value is above the threshold */ anomaly: number; /** * upper threshold for the metric value */ high: number; /** * lower threshold for the metric value */ low: number; /** * timestamp of when the metric was collected */ timestamp: string; /** * value for the metric data point */ value: number; } interface GetBaselineableMetricsEvaluateItem { /** * list of anomaly data points for the metric */ dataPoints: outputs.StackMonitoring.GetBaselineableMetricsEvaluateItemDataPoint[]; /** * list of dimensions for the metric */ dimensions: { [key: string]: string; }; /** * list of data points for the metric for evaluation of anomalies */ evaluationDataPoints: outputs.StackMonitoring.GetBaselineableMetricsEvaluateItemEvaluationDataPoint[]; /** * list of data points for the metric for training of baseline */ trainingDataPoints: outputs.StackMonitoring.GetBaselineableMetricsEvaluateItemTrainingDataPoint[]; } interface GetBaselineableMetricsEvaluateItemDataPoint { /** * if the value is anomaly or not 0 indicates not an anomaly -1 indicates value is below the threshold +1 indicates value is above the threshold */ anomaly: number; /** * upper threshold for the metric value */ high: number; /** * lower threshold for the metric value */ low: number; /** * timestamp of when the metric was collected */ timestamp: string; /** * value for the metric data point */ value: number; } interface GetBaselineableMetricsEvaluateItemEvaluationDataPoint { /** * timestamp of when the metric was collected */ timestamp: string; /** * value for the metric data point */ value: number; } interface GetBaselineableMetricsEvaluateItemTrainingDataPoint { /** * timestamp of when the metric was collected */ timestamp: string; /** * value for the metric data point */ value: number; } interface GetBaselineableMetricsFilter { /** * Metric Name */ name: string; regex?: boolean; values: string[]; } interface GetConfigAdditionalConfiguration { /** * Key/Value pair of Property */ propertiesMap: { [key: string]: string; }; } interface GetConfigDynamicGroup { /** * Identity domain name */ domain: string; /** * Name of user Group */ name: string; /** * Assignment of dynamic group in context of Stack Monitoring service. It describes the purpose of dynamic groups in Stack Monitoring. */ stackMonitoringAssignment: string; } interface GetConfigUserGroup { /** * Identity domain name */ domain: string; /** * Name of user Group */ name: string; /** * Role assigned to user group in context of Stack Monitoring service. Access role can be for example: ADMINISTRATOR, OPERATOR, VIEWER, any other access role */ stackMonitoringRole: string; } interface GetConfigsConfigCollection { items: outputs.StackMonitoring.GetConfigsConfigCollectionItem[]; } interface GetConfigsConfigCollectionItem { /** * Property Details */ additionalConfigurations: outputs.StackMonitoring.GetConfigsConfigCollectionItemAdditionalConfiguration[]; /** * The ID of the compartment in which data is listed. */ compartmentId: string; /** * The type of configuration. */ configType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * List of dynamic groups dedicated for Stack Monitoring. */ dynamicGroups: outputs.StackMonitoring.GetConfigsConfigCollectionItemDynamicGroup[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The Unique Oracle ID (OCID) that is immutable on creation. */ id: string; /** * True if automatic activation of the Management Agent plugin, automatic promotion or enterprise extensibility is enabled, false if it is not enabled. */ isEnabled: boolean; /** * True if customer decides marks configuration as manually configured. */ isManuallyOnboarded: boolean; /** * License edition. */ license: string; /** * List of policy names assigned for onboarding */ policyNames: string[]; /** * The type of resource to configure for automatic promotion. */ resourceType: string; /** * The current state of the Config. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the configuration was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the Config was updated. */ timeUpdated: string; /** * List of user groups dedicated for Stack Monitoring. */ userGroups: outputs.StackMonitoring.GetConfigsConfigCollectionItemUserGroup[]; /** * Assigned version to given onboard configuration. */ version: string; } interface GetConfigsConfigCollectionItemAdditionalConfiguration { /** * Key/Value pair of Property */ propertiesMap: { [key: string]: string; }; } interface GetConfigsConfigCollectionItemDynamicGroup { /** * Identity domain name */ domain: string; /** * Name of user Group */ name: string; /** * Assignment of dynamic group in context of Stack Monitoring service. It describes the purpose of dynamic groups in Stack Monitoring. */ stackMonitoringAssignment: string; } interface GetConfigsConfigCollectionItemUserGroup { /** * Identity domain name */ domain: string; /** * Name of user Group */ name: string; /** * Role assigned to user group in context of Stack Monitoring service. Access role can be for example: ADMINISTRATOR, OPERATOR, VIEWER, any other access role */ stackMonitoringRole: string; } interface GetConfigsFilter { /** * Name of user Group */ name: string; regex?: boolean; values: string[]; } interface GetDefinedMonitoringTemplatesDefinedMonitoringTemplateCollection { /** * List of defined Monitoring Template. */ items: outputs.StackMonitoring.GetDefinedMonitoringTemplatesDefinedMonitoringTemplateCollectionItem[]; } interface GetDefinedMonitoringTemplatesDefinedMonitoringTemplateCollectionItem { /** * Type of composite resource type OCID like EBS/PEOPLE_SOFT. */ compositeType: string; /** * Defined Monitoring template alarm conditions */ definedAlarmConditions: outputs.StackMonitoring.GetDefinedMonitoringTemplatesDefinedMonitoringTemplateCollectionItemDefinedAlarmCondition[]; /** * A filter to return monitoring template based on name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the definedMonitoringTemplate. */ id: string; /** * The stack monitoring service or application emitting the metric that is evaluated by the alarm. */ namespace: string; /** * The resource types OCID. */ resourceType: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the monitoringTemplate was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the monitoringTemplate was updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetDefinedMonitoringTemplatesDefinedMonitoringTemplateCollectionItemDefinedAlarmCondition { /** * Type of defined monitoring template. */ conditionType: string; /** * Monitoring template conditions. */ conditions: outputs.StackMonitoring.GetDefinedMonitoringTemplatesDefinedMonitoringTemplateCollectionItemDefinedAlarmConditionCondition[]; /** * The metric name. */ metricName: string; } interface GetDefinedMonitoringTemplatesDefinedMonitoringTemplateCollectionItemDefinedAlarmConditionCondition { /** * The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. */ body: string; /** * The Monitoring Query Language (MQL) expression to evaluate for the alarm. */ query: string; /** * Severity - Critical/Warning */ severity: string; /** * Whether the note need to add into bottom of the body for mapping the alarms information with template or not. */ shouldAppendNote: boolean; /** * Whether the URL need to add into bottom of the body for mapping the alarms information with template or not. */ shouldAppendUrl: boolean; /** * The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". */ triggerDelay: string; } interface GetDefinedMonitoringTemplatesFilter { name: string; regex?: boolean; values: string[]; } interface GetDiscoveryJobDiscoveryDetail { /** * The OCID of Management Agent */ agentId: string; /** * List of DiscoveryJOb Credential Details. */ credentials: outputs.StackMonitoring.GetDiscoveryJobDiscoveryDetailCredential[]; /** * License edition of the monitored resource. */ license: string; /** * Property Details */ properties: outputs.StackMonitoring.GetDiscoveryJobDiscoveryDetailProperty[]; /** * The Name of resource type */ resourceName: string; /** * Resource Type. */ resourceType: string; /** * Property Details */ tags: outputs.StackMonitoring.GetDiscoveryJobDiscoveryDetailTag[]; } interface GetDiscoveryJobDiscoveryDetailCredential { /** * List of DiscoveryJob credentials. */ items: outputs.StackMonitoring.GetDiscoveryJobDiscoveryDetailCredentialItem[]; } interface GetDiscoveryJobDiscoveryDetailCredentialItem { /** * Name of Credential */ credentialName: string; /** * Name of Credential Type */ credentialType: string; /** * Property Details */ properties: outputs.StackMonitoring.GetDiscoveryJobDiscoveryDetailCredentialItemProperty[]; } interface GetDiscoveryJobDiscoveryDetailCredentialItemProperty { /** * Key/Value pair of Property */ propertiesMap: { [key: string]: string; }; } interface GetDiscoveryJobDiscoveryDetailProperty { /** * Key/Value pair of Property */ propertiesMap: { [key: string]: string; }; } interface GetDiscoveryJobDiscoveryDetailTag { /** * Key/Value pair of Property */ propertiesMap: { [key: string]: string; }; } interface GetDiscoveryJobLogsDiscoveryJobLogCollection { /** * List of logs */ items: outputs.StackMonitoring.GetDiscoveryJobLogsDiscoveryJobLogCollectionItem[]; } interface GetDiscoveryJobLogsDiscoveryJobLogCollectionItem { /** * The OCID of Discovery job */ id: string; /** * Log message */ logMessage: string; /** * The log type like INFO, WARNING, ERROR, SUCCESS */ logType: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time the Job log was created */ timeCreated: string; } interface GetDiscoveryJobLogsFilter { name: string; regex?: boolean; values: string[]; } interface GetDiscoveryJobsDiscoveryJobCollection { /** * List of DiscoveryJob credentials. */ items: outputs.StackMonitoring.GetDiscoveryJobsDiscoveryJobCollectionItem[]; } interface GetDiscoveryJobsDiscoveryJobCollectionItem { /** * The ID of the compartment in which data is listed. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Add option submits new discovery Job. Add with retry option to re-submit failed discovery job. Refresh option refreshes the existing discovered resources. */ discoveryType: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of Discovery job */ id: string; /** * The Name of resource type */ resourceName: string; /** * Resource Type. */ resourceType: string; /** * The current state of the DiscoveryJob Resource. */ state: string; /** * Specifies the status of the discovery job */ status: string; /** * The short summary of the status of the discovery job */ statusMessage: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The OCID of Tenant */ tenantId: string; /** * The time the discovery Job was updated. */ timeUpdated: string; /** * The OCID of user in which the job is submitted */ userId: string; } interface GetDiscoveryJobsFilter { /** * A filter to return only discovery jobs that match the entire resource name given. */ name: string; regex?: boolean; values: string[]; } interface GetMaintenanceWindowResource { /** * Flag to indicate if the members of the resource has to be include in the Maintenance Window. */ areMembersIncluded: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of monitored resource part of the Maintenance window. */ resourceId: string; } interface GetMaintenanceWindowResourcesDetail { /** * Name of the monitored resource */ name: string; /** * Number of members of the resource */ numberOfMembers: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of monitored resource part of the Maintenance window. */ resourceId: string; /** * Type of the monitored resource */ type: string; } interface GetMaintenanceWindowSchedule { /** * Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format. */ maintenanceWindowDuration: string; /** * A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after `timeMaintenanceWindowStart` value. BYMINUTE: Specifies the start minute of each reccurrence after `timeMaintenanceWindowStart` value. The default value is 00 BYSECOND: Specifies the start second of each reccurrence after `timeMaintenanceWindowStart` value. The default value is 00 Other Rules are not supported. */ maintenanceWindowRecurrences: string; /** * Property to identify the type of the Maintenance Window. */ scheduleType: string; /** * Start time of Maintenance window. A RFC3339 formatted datetime string */ timeMaintenanceWindowEnd: string; /** * Start time of Maintenance window. A RFC3339 formatted datetime string */ timeMaintenanceWindowStart: string; } interface GetMaintenanceWindowsFilter { /** * A filter to return maintenance windows that match exact resource name. */ name: string; regex?: boolean; values: string[]; } interface GetMaintenanceWindowsMaintenanceWindowCollection { items: outputs.StackMonitoring.GetMaintenanceWindowsMaintenanceWindowCollectionItem[]; } interface GetMaintenanceWindowsMaintenanceWindowCollectionItem { /** * The ID of the compartment in which data is listed. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of maintenance window. */ id: string; /** * A filter to return maintenance windows with matching lifecycleDetails. */ lifecycleDetails: string; lifecycleState: string; /** * A filter to return maintenance windows that match exact resource name. */ name: string; numberOfResources: number; operationStatus: string; operationType: string; /** * Schedule information of the Maintenance Window */ schedules: outputs.StackMonitoring.GetMaintenanceWindowsMaintenanceWindowCollectionItemSchedule[]; /** * Lifecycle state of the monitored resource. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetMaintenanceWindowsMaintenanceWindowCollectionItemSchedule { /** * Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format. */ maintenanceWindowDuration: string; /** * A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after `timeMaintenanceWindowStart` value. BYMINUTE: Specifies the start minute of each reccurrence after `timeMaintenanceWindowStart` value. The default value is 00 BYSECOND: Specifies the start second of each reccurrence after `timeMaintenanceWindowStart` value. The default value is 00 Other Rules are not supported. */ maintenanceWindowRecurrences: string; /** * Property to identify the type of the Maintenance Window. */ scheduleType: string; /** * Start time of Maintenance window. A RFC3339 formatted datetime string */ timeMaintenanceWindowEnd: string; /** * Start time of Maintenance window. A RFC3339 formatted datetime string */ timeMaintenanceWindowStart: string; } interface GetMetricExtensionEnabledOnResource { /** * The OCID of the resource on which Metric Extension is enabled */ resourceId: string; } interface GetMetricExtensionMetricList { /** * Compute Expression to calculate the value of this metric */ computeExpression: string; /** * Data type of value of this metric */ dataType: string; /** * Display name of the metric. */ displayName: string; /** * Current metric need to be included as dimension or not */ isDimension: boolean; /** * Flag to marks whether a metric has to be uploaded or not. When isHidden = false > Metric is uploaded, isHidden = true > Metric is NOT uploaded */ isHidden: boolean; /** * Metric category */ metricCategory: string; /** * Name of the script file */ name: string; /** * Unit of metric value */ unit: string; } interface GetMetricExtensionQueryProperty { /** * Arguments required by either command or script */ arguments: string; /** * Prefix for an auto generated metric, in case multiple rows with non unique key values are returned */ autoRowPrefix: string; /** * Type of possible collection methods. */ collectionMethod: string; /** * OS command to execute without arguments */ command: string; /** * Character used to delimit multiple metric values in single line of output */ delimiter: string; /** * Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics */ identityMetric: string; /** * List of values and position of PL/SQL procedure IN parameters */ inParamDetails: outputs.StackMonitoring.GetMetricExtensionQueryPropertyInParamDetail[]; /** * Indicates if Metric Service is enabled on server domain */ isMetricServiceEnabled: boolean; /** * List of JMX attributes or Metric Service Table columns separated by semi-colon */ jmxAttributes: string; /** * JMX Managed Bean Query or Metric Service Table name */ managedBeanQuery: string; /** * Position and SQL Type of PL/SQL OUT parameter */ outParamDetails: outputs.StackMonitoring.GetMetricExtensionQueryPropertyOutParamDetail[]; /** * Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL */ protocolType: string; /** * Type of content response given by the http(s) URL */ responseContentType: string; /** * Script details applicable to any OS Command/HTTP based Metric Extension which needs to run a script to collect data. For removing it during OS Command based Metric Extension update, set its "content" property to an empty string. In that case, "name" property value is ignored. */ scriptDetails: outputs.StackMonitoring.GetMetricExtensionQueryPropertyScriptDetail[]; /** * Details of Sql content which needs to execute to collect Metric Extension data */ sqlDetails: outputs.StackMonitoring.GetMetricExtensionQueryPropertySqlDetail[]; /** * Type of SQL data collection method i.e. either a Statement or SQL Script File */ sqlType: string; /** * String prefix used to identify metric output of the OS Command */ startsWith: string; /** * Http(s) end point URL */ url: string; } interface GetMetricExtensionQueryPropertyInParamDetail { /** * Position of IN parameter */ inParamPosition: number; /** * Value of IN parameter */ inParamValue: string; } interface GetMetricExtensionQueryPropertyOutParamDetail { /** * Name of the Out Parameter */ outParamName: string; /** * Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value. */ outParamPosition: number; /** * SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored. */ outParamType: string; } interface GetMetricExtensionQueryPropertyScriptDetail { /** * Sql statement or script file content as base64 encoded string */ content: string; /** * Name of the script file */ name: string; } interface GetMetricExtensionQueryPropertySqlDetail { /** * Sql statement or script file content as base64 encoded string */ content: string; /** * If a script needs to be executed, then provide file name of the script */ scriptFileName: string; } interface GetMetricExtensionsFilter { /** * A filter to return resources based on name. */ name: string; regex?: boolean; values: string[]; } interface GetMetricExtensionsMetricExtensionCollection { items: outputs.StackMonitoring.GetMetricExtensionsMetricExtensionCollectionItem[]; } interface GetMetricExtensionsMetricExtensionCollectionItem { /** * Type of possible collection methods. */ collectionMethod: string; /** * Schedule of metric extension should use RFC 5545 format > recur-rule-part = "FREQ";"INTERVAL" where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1 */ collectionRecurrences: string; /** * The ID of the compartment in which data is listed. */ compartmentId: string; /** * Created by user */ createdBy: string; /** * Description of the metric extension. */ description: string; /** * Display name of the metric. */ displayName: string; /** * List of resource details objects having resourceIds on which this metric extension is enabled. */ enabledOnResources: outputs.StackMonitoring.GetMetricExtensionsMetricExtensionCollectionItemEnabledOnResource[]; /** * Count of resources on which this metric extension is enabled. */ enabledOnResourcesCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Metric Extension resource */ id: string; /** * Last updated by user */ lastUpdatedBy: string; /** * List of metrics which are part of this metric extension */ metricLists: outputs.StackMonitoring.GetMetricExtensionsMetricExtensionCollectionItemMetricList[]; /** * A filter to return resources based on name. */ name: string; publishTrigger: boolean; /** * Collection method and query properties details of metric extension */ queryProperties: outputs.StackMonitoring.GetMetricExtensionsMetricExtensionCollectionItemQueryProperty[]; /** * A filter to return resources based on resource type. */ resourceType: string; /** * The URI path that the user can do a GET on to access the metric extension metadata */ resourceUri: string; /** * A filter to return metric extensions based on Lifecycle State */ state: string; /** * A filter to return resources based on status e.g. Draft or Published */ status: string; /** * Tenant Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ tenantId: string; /** * Metric Extension creation time. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Metric Extension update time. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetMetricExtensionsMetricExtensionCollectionItemEnabledOnResource { /** * The OCID of the resource on which Metric Extension is enabled */ resourceId: string; } interface GetMetricExtensionsMetricExtensionCollectionItemMetricList { /** * Compute Expression to calculate the value of this metric */ computeExpression: string; /** * Data type of value of this metric */ dataType: string; /** * Display name of the metric. */ displayName: string; /** * Current metric need to be included as dimension or not */ isDimension: boolean; /** * Flag to marks whether a metric has to be uploaded or not. When isHidden = false > Metric is uploaded, isHidden = true > Metric is NOT uploaded */ isHidden: boolean; /** * Metric category */ metricCategory: string; /** * A filter to return resources based on name. */ name: string; /** * Unit of metric value */ unit: string; } interface GetMetricExtensionsMetricExtensionCollectionItemQueryProperty { /** * Arguments required by either command or script */ arguments: string; /** * Prefix for an auto generated metric, in case multiple rows with non unique key values are returned */ autoRowPrefix: string; /** * Type of possible collection methods. */ collectionMethod: string; /** * OS command to execute without arguments */ command: string; /** * Character used to delimit multiple metric values in single line of output */ delimiter: string; /** * Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics */ identityMetric: string; /** * List of values and position of PL/SQL procedure IN parameters */ inParamDetails: outputs.StackMonitoring.GetMetricExtensionsMetricExtensionCollectionItemQueryPropertyInParamDetail[]; /** * Indicates if Metric Service is enabled on server domain */ isMetricServiceEnabled: boolean; /** * List of JMX attributes or Metric Service Table columns separated by semi-colon */ jmxAttributes: string; /** * JMX Managed Bean Query or Metric Service Table name */ managedBeanQuery: string; /** * Position and SQL Type of PL/SQL OUT parameter */ outParamDetails: outputs.StackMonitoring.GetMetricExtensionsMetricExtensionCollectionItemQueryPropertyOutParamDetail[]; /** * Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL */ protocolType: string; /** * Type of content response given by the http(s) URL */ responseContentType: string; /** * Script details applicable to any OS Command/HTTP based Metric Extension which needs to run a script to collect data. For removing it during OS Command based Metric Extension update, set its "content" property to an empty string. In that case, "name" property value is ignored. */ scriptDetails: outputs.StackMonitoring.GetMetricExtensionsMetricExtensionCollectionItemQueryPropertyScriptDetail[]; /** * Details of Sql content which needs to execute to collect Metric Extension data */ sqlDetails: outputs.StackMonitoring.GetMetricExtensionsMetricExtensionCollectionItemQueryPropertySqlDetail[]; /** * Type of SQL data collection method i.e. either a Statement or SQL Script File */ sqlType: string; /** * String prefix used to identify metric output of the OS Command */ startsWith: string; /** * Http(s) end point URL */ url: string; } interface GetMetricExtensionsMetricExtensionCollectionItemQueryPropertyInParamDetail { /** * Position of IN parameter */ inParamPosition: number; /** * Value of IN parameter */ inParamValue: string; } interface GetMetricExtensionsMetricExtensionCollectionItemQueryPropertyOutParamDetail { /** * Name of the Out Parameter */ outParamName: string; /** * Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value. */ outParamPosition: number; /** * SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored. */ outParamType: string; } interface GetMetricExtensionsMetricExtensionCollectionItemQueryPropertyScriptDetail { /** * Sql statement or script file content as base64 encoded string */ content: string; /** * A filter to return resources based on name. */ name: string; } interface GetMetricExtensionsMetricExtensionCollectionItemQueryPropertySqlDetail { /** * Sql statement or script file content as base64 encoded string */ content: string; /** * If a script needs to be executed, then provide file name of the script */ scriptFileName: string; } interface GetMonitoredResourceAdditionalAlias { /** * Monitored Resource Alias Reference Source Credential. */ credentials: outputs.StackMonitoring.GetMonitoredResourceAdditionalAliasCredential[]; /** * Property Name. */ name: string; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; } interface GetMonitoredResourceAdditionalAliasCredential { /** * Property Name. */ name: string; /** * The name of the service owning the credential. Example: stack-monitoring or dbmgmt */ service: string; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; } interface GetMonitoredResourceAdditionalCredential { /** * Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * * PLAINTEXT - The credential properties will have credentials in plain text format. * * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent. */ credentialType: string; /** * The user-specified textual description of the credential. */ description: string; /** * The master key should be created in Oracle Cloud Infrastructure Vault owned by the client of this API. The user should have permission to access the vault key. */ keyId: string; /** * Property Name. */ name: string; /** * List of monitored resource properties. */ properties: outputs.StackMonitoring.GetMonitoredResourceAdditionalCredentialProperty[]; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; /** * Monitored Resource Type. */ type: string; } interface GetMonitoredResourceAdditionalCredentialProperty { /** * Property Name. */ name: string; /** * Property Value. */ value: string; } interface GetMonitoredResourceAlias { /** * Monitored Resource Alias Reference Source Credential. */ credentials: outputs.StackMonitoring.GetMonitoredResourceAliasCredential[]; /** * Property Name. */ name: string; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; } interface GetMonitoredResourceAliasCredential { /** * Property Name. */ name: string; /** * The name of the service owning the credential. Example: stack-monitoring or dbmgmt */ service: string; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; } interface GetMonitoredResourceCredential { /** * Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * * PLAINTEXT - The credential properties will have credentials in plain text format. * * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent. */ credentialType: string; /** * The user-specified textual description of the credential. */ description: string; /** * The master key should be created in Oracle Cloud Infrastructure Vault owned by the client of this API. The user should have permission to access the vault key. */ keyId: string; /** * Property Name. */ name: string; /** * List of monitored resource properties. */ properties: outputs.StackMonitoring.GetMonitoredResourceCredentialProperty[]; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; /** * Monitored Resource Type. */ type: string; } interface GetMonitoredResourceCredentialProperty { /** * Property Name. */ name: string; /** * Property Value. */ value: string; } interface GetMonitoredResourceDatabaseConnectionDetail { /** * Database connector Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ connectorId: string; /** * dbId of the database. */ dbId: string; /** * UniqueName used for database connection requests. */ dbUniqueName: string; /** * Listener Port number used for connection requests. */ port: number; /** * Protocol used in DB connection string when connecting to external database service. */ protocol: string; /** * Service name used for connection requests. */ serviceName: string; /** * SSL Secret Identifier for TCPS connector in Oracle Cloud Infrastructure Vault[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sslSecretId: string; } interface GetMonitoredResourceProperty { /** * Property Name. */ name: string; /** * Property Value. */ value: string; } interface GetMonitoredResourceTaskTaskDetail { /** * Management Agent Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ agentId: string; /** * Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'. */ availabilityProxyMetricCollectionInterval: number; /** * List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource. */ availabilityProxyMetrics: string[]; /** * The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page. */ consolePathPrefix: string; /** * The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id. */ externalIdMapping: string; /** * Type of the handler. */ handlerType: string; /** * True to enable the receiver and false to disable the receiver on the agent. */ isEnable: boolean; /** * Lifecycle states of the external resource which reflects the status of the resource being up. */ lifecycleStatusMappingsForUpStatuses: string[]; /** * Name space to be used for Oracle Cloud Infrastructure Native service resources' import. */ namespace: string; /** * Properties for agent receiver. */ receiverProperties: outputs.StackMonitoring.GetMonitoredResourceTaskTaskDetailReceiverProperty[]; /** * The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request. */ resourceGroup: string; /** * The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted. */ resourceNameFilter: string; /** * The resource name property in the metric dimensions. Resources imported will be using this property value for resource name. */ resourceNameMapping: string; /** * The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted. */ resourceTypeFilter: string; /** * The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type. */ resourceTypeMapping: string; /** * A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types. */ resourceTypesConfigurations: outputs.StackMonitoring.GetMonitoredResourceTaskTaskDetailResourceTypesConfiguration[]; /** * The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE. */ serviceBaseUrl: string; /** * Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service. */ shouldUseMetricsFlowForStatus: boolean; /** * Source from where the metrics pushed to telemetry. Possible values: * * OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services. * * OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus. * * OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver. * * OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver. */ source: string; /** * Type of the task. */ type: string; } interface GetMonitoredResourceTaskTaskDetailReceiverProperty { /** * Receiver listener port. */ listenerPort: number; } interface GetMonitoredResourceTaskTaskDetailResourceTypesConfiguration { /** * Availability metrics details. */ availabilityMetricsConfigs: outputs.StackMonitoring.GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationAvailabilityMetricsConfig[]; /** * Specific resource mapping configurations for Agent Extension Handlers. */ handlerConfigs: outputs.StackMonitoring.GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfig[]; /** * Resource type. */ resourceType: string; } interface GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationAvailabilityMetricsConfig { /** * Availability metric collection internal in seconds. */ collectionIntervalInSeconds: number; /** * List of metrics used for availability calculation for the resource. */ metrics: string[]; } interface GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfig { /** * Resource name generation overriding configurations for collectd resource types. */ collectdResourceNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig[]; /** * List of collector/plugin names. */ collectorTypes: string[]; /** * List of handler configuration properties */ handlerProperties: outputs.StackMonitoring.GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty[]; /** * List of AgentExtensionHandlerMetricMappingDetails. */ metricMappings: outputs.StackMonitoring.GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping[]; /** * Metric name generation overriding configurations. */ metricNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig[]; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Resource name generation overriding configurations for telegraf resource types. */ telegrafResourceNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig[]; /** * Resource group string; if not specified, the resource group string will be generated by the handler. */ telemetryResourceGroup: string; } interface GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig { /** * List of property names to be excluded. */ excludeProperties: string[]; /** * List of property names to be included. */ includeProperties: string[]; /** * String to be suffixed to the resource name. */ suffix: string; } interface GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty { /** * Property name. */ name: string; /** * Property value. */ value: string; } interface GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping { /** * Metric name as defined by the collector. */ collectorMetricName: string; /** * Is ignoring this metric. */ isSkipUpload: boolean; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Metric name to be upload to telemetry. */ telemetryMetricName: string; } interface GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig { /** * String pattern to be removed from the prefix of the metric name. */ excludePatternOnPrefix: string; /** * is prefixing the metric with collector type. */ isPrefixWithCollectorType: boolean; } interface GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig { /** * List of tag names to be excluded. */ excludeTags: string[]; /** * List of tag names to be included. */ includeTags: string[]; /** * Flag to indicate if only tags will be used for resource name generation. */ isUseTagsOnly: boolean; } interface GetMonitoredResourceTasksFilter { /** * Property name. */ name: string; regex?: boolean; values: string[]; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollection { items: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItem[]; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for which stack monitoring resource tasks should be listed. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Task identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * Property name. */ name: string; /** * The current state of the stack monitoring resource task. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The request details for the performing the task. */ taskDetails: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenancy. */ tenantId: string; /** * The date and time when the stack monitoring resource task was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. */ timeCreated: string; /** * The date and time when the stack monitoring resource task was last updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. */ timeUpdated: string; /** * Type of the task. */ type: string; /** * Identifiers [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for work requests submitted for this task. */ workRequestIds: string[]; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetail { /** * Management Agent Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ agentId: string; /** * Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'. */ availabilityProxyMetricCollectionInterval: number; /** * List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource. */ availabilityProxyMetrics: string[]; /** * The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page. */ consolePathPrefix: string; /** * The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id. */ externalIdMapping: string; /** * Type of the handler. */ handlerType: string; /** * True to enable the receiver and false to disable the receiver on the agent. */ isEnable: boolean; /** * Lifecycle states of the external resource which reflects the status of the resource being up. */ lifecycleStatusMappingsForUpStatuses: string[]; /** * Name space to be used for Oracle Cloud Infrastructure Native service resources discovery. */ namespace: string; /** * Properties for agent receiver. */ receiverProperties: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailReceiverProperty[]; /** * The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request. */ resourceGroup: string; /** * The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted. */ resourceNameFilter: string; /** * The resource name property in the metric dimensions. Resources imported will be using this property value for resource name. */ resourceNameMapping: string; /** * The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted. */ resourceTypeFilter: string; /** * The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type. */ resourceTypeMapping: string; /** * A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types. */ resourceTypesConfigurations: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfiguration[]; /** * The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE. */ serviceBaseUrl: string; /** * Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service. */ shouldUseMetricsFlowForStatus: boolean; /** * Source from where the metrics pushed to telemetry. Possible values: * * OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services. * * OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus. * * OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver. * * OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver. */ source: string; /** * Type of the task. */ type: string; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailReceiverProperty { /** * Receiver listener port. */ listenerPort: number; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfiguration { /** * Availability metrics details. */ availabilityMetricsConfigs: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationAvailabilityMetricsConfig[]; /** * Specific resource mapping configurations for Agent Extension Handlers. */ handlerConfigs: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfig[]; /** * Resource type. */ resourceType: string; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationAvailabilityMetricsConfig { /** * Availability metric collection internal in seconds. */ collectionIntervalInSeconds: number; /** * List of metrics used for availability calculation for the resource. */ metrics: string[]; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfig { /** * Resource name generation overriding configurations for collectd resource types. */ collectdResourceNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig[]; /** * List of collector/plugin names. */ collectorTypes: string[]; /** * List of handler configuration properties */ handlerProperties: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty[]; /** * List of AgentExtensionHandlerMetricMappingDetails. */ metricMappings: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping[]; /** * Metric name generation overriding configurations. */ metricNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig[]; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Resource name generation overriding configurations for telegraf resource types. */ telegrafResourceNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig[]; /** * Resource group string; if not specified, the resource group string will be generated by the handler. */ telemetryResourceGroup: string; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig { /** * List of property names to be excluded. */ excludeProperties: string[]; /** * List of property names to be included. */ includeProperties: string[]; /** * String to be suffixed to the resource name. */ suffix: string; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty { /** * Property name. */ name: string; /** * Property value. */ value: string; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping { /** * Metric name as defined by the collector. */ collectorMetricName: string; /** * Is ignoring this metric. */ isSkipUpload: boolean; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Metric name to be upload to telemetry. */ telemetryMetricName: string; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig { /** * String pattern to be removed from the prefix of the metric name. */ excludePatternOnPrefix: string; /** * is prefixing the metric with collector type. */ isPrefixWithCollectorType: boolean; } interface GetMonitoredResourceTasksMonitoredResourceTasksCollectionItemTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig { /** * List of tag names to be excluded. */ excludeTags: string[]; /** * List of tag names to be included. */ includeTags: string[]; /** * Flag to indicate if only tags will be used for resource name generation. */ isUseTagsOnly: boolean; } interface GetMonitoredResourceTypeAvailabilityMetricsConfig { /** * Availability metric collection internal in seconds. */ collectionIntervalInSeconds: number; /** * List of metrics used for availability calculation for the resource. */ metrics: string[]; } interface GetMonitoredResourceTypeHandlerConfig { /** * Resource name generation overriding configurations for collectd resource types. */ collectdResourceNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTypeHandlerConfigCollectdResourceNameConfig[]; /** * List of collector/plugin names. */ collectorTypes: string[]; /** * List of handler configuration properties */ handlerProperties: outputs.StackMonitoring.GetMonitoredResourceTypeHandlerConfigHandlerProperty[]; /** * List of AgentExtensionHandlerMetricMappingDetails. */ metricMappings: outputs.StackMonitoring.GetMonitoredResourceTypeHandlerConfigMetricMapping[]; /** * Metric name generation overriding configurations. */ metricNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTypeHandlerConfigMetricNameConfig[]; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Resource name generation overriding configurations for telegraf resource types. */ telegrafResourceNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTypeHandlerConfigTelegrafResourceNameConfig[]; /** * Resource group string; if not specified, the resource group string will be generated by the handler. */ telemetryResourceGroup: string; } interface GetMonitoredResourceTypeHandlerConfigCollectdResourceNameConfig { /** * List of property names to be excluded. */ excludeProperties: string[]; /** * List of property names to be included. */ includeProperties: string[]; /** * String to be suffixed to the resource name. */ suffix: string; } interface GetMonitoredResourceTypeHandlerConfigHandlerProperty { /** * A unique monitored resource type name. The name must be unique across tenancy. Name can not be changed. */ name: string; /** * Property value. */ value: string; } interface GetMonitoredResourceTypeHandlerConfigMetricMapping { /** * Metric name as defined by the collector. */ collectorMetricName: string; /** * Is ignoring this metric. */ isSkipUpload: boolean; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Metric name to be upload to telemetry. */ telemetryMetricName: string; } interface GetMonitoredResourceTypeHandlerConfigMetricNameConfig { /** * String pattern to be removed from the prefix of the metric name. */ excludePatternOnPrefix: string; /** * is prefixing the metric with collector type. */ isPrefixWithCollectorType: boolean; } interface GetMonitoredResourceTypeHandlerConfigTelegrafResourceNameConfig { /** * List of tag names to be excluded. */ excludeTags: string[]; /** * List of tag names to be included. */ includeTags: string[]; /** * Flag to indicate if only tags will be used for resource name generation. */ isUseTagsOnly: boolean; } interface GetMonitoredResourceTypeMetadata { /** * List of properties needed by the agent for monitoring the resource. Valid only if resource type is Oracle Cloud Infrastructure management agent based. When specified, these properties are passed to the management agent during resource create or update. */ agentProperties: string[]; /** * ResourceType metadata format to be used. Currently supports only one format. Possible values - SYSTEM_FORMAT. * * SYSTEM_FORMAT - The resource type metadata is defined in machine friendly format. */ format: string; /** * List of required properties for resource type. */ requiredProperties: string[]; /** * List of property sets used to uniquely identify the resources. This check is made during create or update of stack monitoring resource. The resource has to pass unique check for each set in the list. For example, database can have user, password and SID as one unique set. Another unique set would be user, password and service name. */ uniquePropertySets: outputs.StackMonitoring.GetMonitoredResourceTypeMetadataUniquePropertySet[]; /** * List of valid properties for resource type while creating the monitored resource. If resources of this type specifies any other properties during create operation, the operation will fail. */ validPropertiesForCreates: string[]; /** * List of valid properties for resource type while updating the monitored resource. If resources of this type specifies any other properties during update operation, the operation will fail. */ validPropertiesForUpdates: string[]; /** * List of valid values for the properties. This is useful when resource type wants to restrict only certain values for some properties. For instance for 'osType' property, supported values can be restricted to be either Linux or Windows. Example: `{"osType": "Linux,Windows,Solaris", "osVersion": "v6.0,v7.0"}` */ validPropertyValues: { [key: string]: string; }; /** * List of valid sub-resource types for a composite resource type. The sub-resource types will be obtained from the valid association pairs corresponding to the composite resource types. It will be empty for non composite resource types */ validSubResourceTypes: string[]; } interface GetMonitoredResourceTypeMetadataUniquePropertySet { /** * List of properties. */ properties: string[]; } interface GetMonitoredResourceTypesFilter { /** * A filter to return monitored resource types that match exactly with the resource type name given. */ name: string; regex?: boolean; values: string[]; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollection { items: outputs.StackMonitoring.GetMonitoredResourceTypesMonitoredResourceTypesCollectionItem[]; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollectionItem { /** * Key/Value pair for additional namespaces used by stack monitoring services for SYSTEM (SMB) resource types. */ additionalNamespaceMap: { [key: string]: string; }; /** * Availability metrics details. */ availabilityMetricsConfigs: outputs.StackMonitoring.GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemAvailabilityMetricsConfig[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenancy for which monitored resource types should be listed. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A friendly description. */ description: string; /** * Monitored resource type display name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Specific resource mapping configurations for Agent Extension Handlers. */ handlerConfigs: outputs.StackMonitoring.GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfig[]; /** * Monitored resource type identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * If boolean flag is true, then the resource type cannot be modified or deleted. */ isSystemDefined: boolean; /** * The metadata details for resource type. */ metadatas: outputs.StackMonitoring.GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemMetadata[]; /** * A filter to return monitored resource types that has the matching namespace. */ metricNamespace: string; /** * A filter to return monitored resource types that match exactly with the resource type name given. */ name: string; /** * A filter to return only resources with matching resource category. */ resourceCategory: string; /** * A filter to return only resources with matching source type. */ sourceType: string; /** * Lifecycle state of the monitored resource type. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Tenancy Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ tenancyId: string; /** * The date and time when the monitored resource type was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. */ timeCreated: string; /** * The date and time when the monitored resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. */ timeUpdated: string; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemAvailabilityMetricsConfig { /** * Availability metric collection internal in seconds. */ collectionIntervalInSeconds: number; /** * List of metrics used for availability calculation for the resource. */ metrics: string[]; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfig { /** * Resource name generation overriding configurations for collectd resource types. */ collectdResourceNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfigCollectdResourceNameConfig[]; /** * List of collector/plugin names. */ collectorTypes: string[]; /** * List of handler configuration properties */ handlerProperties: outputs.StackMonitoring.GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfigHandlerProperty[]; /** * List of AgentExtensionHandlerMetricMappingDetails. */ metricMappings: outputs.StackMonitoring.GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfigMetricMapping[]; /** * Metric name generation overriding configurations. */ metricNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfigMetricNameConfig[]; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Resource name generation overriding configurations for telegraf resource types. */ telegrafResourceNameConfigs: outputs.StackMonitoring.GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfigTelegrafResourceNameConfig[]; /** * Resource group string; if not specified, the resource group string will be generated by the handler. */ telemetryResourceGroup: string; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfigCollectdResourceNameConfig { /** * List of property names to be excluded. */ excludeProperties: string[]; /** * List of property names to be included. */ includeProperties: string[]; /** * String to be suffixed to the resource name. */ suffix: string; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfigHandlerProperty { /** * A filter to return monitored resource types that match exactly with the resource type name given. */ name: string; /** * Property value. */ value: string; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfigMetricMapping { /** * Metric name as defined by the collector. */ collectorMetricName: string; /** * Is ignoring this metric. */ isSkipUpload: boolean; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Metric name to be upload to telemetry. */ telemetryMetricName: string; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfigMetricNameConfig { /** * String pattern to be removed from the prefix of the metric name. */ excludePatternOnPrefix: string; /** * is prefixing the metric with collector type. */ isPrefixWithCollectorType: boolean; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemHandlerConfigTelegrafResourceNameConfig { /** * List of tag names to be excluded. */ excludeTags: string[]; /** * List of tag names to be included. */ includeTags: string[]; /** * Flag to indicate if only tags will be used for resource name generation. */ isUseTagsOnly: boolean; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemMetadata { /** * List of properties needed by the agent for monitoring the resource. Valid only if resource type is Oracle Cloud Infrastructure management agent based. When specified, these properties are passed to the management agent during resource create or update. */ agentProperties: string[]; /** * ResourceType metadata format to be used. Currently supports only one format. Possible values - SYSTEM_FORMAT. * * SYSTEM_FORMAT - The resource type metadata is defined in machine friendly format. */ format: string; /** * List of required properties for resource type. */ requiredProperties: string[]; /** * List of property sets used to uniquely identify the resources. This check is made during create or update of stack monitoring resource. The resource has to pass unique check for each set in the list. For example, database can have user, password and SID as one unique set. Another unique set would be user, password and service name. */ uniquePropertySets: outputs.StackMonitoring.GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemMetadataUniquePropertySet[]; /** * List of valid properties for resource type while creating the monitored resource. If resources of this type specifies any other properties during create operation, the operation will fail. */ validPropertiesForCreates: string[]; /** * List of valid properties for resource type while updating the monitored resource. If resources of this type specifies any other properties during update operation, the operation will fail. */ validPropertiesForUpdates: string[]; /** * List of valid values for the properties. This is useful when resource type wants to restrict only certain values for some properties. For instance for 'osType' property, supported values can be restricted to be either Linux or Windows. Example: `{"osType": "Linux,Windows,Solaris", "osVersion": "v6.0,v7.0"}` */ validPropertyValues: { [key: string]: string; }; /** * List of valid sub-resource types for a composite resource type. The sub-resource types will be obtained from the valid association pairs corresponding to the composite resource types. It will be empty for non composite resource types */ validSubResourceTypes: string[]; } interface GetMonitoredResourceTypesMonitoredResourceTypesCollectionItemMetadataUniquePropertySet { /** * List of properties. */ properties: string[]; } interface GetMonitoredResourcesFilter { /** * A filter to return resources that match exact resource name. */ name: string; regex?: boolean; values: string[]; } interface GetMonitoredResourcesMonitoredResourceCollection { items: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItem[]; } interface GetMonitoredResourcesMonitoredResourceCollectionItem { additionalAliases: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItemAdditionalAlias[]; additionalCredentials: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItemAdditionalCredential[]; /** * Monitored Resource Alias Credential Details */ aliases: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItemAlias[]; /** * The ID of the compartment in which data is listed. */ compartmentId: string; /** * Monitored Resource Credential Details. */ credentials: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItemCredential[]; /** * Connection details for the database. */ databaseConnectionDetails: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItemDatabaseConnectionDetail[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Monitored resource display name. */ displayName: string; /** * The external resource identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). External resource is any Oracle Cloud Infrastructure resource which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and Oracle Cloud Infrastructure compute instance. */ externalId: string; externalResourceId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Monitored resource host name. */ hostName: string; /** * Monitored resource identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; license: string; /** * Management Agent Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ managementAgentId: string; /** * A filter to return resources that match exact resource name. */ name: string; /** * List of monitored resource properties. */ properties: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItemProperty[]; /** * Resource Category to indicate the kind of resource type. */ resourceCategory: string; /** * Time zone in the form of tz database canonical zone ID. */ resourceTimeZone: string; /** * Source type to indicate if the resource is stack monitoring discovered, Oracle Cloud Infrastructure native resource, etc. */ sourceType: string; /** * Lifecycle state of the monitored resource. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Tenancy Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ tenantId: string; /** * The date and time when the monitored resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. */ timeCreated: string; /** * The date and time when the monitored resource was last updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. */ timeUpdated: string; /** * Monitored Resource Type. */ type: string; } interface GetMonitoredResourcesMonitoredResourceCollectionItemAdditionalAlias { /** * Monitored Resource Alias Reference Source Credential. */ credentials: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItemAdditionalAliasCredential[]; /** * A filter to return resources that match exact resource name. */ name: string; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; } interface GetMonitoredResourcesMonitoredResourceCollectionItemAdditionalAliasCredential { /** * A filter to return resources that match exact resource name. */ name: string; /** * The name of the service owning the credential. Example: stack-monitoring or dbmgmt */ service: string; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; } interface GetMonitoredResourcesMonitoredResourceCollectionItemAdditionalCredential { /** * Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * * PLAINTEXT - The credential properties will have credentials in plain text format. * * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent. */ credentialType: string; /** * The user-specified textual description of the credential. */ description: string; /** * The master key should be created in Oracle Cloud Infrastructure Vault owned by the client of this API. The user should have permission to access the vault key. */ keyId: string; /** * A filter to return resources that match exact resource name. */ name: string; /** * List of monitored resource properties. */ properties: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItemAdditionalCredentialProperty[]; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; /** * Monitored Resource Type. */ type: string; } interface GetMonitoredResourcesMonitoredResourceCollectionItemAdditionalCredentialProperty { /** * A filter to return resources that match exact resource name. */ name: string; /** * Property Value. */ value: string; } interface GetMonitoredResourcesMonitoredResourceCollectionItemAlias { /** * Monitored Resource Alias Reference Source Credential. */ credentials: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItemAliasCredential[]; /** * A filter to return resources that match exact resource name. */ name: string; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; } interface GetMonitoredResourcesMonitoredResourceCollectionItemAliasCredential { /** * A filter to return resources that match exact resource name. */ name: string; /** * The name of the service owning the credential. Example: stack-monitoring or dbmgmt */ service: string; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; } interface GetMonitoredResourcesMonitoredResourceCollectionItemCredential { /** * Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * * PLAINTEXT - The credential properties will have credentials in plain text format. * * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent. */ credentialType: string; /** * The user-specified textual description of the credential. */ description: string; /** * The master key should be created in Oracle Cloud Infrastructure Vault owned by the client of this API. The user should have permission to access the vault key. */ keyId: string; /** * A filter to return resources that match exact resource name. */ name: string; /** * List of monitored resource properties. */ properties: outputs.StackMonitoring.GetMonitoredResourcesMonitoredResourceCollectionItemCredentialProperty[]; /** * The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source: string; /** * Monitored Resource Type. */ type: string; } interface GetMonitoredResourcesMonitoredResourceCollectionItemCredentialProperty { /** * A filter to return resources that match exact resource name. */ name: string; /** * Property Value. */ value: string; } interface GetMonitoredResourcesMonitoredResourceCollectionItemDatabaseConnectionDetail { /** * Database connector Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ connectorId: string; /** * dbId of the database. */ dbId: string; /** * UniqueName used for database connection requests. */ dbUniqueName: string; /** * Listener Port number used for connection requests. */ port: number; /** * Protocol used in DB connection string when connecting to external database service. */ protocol: string; /** * Service name used for connection requests. */ serviceName: string; /** * SSL Secret Identifier for TCPS connector in Oracle Cloud Infrastructure Vault[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sslSecretId: string; } interface GetMonitoredResourcesMonitoredResourceCollectionItemProperty { /** * A filter to return resources that match exact resource name. */ name: string; /** * Property Value. */ value: string; } interface GetMonitoringTemplateAlarmConditionCondition { /** * The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. */ body: string; /** * The Monitoring Query Language (MQL) expression to evaluate for the alarm. */ query: string; /** * Severity - Critical/Warning */ severity: string; /** * Whether the note need to add into bottom of the body for mapping the alarms information with template or not. */ shouldAppendNote: boolean; /** * Whether the URL need to add into bottom of the body for mapping the alarms information with template or not. */ shouldAppendUrl: boolean; /** * The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". */ triggerDelay: string; } interface GetMonitoringTemplateAlarmConditionsAlarmConditionCollection { items: outputs.StackMonitoring.GetMonitoringTemplateAlarmConditionsAlarmConditionCollectionItem[]; } interface GetMonitoringTemplateAlarmConditionsAlarmConditionCollectionItem { /** * The OCID of the composite resource type like EBS/PEOPLE_SOFT. */ compositeType: string; /** * Type of defined monitoring template. */ conditionType: string; /** * Monitoring template conditions */ conditions: outputs.StackMonitoring.GetMonitoringTemplateAlarmConditionsAlarmConditionCollectionItemCondition[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Alarm Condition. */ id: string; /** * metricName filter. */ metricName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitoring template. */ monitoringTemplateId: string; /** * The stack monitoring service or application emitting the metric that is evaluated by the alarm. */ namespace: string; /** * The resource type OCID. */ resourceType: string; /** * A filter to return alarm condition based on Lifecycle State. */ state: string; /** * A filter to return alarm condition based on input status. */ status: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the alarm condition was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the alarm condition was updated. Format defined by RFC3339. */ timeUpdated: string; } interface GetMonitoringTemplateAlarmConditionsAlarmConditionCollectionItemCondition { /** * The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. */ body: string; /** * The Monitoring Query Language (MQL) expression to evaluate for the alarm. */ query: string; /** * Severity - Critical/Warning */ severity: string; /** * Whether the note need to add into bottom of the body for mapping the alarms information with template or not. */ shouldAppendNote: boolean; /** * Whether the URL need to add into bottom of the body for mapping the alarms information with template or not. */ shouldAppendUrl: boolean; /** * The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". */ triggerDelay: string; } interface GetMonitoringTemplateAlarmConditionsFilter { name: string; regex?: boolean; values: string[]; } interface GetMonitoringTemplateMember { /** * The OCID of the composite resource type like EBS or Peoplesoft. */ compositeType: string; /** * The OCID of the resourceInstance/resourceType/resourceGroup */ id: string; /** * Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP */ type: string; } interface GetMonitoringTemplatesFilter { name: string; regex?: boolean; values: string[]; } interface GetMonitoringTemplatesMonitoringTemplateCollection { items: outputs.StackMonitoring.GetMonitoringTemplatesMonitoringTemplateCollectionItem[]; } interface GetMonitoringTemplatesMonitoringTemplateCollectionItem { /** * The ID of the compartment in which data is listed. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly description for the monitoring template. It does not have to be unique, and it's changeable. Avoid entering confidential information. */ description: string; /** * A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource. */ destinations: string[]; /** * A filter to return monitoring template based on name. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the resourceInstance/resourceType/resourceGroup */ id: string; /** * Whether the alarm is enabled or disabled. Default value is enabled. */ isAlarmsEnabled: boolean; /** * Whether the alarm notification is enabled or disabled, it will be Enabled by default. */ isSplitNotificationEnabled: boolean; /** * List of members of this monitoring template. */ members: outputs.StackMonitoring.GetMonitoringTemplatesMonitoringTemplateCollectionItemMember[]; /** * The format to use for alarm notifications. */ messageFormat: string; /** * The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum- PT1M. Maximum - P30D. */ repeatNotificationDuration: string; /** * A filter to return monitoring template based on Lifecycle State */ state: string; /** * A filter to return monitoring template based on input status */ status: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Tenant Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) */ tenantId: string; /** * The date and time the monitoringTemplate was created. Format defined by RFC3339. */ timeCreated: string; /** * The date and time the monitoringTemplate was last updated. Format defined by RFC3339. */ timeUpdated: string; /** * Total Alarm Conditions */ totalAlarmConditions: number; /** * Total Applied Alarm Conditions */ totalAppliedAlarmConditions: number; } interface GetMonitoringTemplatesMonitoringTemplateCollectionItemMember { /** * The OCID of the composite resource type like EBS or Peoplesoft. */ compositeType: string; /** * The OCID of the resourceInstance/resourceType/resourceGroup */ id: string; /** * Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP */ type: string; } interface GetProcessSetSpecification { /** * List of Process Set specification details. */ items: outputs.StackMonitoring.GetProcessSetSpecificationItem[]; } interface GetProcessSetSpecificationItem { /** * Optional label used to identify a single filter. */ label: string; /** * String literal used for exact matching on process name. */ processCommand: string; /** * Regex pattern matching on process arguments. */ processLineRegexPattern: string; /** * String literal used for exact matching on process user. */ processUser: string; } interface GetProcessSetsFilter { name: string; regex?: boolean; values: string[]; } interface GetProcessSetsProcessSetCollection { /** * List of Process Set specification details. */ items: outputs.StackMonitoring.GetProcessSetsProcessSetCollectionItem[]; } interface GetProcessSetsProcessSetCollectionItem { /** * The ID of the compartment in which data is listed. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Process Set. */ id: string; /** * The current revision of the Process Set. */ revision: string; /** * Collection of regular expression specifications used to identify the processes to be monitored. */ specifications: outputs.StackMonitoring.GetProcessSetsProcessSetCollectionItemSpecification[]; /** * The current state of the Resource. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the process set was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the process set was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetProcessSetsProcessSetCollectionItemSpecification { /** * List of Process Set specification details. */ items: outputs.StackMonitoring.GetProcessSetsProcessSetCollectionItemSpecificationItem[]; } interface GetProcessSetsProcessSetCollectionItemSpecificationItem { /** * Optional label used to identify a single filter. */ label: string; /** * String literal used for exact matching on process name. */ processCommand: string; /** * Regex pattern matching on process arguments. */ processLineRegexPattern: string; /** * String literal used for exact matching on process user. */ processUser: string; } interface MaintenanceWindowResource { /** * (Updatable) Flag to indicate if the members of the resource has to be include in the Maintenance Window. */ areMembersIncluded: boolean; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of monitored resource part of the Maintenance window. */ resourceId: string; } interface MaintenanceWindowResourcesDetail { /** * Maintenance Window name. */ name: string; /** * Number of members of the resource */ numberOfMembers: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of monitored resource part of the Maintenance window. */ resourceId: string; /** * Type of the monitored resource */ type: string; } interface MaintenanceWindowSchedule { /** * (Updatable) Duration time of each recurrence of each Maintenance Window. It must be specified as a string in ISO 8601 extended format. */ maintenanceWindowDuration: string; /** * (Updatable) A RFC5545 formatted recurrence string which represents the Maintenance Window Recurrence. Please refer this for details:https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10 FREQ: Frequency of the Maintenance Window. The supported values are: DAILY and WEEKLY. BYDAY: Comma separated days for Weekly Maintenance Window. BYHOUR: Specifies the start hour of each recurrence after `timeMaintenanceWindowStart` value. BYMINUTE: Specifies the start minute of each reccurrence after `timeMaintenanceWindowStart` value. The default value is 00 BYSECOND: Specifies the start second of each reccurrence after `timeMaintenanceWindowStart` value. The default value is 00 Other Rules are not supported. */ maintenanceWindowRecurrences: string; /** * (Updatable) Property to identify the type of the Maintenance Window. */ scheduleType: string; /** * (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string */ timeMaintenanceWindowEnd: string; /** * (Updatable) Start time of Maintenance window. A RFC3339 formatted datetime string * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ timeMaintenanceWindowStart: string; } interface MetricExtensionEnabledOnResource { /** * The OCID of the resource on which Metric Extension is enabled */ resourceId: string; } interface MetricExtensionMetricList { /** * (Updatable) Compute Expression to calculate the value of this metric */ computeExpression?: string; /** * (Updatable) Data type of value of this metric */ dataType: string; /** * (Updatable) Display name of the metric. */ displayName?: string; /** * (Updatable) Current metric need to be included as dimension or not */ isDimension: boolean; /** * (Updatable) Flag to marks whether a metric has to be uploaded or not. When isHidden = false > Metric is uploaded, isHidden = true > Metric is NOT uploaded */ isHidden: boolean; /** * (Updatable) Metric category */ metricCategory: string; /** * (Updatable) Name of the metric. */ name: string; /** * (Updatable) Unit of metric value */ unit?: string; } interface MetricExtensionQueryProperties { /** * (Updatable) Arguments required by either command or script */ arguments: string; /** * (Updatable) Prefix for an auto generated metric, in case multiple rows with non unique key values are returned */ autoRowPrefix: string; /** * (Updatable) Type of possible collection methods. */ collectionMethod: string; /** * (Updatable) OS command to execute without arguments */ command: string; /** * (Updatable) Character used to delimit multiple metric values in single line of output */ delimiter: string; /** * (Updatable) Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics */ identityMetric: string; /** * (Updatable) List of values and position of PL/SQL procedure IN parameters */ inParamDetails: outputs.StackMonitoring.MetricExtensionQueryPropertiesInParamDetail[]; /** * (Updatable) Indicates if Metric Service is enabled on server domain */ isMetricServiceEnabled: boolean; /** * (Updatable) List of JMX attributes or Metric Service Table columns separated by semi-colon */ jmxAttributes: string; /** * (Updatable) JMX Managed Bean Query or Metric Service Table name */ managedBeanQuery: string; /** * (Updatable) Position and SQL Type of PL/SQL OUT parameter */ outParamDetails: outputs.StackMonitoring.MetricExtensionQueryPropertiesOutParamDetails; /** * (Updatable) Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL */ protocolType: string; /** * (Updatable) Type of content response given by the http(s) URL */ responseContentType: string; /** * (Updatable) Script details applicable to any OS Command/HTTP based Metric Extension which needs to run a script to collect data. For removing it during OS Command based Metric Extension update, set its "content" property to an empty string. In that case, "name" property value is ignored. */ scriptDetails: outputs.StackMonitoring.MetricExtensionQueryPropertiesScriptDetails; /** * (Updatable) Details of Sql content which needs to execute to collect Metric Extension data */ sqlDetails: outputs.StackMonitoring.MetricExtensionQueryPropertiesSqlDetails; /** * (Updatable) Type of SQL data collection method i.e. either a Statement or SQL Script File */ sqlType: string; /** * (Updatable) String prefix used to identify metric output of the OS Command */ startsWith: string; /** * (Updatable) Http(s) end point URL */ url: string; } interface MetricExtensionQueryPropertiesInParamDetail { /** * (Updatable) Position of IN parameter */ inParamPosition: number; /** * (Updatable) Value of IN parameter */ inParamValue: string; } interface MetricExtensionQueryPropertiesOutParamDetails { /** * (Updatable) Name of the Out Parameter */ outParamName: string; /** * (Updatable) Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value. */ outParamPosition: number; /** * (Updatable) SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored. */ outParamType: string; } interface MetricExtensionQueryPropertiesScriptDetails { /** * (Updatable) Content of the script/JavaScript file as base64 encoded string */ content: string; /** * (Updatable) Name of the script file */ name: string; } interface MetricExtensionQueryPropertiesSqlDetails { /** * (Updatable) Sql statement or script file content as base64 encoded string */ content: string; /** * (Updatable) If a script needs to be executed, then provide file name of the script */ scriptFileName?: string; } interface MonitoredResourceAdditionalAlias { /** * (Updatable) Monitored Resource Alias Reference Source Credential. */ credential: outputs.StackMonitoring.MonitoredResourceAdditionalAliasCredential; /** * (Updatable) The name of the alias, within the context of the source. */ name: string; /** * (Updatable) The source type and source name combination,delimited with (.) separator. Example: {source type}.{source name} and source type max char limit is 63. */ source: string; } interface MonitoredResourceAdditionalAliasCredential { /** * (Updatable) The name of the pre-existing source credential which alias cred should point to. This should refer to the pre-existing source attribute which is bound to credential name. */ name: string; /** * (Updatable) The name of the service owning the credential. Example: stack-monitoring or dbmgmt */ service: string; /** * (Updatable) The source type and source name combination,delimited with (.) separator. This refers to the pre-existing source which alias cred should point to. Ex. {source type}.{source name} and source type max char limit is 63. */ source: string; } interface MonitoredResourceAdditionalCredential { /** * (Updatable) Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * * PLAINTEXT - The credential properties will have credentials in plain text format. * * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent. */ credentialType?: string; /** * (Updatable) The user-specified textual description of the credential. */ description?: string; /** * (Updatable) The master key should be created in Oracle Cloud Infrastructure Vault owned by the client of this API. The user should have permission to access the vault key. */ keyId?: string; /** * (Updatable) The name of the credential, within the context of the source. */ name?: string; /** * (Updatable) The credential properties list. Credential property values will be either in plain text format or encrypted for encrypted credentials. */ properties?: outputs.StackMonitoring.MonitoredResourceAdditionalCredentialProperty[]; /** * (Updatable) The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source?: string; /** * (Updatable) The type of the credential ( ex. JMXCreds,DBCreds). */ type?: string; } interface MonitoredResourceAdditionalCredentialProperty { /** * (Updatable) The name of the credential property, should confirm with names of properties of this credential's type. Example: For JMXCreds type, credential property name for weblogic user is 'Username'. */ name?: string; /** * (Updatable) The value of the credential property name. Example: For JMXCreds type, credential property value for 'Username' property is 'weblogic'. */ value?: string; } interface MonitoredResourceAliases { /** * (Updatable) Monitored Resource Alias Reference Source Credential. */ credential: outputs.StackMonitoring.MonitoredResourceAliasesCredential; /** * (Updatable) The name of the alias, within the context of the source. */ name: string; /** * (Updatable) The source type and source name combination,delimited with (.) separator. Example: {source type}.{source name} and source type max char limit is 63. */ source: string; } interface MonitoredResourceAliasesCredential { /** * (Updatable) The name of the pre-existing source credential which alias cred should point to. This should refer to the pre-existing source attribute which is bound to credential name. */ name: string; /** * (Updatable) The name of the service owning the credential. Example: stack-monitoring or dbmgmt */ service: string; /** * (Updatable) The source type and source name combination,delimited with (.) separator. This refers to the pre-existing source which alias cred should point to. Ex. {source type}.{source name} and source type max char limit is 63. */ source: string; } interface MonitoredResourceCredentials { /** * (Updatable) Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * * EXISTING - Credential is already stored in agent and only credential name need to be passed for existing credential. * * PLAINTEXT - The credential properties will have credentials in plain text format. * * ENCRYPTED - The credential properties will have credentials stored in vault in encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent. */ credentialType?: string; /** * (Updatable) The user-specified textual description of the credential. */ description?: string; /** * (Updatable) The master key should be created in Oracle Cloud Infrastructure Vault owned by the client of this API. The user should have permission to access the vault key. */ keyId?: string; /** * (Updatable) The name of the credential, within the context of the source. */ name?: string; /** * (Updatable) The credential properties list. Credential property values will be either in plain text format or encrypted for encrypted credentials. */ properties?: outputs.StackMonitoring.MonitoredResourceCredentialsProperty[]; /** * (Updatable) The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63. */ source?: string; /** * (Updatable) The type of the credential ( ex. JMXCreds,DBCreds). */ type?: string; } interface MonitoredResourceCredentialsProperty { /** * (Updatable) The name of the credential property, should confirm with names of properties of this credential's type. Example: For JMXCreds type, credential property name for weblogic user is 'Username'. */ name?: string; /** * (Updatable) The value of the credential property name. Example: For JMXCreds type, credential property value for 'Username' property is 'weblogic'. */ value?: string; } interface MonitoredResourceDatabaseConnectionDetails { /** * (Updatable) Database connector Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ connectorId?: string; /** * (Updatable) dbId of the database. */ dbId?: string; /** * (Updatable) UniqueName used for database connection requests. */ dbUniqueName?: string; /** * (Updatable) Listener Port number used for connection requests. */ port: number; /** * (Updatable) Protocol used in DB connection string when connecting to external database service. */ protocol: string; /** * (Updatable) Service name used for connection requests. */ serviceName: string; /** * (Updatable) SSL Secret Identifier for TCPS connector in Oracle Cloud Infrastructure Vault[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sslSecretId?: string; } interface MonitoredResourceProperty { /** * (Updatable) Property Name. */ name?: string; /** * (Updatable) Property Value. */ value?: string; } interface MonitoredResourceTaskTaskDetails { /** * Management Agent Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ agentId: string; /** * Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'. */ availabilityProxyMetricCollectionInterval: number; /** * List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource. */ availabilityProxyMetrics: string[]; /** * The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page. */ consolePathPrefix?: string; /** * The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id. */ externalIdMapping?: string; /** * Type of the handler. */ handlerType: string; /** * True to enable the receiver and false to disable the receiver on the agent. */ isEnable: boolean; /** * Lifecycle states of the external resource which reflects the status of the resource being up. */ lifecycleStatusMappingsForUpStatuses?: string[]; /** * Name space to be used for Oracle Cloud Infrastructure Native service resources discovery. */ namespace: string; /** * Properties for agent receiver. */ receiverProperties: outputs.StackMonitoring.MonitoredResourceTaskTaskDetailsReceiverProperties; /** * The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request. */ resourceGroup: string; /** * The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted. */ resourceNameFilter?: string; /** * The resource name property in the metric dimensions. Resources imported will be using this property value for resource name. */ resourceNameMapping?: string; /** * The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted. */ resourceTypeFilter?: string; /** * The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type. */ resourceTypeMapping?: string; /** * A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types. */ resourceTypesConfigurations: outputs.StackMonitoring.MonitoredResourceTaskTaskDetailsResourceTypesConfiguration[]; /** * The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE. */ serviceBaseUrl?: string; /** * Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service. */ shouldUseMetricsFlowForStatus: boolean; /** * Source from where the metrics pushed to telemetry. Possible values: * * OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services. * * OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus. * * OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver. * * OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver. */ source: string; /** * Task type. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface MonitoredResourceTaskTaskDetailsReceiverProperties { /** * Receiver listener port. */ listenerPort: number; } interface MonitoredResourceTaskTaskDetailsResourceTypesConfiguration { /** * Availability metrics details. */ availabilityMetricsConfig: outputs.StackMonitoring.MonitoredResourceTaskTaskDetailsResourceTypesConfigurationAvailabilityMetricsConfig; /** * Specific resource mapping configurations for Agent Extension Handlers. */ handlerConfig: outputs.StackMonitoring.MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfig; /** * Resource type. */ resourceType: string; } interface MonitoredResourceTaskTaskDetailsResourceTypesConfigurationAvailabilityMetricsConfig { /** * Availability metric collection internal in seconds. */ collectionIntervalInSeconds: number; /** * List of metrics used for availability calculation for the resource. */ metrics: string[]; } interface MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfig { /** * Resource name generation overriding configurations for collectd resource types. */ collectdResourceNameConfig: outputs.StackMonitoring.MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig; /** * List of collector/plugin names. */ collectorTypes: string[]; /** * List of handler configuration properties */ handlerProperties: outputs.StackMonitoring.MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfigHandlerProperty[]; /** * List of AgentExtensionHandlerMetricMappingDetails. */ metricMappings: outputs.StackMonitoring.MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfigMetricMapping[]; /** * Metric name generation overriding configurations. */ metricNameConfig: outputs.StackMonitoring.MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfigMetricNameConfig; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Resource name generation overriding configurations for telegraf resource types. */ telegrafResourceNameConfig: outputs.StackMonitoring.MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig; /** * Resource group string; if not specified, the resource group string will be generated by the handler. */ telemetryResourceGroup: string; } interface MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig { /** * List of property names to be excluded. */ excludeProperties: string[]; /** * List of property names to be included. */ includeProperties: string[]; /** * String to be suffixed to the resource name. */ suffix: string; } interface MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfigHandlerProperty { /** * Property name. */ name: string; /** * Property value. */ value: string; } interface MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfigMetricMapping { /** * Metric name as defined by the collector. */ collectorMetricName: string; /** * Is ignoring this metric. */ isSkipUpload: boolean; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Metric name to be upload to telemetry. */ telemetryMetricName: string; } interface MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfigMetricNameConfig { /** * String pattern to be removed from the prefix of the metric name. */ excludePatternOnPrefix: string; /** * is prefixing the metric with collector type. */ isPrefixWithCollectorType: boolean; } interface MonitoredResourceTaskTaskDetailsResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig { /** * List of tag names to be excluded. */ excludeTags: string[]; /** * List of tag names to be included. */ includeTags: string[]; /** * Flag to indicate if only tags will be used for resource name generation. */ isUseTagsOnly: boolean; } interface MonitoredResourceTypeAvailabilityMetricsConfig { /** * Availability metric collection internal in seconds. */ collectionIntervalInSeconds: number; /** * List of metrics used for availability calculation for the resource. */ metrics: string[]; } interface MonitoredResourceTypeHandlerConfig { /** * Resource name generation overriding configurations for collectd resource types. */ collectdResourceNameConfigs: outputs.StackMonitoring.MonitoredResourceTypeHandlerConfigCollectdResourceNameConfig[]; /** * List of collector/plugin names. */ collectorTypes: string[]; /** * List of handler configuration properties */ handlerProperties: outputs.StackMonitoring.MonitoredResourceTypeHandlerConfigHandlerProperty[]; /** * List of AgentExtensionHandlerMetricMappingDetails. */ metricMappings: outputs.StackMonitoring.MonitoredResourceTypeHandlerConfigMetricMapping[]; /** * Metric name generation overriding configurations. */ metricNameConfigs: outputs.StackMonitoring.MonitoredResourceTypeHandlerConfigMetricNameConfig[]; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Resource name generation overriding configurations for telegraf resource types. */ telegrafResourceNameConfigs: outputs.StackMonitoring.MonitoredResourceTypeHandlerConfigTelegrafResourceNameConfig[]; /** * Resource group string; if not specified, the resource group string will be generated by the handler. */ telemetryResourceGroup: string; } interface MonitoredResourceTypeHandlerConfigCollectdResourceNameConfig { /** * List of property names to be excluded. */ excludeProperties: string[]; /** * List of property names to be included. */ includeProperties: string[]; /** * String to be suffixed to the resource name. */ suffix: string; } interface MonitoredResourceTypeHandlerConfigHandlerProperty { /** * A unique monitored resource type name. The name must be unique across tenancy. Name can not be changed. */ name: string; /** * Property value. */ value: string; } interface MonitoredResourceTypeHandlerConfigMetricMapping { /** * Metric name as defined by the collector. */ collectorMetricName: string; /** * Is ignoring this metric. */ isSkipUpload: boolean; /** * Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped. */ metricUploadIntervalInSeconds: number; /** * Metric name to be upload to telemetry. */ telemetryMetricName: string; } interface MonitoredResourceTypeHandlerConfigMetricNameConfig { /** * String pattern to be removed from the prefix of the metric name. */ excludePatternOnPrefix: string; /** * is prefixing the metric with collector type. */ isPrefixWithCollectorType: boolean; } interface MonitoredResourceTypeHandlerConfigTelegrafResourceNameConfig { /** * List of tag names to be excluded. */ excludeTags: string[]; /** * List of tag names to be included. */ includeTags: string[]; /** * Flag to indicate if only tags will be used for resource name generation. */ isUseTagsOnly: boolean; } interface MonitoredResourceTypeMetadata { /** * (Updatable) List of properties needed by the agent for monitoring the resource. Valid only if resource type is Oracle Cloud Infrastructure management agent based. When specified, these properties are passed to the management agent during resource create or update. */ agentProperties: string[]; /** * (Updatable) ResourceType metadata format to be used. Currently supports only one format. Possible values - SYSTEM_FORMAT. * * SYSTEM_FORMAT - The resource type metadata is defined in machine friendly format. */ format: string; /** * (Updatable) List of required properties for resource type. */ requiredProperties: string[]; /** * (Updatable) List of property sets used to uniquely identify the resources. This check is made during create or update of stack monitoring resource. The resource has to pass unique check for each set in the list. For example, database can have user, password and SID as one unique set. Another unique set would be user, password and service name. */ uniquePropertySets?: outputs.StackMonitoring.MonitoredResourceTypeMetadataUniquePropertySet[]; /** * (Updatable) List of valid properties for resource type while creating the monitored resource. If resources of this type specifies any other properties during create operation, the operation will fail. */ validPropertiesForCreates: string[]; /** * (Updatable) List of valid properties for resource type while updating the monitored resource. If resources of this type specifies any other properties during update operation, the operation will fail. */ validPropertiesForUpdates: string[]; /** * (Updatable) List of valid values for the properties. This is useful when resource type wants to restrict only certain values for some properties. For instance for 'osType' property, supported values can be restricted to be either Linux or Windows. Example: `{ "osType": "Linux,Windows,Solaris"}` */ validPropertyValues: { [key: string]: string; }; /** * (Updatable) List of valid sub-resource types for a composite resource type. The sub-resource types will be obtained from the valid association pairs corresponding to the composite resource types. It will be empty for non composite resource types */ validSubResourceTypes: string[]; } interface MonitoredResourceTypeMetadataUniquePropertySet { /** * (Updatable) List of properties. */ properties: string[]; } interface MonitoredResourcesAssociateMonitoredResourceDestinationResourceDetail { /** * Compartment Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Monitored Resource Name. */ name: string; /** * Monitored Resource Type. */ type: string; } interface MonitoredResourcesAssociateMonitoredResourceSourceResourceDetail { /** * Compartment Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Monitored Resource Name. */ name: string; /** * Monitored Resource Type. */ type: string; } interface MonitoredResourcesListMemberItem { /** * Compartment Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * External resource is any Oracle Cloud Infrastructure resource identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and Oracle Cloud Infrastructure compute instance. */ externalId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Monitored Resource Host Name. */ hostName: string; /** * License edition of the monitored resource. */ license: string; /** * Parent monitored resource identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ parentId: string; /** * Resource Category to indicate the kind of resource type. */ resourceCategory: string; /** * Monitored resource display name. */ resourceDisplayName: string; /** * Monitored resource identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ resourceId: string; /** * Monitored Resource Name. */ resourceName: string; /** * Monitored Resource Type. */ resourceType: string; /** * Source type to indicate if the resource is stack monitoring discovered, Oracle Cloud Infrastructure native resource, etc. */ sourceType: string; /** * The current state of the Resource. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface MonitoredResourcesSearchAssociationItem { /** * Association type filter to search associated resources. */ associationType: string; /** * Association Resource Details. */ destinationResourceDetails: outputs.StackMonitoring.MonitoredResourcesSearchAssociationItemDestinationResourceDetail[]; /** * Destination Monitored Resource Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ destinationResourceId: string; /** * Association Resource Details. */ sourceResourceDetails: outputs.StackMonitoring.MonitoredResourcesSearchAssociationItemSourceResourceDetail[]; /** * Source Monitored Resource Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ sourceResourceId: string; /** * The association creation time. An RFC3339 formatted datetime string. */ timeCreated: string; } interface MonitoredResourcesSearchAssociationItemDestinationResourceDetail { /** * Compartment Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Monitored Resource Name. */ name: string; /** * Monitored Resource Type. */ type: string; } interface MonitoredResourcesSearchAssociationItemSourceResourceDetail { /** * Compartment Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Monitored Resource Name. */ name: string; /** * Monitored Resource Type. */ type: string; } interface MonitoredResourcesSearchItem { /** * Compartment Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Monitored resource display name. */ displayName: string; /** * External resource is any Oracle Cloud Infrastructure resource identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and Oracle Cloud Infrastructure compute instance. */ externalId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return resources with host name match. */ hostName: string; /** * Monitored resource identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * License edition of the monitored resource. */ license: string; /** * A filter to return resources with matching management agent id. */ managementAgentId: string; /** * A filter to return resources that match exact resource name. */ name: string; /** * List of monitored resource properties. */ properties: outputs.StackMonitoring.MonitoredResourcesSearchItemProperty[]; /** * Resource category filter. */ resourceCategory: string; /** * Source type filter. */ sourceType: string; /** * A filter to return resources with matching lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Monitored resource creation time. An RFC3339 formatted datetime string. */ timeCreated: string; /** * Monitored resource update time. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return resources that match resource type. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } interface MonitoredResourcesSearchItemProperty { /** * A filter to return resources that match exact resource name. */ name: string; /** * Property Value. */ value: string; } interface MonitoringTemplateAlarmConditionCondition { /** * (Updatable) The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. */ body: string; /** * (Updatable) The Monitoring Query Language (MQL) expression to evaluate for the alarm. */ query: string; /** * (Updatable) Severity - Critical/Warning */ severity: string; /** * (Updatable) Whether the note need to add into bottom of the body for mapping the alarms information with template or not. */ shouldAppendNote: boolean; /** * (Updatable) Whether the URL need to add into bottom of the body for mapping the alarms information with template or not. */ shouldAppendUrl: boolean; /** * (Updatable) The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". */ triggerDelay: string; } interface MonitoringTemplateMember { /** * (Updatable) The OCID of the composite resource type like EBS or Peoplesoft. */ compositeType: string; /** * (Updatable) The OCID of the resourceInstance/resourceType/resourceGroup */ id: string; /** * (Updatable) Type of the member reference RESOURCE_INSTANCE, RESOURCE_TYPE, RESOURCE_GROUP */ type: string; } interface ProcessSetSpecification { /** * (Updatable) List of Process Set specification details. */ items: outputs.StackMonitoring.ProcessSetSpecificationItem[]; } interface ProcessSetSpecificationItem { /** * (Updatable) Optional label used to identify a single filter. */ label: string; /** * (Updatable) String literal used for exact matching on process name. */ processCommand: string; /** * (Updatable) Regex pattern matching on process arguments. */ processLineRegexPattern: string; /** * (Updatable) String literal used for exact matching on process user. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ processUser: string; } } export declare namespace Streaming { interface GetConnectHarnessesConnectHarness { /** * The OCID of the compartment. */ compartmentId: string; /** * 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"}}' */ definedTags: { [key: string]: string; }; /** * Free-form tags for this resource. Each tag is a simple key-value pair that is applied 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only resources that match the given ID exactly. */ id: string; /** * Any additional details about the current state of the connect harness. */ lifecycleStateDetails: string; /** * A filter to return only resources that match the given name exactly. */ name: string; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the connect harness was created, expressed in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` */ timeCreated: string; } interface GetConnectHarnessesFilter { /** * A filter to return only resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetStreamPoolCustomEncryptionKey { /** * Life cycle State of the custom key */ keyState: string; /** * Custom Encryption Key (Master Key) ocid. */ kmsKeyId: string; } interface GetStreamPoolKafkaSetting { /** * Enable auto creation of topic on the server. */ autoCreateTopicsEnable: boolean; /** * Bootstrap servers. */ bootstrapServers: string; /** * The number of hours to keep a log file before deleting it (in hours). */ logRetentionHours: number; /** * The default number of log partitions per topic. */ numPartitions: number; } interface GetStreamPoolPrivateEndpointSetting { /** * The optional list of network security groups that are associated with the private endpoint of the stream pool. */ nsgIds: string[]; /** * The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues. */ privateEndpointIp: string; /** * The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error. */ subnetId: string; } interface GetStreamPoolsFilter { /** * A filter to return only resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetStreamPoolsStreamPool { /** * The OCID of the compartment. */ compartmentId: string; /** * Custom Encryption Key which will be used for encryption by all the streams in the pool. */ customEncryptionKeys: outputs.Streaming.GetStreamPoolsStreamPoolCustomEncryptionKey[]; /** * 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"}}' */ definedTags: { [key: string]: string; }; /** * The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a [Stream](https://docs.cloud.oracle.com/iaas/api/#/en/streaming/20180418/Stream) object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port. */ endpointFqdn: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair that is applied 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only resources that match the given ID exactly. */ id: string; /** * True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the [GetStreamPool](https://docs.cloud.oracle.com/iaas/api/#/en/streaming/20180418/StreamPool/GetStreamPool) API. */ isPrivate: boolean; /** * Settings for the Kafka compatibility layer. */ kafkaSettings: outputs.Streaming.GetStreamPoolsStreamPoolKafkaSetting[]; /** * Any additional details about the current state of the stream. */ lifecycleStateDetails: string; /** * A filter to return only resources that match the given name exactly. */ name: string; /** * Optional settings if the stream pool is private. */ privateEndpointSettings: outputs.Streaming.GetStreamPoolsStreamPoolPrivateEndpointSetting[]; /** * 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"}}}` */ securityAttributes: { [key: string]: string; }; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The date and time the stream pool was created, expressed in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` */ timeCreated: string; } interface GetStreamPoolsStreamPoolCustomEncryptionKey { /** * Life cycle State of the custom key */ keyState: string; /** * Custom Encryption Key (Master Key) ocid. */ kmsKeyId: string; } interface GetStreamPoolsStreamPoolKafkaSetting { /** * Enable auto creation of topic on the server. */ autoCreateTopicsEnable: boolean; /** * Bootstrap servers. */ bootstrapServers: string; /** * The number of hours to keep a log file before deleting it (in hours). */ logRetentionHours: number; /** * The default number of log partitions per topic. */ numPartitions: number; } interface GetStreamPoolsStreamPoolPrivateEndpointSetting { /** * The optional list of network security groups that are associated with the private endpoint of the stream pool. */ nsgIds: string[]; /** * The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues. */ privateEndpointIp: string; /** * The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error. */ subnetId: string; } interface GetStreamsFilter { /** * A filter to return only resources that match the given name exactly. */ name: string; regex?: boolean; values: string[]; } interface GetStreamsStream { /** * The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required. */ compartmentId: string; /** * 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"}}' */ definedTags: { [key: string]: string; }; /** * Free-form tags for this resource. Each tag is a simple key-value pair that is applied 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"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only resources that match the given ID exactly. */ id: string; /** * Any additional details about the current state of the stream. */ lifecycleStateDetails: string; /** * The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet. */ messagesEndpoint: string; /** * A filter to return only resources that match the given name exactly. */ name: string; /** * The number of partitions in the stream. */ partitions: number; /** * The retention period of the stream, in hours. This property is read-only. */ retentionInHours: number; /** * A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The OCID of the stream pool. Is exclusive with the `compartmentId` parameter. One of them is required. */ streamPoolId: string; /** * The date and time the stream was created, expressed in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z` */ timeCreated: string; } interface StreamPoolCustomEncryptionKey { /** * Life cycle State of the custom key */ keyState: string; /** * (Updatable) Custom Encryption Key (Master Key) ocid. */ kmsKeyId: string; } interface StreamPoolKafkaSettings { /** * (Updatable) Enable auto creation of topic on the server. */ autoCreateTopicsEnable: boolean; /** * (Updatable) Bootstrap servers. */ bootstrapServers: string; /** * (Updatable) The number of hours to keep a log file before deleting it (in hours). */ logRetentionHours: number; /** * (Updatable) The default number of log partitions per topic. */ numPartitions: number; } interface StreamPoolPrivateEndpointSettings { /** * The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed. */ nsgIds: string[]; /** * The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP. */ privateEndpointIp: string; /** * If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed. */ subnetId: string; } } export declare namespace Tenantmanagercontrolplane { interface GetAssignedSubscriptionLineItemsAssignedSubscriptionLineItemCollection { /** * Array containing line item summaries in an assigned subscription. */ items: outputs.Tenantmanagercontrolplane.GetAssignedSubscriptionLineItemsAssignedSubscriptionLineItemCollectionItem[]; } interface GetAssignedSubscriptionLineItemsAssignedSubscriptionLineItemCollectionItem { /** * Billing model supported by the associated line item. */ billingModel: string; /** * Subscription line item identifier. */ id: string; /** * Product code. */ productCode: string; /** * Product number. */ quantity: number; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the subscription item and associated products should end. An RFC 3339 formatted date and time string. */ timeEnded: string; /** * The time the subscription item and associated products should start. An RFC 3339 formatted date and time string. */ timeStarted: string; } interface GetAssignedSubscriptionLineItemsFilter { name: string; regex?: boolean; values: string[]; } interface GetAssignedSubscriptionPromotion { /** * If a subscription is present, indicates the total amount of promotional subscription credits. */ amount: number; /** * Currency unit associated with the promotion. */ currencyUnit: string; /** * Specifies how long the promotion related to the subscription, if any, is valid in duration units. */ duration: number; /** * Unit for the duration. */ durationUnit: string; /** * Speficies whether or not the customer intends to pay after the promotion has expired. */ isIntentToPay: boolean; /** * If a subscription is present, indicates the current status of the subscription promotion. */ status: string; /** * Date and time when the promotion ends. */ timeExpired: string; /** * Date and time when the promotion starts. */ timeStarted: string; } interface GetAssignedSubscriptionSkus { /** * Description of the stock units. */ description: string; /** * Date and time when the SKU ended. */ endDate: string; /** * Sales order line identifier. */ gsiOrderLineId: string; /** * Specifies if an additional test instance can be provisioned by the SaaS application. */ isAdditionalInstance: boolean; /** * Specifies if the SKU is considered as a parent or child. */ isBaseServiceComponent: boolean; /** * Description of the covered product belonging to this SKU. */ licensePartDescription: string; /** * Base metric for billing the service. */ metricName: string; /** * Quantity of the stock units. */ quantity: number; /** * Stock Keeping Unit (SKU) ID. */ sku: string; /** * Subscription start time. */ startDate: string; } interface GetAssignedSubscriptionsAssignedSubscriptionCollection { items: outputs.Tenantmanagercontrolplane.GetAssignedSubscriptionsAssignedSubscriptionCollectionItem[]; } interface GetAssignedSubscriptionsAssignedSubscriptionCollectionItem { /** * Subscription ID. */ classicSubscriptionId: string; /** * The currency code for the customer associated with the subscription. */ cloudAmountCurrency: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Customer service identifier for the customer associated with the subscription. */ csiNumber: string; /** * Currency code. For example USD, MXN. */ currencyCode: string; /** * The country code for the customer associated with the subscription. */ customerCountryCode: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Date and time when the SKU ended. */ endDate: string; /** * The version of the subscription entity. */ entityVersion: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription. */ id: string; /** * Specifies whether or not the subscription is legacy. */ isClassicSubscription: boolean; /** * Specifies whether or not the subscription is a government subscription. */ isGovernmentSubscription: boolean; /** * Service or component which is used to provision and manage the subscription. */ managedBy: string; /** * List of subscription order OCIDs that contributed to this subscription. */ orderIds: string[]; /** * Specifies any program that is associated with the subscription. */ programType: string; /** * List of promotions related to the subscription. */ promotions: outputs.Tenantmanagercontrolplane.GetAssignedSubscriptionsAssignedSubscriptionCollectionItemPromotion[]; /** * Purchase entitlement ID associated with the subscription. */ purchaseEntitlementId: string; /** * Region for the subscription. */ regionAssignment: string; /** * The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'. */ serviceName: string; /** * List of SKUs linked to the subscription. */ skuses: outputs.Tenantmanagercontrolplane.GetAssignedSubscriptionsAssignedSubscriptionCollectionItemSkus[]; /** * Subscription start time. */ startDate: string; /** * Lifecycle state of the subscription. */ state: string; /** * Unique Oracle Cloud Subscriptions identifier that is immutable on creation. */ subscriptionNumber: string; /** * Tier for the subscription, whether a free promotion subscription or a paid subscription. */ subscriptionTier: string; /** * The date and time of creation, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeCreated: string; /** * The date and time of update, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeUpdated: string; } interface GetAssignedSubscriptionsAssignedSubscriptionCollectionItemPromotion { /** * If a subscription is present, indicates the total amount of promotional subscription credits. */ amount: number; /** * Currency unit associated with the promotion. */ currencyUnit: string; /** * Specifies how long the promotion related to the subscription, if any, is valid in duration units. */ duration: number; /** * Unit for the duration. */ durationUnit: string; /** * Speficies whether or not the customer intends to pay after the promotion has expired. */ isIntentToPay: boolean; /** * If a subscription is present, indicates the current status of the subscription promotion. */ status: string; /** * Date and time when the promotion ends. */ timeExpired: string; /** * Date and time when the promotion starts. */ timeStarted: string; } interface GetAssignedSubscriptionsAssignedSubscriptionCollectionItemSkus { /** * Description of the stock units. */ description: string; /** * Date and time when the SKU ended. */ endDate: string; /** * Sales order line identifier. */ gsiOrderLineId: string; /** * Specifies if an additional test instance can be provisioned by the SaaS application. */ isAdditionalInstance: boolean; /** * Specifies if the SKU is considered as a parent or child. */ isBaseServiceComponent: boolean; /** * Description of the covered product belonging to this SKU. */ licensePartDescription: string; /** * Base metric for billing the service. */ metricName: string; /** * Quantity of the stock units. */ quantity: number; /** * Stock Keeping Unit (SKU) ID. */ sku: string; /** * Subscription start time. */ startDate: string; } interface GetAssignedSubscriptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetDomainGovernancesDomainGovernanceCollection { items: outputs.Tenantmanagercontrolplane.GetDomainGovernancesDomainGovernanceCollectionItem[]; } interface GetDomainGovernancesDomainGovernanceCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The domain OCID. */ domainId: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the domain governance entity. */ id: string; /** * Indicates whether governance is enabled for this domain. */ isGovernanceEnabled: boolean; /** * The ONS subscription associated with this domain governance entity. */ onsSubscriptionId: string; /** * The ONS topic associated with this domain governance entity. */ onsTopicId: string; /** * The OCID of the tenancy that owns this domain governance entity. */ ownerId: string; /** * The lifecycle state of the resource. */ state: string; /** * Email address to be used to notify the user, and that the ONS subscription will be created with. */ subscriptionEmail: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Date-time when this domain governance was created. An RFC 3339-formatted date and time string. */ timeCreated: string; /** * Date-time when this domain governance was last updated. An RFC 3339-formatted date and time string. */ timeUpdated: string; } interface GetDomainGovernancesFilter { /** * A filter to return only resources that exactly match the name given. */ name: string; regex?: boolean; values: string[]; } interface GetDomainsDomainCollection { items: outputs.Tenantmanagercontrolplane.GetDomainsDomainCollectionItem[]; } interface GetDomainsDomainCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * The domain name. */ domainName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the domain. */ id: string; isGovernanceEnabled: boolean; /** * The OCID of the tenancy that has started the registration process for this domain. */ ownerId: string; /** * The lifecycle state of the resource. */ state: string; /** * The status of the domain. */ status: string; subscriptionEmail: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Date-time when this domain was created. An RFC 3339-formatted date and time string. */ timeCreated: string; /** * Date-time when this domain was last updated. An RFC 3339-formatted date and time string. */ timeUpdated: string; /** * The code that the owner of the domain will need to add as a TXT record to their domain. */ txtRecord: string; } interface GetDomainsFilter { /** * A filter to return only resources that exactly match the name given. */ name: string; regex?: boolean; values: string[]; } interface GetLinkFeaturesFilter { name: string; regex?: boolean; values: string[]; } interface GetLinkFeaturesLinkFeaturesCollection { /** * Array containing LinkFeature items. */ items: outputs.Tenantmanagercontrolplane.GetLinkFeaturesLinkFeaturesCollectionItem[]; } interface GetLinkFeaturesLinkFeaturesCollectionItem { /** * Description of the feature. */ description: string; /** * Display name of the feature. */ displayName: string; /** * The feature associated with this link. Default value is CORE. */ feature: string; /** * ConsoleUrl of the feature. */ partnerServiceConsoleUrl: string; /** * UserGuideUrl of the feature. */ userGuideUrl: string; } interface GetLinksFilter { name: string; regex?: boolean; values: string[]; } interface GetLinksLinkCollection { items: outputs.Tenantmanagercontrolplane.GetLinksLinkCollectionItem[]; } interface GetLinksLinkCollectionItem { /** * The ID of the child tenancy this link is associated with. */ childTenancyId: string; /** * The feature associated with this link. */ feature: string; /** * OCID of the link. */ id: string; /** * The ID of the parent tenancy this link is associated with. */ parentTenancyId: string; /** * The lifecycle state of the resource. */ state: string; /** * Date-time when this link was created. */ timeCreated: string; /** * Date-time when this link was terminated. */ timeTerminated: string; /** * Date-time when this link was last updated. */ timeUpdated: string; } interface GetOrganizationTenanciesFilter { /** * Name of the tenancy. */ name: string; regex?: boolean; values: string[]; } interface GetOrganizationTenanciesOrganizationTenancyCollection { items: outputs.Tenantmanagercontrolplane.GetOrganizationTenanciesOrganizationTenancyCollectionItem[]; } interface GetOrganizationTenanciesOrganizationTenancyCollectionItem { /** * The governance status of the tenancy. */ governanceStatus: string; /** * Parameter to indicate the tenancy is approved for transfer to another organization. */ isApprovedForTransfer: boolean; /** * Name of the tenancy. */ name: string; /** * Role of the organization tenancy. */ role: string; /** * Lifecycle state of the organization tenancy. */ state: string; /** * OCID of the tenancy. */ tenancyId: string; /** * Date and time when the tenancy joined the organization. */ timeJoined: string; /** * Date and time when the tenancy left the organization. */ timeLeft: string; } interface GetOrganizationsFilter { name: string; regex?: boolean; values: string[]; } interface GetOrganizationsOrganizationCollection { items: outputs.Tenantmanagercontrolplane.GetOrganizationsOrganizationCollectionItem[]; } interface GetOrganizationsOrganizationCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * OCID of the default Universal Credits Model subscription. Any tenancy joining the organization will automatically get assigned this subscription, if a subscription is not explictly assigned. */ defaultUcmSubscriptionId: string; /** * A display name for the organization. Avoid entering confidential information. */ displayName: string; /** * OCID of the organization. */ id: string; /** * The name of the tenancy that is the organization parent. */ parentName: string; /** * Lifecycle state of the organization. */ state: string; /** * Date and time when the organization was created. */ timeCreated: string; /** * Date and time when the organization was last updated. */ timeUpdated: string; } interface GetRecipientInvitationsFilter { name: string; regex?: boolean; values: string[]; } interface GetRecipientInvitationsRecipientInvitationCollection { items: outputs.Tenantmanagercontrolplane.GetRecipientInvitationsRecipientInvitationCollectionItem[]; } interface GetRecipientInvitationsRecipientInvitationCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-created name to describe the invitation. Avoid entering confidential information. */ displayName: string; /** * List of features that the invitation is being sent for. Each feature would create one link, of that type. */ features: string[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID of the recipient invitation. */ id: string; /** * Email address of the recipient. */ recipientEmailAddress: string; /** * OCID of the corresponding sender invitation. */ senderInvitationId: string; /** * The tenancy that sent the invitation. */ senderTenancyId: string; /** * The lifecycle state of the resource. */ state: string; /** * The status of the recipient invitation. */ status: string; /** * The list of subjects the invitation contains. */ subjects: string[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Date and time when the recipient invitation was created. */ timeCreated: string; /** * Date and time when the recipient invitation was last updated. */ timeUpdated: string; } interface GetSenderInvitationInvitationFeature { /** * Name of the feature. */ name: string; /** * OCID of the corresponding recipient invitation. */ recipientInvitationId: string; /** * Status of the sender invitation. */ status: string; } interface GetSenderInvitationsFilter { /** * Name of the feature. */ name: string; regex?: boolean; values: string[]; } interface GetSenderInvitationsSenderInvitationCollection { items: outputs.Tenantmanagercontrolplane.GetSenderInvitationsSenderInvitationCollectionItem[]; } interface GetSenderInvitationsSenderInvitationCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; features: string[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID of the sender invitation. */ id: string; /** * List of features that the invitation is being sent for. Each feature would create one link, of that type. */ invitationFeatures: outputs.Tenantmanagercontrolplane.GetSenderInvitationsSenderInvitationCollectionItemInvitationFeature[]; /** * Email address of the recipient. */ recipientEmailAddress: string; /** * OCID of the corresponding recipient invitation. */ recipientInvitationId: string; /** * The tenancy that the invitation is addressed to. */ recipientTenancyId: string; /** * The lifecycle state of the resource. */ state: string; /** * The status of the sender invitation. */ status: string; /** * The list of subjects the invitation contains. */ subjects: string[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Date and time when the sender invitation was created. */ timeCreated: string; /** * Date and time when the sender invitation was last updated. */ timeUpdated: string; } interface GetSenderInvitationsSenderInvitationCollectionItemInvitationFeature { /** * Name of the feature. */ name: string; /** * OCID of the corresponding recipient invitation. */ recipientInvitationId: string; /** * The status of the sender invitation. */ status: string; } interface GetSubscriptionAvailableRegionsAvailableRegionCollection { /** * Array containing available region items. */ items: outputs.Tenantmanagercontrolplane.GetSubscriptionAvailableRegionsAvailableRegionCollectionItem[]; } interface GetSubscriptionAvailableRegionsAvailableRegionCollectionItem { /** * Region availability for the subscription. */ regionName: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetSubscriptionAvailableRegionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSubscriptionLineItemsFilter { name: string; regex?: boolean; values: string[]; } interface GetSubscriptionLineItemsSubscriptionLineItemCollection { /** * Array containing line item summaries in a subscription. */ items: outputs.Tenantmanagercontrolplane.GetSubscriptionLineItemsSubscriptionLineItemCollectionItem[]; } interface GetSubscriptionLineItemsSubscriptionLineItemCollectionItem { /** * Billing model supported by the associated line item. */ billingModel: string; /** * Subscription line item identifier. */ id: string; /** * Product code. */ productCode: string; /** * Product number. */ quantity: number; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the subscription item and associated products should end. An RFC 3339 formatted date and time string. */ timeEnded: string; /** * The time the subscription item and associated products should start. An RFC 3339 formatted date and time string. */ timeStarted: string; } interface GetSubscriptionMappingsFilter { name: string; regex?: boolean; values: string[]; } interface GetSubscriptionMappingsSubscriptionMappingCollection { items: outputs.Tenantmanagercontrolplane.GetSubscriptionMappingsSubscriptionMappingCollectionItem[]; } interface GetSubscriptionMappingsSubscriptionMappingCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * OCID of the mapping between subscription and compartment identified by the tenancy. */ id: string; /** * Denotes if the subscription is explicity assigned to the root compartment or tenancy. */ isExplicitlyAssigned: boolean; /** * The lifecycle state of the resource. */ state: string; /** * OCID of the subscription. */ subscriptionId: string; /** * Date-time when subscription mapping was created. */ timeCreated: string; /** * Date-time when subscription mapping was terminated. */ timeTerminated: string; /** * Date-time when subscription mapping was updated. */ timeUpdated: string; } interface GetSubscriptionPromotion { /** * If a subscription is present, indicates the total amount of promotional subscription credits. */ amount: number; /** * Currency unit associated with the promotion. */ currencyUnit: string; /** * Specifies how long the promotion related to the subscription, if any, is valid in duration units. */ duration: number; /** * Unit for the duration. */ durationUnit: string; /** * Speficies whether or not the customer intends to pay after the promotion has expired. */ isIntentToPay: boolean; /** * If a subscription is present, indicates the current status of the subscription promotion. */ status: string; /** * Date and time when the promotion ends. */ timeExpired: string; /** * Date and time when the promotion starts. */ timeStarted: string; } interface GetSubscriptionSkus { /** * Description of the stock units. */ description: string; /** * Date and time when the SKU ended. */ endDate: string; /** * Sales order line identifier. */ gsiOrderLineId: string; /** * Specifies if an additional test instance can be provisioned by the SaaS application. */ isAdditionalInstance: boolean; /** * Specifies if the SKU is considered as a parent or child. */ isBaseServiceComponent: boolean; /** * Description of the covered product belonging to this SKU. */ licensePartDescription: string; /** * Base metric for billing the service. */ metricName: string; /** * Quantity of the stock units. */ quantity: number; /** * Stock Keeping Unit (SKU) ID. */ sku: string; /** * Subscription start time. */ startDate: string; } interface GetSubscriptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSubscriptionsSubscriptionCollection { items: outputs.Tenantmanagercontrolplane.GetSubscriptionsSubscriptionCollectionItem[]; } interface GetSubscriptionsSubscriptionCollectionItem { /** * Classic subscription ID. */ classicSubscriptionId: string; /** * The currency code for the customer associated with the subscription. */ cloudAmountCurrency: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Customer service identifier for the customer associated with the subscription. */ csiNumber: string; /** * Currency code. For example USD, MXN. */ currencyCode: string; /** * The country code for the customer associated with the subscription. */ customerCountryCode: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Date and time when the SKU ended. */ endDate: string; /** * The version of the subscription entity. */ entityVersion: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subscription. */ id: string; /** * Specifies whether or not the subscription is from classic systems. */ isClassicSubscription: boolean; /** * Specifies whether or not the subscription is a government subscription. */ isGovernmentSubscription: boolean; /** * The pay model of the subscription, such as 'Pay as you go' or 'Monthly'. */ paymentModel: string; /** * Specifies any program that is associated with the subscription. */ programType: string; /** * List of promotions related to the subscription. */ promotions: outputs.Tenantmanagercontrolplane.GetSubscriptionsSubscriptionCollectionItemPromotion[]; /** * Purchase entitlement ID associated with the subscription. */ purchaseEntitlementId: string; /** * Region for the subscription. */ regionAssignment: string; /** * The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'. */ serviceName: string; /** * List of SKUs linked to this subscription. */ skuses: outputs.Tenantmanagercontrolplane.GetSubscriptionsSubscriptionCollectionItemSkus[]; /** * Subscription start time. */ startDate: string; /** * Lifecycle state of the subscription. */ state: string; /** * Unique Oracle Cloud Subscriptions identifier that is immutable on creation. */ subscriptionNumber: string; /** * Tier for the subscription, whether a free promotion subscription or a paid subscription. */ subscriptionTier: string; /** * The date and time of creation, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeCreated: string; /** * The date and time of update, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. */ timeUpdated: string; } interface GetSubscriptionsSubscriptionCollectionItemPromotion { /** * If a subscription is present, indicates the total amount of promotional subscription credits. */ amount: number; /** * Currency unit associated with the promotion. */ currencyUnit: string; /** * Specifies how long the promotion related to the subscription, if any, is valid in duration units. */ duration: number; /** * Unit for the duration. */ durationUnit: string; /** * Speficies whether or not the customer intends to pay after the promotion has expired. */ isIntentToPay: boolean; /** * If a subscription is present, indicates the current status of the subscription promotion. */ status: string; /** * Date and time when the promotion ends. */ timeExpired: string; /** * Date and time when the promotion starts. */ timeStarted: string; } interface GetSubscriptionsSubscriptionCollectionItemSkus { /** * Description of the stock units. */ description: string; /** * Date and time when the SKU ended. */ endDate: string; /** * Sales order line identifier. */ gsiOrderLineId: string; /** * Specifies if an additional test instance can be provisioned by the SaaS application. */ isAdditionalInstance: boolean; /** * Specifies if the SKU is considered as a parent or child. */ isBaseServiceComponent: boolean; /** * Description of the covered product belonging to this SKU. */ licensePartDescription: string; /** * Base metric for billing the service. */ metricName: string; /** * Quantity of the stock units. */ quantity: number; /** * Stock Keeping Unit (SKU) ID. */ sku: string; /** * Subscription start time. */ startDate: string; } } export declare namespace UsageProxy { interface GetResourceQuotasFilter { /** * The resource name. */ name: string; regex?: boolean; values: string[]; } interface GetResourceQuotasResourceQuotumCollection { /** * Used to indicate if further quota consumption isAllowed. */ isAllowed: boolean; /** * The list of resource quota details. */ items: outputs.UsageProxy.GetResourceQuotasResourceQuotumCollectionItem[]; } interface GetResourceQuotasResourceQuotumCollectionItem { /** * The affected resource name. */ affectedResource: string; /** * The quota balance. */ balance: number; /** * Used to indicate if further quota consumption isAllowed. */ isAllowed: boolean; /** * Used to indicate any resource dependencies. */ isDependency: boolean; /** * Used to indicate if overages are incurred. */ isOverage: boolean; /** * The resource name. */ name: string; /** * The purchased quota limit. */ purchasedLimit: number; /** * The service name. */ service: string; } interface GetResourcesFilter { /** * Name of the resource. */ name: string; regex?: boolean; values: string[]; } interface GetResourcesResourcesCollection { /** * The list of resource details for a service. */ items: outputs.UsageProxy.GetResourcesResourcesCollectionItem[]; } interface GetResourcesResourcesCollectionItem { /** * The details of any child resources. */ childResources: string[]; /** * Units to be used for daily aggregated data. */ dailyUnitDisplayName: string; /** * Description of the resource. */ description: string; /** * Units to be used for hourly aggregated data. */ hourlyUnitDisplayName: string; /** * Instance type for the resource. */ instanceType: string; /** * Indicates if the SKU was purchased */ isPurchased: boolean; /** * Name of the resource. */ name: string; /** * Default units to use when unspecified. */ rawUnitDisplayName: string; /** * Name of the service. */ servicename: string; /** * The details of resource Skus. */ skuses: outputs.UsageProxy.GetResourcesResourcesCollectionItemSkus[]; /** * Usage data type of the resource. */ usageDataType: string; } interface GetResourcesResourcesCollectionItemSkus { /** * The cloud credit type for the resource. */ cloudCreditType: string; /** * The Sku Id for the resource. */ skuId: string; /** * The Sku type for the resource. */ skuType: string; } interface GetSubscriptionProductItem { /** * The earned rewards for the product. */ earnedRewards: number; /** * The boolean parameter to indicate if the product is eligible to earn rewards. */ isEligibleToEarnRewards: boolean; /** * The rate card product name. */ productName: string; /** * The rate card product number. */ productNumber: string; /** * The rate card product usage amount. */ usageAmount: number; } interface GetSubscriptionProductsFilter { name: string; regex?: boolean; values: string[]; } interface GetSubscriptionProductsProductCollection { /** * The list of product rewards summaries. */ items: outputs.UsageProxy.GetSubscriptionProductsProductCollectionItem[]; } interface GetSubscriptionProductsProductCollectionItem { /** * The list of product rewards summaries. */ items: outputs.UsageProxy.GetSubscriptionProductsProductCollectionItemItem[]; } interface GetSubscriptionProductsProductCollectionItemItem { /** * The earned rewards for the product. */ earnedRewards: number; /** * The boolean parameter to indicate if the product is eligible to earn rewards. */ isEligibleToEarnRewards: boolean; /** * The rate card product name. */ productName: string; /** * The rate card product number. */ productNumber: string; /** * The rate card product usage amount. */ usageAmount: number; } interface GetSubscriptionRedeemableUserItem { /** * The email ID of the user that can redeem rewards. */ emailId: string; /** * The first name of the user that can redeem rewards. */ firstName: string; /** * The last name of the user that can redeem rewards. */ lastName: string; } interface GetSubscriptionRedeemableUsersFilter { name: string; regex?: boolean; values: string[]; } interface GetSubscriptionRedeemableUsersRedeemableUserCollection { /** * The list of user summary that can redeem rewards. */ items: outputs.UsageProxy.GetSubscriptionRedeemableUsersRedeemableUserCollectionItem[]; } interface GetSubscriptionRedeemableUsersRedeemableUserCollectionItem { /** * The list of user summary that can redeem rewards. */ items: outputs.UsageProxy.GetSubscriptionRedeemableUsersRedeemableUserCollectionItemItem[]; /** * The subscription ID for which rewards information is requested for. */ subscriptionId: string; /** * The OCID of the tenancy. */ tenancyId: string; userId: string; } interface GetSubscriptionRedeemableUsersRedeemableUserCollectionItemItem { /** * The email ID of the user that can redeem rewards. */ emailId: string; /** * The first name of the user that can redeem rewards. */ firstName: string; /** * The last name of the user that can redeem rewards. */ lastName: string; } interface GetSubscriptionRedemptionItem { /** * It provides the redeemed rewards in base/subscription currency. */ baseRewards: number; /** * It provides the fxRate between invoice currency and subscription currency. */ fxRate: number; /** * The currency associated with invoice. */ invoiceCurrency: string; /** * It provides the invoice number against the redemption. */ invoiceNumber: string; /** * It provides the invoice total amount of given redemption. */ invoiceTotalAmount: number; /** * It provides the redeemed rewards in invoice currency. */ redeemedRewards: number; /** * The redemption code used in the Billing Center during the reward redemption process. */ redemptionCode: string; /** * It provides the redemption email id. */ redemptionEmail: string; /** * It provides the invoice date. */ timeInvoiced: string; /** * It provides redeem date. */ timeRedeemed: string; } interface GetSubscriptionRedemptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSubscriptionRedemptionsRedemptionCollection { /** * The list of redemption summary. */ items: outputs.UsageProxy.GetSubscriptionRedemptionsRedemptionCollectionItem[]; } interface GetSubscriptionRedemptionsRedemptionCollectionItem { /** * The list of redemption summary. */ items: outputs.UsageProxy.GetSubscriptionRedemptionsRedemptionCollectionItemItem[]; } interface GetSubscriptionRedemptionsRedemptionCollectionItemItem { /** * It provides the redeemed rewards in base/subscription currency. */ baseRewards: number; /** * It provides the fxRate between invoice currency and subscription currency. */ fxRate: number; /** * The currency associated with invoice. */ invoiceCurrency: string; /** * It provides the invoice number against the redemption. */ invoiceNumber: string; /** * It provides the invoice total amount of given redemption. */ invoiceTotalAmount: number; /** * It provides the redeemed rewards in invoice currency. */ redeemedRewards: number; /** * The redemption code used in the Billing Center during the reward redemption process. */ redemptionCode: string; /** * It provides the redemption email id. */ redemptionEmail: string; /** * It provides the invoice date. */ timeInvoiced: string; /** * It provides redeem date. */ timeRedeemed: string; } interface GetSubscriptionRewardItem { /** * The number of rewards available for a specific usage period. */ availableRewards: number; /** * The number of rewards earned for the specific usage period. */ earnedRewards: number; /** * The eligible usage amount for the usage period. */ eligibleUsageAmount: number; /** * The ineligible usage amount for the usage period. */ ineligibleUsageAmount: number; /** * The boolean parameter to indicate whether or not the available rewards are manually posted. */ isManual: boolean; /** * The number of rewards redeemed for a specific month. */ redeemedRewards: number; /** * The date and time when rewards accrue. */ timeRewardsEarned: string; /** * The date and time when rewards expire. */ timeRewardsExpired: string; /** * The end date and time for the usage period. */ timeUsageEnded: string; /** * The start date and time for the usage period. */ timeUsageStarted: string; /** * The usage amount for the usage period. */ usageAmount: number; /** * The usage period ID. */ usagePeriodKey: string; } interface GetSubscriptionRewardSummary { /** * The currency unit for the reward amount. */ currency: string; /** * The redemption code used in the Billing Center during the reward redemption process. */ redemptionCode: string; /** * The current Rewards percentage in decimal format. */ rewardsRate: number; /** * The subscription ID for which rewards information is requested for. */ subscriptionId: string; /** * The OCID of the tenancy. */ tenancyId: string; /** * The total number of available rewards for a given subscription ID. */ totalRewardsAvailable: number; } interface GetSubscriptionRewardsFilter { name: string; regex?: boolean; values: string[]; } interface GetSubscriptionRewardsRewardCollection { /** * The monthly summary of rewards. */ items: outputs.UsageProxy.GetSubscriptionRewardsRewardCollectionItem[]; } interface GetSubscriptionRewardsRewardCollectionItem { /** * The monthly summary of rewards. */ items: outputs.UsageProxy.GetSubscriptionRewardsRewardCollectionItemItem[]; /** * The overall monthly reward summary. */ summaries: outputs.UsageProxy.GetSubscriptionRewardsRewardCollectionItemSummary[]; } interface GetSubscriptionRewardsRewardCollectionItemItem { /** * The number of rewards available for a specific usage period. */ availableRewards: number; /** * The number of rewards earned for the specific usage period. */ earnedRewards: number; /** * The eligible usage amount for the usage period. */ eligibleUsageAmount: number; /** * The ineligible usage amount for the usage period. */ ineligibleUsageAmount: number; /** * The boolean parameter to indicate whether or not the available rewards are manually posted. */ isManual: boolean; /** * The number of rewards redeemed for a specific month. */ redeemedRewards: number; /** * The date and time when rewards accrue. */ timeRewardsEarned: string; /** * The date and time when rewards expire. */ timeRewardsExpired: string; /** * The end date and time for the usage period. */ timeUsageEnded: string; /** * The start date and time for the usage period. */ timeUsageStarted: string; /** * The usage amount for the usage period. */ usageAmount: number; /** * The usage period ID. */ usagePeriodKey: string; } interface GetSubscriptionRewardsRewardCollectionItemSummary { /** * The currency unit for the reward amount. */ currency: string; /** * The redemption code used in the Billing Center during the reward redemption process. */ redemptionCode: string; /** * The current Rewards percentage in decimal format. */ rewardsRate: number; /** * The subscription ID for which rewards information is requested for. */ subscriptionId: string; /** * The OCID of the tenancy. */ tenancyId: string; /** * The total number of available rewards for a given subscription ID. */ totalRewardsAvailable: number; } interface GetUsagelimitsFilter { name: string; regex?: boolean; values: string[]; } interface GetUsagelimitsUsageLimitCollection { /** * The list of usage limits. */ items: outputs.UsageProxy.GetUsagelimitsUsageLimitCollectionItem[]; } interface GetUsagelimitsUsageLimitCollectionItem { /** * The action when usage limit is hit */ action: string; /** * The alert level of the usage limit */ alertLevel: number; /** * The user who created the limit */ createdBy: string; /** * Entitlement ID of the usage limit */ entitlementId: string; /** * The usage limit ID */ id: string; limit: string; /** * Hard or soft limit. Hard limits lead to breaches, soft to alerts. */ limitType: string; /** * The maximum hard limit set for the usage limit */ maxHardLimit: string; /** * The user who modified the limit */ modifiedBy: string; /** * The resource for which the limit is defined */ resourceName: string; /** * The service for which the limit is defined */ serviceName: string; /** * The SKU for which the usage limit is set */ skuPartId: string; /** * The usage limit lifecycle state. */ state: string; /** * Time when the usage limit was created */ timeCreated: string; /** * Time when the usage limit was modified */ timeModified: string; /** * The value type of the usage limit */ valueType: string; } interface SubscriptionRedeemableUserItem { /** * The email ID for a user that can redeem rewards. */ emailId: string; /** * The first name of the user that can redeem rewards. */ firstName: string; /** * The last name of the user that can redeem rewards. */ lastName: string; } } export declare namespace Vault { interface GetSecretReplicationConfig { /** * (Optional) A Boolean value to enable forwarding of write requests from replicated secrets to the source secrets. The default value of false disables this option. */ isWriteForwardEnabled: boolean; /** * List of the secret replication targets. By default, a maximum of 3 targets is allowed. To configure more than 3 targets, an override is required. */ replicationTargets: outputs.Vault.GetSecretReplicationConfigReplicationTarget[]; } interface GetSecretReplicationConfigReplicationTarget { /** * The OCID of the target region KMS key. */ targetKeyId: string; /** * The name of the target's region. */ targetRegion: string; /** * The OCID of the target region's Vault. */ targetVaultId: string; } interface GetSecretRotationConfig { /** * Enables auto rotation, when set to true rotationInterval must be set. */ isScheduledRotationEnabled: boolean; /** * The time interval that indicates the frequency for rotating secret data, as described in ISO 8601 format. The minimum value is 1 day and maximum value is 360 days. For example, if you want to set the time interval for rotating a secret data as 30 days, the duration is expressed as "P30D." */ rotationInterval: string; /** * The TargetSystemDetails provides the targetSystem type and type-specific connection metadata */ targetSystemDetails: outputs.Vault.GetSecretRotationConfigTargetSystemDetail[]; } interface GetSecretRotationConfigTargetSystemDetail { /** * The unique identifier (OCID) for the autonomous database that Vault Secret connects to. */ adbId: string; /** * The unique identifier (OCID) of the Oracle Cloud Infrastructure Functions that vault secret connects to. */ functionId: string; /** * Unique identifier of the target system that Vault Secret connects to. */ targetSystemType: string; } interface GetSecretSecretContent { content: string; contentType: string; name: string; stage: string; } interface GetSecretSecretGenerationContext { /** * Name of random bytes generation template for generating random byte type secret. */ generationTemplate: string; /** * Name of the predefined secret generation type. */ generationType: string; /** * Length of the passphrase to be generated */ passphraseLength: number; /** * SecretTemplate captures structure in which customer wants to store secrets. This is optional and a default structure is available for each secret type. The template can have any structure with static values that are not generated. Within the template, you can insert predefined placeholders to store secrets. These placeholders are later replaced with the generated content and saved as a Base64 encoded content. */ secretTemplate: string; } interface GetSecretSecretRule { /** * A property indicating whether the rule is applied even if the secret version with the content you are trying to reuse was deleted. */ isEnforcedOnDeletedSecretVersions: boolean; /** * A property indicating whether to block retrieval of the secret content, on expiry. The default is false. If the secret has already expired and you would like to retrieve the secret contents, you need to edit the secret rule to disable this property, to allow reading the secret content. */ isSecretContentRetrievalBlockedOnExpiry: boolean; /** * The type of rule, which either controls when the secret contents expire or whether they can be reused. */ ruleType: string; /** * A property indicating how long the secret contents will be considered valid, expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format. The secret needs to be updated when the secret content expires. The timer resets after you update the secret contents. The minimum value is 1 day and the maximum value is 90 days for this property. Currently, only intervals expressed in days are supported. For example, pass `P3D` to have the secret version expire every 3 days. */ secretVersionExpiryInterval: string; /** * An optional property indicating the absolute time when this secret will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. The minimum number of days from current time is 1 day and the maximum number of days from current time is 365 days. Example: `2019-04-03T21:10:29.600Z` */ timeOfAbsoluteExpiry: string; } interface GetSecretSourceRegionInformation { /** * The OCID of the source region KMS key. */ sourceKeyId: string; /** * The name of the source's region. */ sourceRegion: string; /** * The OCID of the source region's Vault. */ sourceVaultId: string; } interface GetSecretsFilter { /** * The secret name. */ name: string; regex?: boolean; values: string[]; } interface GetSecretsSecret { /** * The OCID of the compartment. */ compartmentId: string; /** * The version number of the secret version that's currently in use. */ currentVersionNumber: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A brief description of the secret. Avoid entering confidential information. */ description: string; enableAutoGeneration: boolean; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the secret. */ id: string; /** * The value of this flag determines whether or not secret content will be generated automatically. */ isAutoGenerationEnabled: boolean; /** * A Boolean value that indicates whether the secret is a source or replica secret. */ isReplica: boolean; /** * The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify. */ keyId: string; /** * A property indicating when the secret was last rotated successfully, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` */ lastRotationTime: string; /** * Additional information about the current lifecycle state of the secret. */ lifecycleDetails: string; /** * Additional metadata that you can use to provide context about how to use the secret or during rotation or other administrative tasks. For example, for a secret that you use to connect to a database, the additional metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs. */ metadata: { [key: string]: string; }; /** * A property indicating when the secret is scheduled to be rotated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` */ nextRotationTime: string; /** * Defines the configuration that enables cross-region secret replication. */ replicationConfigs: outputs.Vault.GetSecretsSecretReplicationConfig[]; /** * Defines the frequency of the rotation and the information about the target system */ rotationConfigs: outputs.Vault.GetSecretsSecretRotationConfig[]; /** * Additional information about the status of the secret rotation */ rotationStatus: string; secretContents: outputs.Vault.GetSecretsSecretSecretContent[]; /** * Captures a configurable set of secret generation rules such as length, base characters, additional characters, and so on. */ secretGenerationContexts: outputs.Vault.GetSecretsSecretSecretGenerationContext[]; /** * The user-friendly name of the secret. Avoid entering confidential information. */ secretName: string; /** * A list of rules that control how the secret is used and managed. */ secretRules: outputs.Vault.GetSecretsSecretSecretRule[]; /** * Details for the source that the source secret has. */ sourceRegionInformations: outputs.Vault.GetSecretsSecretSourceRegionInformation[]; /** * A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive. */ state: string; /** * A property indicating when the secret was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` */ timeCreated: string; /** * An optional property indicating when the current secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` */ timeOfCurrentVersionExpiry: string; /** * An optional property indicating when to delete the secret, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z` */ timeOfDeletion: string; /** * The OCID of the vault. */ vaultId: string; } interface GetSecretsSecretReplicationConfig { /** * (Optional) A Boolean value to enable forwarding of write requests from replicated secrets to the source secrets. The default value of false disables this option. */ isWriteForwardEnabled: boolean; /** * List of the secret replication targets. By default, a maximum of 3 targets is allowed. To configure more than 3 targets, an override is required. */ replicationTargets: outputs.Vault.GetSecretsSecretReplicationConfigReplicationTarget[]; } interface GetSecretsSecretReplicationConfigReplicationTarget { /** * The OCID of the target region KMS key. */ targetKeyId: string; /** * The name of the target's region. */ targetRegion: string; /** * The OCID of the target region's Vault. */ targetVaultId: string; } interface GetSecretsSecretRotationConfig { /** * Enables auto rotation, when set to true rotationInterval must be set. */ isScheduledRotationEnabled: boolean; /** * The time interval that indicates the frequency for rotating secret data, as described in ISO 8601 format. The minimum value is 1 day and maximum value is 360 days. For example, if you want to set the time interval for rotating a secret data as 30 days, the duration is expressed as "P30D." */ rotationInterval: string; /** * The TargetSystemDetails provides the targetSystem type and type-specific connection metadata */ targetSystemDetails: outputs.Vault.GetSecretsSecretRotationConfigTargetSystemDetail[]; } interface GetSecretsSecretRotationConfigTargetSystemDetail { /** * The unique identifier (OCID) for the autonomous database that Vault Secret connects to. */ adbId: string; /** * The unique identifier (OCID) of the Oracle Cloud Infrastructure Functions that vault secret connects to. */ functionId: string; /** * Unique identifier of the target system that Vault Secret connects to. */ targetSystemType: string; } interface GetSecretsSecretSecretContent { content: string; contentType: string; /** * The secret name. */ name: string; stage: string; } interface GetSecretsSecretSecretGenerationContext { /** * Name of random bytes generation template for generating random byte type secret. */ generationTemplate: string; /** * Name of the predefined secret generation type. */ generationType: string; /** * Length of the passphrase to be generated */ passphraseLength: number; /** * SecretTemplate captures structure in which customer wants to store secrets. This is optional and a default structure is available for each secret type. The template can have any structure with static values that are not generated. Within the template, you can insert predefined placeholders to store secrets. These placeholders are later replaced with the generated content and saved as a Base64 encoded content. */ secretTemplate: string; } interface GetSecretsSecretSecretRule { /** * A property indicating whether the rule is applied even if the secret version with the content you are trying to reuse was deleted. */ isEnforcedOnDeletedSecretVersions: boolean; /** * A property indicating whether to block retrieval of the secret content, on expiry. The default is false. If the secret has already expired and you would like to retrieve the secret contents, you need to edit the secret rule to disable this property, to allow reading the secret content. */ isSecretContentRetrievalBlockedOnExpiry: boolean; /** * The type of rule, which either controls when the secret contents expire or whether they can be reused. */ ruleType: string; /** * A property indicating how long the secret contents will be considered valid, expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format. The secret needs to be updated when the secret content expires. The timer resets after you update the secret contents. The minimum value is 1 day and the maximum value is 90 days for this property. Currently, only intervals expressed in days are supported. For example, pass `P3D` to have the secret version expire every 3 days. */ secretVersionExpiryInterval: string; /** * An optional property indicating the absolute time when this secret will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. The minimum number of days from current time is 1 day and the maximum number of days from current time is 365 days. Example: `2019-04-03T21:10:29.600Z` */ timeOfAbsoluteExpiry: string; } interface GetSecretsSecretSourceRegionInformation { /** * The OCID of the source region KMS key. */ sourceKeyId: string; /** * The name of the source's region. */ sourceRegion: string; /** * The OCID of the source region's Vault. */ sourceVaultId: string; } interface SecretReplicationConfig { /** * (Updatable) (Optional) A Boolean value to enable forwarding of write requests from replicated secrets to the source secrets. The default value of false disables this option. */ isWriteForwardEnabled?: boolean; /** * (Updatable) List of the secret replication targets. By default, a maximum of 3 targets is allowed. To configure more than 3 targets, an override is required. */ replicationTargets: outputs.Vault.SecretReplicationConfigReplicationTarget[]; } interface SecretReplicationConfigReplicationTarget { /** * (Updatable) The OCID of the target region KMS key. */ targetKeyId: string; /** * (Updatable) The name of the target's region. */ targetRegion: string; /** * (Updatable) The OCID of the target region's Vault. */ targetVaultId: string; } interface SecretRotationConfig { /** * (Updatable) Enables auto rotation, when set to true rotationInterval must be set. */ isScheduledRotationEnabled: boolean; /** * (Updatable) The time interval that indicates the frequency for rotating secret data, as described in ISO 8601 format. The minimum value is 1 day and maximum value is 360 days. For example, if you want to set the time interval for rotating a secret data as 30 days, the duration is expressed as "P30D." */ rotationInterval: string; /** * (Updatable) The TargetSystemDetails provides the targetSystem type and type-specific connection metadata */ targetSystemDetails: outputs.Vault.SecretRotationConfigTargetSystemDetails; } interface SecretRotationConfigTargetSystemDetails { /** * (Updatable) The unique identifier (OCID) for the autonomous database that Vault Secret connects to. */ adbId: string; /** * (Updatable) The unique identifier (OCID) of the Oracle Cloud Infrastructure Functions that vault secret connects to. */ functionId: string; /** * (Updatable) Unique identifier of the target system that Vault Secret connects to. */ targetSystemType: string; } interface SecretSecretContent { /** * (Updatable) The base64-encoded content of the secret. */ content?: string; /** * (Updatable) The base64-encoded content of the secret. */ contentType: string; /** * (Updatable) Names should be unique within a secret. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. */ name?: string; /** * (Updatable) The rotation state of the secret content. The default is `CURRENT`, meaning that the secret is currently in use. A secret version that you mark as `PENDING` is staged and available for use, but you don't yet want to rotate it into current, active use. For example, you might create or update a secret and mark its rotation state as `PENDING` if you haven't yet updated the secret on the target system. When creating a secret, only the value `CURRENT` is applicable, although the value `LATEST` is also automatically applied. When updating a secret, you can specify a version's rotation state as either `CURRENT` or `PENDING`. */ stage: string; } interface SecretSecretGenerationContext { /** * (Updatable) Name of random bytes generation template for generating random byte type secret. */ generationTemplate: string; /** * (Updatable) Name of the predefined secret generation type. */ generationType: string; /** * (Updatable) Length of the passphrase to be generated */ passphraseLength?: number; /** * (Updatable) SecretTemplate captures structure in which customer wants to store secrets. This is optional and a default structure is available for each secret type. The template can have any structure with static values that are not generated. Within the template, you can insert predefined placeholders to store secrets. These placeholders are later replaced with the generated content and saved as a Base64 encoded content. */ secretTemplate?: string; } interface SecretSecretRule { /** * (Updatable) A property indicating whether the rule is applied even if the secret version with the content you are trying to reuse was deleted. */ isEnforcedOnDeletedSecretVersions: boolean; /** * (Updatable) A property indicating whether to block retrieval of the secret content, on expiry. The default is false. If the secret has already expired and you would like to retrieve the secret contents, you need to edit the secret rule to disable this property, to allow reading the secret content. */ isSecretContentRetrievalBlockedOnExpiry: boolean; /** * (Updatable) The type of rule, which either controls when the secret contents expire or whether they can be reused. */ ruleType: string; /** * (Updatable) A property indicating how long the secret contents will be considered valid, expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format. The secret needs to be updated when the secret content expires. The timer resets after you update the secret contents. The minimum value is 1 day and the maximum value is 90 days for this property. Currently, only intervals expressed in days are supported. For example, pass `P3D` to have the secret version expire every 3 days. */ secretVersionExpiryInterval: string; /** * (Updatable) An optional property indicating the absolute time when this secret will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. The minimum number of days from current time is 1 day and the maximum number of days from current time is 365 days. Example: `2019-04-03T21:10:29.600Z` */ timeOfAbsoluteExpiry: string; } interface SecretSourceRegionInformation { /** * The OCID of the source region KMS key. */ sourceKeyId: string; /** * The name of the source's region. */ sourceRegion: string; /** * The OCID of the source region's Vault. */ sourceVaultId: string; } } export declare namespace Vbs { interface GetInstVbsInstancesFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetInstVbsInstancesVbsInstanceSummaryCollection { items: outputs.Vbs.GetInstVbsInstancesVbsInstanceSummaryCollectionItem[]; } interface GetInstVbsInstancesVbsInstanceSummaryCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Service instance display name */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * unique VbsInstance identifier */ id: string; idcsAccessToken: string; /** * Whether the VBS service instance owner explicitly approved VBS to create and use resources in the customer tenancy */ isResourceUsageAgreementGranted: boolean; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ lifecyleDetails: string; /** * A filter to return only resources that match the entire name given. */ name: string; /** * Compartment where VBS may create additional resources for the service instance */ resourceCompartmentId: string; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the VbsInstance was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the VbsInstance was updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * Public web URL for accessing the VBS service instance */ vbsAccessUrl: string; } } export declare namespace VisualBuilder { interface GetVbInstanceAlternateCustomEndpoint { /** * Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified). */ certificateSecretVersion: number; /** * A custom hostname to be used for the vb instance URL, in FQDN format. */ hostname: string; } interface GetVbInstanceApplicationsApplicationSummaryCollection { items: outputs.VisualBuilder.GetVbInstanceApplicationsApplicationSummaryCollectionItem[]; } interface GetVbInstanceApplicationsApplicationSummaryCollectionItem { /** * The Visual Builder application identifier. */ id: string; /** * The Visual Builder application project identifier. */ projectId: string; /** * The state of visual builder application. Either LIVE or STAGED */ state: string; /** * The Visual Builder application version */ version: string; } interface GetVbInstanceCustomEndpoint { /** * Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified). */ certificateSecretVersion: number; /** * A custom hostname to be used for the vb instance URL, in FQDN format. */ hostname: string; } interface GetVbInstanceNetworkEndpointDetail { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5/32", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.VisualBuilder.GetVbInstanceNetworkEndpointDetailAllowlistedHttpVcn[]; /** * The type of network endpoint. */ networkEndpointType: string; /** * Network Security Group OCIDs for the Private Endpoint. */ networkSecurityGroupIds: string[]; /** * The IP address to be assigned to Private Endpoint */ privateEndpointIp: string; /** * The subnet OCID for the private endpoint. */ subnetId: string; } interface GetVbInstanceNetworkEndpointDetailAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5/32", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIpCidrs: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface GetVbInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetVbInstancesVbInstanceSummaryCollection { items: outputs.VisualBuilder.GetVbInstancesVbInstanceSummaryCollectionItem[]; } interface GetVbInstancesVbInstanceSummaryCollectionItem { /** * A list of alternate custom endpoints used for the vb instance URL. */ alternateCustomEndpoints: outputs.VisualBuilder.GetVbInstancesVbInstanceSummaryCollectionItemAlternateCustomEndpoint[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The entitlement used for billing purposes. */ consumptionModel: string; /** * Details for a custom endpoint for the vb instance. */ customEndpoints: outputs.VisualBuilder.GetVbInstancesVbInstanceSummaryCollectionItemCustomEndpoint[]; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource` */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The Virtual Cloud Network OCID. */ id: string; idcsOpenId: string; /** * The Vb Instance URL. */ instanceUrl: string; /** * Visual Builder is enabled or not. */ isVisualBuilderEnabled: boolean; /** * The NAT gateway IP address for the VB management VCN */ managementNatGatewayIp: string; /** * The Oracle Cloud ID (OCID) of the Visual Builder management VCN */ managementVcnId: string; /** * Base representation of a network endpoint. In input payload to update an Visual Builder instance endpoint details, an empty payload will clear out any existing configuration for Public Visual Builder instance. */ networkEndpointDetails: outputs.VisualBuilder.GetVbInstancesVbInstanceSummaryCollectionItemNetworkEndpointDetail[]; /** * The number of Nodes */ nodeCount: number; /** * The NAT gateway IP address for the VB service VCN */ serviceNatGatewayIp: string; /** * The Oracle Cloud ID (OCID) of the Visual Builder service VCN */ serviceVcnId: string; /** * Life cycle state to query on. */ state: string; /** * An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. */ stateMessage: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the VbInstance was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the VbInstance was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetVbInstancesVbInstanceSummaryCollectionItemAlternateCustomEndpoint { /** * Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified). */ certificateSecretVersion: number; /** * A custom hostname to be used for the vb instance URL, in FQDN format. */ hostname: string; } interface GetVbInstancesVbInstanceSummaryCollectionItemCustomEndpoint { /** * Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified). */ certificateSecretVersion: number; /** * A custom hostname to be used for the vb instance URL, in FQDN format. */ hostname: string; } interface GetVbInstancesVbInstanceSummaryCollectionItemNetworkEndpointDetail { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5/32", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.VisualBuilder.GetVbInstancesVbInstanceSummaryCollectionItemNetworkEndpointDetailAllowlistedHttpVcn[]; /** * The type of network endpoint. */ networkEndpointType: string; /** * Network Security Group OCIDs for the Private Endpoint. */ networkSecurityGroupIds: string[]; /** * The IP address to be assigned to Private Endpoint */ privateEndpointIp: string; /** * The subnet OCID for the private endpoint. */ subnetId: string; } interface GetVbInstancesVbInstanceSummaryCollectionItemNetworkEndpointDetailAllowlistedHttpVcn { /** * Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5/32", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIpCidrs: string[]; /** * The Virtual Cloud Network OCID. */ id: string; } interface VbInstanceAlternateCustomEndpoint { /** * (Updatable) Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified). */ certificateSecretVersion: number; /** * (Updatable) A custom hostname to be used for the vb instance URL, in FQDN format. */ hostname: string; } interface VbInstanceCustomEndpoint { /** * (Updatable) Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. */ certificateSecretId: string; /** * The secret version used for the certificate-secret-id (if certificate-secret-id is specified). */ certificateSecretVersion: number; /** * (Updatable) A custom hostname to be used for the vb instance URL, in FQDN format. */ hostname: string; } interface VbInstanceNetworkEndpointDetails { /** * (Updatable) Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5/32", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedHttpIps: string[]; /** * (Updatable) Virtual Cloud Networks allowed to access this network endpoint. */ allowlistedHttpVcns: outputs.VisualBuilder.VbInstanceNetworkEndpointDetailsAllowlistedHttpVcn[]; /** * (Updatable) The type of network endpoint. * * For private endpoint access */ networkEndpointType: string; /** * (Updatable) Network Security Group OCIDs for the Private Endpoint. */ networkSecurityGroupIds: string[]; /** * The IP address to be assigned to Private Endpoint */ privateEndpointIp: string; /** * (Updatable) The subnet OCID for the private endpoint. * * For public network access control */ subnetId?: string; } interface VbInstanceNetworkEndpointDetailsAllowlistedHttpVcn { /** * (Updatable) Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5/32", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. */ allowlistedIpCidrs: string[]; /** * (Updatable) The Virtual Cloud Network OCID. */ id: string; } } export declare namespace VnMonitoring { interface GetPathAnalyzerTestDestinationEndpoint { /** * The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object. */ address: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. */ instanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. */ listenerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's load balancer. */ loadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. */ networkLoadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. */ psaId: string; /** * The current state of the `PathAnalyzerTest` resource. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). */ subnetId: string; /** * The type of the `Endpoint`. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). */ vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. */ vnicId: string; } interface GetPathAnalyzerTestProtocolParameter { /** * The destination port to use in a `PathAnalyzerTest` resource. */ destinationPort: number; /** * The [ICMP](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) code. */ icmpCode: number; /** * The [ICMP](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) type. */ icmpType: number; /** * The source port to use in a `PathAnalyzerTest` resource. */ sourcePort: number; /** * The type of the `Endpoint`. */ type: string; } interface GetPathAnalyzerTestQueryOption { /** * If true, a path analysis is done for both the forward and reverse routes. */ isBiDirectionalAnalysis: boolean; } interface GetPathAnalyzerTestSourceEndpoint { /** * The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object. */ address: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. */ instanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. */ listenerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's load balancer. */ loadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. */ networkLoadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. */ psaId: string; /** * The current state of the `PathAnalyzerTest` resource. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). */ subnetId: string; /** * The type of the `Endpoint`. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). */ vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. */ vnicId: string; } interface GetPathAnalyzerTestsFilter { name: string; regex?: boolean; values: string[]; } interface GetPathAnalyzerTestsPathAnalyzerTestCollection { items: outputs.VnMonitoring.GetPathAnalyzerTestsPathAnalyzerTestCollectionItem[]; } interface GetPathAnalyzerTestsPathAnalyzerTestCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Information describing a source or destination in a `PathAnalyzerTest` resource. */ destinationEndpoints: outputs.VnMonitoring.GetPathAnalyzerTestsPathAnalyzerTestCollectionItemDestinationEndpoint[]; /** * A filter that returns only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A unique identifier established when the resource is created. The identifier can't be changed later. */ id: string; /** * The IP protocol to use for the `PathAnalyzerTest` resource. */ protocol: number; /** * Defines the IP protocol parameters for a `PathAnalyzerTest` resource. */ protocolParameters: outputs.VnMonitoring.GetPathAnalyzerTestsPathAnalyzerTestCollectionItemProtocolParameter[]; /** * Defines the query options required for a `PathAnalyzerTest` resource. */ queryOptions: outputs.VnMonitoring.GetPathAnalyzerTestsPathAnalyzerTestCollectionItemQueryOption[]; /** * Information describing a source or destination in a `PathAnalyzerTest` resource. */ sourceEndpoints: outputs.VnMonitoring.GetPathAnalyzerTestsPathAnalyzerTestCollectionItemSourceEndpoint[]; /** * A filter that returns only resources whose `lifecycleState` matches the given `lifecycleState`. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the `PathAnalyzerTest` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated: string; /** * The date and time the `PathAnalyzerTest` resource was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated: string; } interface GetPathAnalyzerTestsPathAnalyzerTestCollectionItemDestinationEndpoint { /** * The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object. */ address: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. */ instanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. */ listenerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's load balancer. */ loadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. */ networkLoadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. */ psaId: string; /** * A filter that returns only resources whose `lifecycleState` matches the given `lifecycleState`. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). */ subnetId: string; /** * The type of the `Endpoint`. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). */ vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. */ vnicId: string; } interface GetPathAnalyzerTestsPathAnalyzerTestCollectionItemProtocolParameter { /** * The destination port to use in a `PathAnalyzerTest` resource. */ destinationPort: number; /** * The [ICMP](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) code. */ icmpCode: number; /** * The [ICMP](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) type. */ icmpType: number; /** * The source port to use in a `PathAnalyzerTest` resource. */ sourcePort: number; /** * The type of the `Endpoint`. */ type: string; } interface GetPathAnalyzerTestsPathAnalyzerTestCollectionItemQueryOption { /** * If true, a path analysis is done for both the forward and reverse routes. */ isBiDirectionalAnalysis: boolean; } interface GetPathAnalyzerTestsPathAnalyzerTestCollectionItemSourceEndpoint { /** * The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object. */ address: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. */ instanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. */ listenerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's load balancer. */ loadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. */ networkLoadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. */ psaId: string; /** * A filter that returns only resources whose `lifecycleState` matches the given `lifecycleState`. */ state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). */ subnetId: string; /** * The type of the `Endpoint`. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). */ vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. */ vnicId: string; } interface PathAnalysiDestinationEndpoint { /** * The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object. */ address: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. */ instanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. */ listenerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's load balancer. */ loadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. */ networkLoadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. */ psaId: string; state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). */ subnetId: string; /** * The type of the `Endpoint`. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). */ vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. */ vnicId: string; } interface PathAnalysiProtocolParameters { /** * The destination port to use in a `PathAnalyzerTest` resource. */ destinationPort: number; /** * The [ICMP](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) code. */ icmpCode: number; /** * The [ICMP](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) type. */ icmpType: number; /** * The source port to use in a `PathAnalyzerTest` resource. */ sourcePort: number; /** * The type of the `ProtocolParameters` object. */ type: string; } interface PathAnalysiQueryOptions { /** * If true, a path analysis is done for both the forward and reverse routes. */ isBiDirectionalAnalysis: boolean; } interface PathAnalysiSourceEndpoint { /** * The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object. */ address: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. */ instanceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. */ listenerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's load balancer. */ loadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. */ networkLoadBalancerId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. */ psaId: string; state: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). */ subnetId: string; /** * The type of the `Endpoint`. */ type: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). */ vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. */ vnicId: string; } interface PathAnalyzerTestDestinationEndpoint { /** * (Updatable) The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object. */ address: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. */ instanceId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. */ listenerId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's load balancer. */ loadBalancerId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. */ networkLoadBalancerId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. */ psaId: string; /** * The current state of the `PathAnalyzerTest` resource. */ state: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). */ subnetId: string; /** * (Updatable) The type of the `Endpoint`. */ type: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). */ vlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. */ vnicId: string; } interface PathAnalyzerTestProtocolParameters { /** * (Updatable) The destination port to use in a `PathAnalyzerTest` resource. */ destinationPort: number; /** * (Updatable) The [ICMP](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) code. */ icmpCode: number; /** * (Updatable) The [ICMP](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) type. */ icmpType: number; /** * (Updatable) The source port to use in a `PathAnalyzerTest` resource. */ sourcePort: number; /** * (Updatable) The type of the `ProtocolParameters` object. */ type: string; } interface PathAnalyzerTestQueryOptions { /** * (Updatable) If true, a path analysis is done for both the forward and reverse routes. */ isBiDirectionalAnalysis: boolean; } interface PathAnalyzerTestSourceEndpoint { /** * (Updatable) The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object. */ address: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance. */ instanceId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener. */ listenerId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's load balancer. */ loadBalancerId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer. */ networkLoadBalancerId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PSA. */ psaId: string; /** * The current state of the `PathAnalyzerTest` resource. */ state: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges). */ subnetId: string; /** * (Updatable) The type of the `Endpoint`. */ type: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges). */ vlanId: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vnicId: string; } } export declare namespace VulnerabilityScanning { interface ContainerScanRecipeScanSettings { /** * (Updatable) The scan level * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ scanLevel: string; } interface ContainerScanTargetTargetRegistry { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to perform the scans in. All listed repositories must be in the compartment. */ compartmentId: string; /** * (Updatable) List of repositories to scan images in. If left empty, the target defaults to scanning all repos in the compartmentId */ repositories: string[]; /** * (Updatable) The scan level */ type: string; /** * (Updatable) URL of the registry. Required for non-OCIR registry types (for OCIR registry types, it can be inferred from the tenancy). * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ url: string; } interface GetContainerScanRecipeScanSetting { /** * The scan level */ scanLevel: string; } interface GetContainerScanRecipesContainerScanRecipeSummaryCollection { items: outputs.VulnerabilityScanning.GetContainerScanRecipesContainerScanRecipeSummaryCollectionItem[]; } interface GetContainerScanRecipesContainerScanRecipeSummaryCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan recipe. Immutable and generated on creation. */ id: string; /** * This field is set equal to the number of images we want to scan in the first go when the recipe is created */ imageCount: number; /** * A collection of container scan settings */ scanSettings: outputs.VulnerabilityScanning.GetContainerScanRecipesContainerScanRecipeSummaryCollectionItemScanSetting[]; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Date and time the recipe was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) */ timeCreated: string; /** * Date and time the recipe was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) */ timeUpdated: string; } interface GetContainerScanRecipesContainerScanRecipeSummaryCollectionItemScanSetting { /** * The scan level */ scanLevel: string; } interface GetContainerScanRecipesFilter { name: string; regex?: boolean; values: string[]; } interface GetContainerScanTargetTargetRegistry { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to perform the scans in. All listed repositories must be in the compartment. */ compartmentId: string; /** * List of repositories to scan images in. If left empty, the target defaults to scanning all repos in the compartmentId */ repositories: string[]; /** * The scan level */ type: string; /** * URL of the registry. */ url: string; } interface GetContainerScanTargetsContainerScanTargetSummaryCollection { items: outputs.VulnerabilityScanning.GetContainerScanTargetsContainerScanTargetSummaryCollectionItem[]; } interface GetContainerScanTargetsContainerScanTargetSummaryCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * ID of the container scan recipe this target applies. */ containerScanRecipeId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Target description. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of container scan target. Immutable and generated on creation. */ id: string; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Registry information for a container scan target */ targetRegistries: outputs.VulnerabilityScanning.GetContainerScanTargetsContainerScanTargetSummaryCollectionItemTargetRegistry[]; /** * Date and time the target was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) */ timeCreated: string; /** * Date and time the target was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) */ timeUpdated: string; } interface GetContainerScanTargetsContainerScanTargetSummaryCollectionItemTargetRegistry { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * List of repositories to scan images in. If left empty, the target defaults to scanning all repos in the compartmentId */ repositories: string[]; /** * The scan level */ type: string; /** * URL of the registry. */ url: string; } interface GetContainerScanTargetsFilter { name: string; regex?: boolean; values: string[]; } interface GetHostScanRecipeAgentSetting { /** * Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor. */ agentConfigurations: outputs.VulnerabilityScanning.GetHostScanRecipeAgentSettingAgentConfiguration[]; /** * The scan level */ scanLevel: string; } interface GetHostScanRecipeAgentSettingAgentConfiguration { /** * CIS (Center for Internet Security) Benchmark scan settings for a host scan */ cisBenchmarkSettings: outputs.VulnerabilityScanning.GetHostScanRecipeAgentSettingAgentConfigurationCisBenchmarkSetting[]; /** * Endpoint Protection scan settings for a host scan */ endpointProtectionSettings: outputs.VulnerabilityScanning.GetHostScanRecipeAgentSettingAgentConfigurationEndpointProtectionSetting[]; /** * Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped. */ shouldUnInstall: boolean; /** * Vault secret OCID which stores license information. Content inside this secret in vault would be base64 string containing information about customer's Qualys susbcription license. */ vaultSecretId: string; /** * Vendor to use for the host scan agent. */ vendor: string; /** * Vendor to use for the host scan agent. */ vendorType: string; } interface GetHostScanRecipeAgentSettingAgentConfigurationCisBenchmarkSetting { /** * The scan level */ scanLevel: string; } interface GetHostScanRecipeAgentSettingAgentConfigurationEndpointProtectionSetting { /** * The scan level */ scanLevel: string; } interface GetHostScanRecipeApplicationSetting { /** * Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation) */ applicationScanRecurrence: string; /** * List of folders selected for scanning */ foldersToScans: outputs.VulnerabilityScanning.GetHostScanRecipeApplicationSettingFoldersToScan[]; /** * Enable or disable application scan */ isEnabled: boolean; } interface GetHostScanRecipeApplicationSettingFoldersToScan { /** * Folder to be scanned in the corresponding operating system */ folder: string; /** * Operating system type */ operatingsystem: string; } interface GetHostScanRecipePortSetting { /** * The scan level */ scanLevel: string; } interface GetHostScanRecipeSchedule { /** * Day of week the scheduled scan occurs (not applicable for DAILY type) */ dayOfWeek: string; /** * How often the scan occurs */ type: string; } interface GetHostScanRecipesFilter { name: string; regex?: boolean; values: string[]; } interface GetHostScanRecipesHostScanRecipeSummaryCollection { items: outputs.VulnerabilityScanning.GetHostScanRecipesHostScanRecipeSummaryCollectionItem[]; } interface GetHostScanRecipesHostScanRecipeSummaryCollectionItem { /** * Agent scan settings for a host scan */ agentSettings: outputs.VulnerabilityScanning.GetHostScanRecipesHostScanRecipeSummaryCollectionItemAgentSetting[]; /** * Agent scan settings for an application scan (as a part of a host scan) */ applicationSettings: outputs.VulnerabilityScanning.GetHostScanRecipesHostScanRecipeSummaryCollectionItemApplicationSetting[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * Unique identifier of the config that is immutable on creation */ id: string; /** * Port scan settings for a host scan */ portSettings: outputs.VulnerabilityScanning.GetHostScanRecipesHostScanRecipeSummaryCollectionItemPortSetting[]; /** * A scanning schedule */ schedules: outputs.VulnerabilityScanning.GetHostScanRecipesHostScanRecipeSummaryCollectionItemSchedule[]; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Date and time the recipe was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) */ timeCreated: string; /** * Date and time the recipe was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) */ timeUpdated: string; } interface GetHostScanRecipesHostScanRecipeSummaryCollectionItemAgentSetting { /** * Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor. */ agentConfigurations: outputs.VulnerabilityScanning.GetHostScanRecipesHostScanRecipeSummaryCollectionItemAgentSettingAgentConfiguration[]; /** * The scan level */ scanLevel: string; } interface GetHostScanRecipesHostScanRecipeSummaryCollectionItemAgentSettingAgentConfiguration { /** * CIS (Center for Internet Security) Benchmark scan settings for a host scan */ cisBenchmarkSettings: outputs.VulnerabilityScanning.GetHostScanRecipesHostScanRecipeSummaryCollectionItemAgentSettingAgentConfigurationCisBenchmarkSetting[]; /** * Endpoint Protection scan settings for a host scan */ endpointProtectionSettings: outputs.VulnerabilityScanning.GetHostScanRecipesHostScanRecipeSummaryCollectionItemAgentSettingAgentConfigurationEndpointProtectionSetting[]; /** * Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped. */ shouldUnInstall: boolean; /** * Vault secret OCID which stores license information. Content inside this secret in vault would be base64 string containing information about customer's Qualys susbcription license. */ vaultSecretId: string; /** * Vendor to use for the host scan agent. */ vendor: string; /** * Vendor to use for the host scan agent. */ vendorType: string; } interface GetHostScanRecipesHostScanRecipeSummaryCollectionItemAgentSettingAgentConfigurationCisBenchmarkSetting { /** * The scan level */ scanLevel: string; } interface GetHostScanRecipesHostScanRecipeSummaryCollectionItemAgentSettingAgentConfigurationEndpointProtectionSetting { /** * The scan level */ scanLevel: string; } interface GetHostScanRecipesHostScanRecipeSummaryCollectionItemApplicationSetting { /** * Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation) */ applicationScanRecurrence: string; /** * List of folders selected for scanning */ foldersToScans: outputs.VulnerabilityScanning.GetHostScanRecipesHostScanRecipeSummaryCollectionItemApplicationSettingFoldersToScan[]; /** * Enable or disable application scan */ isEnabled: boolean; } interface GetHostScanRecipesHostScanRecipeSummaryCollectionItemApplicationSettingFoldersToScan { /** * Folder to be scanned in the corresponding operating system */ folder: string; /** * Operating system type */ operatingsystem: string; } interface GetHostScanRecipesHostScanRecipeSummaryCollectionItemPortSetting { /** * The scan level */ scanLevel: string; } interface GetHostScanRecipesHostScanRecipeSummaryCollectionItemSchedule { /** * Day of week the scheduled scan occurs (not applicable for DAILY type) */ dayOfWeek: string; /** * How often the scan occurs */ type: string; } interface GetHostScanTargetErrorsFilter { name: string; regex?: boolean; values: string[]; } interface GetHostScanTargetErrorsHostScanTargetErrorSummaryCollection { /** * The HostScanTargetError objects in the collection. */ items: outputs.VulnerabilityScanning.GetHostScanTargetErrorsHostScanTargetErrorSummaryCollectionItem[]; } interface GetHostScanTargetErrorsHostScanTargetErrorSummaryCollectionItem { /** * The HostScanTargetError objects in the collection. */ items: outputs.VulnerabilityScanning.GetHostScanTargetErrorsHostScanTargetErrorSummaryCollectionItemItem[]; } interface GetHostScanTargetErrorsHostScanTargetErrorSummaryCollectionItemItem { /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Error code of task failure. */ errorCode: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * OCID of the host instance where scan was done. */ instanceId: string; /** * Error message detailing task failure. */ message: string; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Task during scan which failed. */ task: string; /** * Date and time the error was updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; /** * Vendor which was used for the host scan agent. */ vendor: string; } interface GetHostScanTargetsFilter { name: string; regex?: boolean; values: string[]; } interface GetHostScanTargetsHostScanTargetSummaryCollection { items: outputs.VulnerabilityScanning.GetHostScanTargetsHostScanTargetSummaryCollectionItem[]; } interface GetHostScanTargetsHostScanTargetSummaryCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Target description. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * ID of the host scan recipe this target applies. */ hostScanRecipeId: string; /** * Unique identifier of the config that is immutable on creation */ id: string; /** * List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId. */ instanceIds: string[]; /** * A filter to return only resources whose lifecycleState matches the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment. */ targetCompartmentId: string; /** * Date and time the target was created, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) */ timeCreated: string; /** * Date and time the target was last updated, format as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) */ timeUpdated: string; } interface HostScanRecipeAgentSettings { /** * (Updatable) Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor. */ agentConfiguration: outputs.VulnerabilityScanning.HostScanRecipeAgentSettingsAgentConfiguration; /** * (Updatable) The scan level */ scanLevel: string; } interface HostScanRecipeAgentSettingsAgentConfiguration { /** * (Updatable) CIS (Center for Internet Security) Benchmark scan settings for a host scan */ cisBenchmarkSettings: outputs.VulnerabilityScanning.HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettings; /** * (Updatable) Endpoint Protection scan settings for a host scan */ endpointProtectionSettings: outputs.VulnerabilityScanning.HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettings; /** * (Updatable) Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped. */ shouldUnInstall: boolean; /** * (Updatable) Vault secret OCID which stores license information. Content inside this secret in vault would be base64 string containing information about customer's Qualys susbcription license. */ vaultSecretId: string; /** * (Updatable) Vendor to use for the host scan agent. */ vendor: string; /** * (Updatable) Vendor to use for the host scan agent. */ vendorType: string; } interface HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettings { /** * (Updatable) The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely. */ scanLevel: string; } interface HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettings { /** * (Updatable) The scan level. Use 'NONE' to disable Endpoint Protection checks entirely. */ scanLevel: string; } interface HostScanRecipeApplicationSettings { /** * (Updatable) Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation) */ applicationScanRecurrence: string; /** * (Updatable) List of folders selected for scanning */ foldersToScans: outputs.VulnerabilityScanning.HostScanRecipeApplicationSettingsFoldersToScan[]; /** * (Updatable) Enable or disable application scan */ isEnabled: boolean; } interface HostScanRecipeApplicationSettingsFoldersToScan { /** * (Updatable) Folder to be scanned in the corresponding operating system */ folder: string; /** * (Updatable) Operating system type */ operatingsystem: string; } interface HostScanRecipePortSettings { /** * (Updatable) The scan level */ scanLevel: string; } interface HostScanRecipeSchedule { /** * (Updatable) Day of week the scheduled scan occurs (not applicable for DAILY type) */ dayOfWeek: string; /** * (Updatable) How often the scan occurs * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ type: string; } } export declare namespace Waa { interface AppAccelerationPolicyResponseCachingPolicy { /** * (Updatable) When false, responses will not be cached by the backend based on response headers. * * When true, responses that contain one of the supported cache control headers will be cached according to the values specified in the cache control headers. * * The "X-Accel-Expires" header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the @ prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached. * * If the header does not include the "X-Accel-Expires" field, parameters of caching may be set in the header fields "Expires" or "Cache-Control". * * If the header includes the "Set-Cookie" field, such a response will not be cached. * * If the header includes the "Vary" field with the special value "*", such a response will not be cached. If the header includes the "Vary" field with another value, such a response will be cached taking into account the corresponding request header fields. */ isResponseHeaderBasedCachingEnabled: boolean; } interface AppAccelerationPolicyResponseCompressionPolicy { /** * (Updatable) An object that specifies the gzip compression policy. */ gzipCompression: outputs.Waa.AppAccelerationPolicyResponseCompressionPolicyGzipCompression; } interface AppAccelerationPolicyResponseCompressionPolicyGzipCompression { /** * (Updatable) When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the "Accept-Encoding: gzip" request header. * * When false, support for gzip compression is disabled and HTTP responses will not be compressed with gzip even if the client indicates support for gzip. */ isEnabled: boolean; } interface GetAppAccelerationPoliciesFilter { name: string; regex?: boolean; values: string[]; } interface GetAppAccelerationPoliciesWebAppAccelerationPolicyCollection { items: outputs.Waa.GetAppAccelerationPoliciesWebAppAccelerationPolicyCollectionItem[]; } interface GetAppAccelerationPoliciesWebAppAccelerationPolicyCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only the WebAppAccelerationPolicy with the given [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state. */ lifecycleDetails: string; /** * An object that specifies an HTTP response caching policy. */ responseCachingPolicies: outputs.Waa.GetAppAccelerationPoliciesWebAppAccelerationPolicyCollectionItemResponseCachingPolicy[]; /** * An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client. */ responseCompressionPolicies: outputs.Waa.GetAppAccelerationPoliciesWebAppAccelerationPolicyCollectionItemResponseCompressionPolicy[]; /** * A filter to return only resources that match the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetAppAccelerationPoliciesWebAppAccelerationPolicyCollectionItemResponseCachingPolicy { /** * When false, responses will not be cached by the backend based on response headers. */ isResponseHeaderBasedCachingEnabled: boolean; } interface GetAppAccelerationPoliciesWebAppAccelerationPolicyCollectionItemResponseCompressionPolicy { /** * An object that specifies the gzip compression policy. */ gzipCompressions: outputs.Waa.GetAppAccelerationPoliciesWebAppAccelerationPolicyCollectionItemResponseCompressionPolicyGzipCompression[]; } interface GetAppAccelerationPoliciesWebAppAccelerationPolicyCollectionItemResponseCompressionPolicyGzipCompression { /** * When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the "Accept-Encoding: gzip" request header. */ isEnabled: boolean; } interface GetAppAccelerationPolicyResponseCachingPolicy { /** * When false, responses will not be cached by the backend based on response headers. */ isResponseHeaderBasedCachingEnabled: boolean; } interface GetAppAccelerationPolicyResponseCompressionPolicy { /** * An object that specifies the gzip compression policy. */ gzipCompressions: outputs.Waa.GetAppAccelerationPolicyResponseCompressionPolicyGzipCompression[]; } interface GetAppAccelerationPolicyResponseCompressionPolicyGzipCompression { /** * When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the "Accept-Encoding: gzip" request header. */ isEnabled: boolean; } interface GetAppAccelerationsFilter { name: string; regex?: boolean; values: string[]; } interface GetAppAccelerationsWebAppAccelerationCollection { items: outputs.Waa.GetAppAccelerationsWebAppAccelerationCollectionItem[]; } interface GetAppAccelerationsWebAppAccelerationCollectionItem { /** * Type of the WebAppFirewall, as example LOAD_BALANCER. */ backendType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only the WebAppAcceleration with the given [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state. */ lifecycleDetails: string; /** * LoadBalancer [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) to which the WebAppAccelerationPolicy is attached to. */ loadBalancerId: string; /** * A filter to return only resources that match the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the WebAppAcceleration was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the WebAppAcceleration was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return only the WebAppAcceleration with the given [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of related WebAppAccelerationPolicy. */ webAppAccelerationPolicyId: string; } } export declare namespace Waas { interface CertificateExtension { /** * The critical flag of the extension. Critical extensions must be processed, non-critical extensions can be ignored. */ isCritical: boolean; /** * The certificate extension name. */ name: string; /** * The certificate extension value. */ value: string; } interface CertificateIssuerName { /** * The fully qualified domain name used for DNS lookups of the server. */ commonName: string; /** * ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). */ country: string; /** * The email address of the server's administrator. */ emailAddress: string; /** * The city in which the organization is located. */ locality: string; /** * The organization name. */ organization: string; /** * The field to differentiate between divisions within an organization. */ organizationalUnit: string; /** * The province where the organization is located. */ stateProvince: string; } interface CertificatePublicKeyInfo { /** * The algorithm identifier and parameters for the public key. */ algorithm: string; /** * The private key exponent. */ exponent: number; /** * The number of bits in a key used by a cryptographic algorithm. */ keySize: number; } interface CertificateSubjectName { /** * The fully qualified domain name used for DNS lookups of the server. */ commonName: string; /** * ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). */ country: string; /** * The email address of the server's administrator. */ emailAddress: string; /** * The city in which the organization is located. */ locality: string; /** * The organization name. */ organization: string; /** * The field to differentiate between divisions within an organization. */ organizationalUnit: string; /** * The province where the organization is located. */ stateProvince: string; } interface GetAddressListsAddressList { /** * The total number of unique IP addresses in the address list. */ addressCount: number; /** * The list of IP addresses or CIDR notations. */ addresses: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The user-friendly name of the address list. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the address list. */ id: string; /** * The current lifecycle state of the address list. */ state: string; /** * The date and time the address list was created, expressed in RFC 3339 timestamp format. */ timeCreated: string; } interface GetAddressListsFilter { name: string; regex?: boolean; values: string[]; } interface GetCertificateExtension { /** * The critical flag of the extension. Critical extensions must be processed, non-critical extensions can be ignored. */ isCritical: boolean; /** * The certificate extension name. */ name: string; /** * The certificate extension value. */ value: string; } interface GetCertificateIssuerName { /** * The fully qualified domain name used for DNS lookups of the server. */ commonName: string; /** * ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). */ country: string; /** * The email address of the server's administrator. */ emailAddress: string; /** * The city in which the organization is located. */ locality: string; /** * The organization name. */ organization: string; /** * The field to differentiate between divisions within an organization. */ organizationalUnit: string; /** * The province where the organization is located. */ stateProvince: string; } interface GetCertificatePublicKeyInfo { /** * The algorithm identifier and parameters for the public key. */ algorithm: string; /** * The private key exponent. */ exponent: number; /** * The number of bits in a key used by a cryptographic algorithm. */ keySize: number; } interface GetCertificateSubjectName { /** * The fully qualified domain name used for DNS lookups of the server. */ commonName: string; /** * ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). */ country: string; /** * The email address of the server's administrator. */ emailAddress: string; /** * The city in which the organization is located. */ locality: string; /** * The organization name. */ organization: string; /** * The field to differentiate between divisions within an organization. */ organizationalUnit: string; /** * The province where the organization is located. */ stateProvince: string; } interface GetCertificatesCertificate { /** * The data of the SSL certificate. */ certificateData: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The user-friendly name of the SSL certificate. */ displayName: string; /** * Additional attributes associated with users or public keys for managing relationships between Certificate Authorities. */ extensions: outputs.Waas.GetCertificatesCertificateExtension[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SSL certificate. */ id: string; /** * This indicates whether trust verification was disabled during the creation of SSL certificate. If `true` SSL certificate trust verification was disabled and this SSL certificate is most likely self-signed. */ isTrustVerificationDisabled: boolean; issuedBy: string; /** * The issuer of the certificate. */ issuerNames: outputs.Waas.GetCertificatesCertificateIssuerName[]; privateKeyData: string; /** * Information about the public key and the algorithm used by the public key. */ publicKeyInfos: outputs.Waas.GetCertificatesCertificatePublicKeyInfo[]; /** * A unique, positive integer assigned by the Certificate Authority (CA). The issuer name and serial number identify a unique certificate. */ serialNumber: string; /** * The identifier for the cryptographic algorithm used by the Certificate Authority (CA) to sign this certificate. */ signatureAlgorithm: string; /** * The current lifecycle state of the SSL certificate. */ state: string; /** * The entity to be secured by the certificate. */ subjectNames: outputs.Waas.GetCertificatesCertificateSubjectName[]; /** * The date and time the certificate was created, expressed in RFC 3339 timestamp format. */ timeCreated: string; /** * The date and time the certificate will expire, expressed in RFC 3339 timestamp format. */ timeNotValidAfter: string; /** * The date and time the certificate will become valid, expressed in RFC 3339 timestamp format. */ timeNotValidBefore: string; /** * The version of the encoded certificate. */ version: number; } interface GetCertificatesCertificateExtension { /** * The critical flag of the extension. Critical extensions must be processed, non-critical extensions can be ignored. */ isCritical: boolean; /** * The certificate extension name. */ name: string; /** * The certificate extension value. */ value: string; } interface GetCertificatesCertificateIssuerName { /** * The fully qualified domain name used for DNS lookups of the server. */ commonName: string; /** * ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). */ country: string; /** * The email address of the server's administrator. */ emailAddress: string; /** * The city in which the organization is located. */ locality: string; /** * The organization name. */ organization: string; /** * The field to differentiate between divisions within an organization. */ organizationalUnit: string; /** * The province where the organization is located. */ stateProvince: string; } interface GetCertificatesCertificatePublicKeyInfo { /** * The algorithm identifier and parameters for the public key. */ algorithm: string; /** * The private key exponent. */ exponent: number; /** * The number of bits in a key used by a cryptographic algorithm. */ keySize: number; } interface GetCertificatesCertificateSubjectName { /** * The fully qualified domain name used for DNS lookups of the server. */ commonName: string; /** * ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). */ country: string; /** * The email address of the server's administrator. */ emailAddress: string; /** * The city in which the organization is located. */ locality: string; /** * The organization name. */ organization: string; /** * The field to differentiate between divisions within an organization. */ organizationalUnit: string; /** * The province where the organization is located. */ stateProvince: string; } interface GetCertificatesFilter { /** * The certificate extension name. */ name: string; regex?: boolean; values: string[]; } interface GetCustomProtectionRulesCustomProtectionRule { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the custom protection rule. */ description: string; /** * The user-friendly name of the custom protection rule. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule. */ id: string; /** * The auto-generated ID for the custom protection rule. These IDs are referenced in logs. */ modSecurityRuleIds: string[]; /** * The current lifecycle state of the custom protection rule. */ state: string; /** * The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language. */ template: string; /** * The date and time the protection rule was created, expressed in RFC 3339 timestamp format. */ timeCreated: string; } interface GetCustomProtectionRulesFilter { name: string; regex?: boolean; values: string[]; } interface GetEdgeSubnetsEdgeSubnet { /** * An edge node subnet. This can include /24 or /8 addresses. */ cidr: string; /** * The name of the region containing the indicated subnet. */ region: string; /** * The date and time the last change was made to the indicated edge node subnet, expressed in RFC 3339 timestamp format. */ timeModified: string; } interface GetEdgeSubnetsFilter { name: string; regex?: boolean; values: string[]; } interface GetHttpRedirectTarget { /** * The host portion of the redirect. */ host: string; /** * The path component of the target URL (e.g., "/path/to/resource" in "https://target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying, or request-prefixing. Use of \ is not permitted except to escape a following \, {, or }. An empty value is treated the same as static "/". A static value must begin with a leading "/", optionally followed by other path characters. A request-copying value must exactly match "{path}", and will be replaced with the path component of the request URL (including its initial "/"). A request-prefixing value must start with "/" and end with a non-escaped "{path}", which will be replaced with the path component of the request URL (including its initial "/"). Only one such replacement token is allowed. */ path: string; /** * Port number of the target destination of the redirect, default to match protocol */ port: number; /** * The protocol used for the target, http or https. */ protocol: string; /** * The query component of the target URL (e.g., "?redirected" in "https://target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying. Use of \ is not permitted except to escape a following \, {, or }. An empty value results in a redirection target URL with no query component. A static value must begin with a leading "?", optionally followed by other query characters. A request-copying value must exactly match "{query}", and will be replaced with the query component of the request URL (including a leading "?" if and only if the request URL includes a query component). */ query: string; } interface GetHttpRedirectsFilter { name: string; regex?: boolean; values: string[]; } interface GetHttpRedirectsHttpRedirect { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The user-friendly name of the HTTP Redirect. The name can be changed and does not need to be unique. */ displayName: string; /** * The domain from which traffic will be redirected. */ domain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HTTP Redirect. */ id: string; /** * The response code returned for the redirect to the client. For more information, see [RFC 7231](https://tools.ietf.org/html/rfc7231#section-6.4). */ responseCode: number; /** * The current lifecycle state of the HTTP Redirect. */ state: string; /** * The redirect target object including all the redirect data. */ targets: outputs.Waas.GetHttpRedirectsHttpRedirectTarget[]; /** * The date and time the policy was created, expressed in RFC 3339 timestamp format. */ timeCreated: string; } interface GetHttpRedirectsHttpRedirectTarget { /** * The host portion of the redirect. */ host: string; /** * The path component of the target URL (e.g., "/path/to/resource" in "https://target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying, or request-prefixing. Use of \ is not permitted except to escape a following \, {, or }. An empty value is treated the same as static "/". A static value must begin with a leading "/", optionally followed by other path characters. A request-copying value must exactly match "{path}", and will be replaced with the path component of the request URL (including its initial "/"). A request-prefixing value must start with "/" and end with a non-escaped "{path}", which will be replaced with the path component of the request URL (including its initial "/"). Only one such replacement token is allowed. */ path: string; /** * Port number of the target destination of the redirect, default to match protocol */ port: number; /** * The protocol used for the target, http or https. */ protocol: string; /** * The query component of the target URL (e.g., "?redirected" in "https://target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying. Use of \ is not permitted except to escape a following \, {, or }. An empty value results in a redirection target URL with no query component. A static value must begin with a leading "?", optionally followed by other query characters. A request-copying value must exactly match "{query}", and will be replaced with the query component of the request URL (including a leading "?" if and only if the request URL includes a query component). */ query: string; } interface GetProtectionRuleExclusion { /** * An array of The target property of a request that would allow it to bypass the protection rule. For example, when `target` is `REQUEST_COOKIE_NAMES`, the list may include names of cookies to exclude from the protection rule. When the target is `ARGS`, the list may include strings of URL query parameters and values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from the protection rule. `Exclusions` properties must not contain whitespace, comma or |. **Note:** If protection rules have been enabled that utilize the `maxArgumentCount` or `maxTotalNameLengthOfArguments` properties, and the `target` property has been set to `ARGS`, it is important that the `exclusions` properties be defined to honor those protection rule settings in a consistent manner. */ exclusions: string[]; /** * The target of the exclusion. */ target: string; } interface GetProtectionRulesFilter { /** * The name of the protection rule. */ name: string; regex?: boolean; values: string[]; } interface GetProtectionRulesProtectionRule { /** * Filter rules using a list of actions. */ action: string; /** * The description of the protection rule. */ description: string; /** * An array of The target property of a request that would allow it to bypass the protection rule. For example, when `target` is `REQUEST_COOKIE_NAMES`, the list may include names of cookies to exclude from the protection rule. When the target is `ARGS`, the list may include strings of URL query parameters and values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from the protection rule. `Exclusions` properties must not contain whitespace, comma or |. **Note:** If protection rules have been enabled that utilize the `maxArgumentCount` or `maxTotalNameLengthOfArguments` properties, and the `target` property has been set to `ARGS`, it is important that the `exclusions` properties be defined to honor those protection rule settings in a consistent manner. */ exclusions: outputs.Waas.GetProtectionRulesProtectionRuleExclusion[]; /** * The unique key of the protection rule. */ key: string; /** * The list of labels for the protection rule. */ labels: string[]; /** * The list of the ModSecurity rule IDs that apply to this protection rule. For more information about ModSecurity's open source WAF rules, see [Mod Security's documentation](https://www.modsecurity.org/CRS/Documentation/index.html). */ modSecurityRuleIds: string[]; /** * The name of the protection rule. */ name: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy. */ waasPolicyId: string; } interface GetProtectionRulesProtectionRuleExclusion { /** * An array of The target property of a request that would allow it to bypass the protection rule. For example, when `target` is `REQUEST_COOKIE_NAMES`, the list may include names of cookies to exclude from the protection rule. When the target is `ARGS`, the list may include strings of URL query parameters and values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from the protection rule. `Exclusions` properties must not contain whitespace, comma or |. **Note:** If protection rules have been enabled that utilize the `maxArgumentCount` or `maxTotalNameLengthOfArguments` properties, and the `target` property has been set to `ARGS`, it is important that the `exclusions` properties be defined to honor those protection rule settings in a consistent manner. */ exclusions: string[]; /** * The target of the exclusion. */ target: string; } interface GetWaasPoliciesFilter { /** * The unique name of the whitelist. */ name: string; regex?: boolean; values: string[]; } interface GetWaasPoliciesWaasPolicy { /** * An array of additional domains for this web application. */ additionalDomains: string[]; /** * The CNAME record to add to your DNS configuration to route traffic for the domain, and all additional domains, through the WAF. */ cname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The user-friendly name of the WAAS policy. The name can be changed and does not need to be unique. */ displayName: string; /** * The domain for which the cookie is set, defaults to WAAS policy domain. */ domain: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule. */ id: string; /** * The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request. */ originGroups: outputs.Waas.GetWaasPoliciesWaasPolicyOriginGroup[]; /** * A map of host servers (origins) and their keys for the web application. Origin keys are used to associate origins to specific protection rules. The key should be a user-friendly name for the host. **Examples:** `primary` or `secondary`. */ origins: outputs.Waas.GetWaasPoliciesWaasPolicyOrigin[]; /** * The configuration details for the WAAS policy. */ policyConfigs: outputs.Waas.GetWaasPoliciesWaasPolicyPolicyConfig[]; /** * The current lifecycle state of the WAAS policy. */ state: string; /** * The date and time the policy was created, expressed in RFC 3339 timestamp format. */ timeCreated: string; /** * The Web Application Firewall configuration for the WAAS policy. */ wafConfigs: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfig[]; } interface GetWaasPoliciesWaasPolicyOrigin { /** * A list of HTTP headers to forward to your origin. */ customHeaders: outputs.Waas.GetWaasPoliciesWaasPolicyOriginCustomHeader[]; /** * The HTTP port on the origin that the web application listens on. If unspecified, defaults to `80`. If `0` is specified - the origin is not used for HTTP traffic. */ httpPort: number; /** * The HTTPS port on the origin that the web application listens on. If unspecified, defaults to `443`. If `0` is specified - the origin is not used for HTTPS traffic. */ httpsPort: number; label: string; /** * The URI of the origin. Does not support paths. Port numbers should be specified in the `httpPort` and `httpsPort` fields. */ uri: string; } interface GetWaasPoliciesWaasPolicyOriginCustomHeader { /** * The unique name of the whitelist. */ name: string; /** * The value of the header. */ value: string; } interface GetWaasPoliciesWaasPolicyOriginGroup { label: string; originGroups: outputs.Waas.GetWaasPoliciesWaasPolicyOriginGroupOriginGroup[]; } interface GetWaasPoliciesWaasPolicyOriginGroupOriginGroup { /** * The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in `Origins`. Required when creating the `WafConfig` resource, but not on update. */ origin: string; weight: number; } interface GetWaasPoliciesWaasPolicyPolicyConfig { /** * The OCID of the SSL certificate to use if HTTPS is supported. */ certificateId: string; /** * The set cipher group for the configured TLS protocol. This sets the configuration for the TLS connections between clients and edge nodes only. * * **DEFAULT:** Cipher group supports TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3 protocols. It has the following ciphers enabled: `ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:!DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA` */ cipherGroup: string; /** * Specifies an HTTP header name which is treated as the connecting client's IP address. Applicable only if `isBehindCdn` is enabled. */ clientAddressHeader: string; /** * Health checks monitor the status of your origin servers and only route traffic to the origins that pass the health check. If the health check fails, origin is automatically removed from the load balancing. There is roughly one health check per EDGE POP per period. Any checks that pass will be reported as "healthy". */ healthChecks: outputs.Waas.GetWaasPoliciesWaasPolicyPolicyConfigHealthCheck[]; /** * Enabling `isBehindCdn` allows for the collection of IP addresses from client requests if the WAF is connected to a CDN. */ isBehindCdn: boolean; /** * Enable or disable automatic content caching based on the response `cache-control` header. This feature enables the origin to act as a proxy cache. Caching is usually defined using `cache-control` header. For example `cache-control: max-age=120` means that the returned resource is valid for 120 seconds. Caching rules will overwrite this setting. */ isCacheControlRespected: boolean; /** * Enable or disable HTTPS support. If true, a `certificateId` is required. If unspecified, defaults to `false`. */ isHttpsEnabled: boolean; /** * Force HTTP to HTTPS redirection. If unspecified, defaults to `false`. */ isHttpsForced: boolean; /** * Enable or disable GZIP compression of origin responses. If enabled, the header `Accept-Encoding: gzip` is sent to origin, otherwise, the empty `Accept-Encoding:` header is used. */ isOriginCompressionEnabled: boolean; /** * Enable or disable buffering of responses from the origin. Buffering improves overall stability in case of network issues, but slightly increases Time To First Byte. */ isResponseBufferingEnabled: boolean; /** * SNI stands for Server Name Indication and is an extension of the TLS protocol. It indicates which hostname is being contacted by the browser at the beginning of the 'handshake'-process. This allows a server to connect multiple SSL Certificates to one IP address and port. */ isSniEnabled: boolean; /** * An object that represents a load balancing method and its properties. */ loadBalancingMethods: outputs.Waas.GetWaasPoliciesWaasPolicyPolicyConfigLoadBalancingMethod[]; /** * A list of allowed TLS protocols. Only applicable when HTTPS support is enabled. The TLS protocol is negotiated while the request is connecting and the most recent protocol supported by both the edge node and client browser will be selected. If no such version exists, the connection will be aborted. * * **TLS_V1:** corresponds to TLS 1.0 specification. * * **TLS_V1_1:** corresponds to TLS 1.1 specification. * * **TLS_V1_2:** corresponds to TLS 1.2 specification. * * **TLS_V1_3:** corresponds to TLS 1.3 specification. */ tlsProtocols: string[]; /** * ModSecurity is not capable to inspect WebSockets. Therefore paths specified here have WAF disabled if Connection request header from the client has the value Upgrade (case insensitive matching) and Upgrade request header has the value websocket (case insensitive matching). Paths matches if the concatenation of request URL path and query starts with the contents of the one of `websocketPathPrefixes` array value. In All other cases challenges, like JSC, HIC and etc., remain active. */ websocketPathPrefixes: string[]; } interface GetWaasPoliciesWaasPolicyPolicyConfigHealthCheck { /** * The HTTP response codes that signify a healthy state. * * **2XX:** Success response code group. * * **3XX:** Redirection response code group. * * **4XX:** Client errors response code group. * * **5XX:** Server errors response code group. */ expectedResponseCodeGroups: string[]; /** * Health check will search for the given text in a case-sensitive manner within the response body and will fail if the text is not found. */ expectedResponseText: string; /** * HTTP header fields to include in health check requests, expressed as `"name": "value"` properties. Because HTTP header field names are case-insensitive, any use of names that are case-insensitive equal to other names will be rejected. If Host is not specified, requests will include a Host header field with value matching the policy's protected domain. If User-Agent is not specified, requests will include a User-Agent header field with value "waf health checks". */ headers: { [key: string]: string; }; /** * Number of successful health checks after which the server is marked up. */ healthyThreshold: number; /** * Time between health checks of an individual origin server, in seconds. */ intervalInSeconds: number; /** * Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * Enables or disables additional check for predefined text in addition to response code. */ isResponseTextCheckEnabled: boolean; /** * Load balancing methods are algorithms used to efficiently distribute traffic among origin servers. * * **[IP_HASH](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/IPHashLoadBalancingMethod):** All the incoming requests from the same client IP address should go to the same content origination server. IP_HASH load balancing method uses origin weights when choosing which origin should the hash be assigned to initially. * * **[ROUND_ROBIN](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/RoundRobinLoadBalancingMethod):** Forwards requests sequentially to the available origin servers. The first request - to the first origin server, the second request - to the next origin server, and so on. After it sends a request to the last origin server, it starts again with the first origin server. When using weights on origins, Weighted Round Robin assigns more requests to origins with a greater weight. Over a period of time, origins will receive a number of requests in proportion to their weight. * * **[STICKY_COOKIE](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/StickyCookieLoadBalancingMethod):** Adds a session cookie to the first response from the origin server and identifies the server that sent the response. The client's next request contains the cookie value, and nginx routes the request to the origin server that responded to the first request. STICKY_COOKIE load balancing method falls back to Round Robin for the first request. */ method: string; /** * Path to visit on your origins when performing the health check. */ path: string; /** * Response timeout represents wait time until request is considered failed, in seconds. */ timeoutInSeconds: number; /** * Number of failed health checks after which the server is marked down. */ unhealthyThreshold: number; } interface GetWaasPoliciesWaasPolicyPolicyConfigLoadBalancingMethod { /** * The domain for which the cookie is set, defaults to WAAS policy domain. */ domain: string; /** * The time for which a browser should keep the cookie in seconds. Empty value will cause the cookie to expire at the end of a browser session. */ expirationTimeInSeconds: number; /** * Load balancing methods are algorithms used to efficiently distribute traffic among origin servers. * * **[IP_HASH](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/IPHashLoadBalancingMethod):** All the incoming requests from the same client IP address should go to the same content origination server. IP_HASH load balancing method uses origin weights when choosing which origin should the hash be assigned to initially. * * **[ROUND_ROBIN](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/RoundRobinLoadBalancingMethod):** Forwards requests sequentially to the available origin servers. The first request - to the first origin server, the second request - to the next origin server, and so on. After it sends a request to the last origin server, it starts again with the first origin server. When using weights on origins, Weighted Round Robin assigns more requests to origins with a greater weight. Over a period of time, origins will receive a number of requests in proportion to their weight. * * **[STICKY_COOKIE](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/StickyCookieLoadBalancingMethod):** Adds a session cookie to the first response from the origin server and identifies the server that sent the response. The client's next request contains the cookie value, and nginx routes the request to the origin server that responded to the first request. STICKY_COOKIE load balancing method falls back to Round Robin for the first request. */ method: string; /** * The unique name of the whitelist. */ name: string; } interface GetWaasPoliciesWaasPolicyWafConfig { /** * The access rules applied to the Web Application Firewall. Used for defining custom access policies with the combination of `ALLOW`, `DETECT`, and `BLOCK` rules, based on different criteria. */ accessRules: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigAccessRule[]; /** * The IP address rate limiting settings used to limit the number of requests from an address. */ addressRateLimitings: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigAddressRateLimiting[]; /** * A list of caching rules applied to the web application. */ cachingRules: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigCachingRule[]; /** * A list of CAPTCHA challenge settings. These are used to challenge requests with a CAPTCHA to block bots. */ captchas: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigCaptcha[]; /** * A list of the custom protection rule OCIDs and their actions. */ customProtectionRules: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigCustomProtectionRule[]; /** * The device fingerprint challenge settings. Used to detect unique devices based on the device fingerprint information collected in order to block bots. */ deviceFingerprintChallenges: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigDeviceFingerprintChallenge[]; /** * The human interaction challenge settings. Used to look for natural human interactions such as mouse movements, time on site, and page scrolling to identify bots. */ humanInteractionChallenges: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigHumanInteractionChallenge[]; /** * The JavaScript challenge settings. Used to challenge requests with a JavaScript challenge and take the action if a browser has no JavaScript support in order to block bots. */ jsChallenges: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigJsChallenge[]; /** * The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in `Origins`. Required when creating the `WafConfig` resource, but not on update. */ origin: string; /** * The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request. */ originGroups: string[]; /** * The settings to apply to protection rules. */ protectionSettings: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigProtectionSetting[]; /** * A list of IP addresses that bypass the Web Application Firewall. */ whitelists: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigWhitelist[]; } interface GetWaasPoliciesWaasPolicyWafConfigAccessRule { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * The list of challenges to bypass when `action` is set to `BYPASS`. If unspecified or empty, all challenges are bypassed. * * **JS_CHALLENGE:** Bypasses JavaScript Challenge. * * **DEVICE_FINGERPRINT_CHALLENGE:** Bypasses Device Fingerprint Challenge. * * **HUMAN_INTERACTION_CHALLENGE:** Bypasses Human Interaction Challenge. * * **CAPTCHA:** Bypasses CAPTCHA Challenge. */ bypassChallenges: string[]; /** * The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; /** * When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions. */ criterias: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigAccessRuleCriteria[]; /** * The unique name of the whitelist. */ name: string; /** * The response status code to return when `action` is set to `REDIRECT`. * * **MOVED_PERMANENTLY:** Used for designating the permanent movement of a page (numerical code - 301). * * **FOUND:** Used for designating the temporary movement of a page (numerical code - 302). */ redirectResponseCode: string; /** * The target to which the request should be redirected, represented as a URI reference. Required when `action` is `REDIRECT`. */ redirectUrl: string; /** * An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of `action` value. */ responseHeaderManipulations: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigAccessRuleResponseHeaderManipulation[]; } interface GetWaasPoliciesWaasPolicyWafConfigAccessRuleCriteria { /** * The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request. * * **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`. * * **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`. * * **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`. * * **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. * * **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. * * **URL_REGEX:** Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the `value` field. * * **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field. * * **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the `value` field. * * **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list. * * **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list. * * **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match. * * **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` */ condition: string; /** * When enabled, the condition will be matched with case-sensitive rules. */ isCaseSensitive: boolean; /** * The value of the header. */ value: string; } interface GetWaasPoliciesWaasPolicyWafConfigAccessRuleResponseHeaderManipulation { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * A header field name that conforms to RFC 7230. Example: `exampleHeaderName` */ header: string; /** * The value of the header. */ value: string; } interface GetWaasPoliciesWaasPolicyWafConfigAddressRateLimiting { /** * The number of allowed requests per second from one IP address. If unspecified, defaults to `1`. */ allowedRatePerAddress: number; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * The maximum number of requests allowed to be queued before subsequent requests are dropped. If unspecified, defaults to `10`. */ maxDelayedCountPerAddress: number; } interface GetWaasPoliciesWaasPolicyWafConfigCachingRule { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` */ cachingDuration: string; /** * The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` */ clientCachingDuration: string; /** * When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions. */ criterias: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigCachingRuleCriteria[]; /** * Enables or disables client caching. Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache-Control` header in responses. */ isClientCachingEnabled: boolean; /** * The unique key for the caching rule. */ key: string; /** * The unique name of the whitelist. */ name: string; } interface GetWaasPoliciesWaasPolicyWafConfigCachingRuleCriteria { /** * The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request. * * **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`. * * **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`. * * **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`. * * **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. * * **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. * * **URL_REGEX:** Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the `value` field. * * **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field. * * **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the `value` field. * * **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list. * * **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list. * * **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match. * * **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` */ condition: string; /** * The value of the header. */ value: string; } interface GetWaasPoliciesWaasPolicyWafConfigCaptcha { /** * The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to `The CAPTCHA was incorrect. Try again.` */ failureMessage: string; /** * The text to show in the footer when showing a CAPTCHA challenge. If unspecified, defaults to 'Enter the letters and numbers as they are shown in the image above.' */ footerText: string; /** * The text to show in the header when showing a CAPTCHA challenge. If unspecified, defaults to 'We have detected an increased number of attempts to access this website. To help us keep this site secure, please let us know that you are not a robot by entering the text from the image below.' */ headerText: string; /** * The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to `300`. */ sessionExpirationInSeconds: number; /** * The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to `Yes, I am human`. */ submitLabel: string; /** * The title used when displaying a CAPTCHA challenge. If unspecified, defaults to `Are you human?` */ title: string; /** * The unique URL path at which to show the CAPTCHA challenge. */ url: string; } interface GetWaasPoliciesWaasPolicyWafConfigCustomProtectionRule { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * An array of The target property of a request that would allow it to bypass the protection rule. For example, when `target` is `REQUEST_COOKIE_NAMES`, the list may include names of cookies to exclude from the protection rule. When the target is `ARGS`, the list may include strings of URL query parameters and values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from the protection rule. `Exclusions` properties must not contain whitespace, comma or |. **Note:** If protection rules have been enabled that utilize the `maxArgumentCount` or `maxTotalNameLengthOfArguments` properties, and the `target` property has been set to `ARGS`, it is important that the `exclusions` properties be defined to honor those protection rule settings in a consistent manner. */ exclusions: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigCustomProtectionRuleExclusion[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule. */ id: string; } interface GetWaasPoliciesWaasPolicyWafConfigCustomProtectionRuleExclusion { /** * An array of The target property of a request that would allow it to bypass the protection rule. For example, when `target` is `REQUEST_COOKIE_NAMES`, the list may include names of cookies to exclude from the protection rule. When the target is `ARGS`, the list may include strings of URL query parameters and values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from the protection rule. `Exclusions` properties must not contain whitespace, comma or |. **Note:** If protection rules have been enabled that utilize the `maxArgumentCount` or `maxTotalNameLengthOfArguments` properties, and the `target` property has been set to `ARGS`, it is important that the `exclusions` properties be defined to honor those protection rule settings in a consistent manner. */ exclusions: string[]; /** * The target of the exclusion. */ target: string; } interface GetWaasPoliciesWaasPolicyWafConfigDeviceFingerprintChallenge { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * The number of seconds between challenges from the same IP address. If unspecified, defaults to `60`. */ actionExpirationInSeconds: number; /** * The challenge settings if `action` is set to `BLOCK`. */ challengeSettings: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigDeviceFingerprintChallengeChallengeSetting[]; /** * The number of failed requests before taking action. If unspecified, defaults to `10`. */ failureThreshold: number; /** * The number of seconds before the failure threshold resets. If unspecified, defaults to `60`. */ failureThresholdExpirationInSeconds: number; /** * Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * The maximum number of IP addresses permitted with the same device fingerprint. If unspecified, defaults to `20`. */ maxAddressCount: number; /** * The number of seconds before the maximum addresses count resets. If unspecified, defaults to `60`. */ maxAddressCountExpirationInSeconds: number; } interface GetWaasPoliciesWaasPolicyWafConfigDeviceFingerprintChallengeChallengeSetting { /** * If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; } interface GetWaasPoliciesWaasPolicyWafConfigHumanInteractionChallenge { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * The number of seconds between challenges from the same IP address. If unspecified, defaults to `60`. */ actionExpirationInSeconds: number; /** * The challenge settings if `action` is set to `BLOCK`. */ challengeSettings: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigHumanInteractionChallengeChallengeSetting[]; /** * The number of failed requests before taking action. If unspecified, defaults to `10`. */ failureThreshold: number; /** * The number of seconds before the failure threshold resets. If unspecified, defaults to `60`. */ failureThresholdExpirationInSeconds: number; /** * The number of interactions required to pass the challenge. If unspecified, defaults to `3`. */ interactionThreshold: number; /** * Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses. */ isNatEnabled: boolean; /** * The number of seconds to record the interactions from the user. If unspecified, defaults to `15`. */ recordingPeriodInSeconds: number; /** * Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the `action` is set to `DETECT`. */ setHttpHeaders: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigHumanInteractionChallengeSetHttpHeader[]; } interface GetWaasPoliciesWaasPolicyWafConfigHumanInteractionChallengeChallengeSetting { /** * If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; } interface GetWaasPoliciesWaasPolicyWafConfigHumanInteractionChallengeSetHttpHeader { /** * The unique name of the whitelist. */ name: string; /** * The value of the header. */ value: string; } interface GetWaasPoliciesWaasPolicyWafConfigJsChallenge { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * The number of seconds between challenges from the same IP address. If unspecified, defaults to `60`. */ actionExpirationInSeconds: number; /** * When enabled, redirect responses from the origin will also be challenged. This will change HTTP 301/302 responses from origin to HTTP 200 with an HTML body containing JavaScript page redirection. */ areRedirectsChallenged: boolean; /** * The challenge settings if `action` is set to `BLOCK`. */ challengeSettings: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigJsChallengeChallengeSetting[]; /** * When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions. */ criterias: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigJsChallengeCriteria[]; /** * The number of failed requests before taking action. If unspecified, defaults to `10`. */ failureThreshold: number; /** * Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses. */ isNatEnabled: boolean; /** * Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the `action` is set to `DETECT`. */ setHttpHeaders: outputs.Waas.GetWaasPoliciesWaasPolicyWafConfigJsChallengeSetHttpHeader[]; } interface GetWaasPoliciesWaasPolicyWafConfigJsChallengeChallengeSetting { /** * If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; } interface GetWaasPoliciesWaasPolicyWafConfigJsChallengeCriteria { /** * The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request. * * **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`. * * **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`. * * **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`. * * **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. * * **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. * * **URL_REGEX:** Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the `value` field. * * **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field. * * **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the `value` field. * * **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list. * * **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list. * * **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match. * * **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` */ condition: string; /** * When enabled, the condition will be matched with case-sensitive rules. */ isCaseSensitive: boolean; /** * The value of the header. */ value: string; } interface GetWaasPoliciesWaasPolicyWafConfigJsChallengeSetHttpHeader { /** * The unique name of the whitelist. */ name: string; /** * The value of the header. */ value: string; } interface GetWaasPoliciesWaasPolicyWafConfigProtectionSetting { /** * The list of allowed HTTP methods. If unspecified, default to `[OPTIONS, GET, HEAD, POST]`. This setting only applies if a corresponding protection rule is enabled, such as the "Restrict HTTP Request Methods" rule (key: 911100). */ allowedHttpMethods: string[]; /** * If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * Inspects the response body of origin responses. Can be used to detect leakage of sensitive data. If unspecified, defaults to `false`. */ isResponseInspected: boolean; /** * The maximum number of arguments allowed to be passed to your application before an action is taken. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `255`. This setting only applies if a corresponding protection rule is enabled, such as the "Number of Arguments Limits" rule (key: 960335). Example: If `maxArgumentCount` to `2` for the Max Number of Arguments protection rule (key: 960335), the following requests would be blocked: `GET /myapp/path?query=one&query=two&query=three` `POST /myapp/path` with Body `{"argument1":"one","argument2":"two","argument3":"three"}` */ maxArgumentCount: number; /** * The maximum length allowed for each argument name, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `400`. This setting only applies if a corresponding protection rule is enabled, such as the "Values Limits" rule (key: 960208). */ maxNameLengthPerArgument: number; /** * The maximum response size to be fully inspected, in binary kilobytes (KiB). Anything over this limit will be partially inspected. If unspecified, defaults to `1024`. */ maxResponseSizeInKiB: number; /** * The maximum length allowed for the sum of the argument name and value, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `64000`. This setting only applies if a corresponding protection rule is enabled, such as the "Total Arguments Limits" rule (key: 960341). */ maxTotalNameLengthOfArguments: number; /** * The list of media types to allow for inspection, if `isResponseInspected` is enabled. Only responses with MIME types in this list will be inspected. If unspecified, defaults to `["text/html", "text/plain", "text/xml"]`. */ mediaTypes: string[]; /** * The length of time to analyze traffic traffic, in days. After the analysis period, `WafRecommendations` will be populated. If unspecified, defaults to `10`. */ recommendationsPeriodInDays: number; } interface GetWaasPoliciesWaasPolicyWafConfigWhitelist { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of IP address lists to include in the whitelist. */ addressLists: string[]; /** * A set of IP addresses or CIDR notations to include in the whitelist. */ addresses: string[]; /** * The unique name of the whitelist. */ name: string; } interface GetWaasPolicyOrigin { /** * A list of HTTP headers to forward to your origin. */ customHeaders: outputs.Waas.GetWaasPolicyOriginCustomHeader[]; /** * The HTTP port on the origin that the web application listens on. If unspecified, defaults to `80`. If `0` is specified - the origin is not used for HTTP traffic. */ httpPort?: number; /** * The HTTPS port on the origin that the web application listens on. If unspecified, defaults to `443`. If `0` is specified - the origin is not used for HTTPS traffic. */ httpsPort?: number; label: string; /** * The URI of the origin. Does not support paths. Port numbers should be specified in the `httpPort` and `httpsPort` fields. */ uri: string; } interface GetWaasPolicyOriginCustomHeader { /** * The unique name of the whitelist. */ name: string; /** * The value of the header. */ value: string; } interface GetWaasPolicyOriginGroup { label: string; originGroups: outputs.Waas.GetWaasPolicyOriginGroupOriginGroup[]; } interface GetWaasPolicyOriginGroupOriginGroup { /** * The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in `Origins`. Required when creating the `WafConfig` resource, but not on update. */ origin: string; weight: number; } interface GetWaasPolicyPolicyConfig { /** * The OCID of the SSL certificate to use if HTTPS is supported. */ certificateId: string; /** * The set cipher group for the configured TLS protocol. This sets the configuration for the TLS connections between clients and edge nodes only. * * **DEFAULT:** Cipher group supports TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3 protocols. It has the following ciphers enabled: `ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:!DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA` */ cipherGroup: string; /** * Specifies an HTTP header name which is treated as the connecting client's IP address. Applicable only if `isBehindCdn` is enabled. */ clientAddressHeader: string; /** * Health checks monitor the status of your origin servers and only route traffic to the origins that pass the health check. If the health check fails, origin is automatically removed from the load balancing. There is roughly one health check per EDGE POP per period. Any checks that pass will be reported as "healthy". */ healthChecks: outputs.Waas.GetWaasPolicyPolicyConfigHealthChecks; /** * Enabling `isBehindCdn` allows for the collection of IP addresses from client requests if the WAF is connected to a CDN. */ isBehindCdn: boolean; /** * Enable or disable automatic content caching based on the response `cache-control` header. This feature enables the origin to act as a proxy cache. Caching is usually defined using `cache-control` header. For example `cache-control: max-age=120` means that the returned resource is valid for 120 seconds. Caching rules will overwrite this setting. */ isCacheControlRespected: boolean; /** * Enable or disable HTTPS support. If true, a `certificateId` is required. If unspecified, defaults to `false`. */ isHttpsEnabled: boolean; /** * Force HTTP to HTTPS redirection. If unspecified, defaults to `false`. */ isHttpsForced: boolean; /** * Enable or disable GZIP compression of origin responses. If enabled, the header `Accept-Encoding: gzip` is sent to origin, otherwise, the empty `Accept-Encoding:` header is used. */ isOriginCompressionEnabled: boolean; /** * Enable or disable buffering of responses from the origin. Buffering improves overall stability in case of network issues, but slightly increases Time To First Byte. */ isResponseBufferingEnabled: boolean; /** * SNI stands for Server Name Indication and is an extension of the TLS protocol. It indicates which hostname is being contacted by the browser at the beginning of the 'handshake'-process. This allows a server to connect multiple SSL Certificates to one IP address and port. */ isSniEnabled: boolean; /** * An object that represents a load balancing method and its properties. */ loadBalancingMethod: outputs.Waas.GetWaasPolicyPolicyConfigLoadBalancingMethod; /** * A list of allowed TLS protocols. Only applicable when HTTPS support is enabled. The TLS protocol is negotiated while the request is connecting and the most recent protocol supported by both the edge node and client browser will be selected. If no such version exists, the connection will be aborted. * * **TLS_V1:** corresponds to TLS 1.0 specification. * * **TLS_V1_1:** corresponds to TLS 1.1 specification. * * **TLS_V1_2:** corresponds to TLS 1.2 specification. * * **TLS_V1_3:** corresponds to TLS 1.3 specification. */ tlsProtocols: string[]; /** * ModSecurity is not capable to inspect WebSockets. Therefore paths specified here have WAF disabled if Connection request header from the client has the value Upgrade (case insensitive matching) and Upgrade request header has the value websocket (case insensitive matching). Paths matches if the concatenation of request URL path and query starts with the contents of the one of `websocketPathPrefixes` array value. In All other cases challenges, like JSC, HIC and etc., remain active. */ websocketPathPrefixes: string[]; } interface GetWaasPolicyPolicyConfigHealthChecks { /** * The HTTP response codes that signify a healthy state. * * **2XX:** Success response code group. * * **3XX:** Redirection response code group. * * **4XX:** Client errors response code group. * * **5XX:** Server errors response code group. */ expectedResponseCodeGroups: string[]; /** * Health check will search for the given text in a case-sensitive manner within the response body and will fail if the text is not found. */ expectedResponseText: string; /** * HTTP header fields to include in health check requests, expressed as `"name": "value"` properties. Because HTTP header field names are case-insensitive, any use of names that are case-insensitive equal to other names will be rejected. If Host is not specified, requests will include a Host header field with value matching the policy's protected domain. If User-Agent is not specified, requests will include a User-Agent header field with value "waf health checks". */ headers: { [key: string]: string; }; /** * Number of successful health checks after which the server is marked up. */ healthyThreshold: number; /** * Time between health checks of an individual origin server, in seconds. */ intervalInSeconds: number; /** * Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * Enables or disables additional check for predefined text in addition to response code. */ isResponseTextCheckEnabled: boolean; /** * Load balancing methods are algorithms used to efficiently distribute traffic among origin servers. * * **[IP_HASH](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/IPHashLoadBalancingMethod):** All the incoming requests from the same client IP address should go to the same content origination server. IP_HASH load balancing method uses origin weights when choosing which origin should the hash be assigned to initially. * * **[ROUND_ROBIN](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/RoundRobinLoadBalancingMethod):** Forwards requests sequentially to the available origin servers. The first request - to the first origin server, the second request - to the next origin server, and so on. After it sends a request to the last origin server, it starts again with the first origin server. When using weights on origins, Weighted Round Robin assigns more requests to origins with a greater weight. Over a period of time, origins will receive a number of requests in proportion to their weight. * * **[STICKY_COOKIE](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/StickyCookieLoadBalancingMethod):** Adds a session cookie to the first response from the origin server and identifies the server that sent the response. The client's next request contains the cookie value, and nginx routes the request to the origin server that responded to the first request. STICKY_COOKIE load balancing method falls back to Round Robin for the first request. */ method: string; /** * Path to visit on your origins when performing the health check. */ path: string; /** * Response timeout represents wait time until request is considered failed, in seconds. */ timeoutInSeconds: number; /** * Number of failed health checks after which the server is marked down. */ unhealthyThreshold: number; } interface GetWaasPolicyPolicyConfigLoadBalancingMethod { /** * The domain for which the cookie is set, defaults to WAAS policy domain. */ domain: string; /** * The time for which a browser should keep the cookie in seconds. Empty value will cause the cookie to expire at the end of a browser session. */ expirationTimeInSeconds: number; /** * Load balancing methods are algorithms used to efficiently distribute traffic among origin servers. * * **[IP_HASH](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/IPHashLoadBalancingMethod):** All the incoming requests from the same client IP address should go to the same content origination server. IP_HASH load balancing method uses origin weights when choosing which origin should the hash be assigned to initially. * * **[ROUND_ROBIN](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/RoundRobinLoadBalancingMethod):** Forwards requests sequentially to the available origin servers. The first request - to the first origin server, the second request - to the next origin server, and so on. After it sends a request to the last origin server, it starts again with the first origin server. When using weights on origins, Weighted Round Robin assigns more requests to origins with a greater weight. Over a period of time, origins will receive a number of requests in proportion to their weight. * * **[STICKY_COOKIE](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/StickyCookieLoadBalancingMethod):** Adds a session cookie to the first response from the origin server and identifies the server that sent the response. The client's next request contains the cookie value, and nginx routes the request to the origin server that responded to the first request. STICKY_COOKIE load balancing method falls back to Round Robin for the first request. */ method: string; /** * The unique name of the whitelist. */ name: string; } interface GetWaasPolicyWafConfig { /** * The access rules applied to the Web Application Firewall. Used for defining custom access policies with the combination of `ALLOW`, `DETECT`, and `BLOCK` rules, based on different criteria. */ accessRules: outputs.Waas.GetWaasPolicyWafConfigAccessRule[]; /** * The IP address rate limiting settings used to limit the number of requests from an address. */ addressRateLimiting: outputs.Waas.GetWaasPolicyWafConfigAddressRateLimiting; /** * A list of caching rules applied to the web application. */ cachingRules: outputs.Waas.GetWaasPolicyWafConfigCachingRule[]; /** * A list of CAPTCHA challenge settings. These are used to challenge requests with a CAPTCHA to block bots. */ captchas: outputs.Waas.GetWaasPolicyWafConfigCaptcha[]; /** * A list of the custom protection rule OCIDs and their actions. */ customProtectionRules: outputs.Waas.GetWaasPolicyWafConfigCustomProtectionRule[]; /** * The device fingerprint challenge settings. Used to detect unique devices based on the device fingerprint information collected in order to block bots. */ deviceFingerprintChallenge: outputs.Waas.GetWaasPolicyWafConfigDeviceFingerprintChallenge; /** * The human interaction challenge settings. Used to look for natural human interactions such as mouse movements, time on site, and page scrolling to identify bots. */ humanInteractionChallenge: outputs.Waas.GetWaasPolicyWafConfigHumanInteractionChallenge; /** * The JavaScript challenge settings. Used to challenge requests with a JavaScript challenge and take the action if a browser has no JavaScript support in order to block bots. */ jsChallenge: outputs.Waas.GetWaasPolicyWafConfigJsChallenge; /** * The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in `Origins`. Required when creating the `WafConfig` resource, but not on update. */ origin: string; /** * The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request. */ originGroups: string[]; /** * The settings to apply to protection rules. */ protectionSettings: outputs.Waas.GetWaasPolicyWafConfigProtectionSettings; /** * A list of IP addresses that bypass the Web Application Firewall. */ whitelists: outputs.Waas.GetWaasPolicyWafConfigWhitelist[]; } interface GetWaasPolicyWafConfigAccessRule { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * The list of challenges to bypass when `action` is set to `BYPASS`. If unspecified or empty, all challenges are bypassed. * * **JS_CHALLENGE:** Bypasses JavaScript Challenge. * * **DEVICE_FINGERPRINT_CHALLENGE:** Bypasses Device Fingerprint Challenge. * * **HUMAN_INTERACTION_CHALLENGE:** Bypasses Human Interaction Challenge. * * **CAPTCHA:** Bypasses CAPTCHA Challenge. */ bypassChallenges: string[]; /** * The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; /** * When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions. */ criterias: outputs.Waas.GetWaasPolicyWafConfigAccessRuleCriteria[]; /** * The unique name of the whitelist. */ name: string; /** * The response status code to return when `action` is set to `REDIRECT`. * * **MOVED_PERMANENTLY:** Used for designating the permanent movement of a page (numerical code - 301). * * **FOUND:** Used for designating the temporary movement of a page (numerical code - 302). */ redirectResponseCode: string; /** * The target to which the request should be redirected, represented as a URI reference. Required when `action` is `REDIRECT`. */ redirectUrl: string; /** * An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of `action` value. */ responseHeaderManipulations: outputs.Waas.GetWaasPolicyWafConfigAccessRuleResponseHeaderManipulation[]; } interface GetWaasPolicyWafConfigAccessRuleCriteria { /** * The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request. * * **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`. * * **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`. * * **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`. * * **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. * * **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. * * **URL_REGEX:** Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the `value` field. * * **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field. * * **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the `value` field. * * **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list. * * **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list. * * **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match. * * **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` */ condition: string; /** * When enabled, the condition will be matched with case-sensitive rules. */ isCaseSensitive: boolean; /** * The value of the header. */ value: string; } interface GetWaasPolicyWafConfigAccessRuleResponseHeaderManipulation { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * A header field name that conforms to RFC 7230. Example: `exampleHeaderName` */ header: string; /** * The value of the header. */ value: string; } interface GetWaasPolicyWafConfigAddressRateLimiting { /** * The number of allowed requests per second from one IP address. If unspecified, defaults to `1`. */ allowedRatePerAddress: number; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * The maximum number of requests allowed to be queued before subsequent requests are dropped. If unspecified, defaults to `10`. */ maxDelayedCountPerAddress: number; } interface GetWaasPolicyWafConfigCachingRule { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` */ cachingDuration: string; /** * The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` */ clientCachingDuration: string; /** * When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions. */ criterias: outputs.Waas.GetWaasPolicyWafConfigCachingRuleCriteria[]; /** * Enables or disables client caching. Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache-Control` header in responses. */ isClientCachingEnabled: boolean; /** * The unique key for the caching rule. */ key: string; /** * The unique name of the whitelist. */ name: string; } interface GetWaasPolicyWafConfigCachingRuleCriteria { /** * The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request. * * **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`. * * **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`. * * **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`. * * **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. * * **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. * * **URL_REGEX:** Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the `value` field. * * **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field. * * **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the `value` field. * * **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list. * * **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list. * * **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match. * * **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` */ condition: string; /** * The value of the header. */ value: string; } interface GetWaasPolicyWafConfigCaptcha { /** * The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to `The CAPTCHA was incorrect. Try again.` */ failureMessage: string; /** * The text to show in the footer when showing a CAPTCHA challenge. If unspecified, defaults to 'Enter the letters and numbers as they are shown in the image above.' */ footerText: string; /** * The text to show in the header when showing a CAPTCHA challenge. If unspecified, defaults to 'We have detected an increased number of attempts to access this website. To help us keep this site secure, please let us know that you are not a robot by entering the text from the image below.' */ headerText: string; /** * The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to `300`. */ sessionExpirationInSeconds: number; /** * The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to `Yes, I am human`. */ submitLabel: string; /** * The title used when displaying a CAPTCHA challenge. If unspecified, defaults to `Are you human?` */ title: string; /** * The unique URL path at which to show the CAPTCHA challenge. */ url: string; } interface GetWaasPolicyWafConfigCustomProtectionRule { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * An array of The target property of a request that would allow it to bypass the protection rule. For example, when `target` is `REQUEST_COOKIE_NAMES`, the list may include names of cookies to exclude from the protection rule. When the target is `ARGS`, the list may include strings of URL query parameters and values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from the protection rule. `Exclusions` properties must not contain whitespace, comma or |. **Note:** If protection rules have been enabled that utilize the `maxArgumentCount` or `maxTotalNameLengthOfArguments` properties, and the `target` property has been set to `ARGS`, it is important that the `exclusions` properties be defined to honor those protection rule settings in a consistent manner. */ exclusions: outputs.Waas.GetWaasPolicyWafConfigCustomProtectionRuleExclusion[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule. */ id: string; } interface GetWaasPolicyWafConfigCustomProtectionRuleExclusion { /** * An array of The target property of a request that would allow it to bypass the protection rule. For example, when `target` is `REQUEST_COOKIE_NAMES`, the list may include names of cookies to exclude from the protection rule. When the target is `ARGS`, the list may include strings of URL query parameters and values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from the protection rule. `Exclusions` properties must not contain whitespace, comma or |. **Note:** If protection rules have been enabled that utilize the `maxArgumentCount` or `maxTotalNameLengthOfArguments` properties, and the `target` property has been set to `ARGS`, it is important that the `exclusions` properties be defined to honor those protection rule settings in a consistent manner. */ exclusions: string[]; /** * The target of the exclusion. */ target: string; } interface GetWaasPolicyWafConfigDeviceFingerprintChallenge { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * The number of seconds between challenges from the same IP address. If unspecified, defaults to `60`. */ actionExpirationInSeconds: number; /** * The challenge settings if `action` is set to `BLOCK`. */ challengeSettings: outputs.Waas.GetWaasPolicyWafConfigDeviceFingerprintChallengeChallengeSettings; /** * The number of failed requests before taking action. If unspecified, defaults to `10`. */ failureThreshold: number; /** * The number of seconds before the failure threshold resets. If unspecified, defaults to `60`. */ failureThresholdExpirationInSeconds: number; /** * Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * The maximum number of IP addresses permitted with the same device fingerprint. If unspecified, defaults to `20`. */ maxAddressCount: number; /** * The number of seconds before the maximum addresses count resets. If unspecified, defaults to `60`. */ maxAddressCountExpirationInSeconds: number; } interface GetWaasPolicyWafConfigDeviceFingerprintChallengeChallengeSettings { /** * If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; } interface GetWaasPolicyWafConfigHumanInteractionChallenge { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * The number of seconds between challenges from the same IP address. If unspecified, defaults to `60`. */ actionExpirationInSeconds: number; /** * The challenge settings if `action` is set to `BLOCK`. */ challengeSettings: outputs.Waas.GetWaasPolicyWafConfigHumanInteractionChallengeChallengeSettings; /** * The number of failed requests before taking action. If unspecified, defaults to `10`. */ failureThreshold: number; /** * The number of seconds before the failure threshold resets. If unspecified, defaults to `60`. */ failureThresholdExpirationInSeconds: number; /** * The number of interactions required to pass the challenge. If unspecified, defaults to `3`. */ interactionThreshold: number; /** * Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses. */ isNatEnabled: boolean; /** * The number of seconds to record the interactions from the user. If unspecified, defaults to `15`. */ recordingPeriodInSeconds: number; /** * Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the `action` is set to `DETECT`. */ setHttpHeader: outputs.Waas.GetWaasPolicyWafConfigHumanInteractionChallengeSetHttpHeader; } interface GetWaasPolicyWafConfigHumanInteractionChallengeChallengeSettings { /** * If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; } interface GetWaasPolicyWafConfigHumanInteractionChallengeSetHttpHeader { /** * The unique name of the whitelist. */ name: string; /** * The value of the header. */ value: string; } interface GetWaasPolicyWafConfigJsChallenge { /** * The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * The number of seconds between challenges from the same IP address. If unspecified, defaults to `60`. */ actionExpirationInSeconds: number; /** * When enabled, redirect responses from the origin will also be challenged. This will change HTTP 301/302 responses from origin to HTTP 200 with an HTML body containing JavaScript page redirection. */ areRedirectsChallenged: boolean; /** * The challenge settings if `action` is set to `BLOCK`. */ challengeSettings: outputs.Waas.GetWaasPolicyWafConfigJsChallengeChallengeSettings; /** * When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions. */ criterias: outputs.Waas.GetWaasPolicyWafConfigJsChallengeCriteria[]; /** * The number of failed requests before taking action. If unspecified, defaults to `10`. */ failureThreshold: number; /** * Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses. */ isNatEnabled: boolean; /** * Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the `action` is set to `DETECT`. */ setHttpHeader: outputs.Waas.GetWaasPolicyWafConfigJsChallengeSetHttpHeader; } interface GetWaasPolicyWafConfigJsChallengeChallengeSettings { /** * If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; } interface GetWaasPolicyWafConfigJsChallengeCriteria { /** * The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request. * * **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`. * * **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`. * * **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`. * * **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. * * **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. * * **URL_REGEX:** Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the `value` field. * * **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field. * * **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the `value` field. * * **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list. * * **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list. * * **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match. * * **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` */ condition: string; /** * When enabled, the condition will be matched with case-sensitive rules. */ isCaseSensitive: boolean; /** * The value of the header. */ value: string; } interface GetWaasPolicyWafConfigJsChallengeSetHttpHeader { /** * The unique name of the whitelist. */ name: string; /** * The value of the header. */ value: string; } interface GetWaasPolicyWafConfigProtectionSettings { /** * The list of allowed HTTP methods. If unspecified, default to `[OPTIONS, GET, HEAD, POST]`. This setting only applies if a corresponding protection rule is enabled, such as the "Restrict HTTP Request Methods" rule (key: 911100). */ allowedHttpMethods: string[]; /** * If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * Inspects the response body of origin responses. Can be used to detect leakage of sensitive data. If unspecified, defaults to `false`. */ isResponseInspected: boolean; /** * The maximum number of arguments allowed to be passed to your application before an action is taken. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `255`. This setting only applies if a corresponding protection rule is enabled, such as the "Number of Arguments Limits" rule (key: 960335). Example: If `maxArgumentCount` to `2` for the Max Number of Arguments protection rule (key: 960335), the following requests would be blocked: `GET /myapp/path?query=one&query=two&query=three` `POST /myapp/path` with Body `{"argument1":"one","argument2":"two","argument3":"three"}` */ maxArgumentCount: number; /** * The maximum length allowed for each argument name, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `400`. This setting only applies if a corresponding protection rule is enabled, such as the "Values Limits" rule (key: 960208). */ maxNameLengthPerArgument: number; /** * The maximum response size to be fully inspected, in binary kilobytes (KiB). Anything over this limit will be partially inspected. If unspecified, defaults to `1024`. */ maxResponseSizeInKiB: number; /** * The maximum length allowed for the sum of the argument name and value, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `64000`. This setting only applies if a corresponding protection rule is enabled, such as the "Total Arguments Limits" rule (key: 960341). */ maxTotalNameLengthOfArguments: number; /** * The list of media types to allow for inspection, if `isResponseInspected` is enabled. Only responses with MIME types in this list will be inspected. If unspecified, defaults to `["text/html", "text/plain", "text/xml"]`. */ mediaTypes: string[]; /** * The length of time to analyze traffic traffic, in days. After the analysis period, `WafRecommendations` will be populated. If unspecified, defaults to `10`. */ recommendationsPeriodInDays: number; } interface GetWaasPolicyWafConfigWhitelist { /** * A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of IP address lists to include in the whitelist. */ addressLists: string[]; /** * A set of IP addresses or CIDR notations to include in the whitelist. */ addresses: string[]; /** * The unique name of the whitelist. */ name: string; } interface HttpRedirectTarget { /** * (Updatable) The host portion of the redirect. */ host: string; /** * (Updatable) The path component of the target URL (e.g., "/path/to/resource" in "https://target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying, or request-prefixing. Use of \ is not permitted except to escape a following \, {, or }. An empty value is treated the same as static "/". A static value must begin with a leading "/", optionally followed by other path characters. A request-copying value must exactly match "{path}", and will be replaced with the path component of the request URL (including its initial "/"). A request-prefixing value must start with "/" and end with a non-escaped "{path}", which will be replaced with the path component of the request URL (including its initial "/"). Only one such replacement token is allowed. */ path: string; /** * (Updatable) Port number of the target destination of the redirect, default to match protocol */ port: number; /** * (Updatable) The protocol used for the target, http or https. */ protocol: string; /** * (Updatable) The query component of the target URL (e.g., "?redirected" in "https://target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying. Use of \ is not permitted except to escape a following \, {, or }. An empty value results in a redirection target URL with no query component. A static value must begin with a leading "?", optionally followed by other query characters. A request-copying value must exactly match "{query}", and will be replaced with the query component of the request URL (including a leading "?" if and only if the request URL includes a query component). * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ query: string; } interface PolicyOrigin { /** * (Updatable) A list of HTTP headers to forward to your origin. */ customHeaders: outputs.Waas.PolicyOriginCustomHeader[]; /** * (Updatable) The HTTP port on the origin that the web application listens on. If unspecified, defaults to `80`. If `0` is specified - the origin is not used for HTTP traffic. */ httpPort?: number; /** * (Updatable) The HTTPS port on the origin that the web application listens on. If unspecified, defaults to `443`. If `0` is specified - the origin is not used for HTTPS traffic. */ httpsPort?: number; label: string; /** * (Updatable) The URI of the origin. Does not support paths. Port numbers should be specified in the `httpPort` and `httpsPort` fields. */ uri: string; } interface PolicyOriginCustomHeader { /** * (Updatable) The name of the header. */ name: string; /** * (Updatable) The value of the header. */ value: string; } interface PolicyOriginGroup { label: string; originGroups: outputs.Waas.PolicyOriginGroupOriginGroup[]; } interface PolicyOriginGroupOriginGroup { /** * The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in `Origins`. Required when creating the `WafConfig` resource, but not on update. */ origin: string; weight?: number; } interface PolicyPolicyConfig { /** * (Updatable) The OCID of the SSL certificate to use if HTTPS is supported. */ certificateId: string; /** * (Updatable) The set cipher group for the configured TLS protocol. This sets the configuration for the TLS connections between clients and edge nodes only. * * **DEFAULT:** Cipher group supports TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3 protocols. It has the following ciphers enabled: `ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:!DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA` */ cipherGroup: string; /** * (Updatable) Specifies an HTTP header name which is treated as the connecting client's IP address. Applicable only if `isBehindCdn` is enabled. * * The edge node reads this header and its value and sets the client IP address as specified. It does not create the header if the header is not present in the request. If the header is not present, the connecting IP address will be used as the client's true IP address. It uses the last IP address in the header's value as the true IP address. * * Example: `X-Client-Ip: 11.1.1.1, 13.3.3.3` * * In the case of multiple headers with the same name, only the first header will be used. It is assumed that CDN sets the correct client IP address to prevent spoofing. * * **X_FORWARDED_FOR:** Corresponds to `X-Forwarded-For` header name. * * **X_CLIENT_IP:** Corresponds to `X-Client-Ip` header name. * * **X_REAL_IP:** Corresponds to `X-Real-Ip` header name. * * **CLIENT_IP:** Corresponds to `Client-Ip` header name. * * **TRUE_CLIENT_IP:** Corresponds to `True-Client-Ip` header name. */ clientAddressHeader?: string; /** * (Updatable) Health checks monitor the status of your origin servers and only route traffic to the origins that pass the health check. If the health check fails, origin is automatically removed from the load balancing. There is roughly one health check per EDGE POP per period. Any checks that pass will be reported as "healthy". */ healthChecks: outputs.Waas.PolicyPolicyConfigHealthChecks; /** * (Updatable) Enabling `isBehindCdn` allows for the collection of IP addresses from client requests if the WAF is connected to a CDN. */ isBehindCdn: boolean; /** * (Updatable) Enable or disable automatic content caching based on the response `cache-control` header. This feature enables the origin to act as a proxy cache. Caching is usually defined using `cache-control` header. For example `cache-control: max-age=120` means that the returned resource is valid for 120 seconds. Caching rules will overwrite this setting. */ isCacheControlRespected: boolean; /** * (Updatable) Enable or disable HTTPS support. If true, a `certificateId` is required. If unspecified, defaults to `false`. */ isHttpsEnabled: boolean; /** * (Updatable) Force HTTP to HTTPS redirection. If unspecified, defaults to `false`. */ isHttpsForced: boolean; /** * (Updatable) Enable or disable GZIP compression of origin responses. If enabled, the header `Accept-Encoding: gzip` is sent to origin, otherwise, the empty `Accept-Encoding:` header is used. */ isOriginCompressionEnabled: boolean; /** * (Updatable) Enable or disable buffering of responses from the origin. Buffering improves overall stability in case of network issues, but slightly increases Time To First Byte. */ isResponseBufferingEnabled: boolean; /** * (Updatable) SNI stands for Server Name Indication and is an extension of the TLS protocol. It indicates which hostname is being contacted by the browser at the beginning of the 'handshake'-process. This allows a server to connect multiple SSL Certificates to one IP address and port. */ isSniEnabled: boolean; /** * (Updatable) An object that represents a load balancing method and its properties. */ loadBalancingMethod: outputs.Waas.PolicyPolicyConfigLoadBalancingMethod; /** * (Updatable) A list of allowed TLS protocols. Only applicable when HTTPS support is enabled. The TLS protocol is negotiated while the request is connecting and the most recent protocol supported by both the edge node and client browser will be selected. If no such version exists, the connection will be aborted. * * **TLS_V1:** corresponds to TLS 1.0 specification. * * **TLS_V1_1:** corresponds to TLS 1.1 specification. * * **TLS_V1_2:** corresponds to TLS 1.2 specification. * * **TLS_V1_3:** corresponds to TLS 1.3 specification. * * Enabled TLS protocols must go in a row. For example if `TLS_v1_1` and `TLS_V1_3` are enabled, `TLS_V1_2` must be enabled too. */ tlsProtocols: string[]; /** * (Updatable) ModSecurity is not capable to inspect WebSockets. Therefore paths specified here have WAF disabled if Connection request header from the client has the value Upgrade (case insensitive matching) and Upgrade request header has the value websocket (case insensitive matching). Paths matches if the concatenation of request URL path and query starts with the contents of the one of `websocketPathPrefixes` array value. In All other cases challenges, like JSC, HIC and etc., remain active. */ websocketPathPrefixes: string[]; } interface PolicyPolicyConfigHealthChecks { /** * (Updatable) The HTTP response codes that signify a healthy state. * * **2XX:** Success response code group. * * **3XX:** Redirection response code group. * * **4XX:** Client errors response code group. * * **5XX:** Server errors response code group. */ expectedResponseCodeGroups: string[]; /** * (Updatable) Health check will search for the given text in a case-sensitive manner within the response body and will fail if the text is not found. */ expectedResponseText: string; /** * (Updatable) HTTP header fields to include in health check requests, expressed as `"name": "value"` properties. Because HTTP header field names are case-insensitive, any use of names that are case-insensitive equal to other names will be rejected. If Host is not specified, requests will include a Host header field with value matching the policy's protected domain. If User-Agent is not specified, requests will include a User-Agent header field with value "waf health checks". * * **Note:** The only currently-supported header fields are Host and User-Agent. */ headers: { [key: string]: string; }; /** * (Updatable) Number of successful health checks after which the server is marked up. */ healthyThreshold: number; /** * (Updatable) Time between health checks of an individual origin server, in seconds. */ intervalInSeconds: number; /** * (Updatable) Enables or disables the health checks. */ isEnabled: boolean; /** * (Updatable) Enables or disables additional check for predefined text in addition to response code. */ isResponseTextCheckEnabled: boolean; /** * (Updatable) An HTTP verb (i.e. HEAD, GET, or POST) to use when performing the health check. */ method: string; /** * (Updatable) Path to visit on your origins when performing the health check. */ path: string; /** * (Updatable) Response timeout represents wait time until request is considered failed, in seconds. */ timeoutInSeconds: number; /** * (Updatable) Number of failed health checks after which the server is marked down. */ unhealthyThreshold: number; } interface PolicyPolicyConfigLoadBalancingMethod { /** * (Updatable) The domain for which the cookie is set, defaults to WAAS policy domain. */ domain: string; /** * (Updatable) The time for which a browser should keep the cookie in seconds. Empty value will cause the cookie to expire at the end of a browser session. */ expirationTimeInSeconds: number; /** * (Updatable) Load balancing methods are algorithms used to efficiently distribute traffic among origin servers. * * **[IP_HASH](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/IPHashLoadBalancingMethod):** All the incoming requests from the same client IP address should go to the same content origination server. IP_HASH load balancing method uses origin weights when choosing which origin should the hash be assigned to initially. * * **[ROUND_ROBIN](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/RoundRobinLoadBalancingMethod):** Forwards requests sequentially to the available origin servers. The first request - to the first origin server, the second request - to the next origin server, and so on. After it sends a request to the last origin server, it starts again with the first origin server. When using weights on origins, Weighted Round Robin assigns more requests to origins with a greater weight. Over a period of time, origins will receive a number of requests in proportion to their weight. * * **[STICKY_COOKIE](https://www.terraform.io/iaas/api/#/en/waas/latest/datatypes/StickyCookieLoadBalancingMethod):** Adds a session cookie to the first response from the origin server and identifies the server that sent the response. The client's next request contains the cookie value, and nginx routes the request to the origin server that responded to the first request. STICKY_COOKIE load balancing method falls back to Round Robin for the first request. */ method: string; /** * (Updatable) The name of the cookie used to track the persistence. Can contain any US-ASCII character except separator or control character. */ name: string; } interface PolicyWafConfig { /** * (Updatable) The access rules applied to the Web Application Firewall. Access rules allow custom content access policies to be defined and `ALLOW`, `DETECT`, or `BLOCK` actions to be taken on a request when specified criteria are met. */ accessRules: outputs.Waas.PolicyWafConfigAccessRule[]; /** * (Updatable) The settings used to limit the number of requests from an IP address. */ addressRateLimiting: outputs.Waas.PolicyWafConfigAddressRateLimiting; /** * (Updatable) A list of caching rules applied to the web application. */ cachingRules: outputs.Waas.PolicyWafConfigCachingRule[]; /** * (Updatable) A list of CAPTCHA challenge settings. CAPTCHAs challenge requests to ensure a human is attempting to reach the specified URL and not a bot. */ captchas: outputs.Waas.PolicyWafConfigCaptcha[]; /** * (Updatable) A list of the custom protection rule OCIDs and their actions. */ customProtectionRules: outputs.Waas.PolicyWafConfigCustomProtectionRule[]; /** * (Updatable) The device fingerprint challenge settings. Blocks bots based on unique device fingerprint information. */ deviceFingerprintChallenge: outputs.Waas.PolicyWafConfigDeviceFingerprintChallenge; /** * (Updatable) The human interaction challenge settings. Detects natural human interactions such as mouse movements, time on site, and page scrolling to identify bots. */ humanInteractionChallenge: outputs.Waas.PolicyWafConfigHumanInteractionChallenge; /** * (Updatable) The JavaScript challenge settings. Blocks bots by challenging requests from browsers that have no JavaScript support. */ jsChallenge: outputs.Waas.PolicyWafConfigJsChallenge; /** * (Updatable) The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in `Origins`. Required when creating the `WafConfig` resource, but is not required upon updating the configuration. */ origin: string; /** * (Updatable) The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request. */ originGroups: string[]; /** * (Updatable) The settings applied to protection rules. */ protectionSettings: outputs.Waas.PolicyWafConfigProtectionSettings; /** * (Updatable) A list of IP addresses that bypass the Web Application Firewall. */ whitelists: outputs.Waas.PolicyWafConfigWhitelist[]; } interface PolicyWafConfigAccessRule { /** * (Updatable) The action to take when the access criteria are met for a rule. If unspecified, defaults to `ALLOW`. * * **ALLOW:** Takes no action, just logs the request. * * **DETECT:** Takes no action, but creates an alert for the request. * * **BLOCK:** Blocks the request by returning specified response code or showing error page. * * **BYPASS:** Bypasses some or all challenges. * * **REDIRECT:** Redirects the request to the specified URL. These fields are required when `REDIRECT` is selected: `redirectUrl`, `redirectResponseCode`. * * **SHOW_CAPTCHA:** Show a CAPTCHA Challenge page instead of the requested page. * * Regardless of action, no further rules are processed once a rule is matched. */ action: string; /** * (Updatable) The method used to block requests if `action` is set to `BLOCK` and the access criteria are met. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * (Updatable) The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access rules'. */ blockErrorPageCode: string; /** * (Updatable) The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access blocked by website owner. Please contact support.' */ blockErrorPageDescription: string; /** * (Updatable) The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * (Updatable) The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the access criteria are met. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * (Updatable) The list of challenges to bypass when `action` is set to `BYPASS`. If unspecified or empty, all challenges are bypassed. * * **JS_CHALLENGE:** Bypasses JavaScript Challenge. * * **DEVICE_FINGERPRINT_CHALLENGE:** Bypasses Device Fingerprint Challenge. * * **HUMAN_INTERACTION_CHALLENGE:** Bypasses Human Interaction Challenge. * * **CAPTCHA:** Bypasses CAPTCHA Challenge. */ bypassChallenges: string[]; /** * (Updatable) The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. */ captchaFooter: string; /** * (Updatable) The text to show in the header when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. */ captchaHeader: string; /** * (Updatable) The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `SHOW_CAPTCHA` and the request is challenged. */ captchaSubmitLabel: string; /** * (Updatable) The title used when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged. */ captchaTitle: string; /** * (Updatable) The list of access rule criteria. The rule would be applied only for the requests that matched all the listed conditions. */ criterias: outputs.Waas.PolicyWafConfigAccessRuleCriteria[]; /** * (Updatable) The unique name of the access rule. */ name: string; /** * (Updatable) The response status code to return when `action` is set to `REDIRECT`. * * **MOVED_PERMANENTLY:** Used for designating the permanent movement of a page (numerical code - 301). * * **FOUND:** Used for designating the temporary movement of a page (numerical code - 302). */ redirectResponseCode: string; /** * (Updatable) The target to which the request should be redirected, represented as a URI reference. Required when `action` is `REDIRECT`. */ redirectUrl: string; /** * (Updatable) An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of `action` value. */ responseHeaderManipulations: outputs.Waas.PolicyWafConfigAccessRuleResponseHeaderManipulation[]; } interface PolicyWafConfigAccessRuleCriteria { /** * (Updatable) The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request. * * **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`. * * **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`. * * **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`. * * **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. * * **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. * * **URL_REGEX:** Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the `value` field. * * **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field. * * **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the `value` field. * * **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list. * * **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list. * * **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match. * * **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` * * *Example:* "GET\nPOST" * * **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the contents of the `value` field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` * * *Example:* "GET\nPOST" * * **COUNTRY_IS:** Matches if the request originates from one of countries in the `value` field. The `value` in this case is string with one or multiple countries separated by new line symbol \n Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\nDZ\nAM" * * **COUNTRY_IS_NOT:** Matches if the request does not originate from any of countries in the `value` field. The `value` in this case is string with one or multiple countries separated by new line symbol \n Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\nDZ\nAM" * * **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of the `value` field. *Example:* `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0` * * **USER_AGENT_IS_NOT:** Matches if the requesting user agent is not identical to the contents of the `value` field. *Example:* `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0` */ condition: string; /** * (Updatable) When enabled, the condition will be matched with case-sensitive rules. */ isCaseSensitive: boolean; /** * (Updatable) The criteria value. */ value: string; } interface PolicyWafConfigAccessRuleResponseHeaderManipulation { /** * (Updatable) The action can be one of these values: `ADD_HTTP_RESPONSE_HEADER`, `EXTEND_HTTP_RESPONSE_HEADER`, `REMOVE_HTTP_RESPONSE_HEADER` */ action: string; /** * (Updatable) A header field name that conforms to RFC 7230. Example: `exampleHeaderName` */ header: string; /** * (Updatable) A header field value that conforms to RFC 7230. Example: `exampleValue` */ value: string; } interface PolicyWafConfigAddressRateLimiting { /** * (Updatable) The number of allowed requests per second from one IP address. If unspecified, defaults to `1`. */ allowedRatePerAddress: number; /** * (Updatable) The response status code returned when a request is blocked. If unspecified, defaults to `503`. The list of available response codes: `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * (Updatable) Enables or disables the address rate limiting Web Application Firewall feature. */ isEnabled: boolean; /** * (Updatable) The maximum number of requests allowed to be queued before subsequent requests are dropped. If unspecified, defaults to `10`. */ maxDelayedCountPerAddress: number; } interface PolicyWafConfigCachingRule { /** * (Updatable) The action to take when the criteria of a caching rule are met. * * **CACHE:** Caches requested content when the criteria of the rule are met. * * **BYPASS_CACHE:** Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met. */ action: string; /** * (Updatable) The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` */ cachingDuration?: string; /** * (Updatable) The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`. Example: `PT1H` */ clientCachingDuration?: string; /** * (Updatable) The array of the rule criteria with condition and value. The caching rule would be applied for the requests that matched any of the listed conditions. */ criterias: outputs.Waas.PolicyWafConfigCachingRuleCriteria[]; /** * (Updatable) Enables or disables client caching. Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache-Control` header in responses. */ isClientCachingEnabled: boolean; /** * (Updatable) The unique key for the caching rule. */ key: string; /** * (Updatable) The name of the caching rule. */ name: string; } interface PolicyWafConfigCachingRuleCriteria { /** * (Updatable) The condition of the caching rule criteria. * * **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. * * **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. * * **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. * * **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. * * URLs must start with a `/`. URLs can't contain restricted double slashes `//`. URLs can't contain the restricted `'` `&` `?` symbols. Resources to cache can only be specified by a URL, any query parameters are ignored. */ condition: string; /** * (Updatable) The value of the caching rule criteria. */ value: string; } interface PolicyWafConfigCaptcha { /** * (Updatable) The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to `The CAPTCHA was incorrect. Try again.` */ failureMessage: string; /** * (Updatable) The text to show in the footer when showing a CAPTCHA challenge. If unspecified, defaults to 'Enter the letters and numbers as they are shown in the image above.' */ footerText: string; /** * (Updatable) The text to show in the header when showing a CAPTCHA challenge. If unspecified, defaults to 'We have detected an increased number of attempts to access this website. To help us keep this site secure, please let us know that you are not a robot by entering the text from the image below.' */ headerText: string; /** * (Updatable) The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to `300`. */ sessionExpirationInSeconds: number; /** * (Updatable) The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to `Yes, I am human`. */ submitLabel: string; /** * (Updatable) The title used when displaying a CAPTCHA challenge. If unspecified, defaults to `Are you human?` */ title: string; /** * (Updatable) The unique URL path at which to show the CAPTCHA challenge. */ url: string; } interface PolicyWafConfigCustomProtectionRule { /** * (Updatable) The action to take when the custom protection rule is triggered. `DETECT` - Logs the request when the criteria of the custom protection rule are met. `BLOCK` - Blocks the request when the criteria of the custom protection rule are met. */ action: string; /** * (Updatable) */ exclusions: outputs.Waas.PolicyWafConfigCustomProtectionRuleExclusion[]; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule. */ id: string; } interface PolicyWafConfigCustomProtectionRuleExclusion { /** * (Updatable) An array of The target property of a request that would allow it to bypass the protection rule. For example, when `target` is `REQUEST_COOKIE_NAMES`, the list may include names of cookies to exclude from the protection rule. When the target is `ARGS`, the list may include strings of URL query parameters and values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from the protection rule. `Exclusions` properties must not contain whitespace, comma or |. **Note:** If protection rules have been enabled that utilize the `maxArgumentCount` or `maxTotalNameLengthOfArguments` properties, and the `target` property has been set to `ARGS`, it is important that the `exclusions` properties be defined to honor those protection rule settings in a consistent manner. */ exclusions: string[]; /** * (Updatable) The target of the exclusion. */ target: string; } interface PolicyWafConfigDeviceFingerprintChallenge { /** * (Updatable) The action to take on requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * (Updatable) The number of seconds between challenges for the same IP address. If unspecified, defaults to `60`. */ actionExpirationInSeconds: number; /** * (Updatable) The challenge settings if `action` is set to `BLOCK`. */ challengeSettings: outputs.Waas.PolicyWafConfigDeviceFingerprintChallengeChallengeSettings; /** * (Updatable) The number of failed requests allowed before taking action. If unspecified, defaults to `10`. */ failureThreshold: number; /** * (Updatable) The number of seconds before the failure threshold resets. If unspecified, defaults to `60`. */ failureThresholdExpirationInSeconds: number; /** * (Updatable) Enables or disables the device fingerprint challenge Web Application Firewall feature. */ isEnabled: boolean; /** * (Updatable) The maximum number of IP addresses permitted with the same device fingerprint. If unspecified, defaults to `20`. */ maxAddressCount: number; /** * (Updatable) The number of seconds before the maximum addresses count resets. If unspecified, defaults to `60`. */ maxAddressCountExpirationInSeconds: number; } interface PolicyWafConfigDeviceFingerprintChallengeChallengeSettings { /** * (Updatable) The method used to block requests that fail the challenge, if `action` is set to `BLOCK`. If unspecified, defaults to `SHOW_ERROR_PAGE`. */ blockAction: string; /** * (Updatable) The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE` and the request is blocked. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * (Updatable) The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * (Updatable) The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access to the website is blocked`. */ blockErrorPageMessage: string; /** * (Updatable) The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE` or `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * (Updatable) The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * (Updatable) The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * (Updatable) The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * (Updatable) The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; } interface PolicyWafConfigHumanInteractionChallenge { /** * (Updatable) The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * (Updatable) The number of seconds between challenges for the same IP address. If unspecified, defaults to `60`. */ actionExpirationInSeconds: number; /** * (Updatable) The challenge settings if `action` is set to `BLOCK`. */ challengeSettings: outputs.Waas.PolicyWafConfigHumanInteractionChallengeChallengeSettings; /** * (Updatable) The number of failed requests before taking action. If unspecified, defaults to `10`. */ failureThreshold: number; /** * (Updatable) The number of seconds before the failure threshold resets. If unspecified, defaults to `60`. */ failureThresholdExpirationInSeconds: number; /** * (Updatable) The number of interactions required to pass the challenge. If unspecified, defaults to `3`. */ interactionThreshold: number; /** * (Updatable) Enables or disables the human interaction challenge Web Application Firewall feature. */ isEnabled: boolean; /** * (Updatable) When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses. */ isNatEnabled: boolean; /** * (Updatable) The number of seconds to record the interactions from the user. If unspecified, defaults to `15`. */ recordingPeriodInSeconds: number; /** * (Updatable) Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the `action` is set to `DETECT`. */ setHttpHeader: outputs.Waas.PolicyWafConfigHumanInteractionChallengeSetHttpHeader; } interface PolicyWafConfigHumanInteractionChallengeChallengeSettings { /** * (Updatable) The method used to block requests that fail the challenge, if `action` is set to `BLOCK`. If unspecified, defaults to `SHOW_ERROR_PAGE`. */ blockAction: string; /** * (Updatable) The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE` and the request is blocked. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * (Updatable) The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * (Updatable) The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access to the website is blocked`. */ blockErrorPageMessage: string; /** * (Updatable) The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE` or `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * (Updatable) The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * (Updatable) The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * (Updatable) The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * (Updatable) The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; } interface PolicyWafConfigHumanInteractionChallengeSetHttpHeader { /** * (Updatable) The name of the header. */ name: string; /** * (Updatable) The value of the header. */ value: string; } interface PolicyWafConfigJsChallenge { /** * (Updatable) The action to take against requests from detected bots. If unspecified, defaults to `DETECT`. */ action: string; /** * (Updatable) The number of seconds between challenges from the same IP address. If unspecified, defaults to `60`. */ actionExpirationInSeconds: number; /** * (Updatable) When enabled, redirect responses from the origin will also be challenged. This will change HTTP 301/302 responses from origin to HTTP 200 with an HTML body containing JavaScript page redirection. */ areRedirectsChallenged: boolean; /** * (Updatable) The challenge settings if `action` is set to `BLOCK`. */ challengeSettings: outputs.Waas.PolicyWafConfigJsChallengeChallengeSettings; /** * (Updatable) When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions. */ criterias: outputs.Waas.PolicyWafConfigJsChallengeCriteria[]; /** * (Updatable) The number of failed requests before taking action. If unspecified, defaults to `10`. */ failureThreshold: number; /** * (Updatable) Enables or disables the JavaScript challenge Web Application Firewall feature. */ isEnabled: boolean; /** * (Updatable) When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses. */ isNatEnabled: boolean; /** * (Updatable) Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the `action` is set to `DETECT`. */ setHttpHeader: outputs.Waas.PolicyWafConfigJsChallengeSetHttpHeader; } interface PolicyWafConfigJsChallengeChallengeSettings { /** * (Updatable) The method used to block requests that fail the challenge, if `action` is set to `BLOCK`. If unspecified, defaults to `SHOW_ERROR_PAGE`. */ blockAction: string; /** * (Updatable) The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE` and the request is blocked. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * (Updatable) The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * (Updatable) The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access to the website is blocked`. */ blockErrorPageMessage: string; /** * (Updatable) The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE` or `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * (Updatable) The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`. */ captchaFooter: string; /** * (Updatable) The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.` */ captchaHeader: string; /** * (Updatable) The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`. */ captchaSubmitLabel: string; /** * (Updatable) The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?` */ captchaTitle: string; } interface PolicyWafConfigJsChallengeCriteria { /** * (Updatable) The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request. * * **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`. * * **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`. * * **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`. * * **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field. * * **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field. * * **URL_REGEX:** Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). * * **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the `value` field. * * **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field. * * **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the `value` field. * * **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30" * * **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list. * * **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list. * * **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match. * * **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` * * *Example:* "GET\nPOST" * * **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the contents of the `value` field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` * * *Example:* "GET\nPOST" * * **COUNTRY_IS:** Matches if the request originates from one of countries in the `value` field. The `value` in this case is string with one or multiple countries separated by new line symbol \n Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\nDZ\nAM" * * **COUNTRY_IS_NOT:** Matches if the request does not originate from any of countries in the `value` field. The `value` in this case is string with one or multiple countries separated by new line symbol \n Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\nDZ\nAM" * * **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of the `value` field. *Example:* `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0` * * **USER_AGENT_IS_NOT:** Matches if the requesting user agent is not identical to the contents of the `value` field. *Example:* `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0` */ condition: string; /** * (Updatable) When enabled, the condition will be matched with case-sensitive rules. */ isCaseSensitive: boolean; /** * (Updatable) The criteria value. */ value: string; } interface PolicyWafConfigJsChallengeSetHttpHeader { /** * (Updatable) The name of the header. */ name: string; /** * (Updatable) The value of the header. */ value: string; } interface PolicyWafConfigProtectionSettings { /** * (Updatable) The list of allowed HTTP methods. If unspecified, default to `[OPTIONS, GET, HEAD, POST]`. This setting only applies if a corresponding protection rule is enabled, such as the "Restrict HTTP Request Methods" rule (key: 911100). */ allowedHttpMethods: string[]; /** * (Updatable) If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`. */ blockAction: string; /** * (Updatable) The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. */ blockErrorPageCode: string; /** * (Updatable) The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.` */ blockErrorPageDescription: string; /** * (Updatable) The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.' */ blockErrorPageMessage: string; /** * (Updatable) The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`. */ blockResponseCode: number; /** * (Updatable) Inspects the response body of origin responses. Can be used to detect leakage of sensitive data. If unspecified, defaults to `false`. * * **Note:** Only origin responses with a Content-Type matching a value in `mediaTypes` will be inspected. */ isResponseInspected: boolean; /** * (Updatable) The maximum number of arguments allowed to be passed to your application before an action is taken. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `255`. This setting only applies if a corresponding protection rule is enabled, such as the "Number of Arguments Limits" rule (key: 960335). Example: If `maxArgumentCount` to `2` for the Max Number of Arguments protection rule (key: 960335), the following requests would be blocked: `GET /myapp/path?query=one&query=two&query=three` `POST /myapp/path` with Body `{"argument1":"one","argument2":"two","argument3":"three"}` */ maxArgumentCount: number; /** * (Updatable) The maximum length allowed for each argument name, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `400`. This setting only applies if a corresponding protection rule is enabled, such as the "Values Limits" rule (key: 960208). */ maxNameLengthPerArgument: number; /** * (Updatable) The maximum response size to be fully inspected, in binary kilobytes (KiB). Anything over this limit will be partially inspected. If unspecified, defaults to `1024`. */ maxResponseSizeInKiB: number; /** * (Updatable) The maximum length allowed for the sum of the argument name and value, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `64000`. This setting only applies if a corresponding protection rule is enabled, such as the "Total Arguments Limits" rule (key: 960341). */ maxTotalNameLengthOfArguments: number; /** * (Updatable) The list of media types to allow for inspection, if `isResponseInspected` is enabled. Only responses with MIME types in this list will be inspected. If unspecified, defaults to `["text/html", "text/plain", "text/xml"]`. * * Supported MIME types include: * * text/html * * text/plain * * text/asp * * text/css * * text/x-script * * application/json * * text/webviewhtml * * text/x-java-source * * application/x-javascript * * application/javascript * * application/ecmascript * * text/javascript * * text/ecmascript * * text/x-script.perl * * text/x-script.phyton * * application/plain * * application/xml * * text/xml */ mediaTypes: string[]; /** * (Updatable) The length of time to analyze traffic traffic, in days. After the analysis period, `WafRecommendations` will be populated. If unspecified, defaults to `10`. * * Use `GET /waasPolicies/{waasPolicyId}/wafRecommendations` to view WAF recommendations. */ recommendationsPeriodInDays: number; } interface PolicyWafConfigWhitelist { /** * (Updatable) A list of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of IP address lists to include in the whitelist. */ addressLists: string[]; /** * (Updatable) A set of IP addresses or CIDR notations to include in the whitelist. */ addresses: string[]; /** * (Updatable) The unique name of the whitelist. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ name: string; } interface ProtectionRuleExclusion { /** * An array of The target property of a request that would allow it to bypass the protection rule. For example, when `target` is `REQUEST_COOKIE_NAMES`, the list may include names of cookies to exclude from the protection rule. When the target is `ARGS`, the list may include strings of URL query parameters and values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from the protection rule. `Exclusions` properties must not contain whitespace, comma or |. **Note:** If protection rules have been enabled that utilize the `maxArgumentCount` or `maxTotalNameLengthOfArguments` properties, and the `target` property has been set to `ARGS`, it is important that the `exclusions` properties be defined to honor those protection rule settings in a consistent manner. */ exclusions: string[]; /** * The target of the exclusion. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ target: string; } } export declare namespace Waf { interface AppFirewallPolicyAction { /** * (Updatable) Type of returned HTTP response body. */ body: outputs.Waf.AppFirewallPolicyActionBody; /** * (Updatable) Response code. * * The following response codes are valid values for this property: * * 2xx * * 200 OK 201 Created 202 Accepted 206 Partial Content * * 3xx * * 300 Multiple Choices 301 Moved Permanently 302 Found 303 See Other 307 Temporary Redirect * * 4xx * * 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 408 Request Timeout 409 Conflict 411 Length Required 412 Precondition Failed 413 Payload Too Large 414 URI Too Long 415 Unsupported Media Type 416 Range Not Satisfiable 422 Unprocessable Entity 494 Request Header Too Large 495 Cert Error 496 No Cert 497 HTTP to HTTPS * * 5xx * * 500 Internal Server Error 501 Not Implemented 502 Bad Gateway 503 Service Unavailable 504 Gateway Timeout 507 Insufficient Storage * * Example: `200` */ code: number; /** * (Updatable) Adds headers defined in this array for HTTP response. * * Hop-by-hop headers are not allowed to be set: * * Connection * * Keep-Alive * * Proxy-Authenticate * * Proxy-Authorization * * TE * * Trailer * * Transfer-Encoding * * Upgrade */ headers: outputs.Waf.AppFirewallPolicyActionHeader[]; /** * (Updatable) Action name. Can be used to reference the action. */ name: string; /** * (Updatable) * * **CHECK** is a non-terminating action that does not stop the execution of rules in current module, just emits a log message documenting result of rule execution. * * **ALLOW** is a non-terminating action which upon matching rule skips all remaining rules in the current module. * * **RETURN_HTTP_RESPONSE** is a terminating action which is executed immediately, returns a defined HTTP response. */ type: string; } interface AppFirewallPolicyActionBody { template?: string; /** * (Updatable) Static response body text. */ text?: string; /** * (Updatable) Type of HttpResponseBody. */ type: string; } interface AppFirewallPolicyActionHeader { /** * (Updatable) The name of the header field. */ name: string; /** * (Updatable) The value of the header field. */ value: string; } interface AppFirewallPolicyRequestAccessControl { /** * (Updatable) References an default Action to take if no AccessControlRule was matched. Allowed action types: * * **ALLOW** continues execution of other modules and their rules. * * **RETURN_HTTP_RESPONSE** terminates further execution of modules and rules and returns defined HTTP response. */ defaultActionName: string; /** * (Updatable) Ordered list of AccessControlRules. Rules are executed in order of appearance in this array. */ rules: outputs.Waf.AppFirewallPolicyRequestAccessControlRule[]; } interface AppFirewallPolicyRequestAccessControlRule { /** * (Updatable) References action by name from actions defined in WebAppFirewallPolicy. */ actionName: string; /** * (Updatable) An expression that determines whether or not the rule action should be executed. */ condition: string; /** * (Updatable) The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * (Updatable) Rule name. Must be unique within the module. */ name: string; /** * (Updatable) Type of WebAppFirewallPolicyRule. */ type: string; } interface AppFirewallPolicyRequestProtection { /** * (Updatable) References action by name from actions defined in WebAppFirewallPolicy. Executed if HTTP message body size exceeds limit set in field `bodyInspectionSizeLimitInBytes`. * * If this field is `null` HTTP message body will inspected up to `bodyInspectionSizeLimitInBytes` and the rest will not be inspected by Protection Capabilities. * * Allowed action types: * * **RETURN_HTTP_RESPONSE** terminates further execution of modules and rules and returns defined HTTP response. */ bodyInspectionSizeLimitExceededActionName: string; /** * (Updatable) Maximum size of inspected HTTP message body in bytes. Actions to take if this limit is exceeded are defined in `bodyInspectionSizeLimitExceededActionName`. * * Body inspection maximum size allowed is defined with per-tenancy limit: 8192 bytes. * * For steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/servicelimits.htm). */ bodyInspectionSizeLimitInBytes?: number; /** * (Updatable) Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection Capabilities of REQUEST_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.AppFirewallPolicyRequestProtectionRule[]; } interface AppFirewallPolicyRequestProtectionRule { /** * (Updatable) References action by name from actions defined in WebAppFirewallPolicy. */ actionName: string; /** * (Updatable) An expression that determines whether or not the rule action should be executed. */ condition: string; /** * (Updatable) The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * (Updatable) Enables/disables body inspection for this protection rule. Only Protection Rules in RequestProtection can have this option enabled. Response body inspection will be available at a later date. */ isBodyInspectionEnabled: boolean; /** * (Updatable) Rule name. Must be unique within the module. */ name: string; /** * (Updatable) An ordered list that references OCI-managed protection capabilities. Referenced protection capabilities are not necessarily executed in order of appearance. Their execution order is decided at runtime for improved performance. The array cannot contain entries with the same pair of capability key and version more than once. */ protectionCapabilities: outputs.Waf.AppFirewallPolicyRequestProtectionRuleProtectionCapability[]; /** * (Updatable) Settings for protection capabilities */ protectionCapabilitySettings: outputs.Waf.AppFirewallPolicyRequestProtectionRuleProtectionCapabilitySettings; /** * (Updatable) Type of WebAppFirewallPolicyRule. */ type: string; } interface AppFirewallPolicyRequestProtectionRuleProtectionCapability { /** * (Updatable) Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * (Updatable) The minimum sum of weights of associated collaborative protection capabilities that have triggered which must be reached in order for _this_ capability to trigger. This field is ignored for non-collaborative capabilities. */ collaborativeActionThreshold: number; /** * (Updatable) Explicit weight values to use for associated collaborative protection capabilities. */ collaborativeWeights: outputs.Waf.AppFirewallPolicyRequestProtectionRuleProtectionCapabilityCollaborativeWeight[]; /** * (Updatable) Identifies specific HTTP message parameters to exclude from inspection by a protection capability. */ exclusions: outputs.Waf.AppFirewallPolicyRequestProtectionRuleProtectionCapabilityExclusions; /** * (Updatable) Unique key of referenced protection capability. */ key: string; /** * (Updatable) Version of referenced protection capability. */ version: number; } interface AppFirewallPolicyRequestProtectionRuleProtectionCapabilityCollaborativeWeight { /** * (Updatable) Unique key of collaborative capability for which weight will be overridden. */ key: string; /** * (Updatable) The value of weight to set. */ weight: number; } interface AppFirewallPolicyRequestProtectionRuleProtectionCapabilityExclusions { /** * (Updatable) List of URL query parameter values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from inspecting. Example: If we have query parameter 'argumentName=argumentValue' and args=['argumentName'], both 'argumentName' and 'argumentValue' will not be inspected. */ args: string[]; /** * (Updatable) List of HTTP request cookie values (by cookie name) to exclude from inspecting. Example: If we have cookie 'cookieName=cookieValue' and requestCookies=['cookieName'], both 'cookieName' and 'cookieValue' will not be inspected. */ requestCookies: string[]; } interface AppFirewallPolicyRequestProtectionRuleProtectionCapabilitySettings { /** * (Updatable) List of allowed HTTP methods. Each value as a RFC7230 formated token string. Used in protection capability 911100: Restrict HTTP Request Methods. */ allowedHttpMethods: string[]; /** * (Updatable) Maximum allowed length of headers in an HTTP request. Used in protection capability: 9200024: Limit length of request header size. */ maxHttpRequestHeaderLength?: number; /** * (Updatable) Maximum number of headers allowed in an HTTP request. Used in protection capability 9200014: Limit Number of Request Headers. */ maxHttpRequestHeaders?: number; /** * (Updatable) Maximum number of arguments allowed. Used in protection capability 920380: Number of Arguments Limits. */ maxNumberOfArguments?: number; /** * (Updatable) Maximum allowed length of a single argument. Used in protection capability 920370: Limit argument value length. */ maxSingleArgumentLength?: number; /** * (Updatable) Maximum allowed total length of all arguments. Used in protection capability 920390: Limit arguments total length. */ maxTotalArgumentLength?: number; } interface AppFirewallPolicyRequestRateLimiting { /** * (Updatable) Ordered list of RequestRateLimitingRules. Rules are executed in order of appearance in this array. */ rules: outputs.Waf.AppFirewallPolicyRequestRateLimitingRule[]; } interface AppFirewallPolicyRequestRateLimitingRule { /** * (Updatable) References action by name from actions defined in WebAppFirewallPolicy. */ actionName: string; /** * (Updatable) An expression that determines whether or not the rule action should be executed. */ condition: string; /** * (Updatable) The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * (Updatable) Rate Limiting Configurations. Each configuration counts requests towards its own `requestsLimit`. */ configurations: outputs.Waf.AppFirewallPolicyRequestRateLimitingRuleConfiguration[]; /** * (Updatable) Rule name. Must be unique within the module. */ name: string; /** * (Updatable) Type of WebAppFirewallPolicyRule. */ type: string; } interface AppFirewallPolicyRequestRateLimitingRuleConfiguration { /** * (Updatable) Duration of block action application in seconds when `requestsLimit` is reached. Optional and can be 0 (no block duration). */ actionDurationInSeconds: number; /** * (Updatable) Evaluation period in seconds. */ periodInSeconds: number; /** * (Updatable) Requests allowed per evaluation period. */ requestsLimit: number; } interface AppFirewallPolicyResponseAccessControl { /** * (Updatable) Ordered list of AccessControlRules. Rules are executed in order of appearance in this array. */ rules: outputs.Waf.AppFirewallPolicyResponseAccessControlRule[]; } interface AppFirewallPolicyResponseAccessControlRule { /** * (Updatable) References action by name from actions defined in WebAppFirewallPolicy. */ actionName: string; /** * (Updatable) An expression that determines whether or not the rule action should be executed. */ condition: string; /** * (Updatable) The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * (Updatable) Rule name. Must be unique within the module. */ name: string; /** * (Updatable) Type of WebAppFirewallPolicyRule. */ type: string; } interface AppFirewallPolicyResponseProtection { /** * (Updatable) Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.AppFirewallPolicyResponseProtectionRule[]; } interface AppFirewallPolicyResponseProtectionRule { /** * (Updatable) References action by name from actions defined in WebAppFirewallPolicy. */ actionName: string; /** * (Updatable) An expression that determines whether or not the rule action should be executed. */ condition: string; /** * (Updatable) The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * (Updatable) Enables/disables body inspection for this protection rule. Only Protection Rules in RequestProtection can have this option enabled. Response body inspection will be available at a later date. */ isBodyInspectionEnabled: boolean; /** * (Updatable) Rule name. Must be unique within the module. */ name: string; /** * (Updatable) An ordered list that references OCI-managed protection capabilities. Referenced protection capabilities are not necessarily executed in order of appearance. Their execution order is decided at runtime for improved performance. The array cannot contain entries with the same pair of capability key and version more than once. */ protectionCapabilities: outputs.Waf.AppFirewallPolicyResponseProtectionRuleProtectionCapability[]; /** * (Updatable) Settings for protection capabilities */ protectionCapabilitySettings: outputs.Waf.AppFirewallPolicyResponseProtectionRuleProtectionCapabilitySettings; /** * (Updatable) Type of WebAppFirewallPolicyRule. */ type: string; } interface AppFirewallPolicyResponseProtectionRuleProtectionCapability { /** * (Updatable) Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * (Updatable) The minimum sum of weights of associated collaborative protection capabilities that have triggered which must be reached in order for _this_ capability to trigger. This field is ignored for non-collaborative capabilities. */ collaborativeActionThreshold: number; /** * (Updatable) Explicit weight values to use for associated collaborative protection capabilities. */ collaborativeWeights: outputs.Waf.AppFirewallPolicyResponseProtectionRuleProtectionCapabilityCollaborativeWeight[]; /** * (Updatable) Identifies specific HTTP message parameters to exclude from inspection by a protection capability. */ exclusions: outputs.Waf.AppFirewallPolicyResponseProtectionRuleProtectionCapabilityExclusions; /** * (Updatable) Unique key of referenced protection capability. */ key: string; /** * (Updatable) Version of referenced protection capability. */ version: number; } interface AppFirewallPolicyResponseProtectionRuleProtectionCapabilityCollaborativeWeight { /** * (Updatable) Unique key of collaborative capability for which weight will be overridden. */ key: string; /** * (Updatable) The value of weight to set. */ weight: number; } interface AppFirewallPolicyResponseProtectionRuleProtectionCapabilityExclusions { /** * (Updatable) List of URL query parameter values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from inspecting. Example: If we have query parameter 'argumentName=argumentValue' and args=['argumentName'], both 'argumentName' and 'argumentValue' will not be inspected. */ args: string[]; /** * (Updatable) List of HTTP request cookie values (by cookie name) to exclude from inspecting. Example: If we have cookie 'cookieName=cookieValue' and requestCookies=['cookieName'], both 'cookieName' and 'cookieValue' will not be inspected. */ requestCookies: string[]; } interface AppFirewallPolicyResponseProtectionRuleProtectionCapabilitySettings { /** * (Updatable) List of allowed HTTP methods. Each value as a RFC7230 formated token string. Used in protection capability 911100: Restrict HTTP Request Methods. */ allowedHttpMethods: string[]; /** * (Updatable) Maximum allowed length of headers in an HTTP request. Used in protection capability: 9200024: Limit length of request header size. */ maxHttpRequestHeaderLength?: number; /** * (Updatable) Maximum number of headers allowed in an HTTP request. Used in protection capability 9200014: Limit Number of Request Headers. */ maxHttpRequestHeaders?: number; /** * (Updatable) Maximum number of arguments allowed. Used in protection capability 920380: Number of Arguments Limits. */ maxNumberOfArguments?: number; /** * (Updatable) Maximum allowed length of a single argument. Used in protection capability 920370: Limit argument value length. */ maxSingleArgumentLength?: number; /** * (Updatable) Maximum allowed total length of all arguments. Used in protection capability 920390: Limit arguments total length. */ maxTotalArgumentLength?: number; } interface GetFirewallsFilter { name: string; regex?: boolean; values: string[]; } interface GetFirewallsWebAppFirewallCollection { items: outputs.Waf.GetFirewallsWebAppFirewallCollectionItem[]; } interface GetFirewallsWebAppFirewallCollectionItem { /** * Type of the WebAppFirewall, as example LOAD_BALANCER. */ backendType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only the WebAppFirewall with the given [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state. */ lifecycleDetails: string; /** * LoadBalancer [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) to which the WebAppFirewallPolicy is attached to. */ loadBalancerId: string; /** * A filter to return only resources that match the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the WebAppFirewall was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the WebAppFirewall was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * A filter to return only the WebAppFirewall with the given [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of related WebAppFirewallPolicy. */ webAppFirewallPolicyId: string; } interface GetNetworkAddressListVcnAddress { /** * A private IP address or CIDR IP address range. */ addresses: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetNetworkAddressListsFilter { name: string; regex?: boolean; values: string[]; } interface GetNetworkAddressListsNetworkAddressListCollection { items: outputs.Waf.GetNetworkAddressListsNetworkAddressListCollectionItem[]; } interface GetNetworkAddressListsNetworkAddressListCollectionItem { /** * A private IP address or CIDR IP address range. */ addresses: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only the NetworkAddressList with the given [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state. */ lifecycleDetails: string; /** * A filter to return only resources that match the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the NetworkAddressList was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the NetworkAddressList was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Type of NetworkAddressList. */ type: string; /** * A list of private address prefixes, each associated with a particular VCN. To specify all addresses in a VCN, use "0.0.0.0/0" for IPv4 and "::/0" for IPv6. */ vcnAddresses: outputs.Waf.GetNetworkAddressListsNetworkAddressListCollectionItemVcnAddress[]; } interface GetNetworkAddressListsNetworkAddressListCollectionItemVcnAddress { /** * A private IP address or CIDR IP address range. */ addresses: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. */ vcnId: string; } interface GetProtectionCapabilitiesFilter { name: string; regex?: boolean; values: string[]; } interface GetProtectionCapabilitiesProtectionCapabilityCollection { /** * List of protection capabilities. */ items: outputs.Waf.GetProtectionCapabilitiesProtectionCapabilityCollectionItem[]; } interface GetProtectionCapabilitiesProtectionCapabilityCollectionItem { /** * The default collaborative action threshold for OCI-managed collaborative protection capability. Collaborative protection capabilities are made of several simple, non-collaborative protection capabilities (referred to as `contributing capabilities` later on) which have weights assigned to them. These weights can be found in the `collaborativeWeights` array. For incoming/outgoing HTTP messages, all contributing capabilities are executed and the sum of all triggered contributing capabilities weights is calculated. Only if this sum is greater than or equal to `collaborativeActionThreshold` is the incoming/outgoing HTTP message marked as malicious. */ collaborativeActionThreshold: number; /** * The weights of contributing capabilities. Defines how much each contributing capability contributes towards the action threshold of a collaborative protection capability. */ collaborativeWeights: outputs.Waf.GetProtectionCapabilitiesProtectionCapabilityCollectionItemCollaborativeWeight[]; /** * The description of protection capability. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The list of unique names protection capability group tags that are associated with this capability. Example: ["PCI", "Recommended"] */ groupTags: string[]; /** * A filter to return only resources that matches given isLatestVersion. */ isLatestVersion: boolean; /** * The unique key of protection capability to filter by. */ key: string; /** * A filter to return only resources that matches given type. */ type: string; /** * The version of protection capability. */ version: number; } interface GetProtectionCapabilitiesProtectionCapabilityCollectionItemCollaborativeWeight { /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The unique key of protection capability to filter by. */ key: string; /** * The weight of contributing protection capability. */ weight: number; } interface GetProtectionCapabilityGroupTagsFilter { /** * A filter to return only resources that match the entire name given. */ name: string; regex?: boolean; values: string[]; } interface GetProtectionCapabilityGroupTagsProtectionCapabilityGroupTagCollection { /** * List of protection capabilities group tags. */ items: outputs.Waf.GetProtectionCapabilityGroupTagsProtectionCapabilityGroupTagCollectionItem[]; } interface GetProtectionCapabilityGroupTagsProtectionCapabilityGroupTagCollectionItem { /** * A filter to return only resources that match the entire name given. */ name: string; } interface GetWebAppFirewallPoliciesFilter { /** * Rule name. Must be unique within the module. */ name: string; regex?: boolean; values: string[]; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollection { items: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItem[]; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItem { /** * Predefined actions for use in multiple different rules. Not all actions are supported in every module. Some actions terminate further execution of modules and rules in a module and some do not. Actions names must be unique within this array. */ actions: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemAction[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * A filter to return only the WebAppFirewallPolicy with the given [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ id: string; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state. */ lifecycleDetails: string; /** * Module that allows inspection of HTTP request properties and to return a defined HTTP response. In this module, rules with the name 'Default Action' are not allowed, since this name is reserved for default action logs. */ requestAccessControls: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestAccessControl[]; /** * Module that allows to enable OCI-managed protection capabilities for incoming HTTP requests. */ requestProtections: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtection[]; /** * Module that allows inspection of HTTP connection properties and to limit requests frequency for a given key. */ requestRateLimitings: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestRateLimiting[]; /** * Module that allows inspection of HTTP response properties and to return a defined HTTP response. */ responseAccessControls: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseAccessControl[]; /** * Module that allows to enable OCI-managed protection capabilities for HTTP responses. */ responseProtections: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtection[]; /** * A filter to return only resources that match the given lifecycleState. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the WebAppFirewallPolicy was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the WebAppFirewallPolicy was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemAction { /** * Type of returned HTTP response body. */ bodies: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemActionBody[]; /** * Response code. */ code: number; /** * Adds headers defined in this array for HTTP response. */ headers: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemActionHeader[]; /** * Rule name. Must be unique within the module. */ name: string; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemActionBody { template: string; /** * Static response body text. */ text: string; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemActionHeader { /** * Rule name. Must be unique within the module. */ name: string; /** * The value of the header field. */ value: string; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestAccessControl { /** * References an default Action to take if no AccessControlRule was matched. Allowed action types: * * **ALLOW** continues execution of other modules and their rules. * * **RETURN_HTTP_RESPONSE** terminates further execution of modules and rules and returns defined HTTP response. */ defaultActionName: string; /** * Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestAccessControlRule[]; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestAccessControlRule { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * An expression that determines whether or not the rule action should be executed. */ condition: string; /** * The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * Rule name. Must be unique within the module. */ name: string; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtection { /** * References action by name from actions defined in WebAppFirewallPolicy. Executed if HTTP message body size exceeds limit set in field `bodyInspectionSizeLimitInBytes`. */ bodyInspectionSizeLimitExceededActionName: string; /** * Maximum size of inspected HTTP message body in bytes. Actions to take if this limit is exceeded are defined in `bodyInspectionSizeLimitExceededActionName`. */ bodyInspectionSizeLimitInBytes: number; /** * Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtectionRule[]; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtectionRule { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * An expression that determines whether or not the rule action should be executed. */ condition: string; /** * The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * Enables/disables body inspection for this protection rule. Only Protection Rules in RequestProtection can have this option enabled. Response body inspection will be available at a later date. */ isBodyInspectionEnabled: boolean; /** * Rule name. Must be unique within the module. */ name: string; /** * An ordered list that references OCI-managed protection capabilities. Referenced protection capabilities are not necessarily executed in order of appearance. Their execution order is decided at runtime for improved performance. The array cannot contain entries with the same pair of capability key and version more than once. */ protectionCapabilities: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtectionRuleProtectionCapability[]; /** * Settings for protection capabilities */ protectionCapabilitySettings: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtectionRuleProtectionCapabilitySetting[]; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtectionRuleProtectionCapability { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * The minimum sum of weights of associated collaborative protection capabilities that have triggered which must be reached in order for _this_ capability to trigger. This field is ignored for non-collaborative capabilities. */ collaborativeActionThreshold: number; /** * Explicit weight values to use for associated collaborative protection capabilities. */ collaborativeWeights: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtectionRuleProtectionCapabilityCollaborativeWeight[]; /** * Identifies specific HTTP message parameters to exclude from inspection by a protection capability. */ exclusions: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtectionRuleProtectionCapabilityExclusion[]; /** * Unique key of referenced protection capability. */ key: string; /** * Version of referenced protection capability. */ version: number; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtectionRuleProtectionCapabilityCollaborativeWeight { /** * Unique key of referenced protection capability. */ key: string; /** * The value of weight to set. */ weight: number; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtectionRuleProtectionCapabilityExclusion { /** * List of URL query parameter values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from inspecting. Example: If we have query parameter 'argumentName=argumentValue' and args=['argumentName'], both 'argumentName' and 'argumentValue' will not be inspected. */ args: string[]; /** * List of HTTP request cookie values (by cookie name) to exclude from inspecting. Example: If we have cookie 'cookieName=cookieValue' and requestCookies=['cookieName'], both 'cookieName' and 'cookieValue' will not be inspected. */ requestCookies: string[]; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestProtectionRuleProtectionCapabilitySetting { /** * List of allowed HTTP methods. Each value as a RFC7230 formated token string. Used in protection capability 911100: Restrict HTTP Request Methods. */ allowedHttpMethods: string[]; /** * Maximum allowed length of headers in an HTTP request. Used in protection capability: 9200024: Limit length of request header size. */ maxHttpRequestHeaderLength: number; /** * Maximum number of headers allowed in an HTTP request. Used in protection capability 9200014: Limit Number of Request Headers. */ maxHttpRequestHeaders: number; /** * Maximum number of arguments allowed. Used in protection capability 920380: Number of Arguments Limits. */ maxNumberOfArguments: number; /** * Maximum allowed length of a single argument. Used in protection capability 920370: Limit argument value length. */ maxSingleArgumentLength: number; /** * Maximum allowed total length of all arguments. Used in protection capability 920390: Limit arguments total length. */ maxTotalArgumentLength: number; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestRateLimiting { /** * Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestRateLimitingRule[]; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestRateLimitingRule { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * An expression that determines whether or not the rule action should be executed. */ condition: string; /** * The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * Rate Limiting Configurations. Each configuration counts requests towards its own `requestsLimit`. */ configurations: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestRateLimitingRuleConfiguration[]; /** * Rule name. Must be unique within the module. */ name: string; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemRequestRateLimitingRuleConfiguration { /** * Duration of block action application in seconds when `requestsLimit` is reached. Optional and can be 0 (no block duration). */ actionDurationInSeconds: number; /** * Evaluation period in seconds. */ periodInSeconds: number; /** * Requests allowed per evaluation period. */ requestsLimit: number; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseAccessControl { /** * Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseAccessControlRule[]; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseAccessControlRule { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * An expression that determines whether or not the rule action should be executed. */ condition: string; /** * The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * Rule name. Must be unique within the module. */ name: string; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtection { /** * Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtectionRule[]; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtectionRule { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * An expression that determines whether or not the rule action should be executed. */ condition: string; /** * The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * Enables/disables body inspection for this protection rule. Only Protection Rules in RequestProtection can have this option enabled. Response body inspection will be available at a later date. */ isBodyInspectionEnabled: boolean; /** * Rule name. Must be unique within the module. */ name: string; /** * An ordered list that references OCI-managed protection capabilities. Referenced protection capabilities are not necessarily executed in order of appearance. Their execution order is decided at runtime for improved performance. The array cannot contain entries with the same pair of capability key and version more than once. */ protectionCapabilities: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtectionRuleProtectionCapability[]; /** * Settings for protection capabilities */ protectionCapabilitySettings: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtectionRuleProtectionCapabilitySetting[]; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtectionRuleProtectionCapability { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * The minimum sum of weights of associated collaborative protection capabilities that have triggered which must be reached in order for _this_ capability to trigger. This field is ignored for non-collaborative capabilities. */ collaborativeActionThreshold: number; /** * Explicit weight values to use for associated collaborative protection capabilities. */ collaborativeWeights: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtectionRuleProtectionCapabilityCollaborativeWeight[]; /** * Identifies specific HTTP message parameters to exclude from inspection by a protection capability. */ exclusions: outputs.Waf.GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtectionRuleProtectionCapabilityExclusion[]; /** * Unique key of referenced protection capability. */ key: string; /** * Version of referenced protection capability. */ version: number; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtectionRuleProtectionCapabilityCollaborativeWeight { /** * Unique key of referenced protection capability. */ key: string; /** * The value of weight to set. */ weight: number; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtectionRuleProtectionCapabilityExclusion { /** * List of URL query parameter values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from inspecting. Example: If we have query parameter 'argumentName=argumentValue' and args=['argumentName'], both 'argumentName' and 'argumentValue' will not be inspected. */ args: string[]; /** * List of HTTP request cookie values (by cookie name) to exclude from inspecting. Example: If we have cookie 'cookieName=cookieValue' and requestCookies=['cookieName'], both 'cookieName' and 'cookieValue' will not be inspected. */ requestCookies: string[]; } interface GetWebAppFirewallPoliciesWebAppFirewallPolicyCollectionItemResponseProtectionRuleProtectionCapabilitySetting { /** * List of allowed HTTP methods. Each value as a RFC7230 formated token string. Used in protection capability 911100: Restrict HTTP Request Methods. */ allowedHttpMethods: string[]; /** * Maximum allowed length of headers in an HTTP request. Used in protection capability: 9200024: Limit length of request header size. */ maxHttpRequestHeaderLength: number; /** * Maximum number of headers allowed in an HTTP request. Used in protection capability 9200014: Limit Number of Request Headers. */ maxHttpRequestHeaders: number; /** * Maximum number of arguments allowed. Used in protection capability 920380: Number of Arguments Limits. */ maxNumberOfArguments: number; /** * Maximum allowed length of a single argument. Used in protection capability 920370: Limit argument value length. */ maxSingleArgumentLength: number; /** * Maximum allowed total length of all arguments. Used in protection capability 920390: Limit arguments total length. */ maxTotalArgumentLength: number; } interface GetWebAppFirewallPolicyAction { /** * Type of returned HTTP response body. */ bodies: outputs.Waf.GetWebAppFirewallPolicyActionBody[]; /** * Response code. */ code: number; /** * Adds headers defined in this array for HTTP response. */ headers: outputs.Waf.GetWebAppFirewallPolicyActionHeader[]; /** * Rule name. Must be unique within the module. */ name: string; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPolicyActionBody { template: string; /** * Static response body text. */ text: string; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPolicyActionHeader { /** * Rule name. Must be unique within the module. */ name: string; /** * The value of the header field. */ value: string; } interface GetWebAppFirewallPolicyRequestAccessControl { /** * References an default Action to take if no AccessControlRule was matched. Allowed action types: * * **ALLOW** continues execution of other modules and their rules. * * **RETURN_HTTP_RESPONSE** terminates further execution of modules and rules and returns defined HTTP response. */ defaultActionName: string; /** * Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.GetWebAppFirewallPolicyRequestAccessControlRule[]; } interface GetWebAppFirewallPolicyRequestAccessControlRule { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * An expression that determines whether or not the rule action should be executed. */ condition: string; /** * The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * Rule name. Must be unique within the module. */ name: string; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPolicyRequestProtection { /** * References action by name from actions defined in WebAppFirewallPolicy. Executed if HTTP message body size exceeds limit set in field `bodyInspectionSizeLimitInBytes`. */ bodyInspectionSizeLimitExceededActionName: string; /** * Maximum size of inspected HTTP message body in bytes. Actions to take if this limit is exceeded are defined in `bodyInspectionSizeLimitExceededActionName`. */ bodyInspectionSizeLimitInBytes: number; /** * Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.GetWebAppFirewallPolicyRequestProtectionRule[]; } interface GetWebAppFirewallPolicyRequestProtectionRule { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * An expression that determines whether or not the rule action should be executed. */ condition: string; /** * The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * Enables/disables body inspection for this protection rule. Only Protection Rules in RequestProtection can have this option enabled. Response body inspection will be available at a later date. */ isBodyInspectionEnabled: boolean; /** * Rule name. Must be unique within the module. */ name: string; /** * An ordered list that references OCI-managed protection capabilities. Referenced protection capabilities are not necessarily executed in order of appearance. Their execution order is decided at runtime for improved performance. The array cannot contain entries with the same pair of capability key and version more than once. */ protectionCapabilities: outputs.Waf.GetWebAppFirewallPolicyRequestProtectionRuleProtectionCapability[]; /** * Settings for protection capabilities */ protectionCapabilitySettings: outputs.Waf.GetWebAppFirewallPolicyRequestProtectionRuleProtectionCapabilitySetting[]; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPolicyRequestProtectionRuleProtectionCapability { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * The minimum sum of weights of associated collaborative protection capabilities that have triggered which must be reached in order for _this_ capability to trigger. This field is ignored for non-collaborative capabilities. */ collaborativeActionThreshold: number; /** * Explicit weight values to use for associated collaborative protection capabilities. */ collaborativeWeights: outputs.Waf.GetWebAppFirewallPolicyRequestProtectionRuleProtectionCapabilityCollaborativeWeight[]; /** * Identifies specific HTTP message parameters to exclude from inspection by a protection capability. */ exclusions: outputs.Waf.GetWebAppFirewallPolicyRequestProtectionRuleProtectionCapabilityExclusion[]; /** * Unique key of referenced protection capability. */ key: string; /** * Version of referenced protection capability. */ version: number; } interface GetWebAppFirewallPolicyRequestProtectionRuleProtectionCapabilityCollaborativeWeight { /** * Unique key of referenced protection capability. */ key: string; /** * The value of weight to set. */ weight: number; } interface GetWebAppFirewallPolicyRequestProtectionRuleProtectionCapabilityExclusion { /** * List of URL query parameter values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from inspecting. Example: If we have query parameter 'argumentName=argumentValue' and args=['argumentName'], both 'argumentName' and 'argumentValue' will not be inspected. */ args: string[]; /** * List of HTTP request cookie values (by cookie name) to exclude from inspecting. Example: If we have cookie 'cookieName=cookieValue' and requestCookies=['cookieName'], both 'cookieName' and 'cookieValue' will not be inspected. */ requestCookies: string[]; } interface GetWebAppFirewallPolicyRequestProtectionRuleProtectionCapabilitySetting { /** * List of allowed HTTP methods. Each value as a RFC7230 formated token string. Used in protection capability 911100: Restrict HTTP Request Methods. */ allowedHttpMethods: string[]; /** * Maximum allowed length of headers in an HTTP request. Used in protection capability: 9200024: Limit length of request header size. */ maxHttpRequestHeaderLength: number; /** * Maximum number of headers allowed in an HTTP request. Used in protection capability 9200014: Limit Number of Request Headers. */ maxHttpRequestHeaders: number; /** * Maximum number of arguments allowed. Used in protection capability 920380: Number of Arguments Limits. */ maxNumberOfArguments: number; /** * Maximum allowed length of a single argument. Used in protection capability 920370: Limit argument value length. */ maxSingleArgumentLength: number; /** * Maximum allowed total length of all arguments. Used in protection capability 920390: Limit arguments total length. */ maxTotalArgumentLength: number; } interface GetWebAppFirewallPolicyRequestRateLimiting { /** * Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.GetWebAppFirewallPolicyRequestRateLimitingRule[]; } interface GetWebAppFirewallPolicyRequestRateLimitingRule { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * An expression that determines whether or not the rule action should be executed. */ condition: string; /** * The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * Rate Limiting Configurations. Each configuration counts requests towards its own `requestsLimit`. */ configurations: outputs.Waf.GetWebAppFirewallPolicyRequestRateLimitingRuleConfiguration[]; /** * Rule name. Must be unique within the module. */ name: string; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPolicyRequestRateLimitingRuleConfiguration { /** * Duration of block action application in seconds when `requestsLimit` is reached. Optional and can be 0 (no block duration). */ actionDurationInSeconds: number; /** * Evaluation period in seconds. */ periodInSeconds: number; /** * Requests allowed per evaluation period. */ requestsLimit: number; } interface GetWebAppFirewallPolicyResponseAccessControl { /** * Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.GetWebAppFirewallPolicyResponseAccessControlRule[]; } interface GetWebAppFirewallPolicyResponseAccessControlRule { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * An expression that determines whether or not the rule action should be executed. */ condition: string; /** * The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * Rule name. Must be unique within the module. */ name: string; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPolicyResponseProtection { /** * Ordered list of ProtectionRules. Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection capabilities of RESPONSE_PROTECTION_CAPABILITY type. */ rules: outputs.Waf.GetWebAppFirewallPolicyResponseProtectionRule[]; } interface GetWebAppFirewallPolicyResponseProtectionRule { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * An expression that determines whether or not the rule action should be executed. */ condition: string; /** * The language used to parse condition from field `condition`. Available languages: * * **JMESPATH** an extended JMESPath language syntax. */ conditionLanguage: string; /** * Enables/disables body inspection for this protection rule. Only Protection Rules in RequestProtection can have this option enabled. Response body inspection will be available at a later date. */ isBodyInspectionEnabled: boolean; /** * Rule name. Must be unique within the module. */ name: string; /** * An ordered list that references OCI-managed protection capabilities. Referenced protection capabilities are not necessarily executed in order of appearance. Their execution order is decided at runtime for improved performance. The array cannot contain entries with the same pair of capability key and version more than once. */ protectionCapabilities: outputs.Waf.GetWebAppFirewallPolicyResponseProtectionRuleProtectionCapability[]; /** * Settings for protection capabilities */ protectionCapabilitySettings: outputs.Waf.GetWebAppFirewallPolicyResponseProtectionRuleProtectionCapabilitySetting[]; /** * Type of WebAppFirewallPolicyRule. */ type: string; } interface GetWebAppFirewallPolicyResponseProtectionRuleProtectionCapability { /** * Override action to take if capability was triggered, defined in Protection Rule for this capability. Only actions of type CHECK are allowed. */ actionName: string; /** * The minimum sum of weights of associated collaborative protection capabilities that have triggered which must be reached in order for _this_ capability to trigger. This field is ignored for non-collaborative capabilities. */ collaborativeActionThreshold: number; /** * Explicit weight values to use for associated collaborative protection capabilities. */ collaborativeWeights: outputs.Waf.GetWebAppFirewallPolicyResponseProtectionRuleProtectionCapabilityCollaborativeWeight[]; /** * Identifies specific HTTP message parameters to exclude from inspection by a protection capability. */ exclusions: outputs.Waf.GetWebAppFirewallPolicyResponseProtectionRuleProtectionCapabilityExclusion[]; /** * Unique key of referenced protection capability. */ key: string; /** * Version of referenced protection capability. */ version: number; } interface GetWebAppFirewallPolicyResponseProtectionRuleProtectionCapabilityCollaborativeWeight { /** * Unique key of referenced protection capability. */ key: string; /** * The value of weight to set. */ weight: number; } interface GetWebAppFirewallPolicyResponseProtectionRuleProtectionCapabilityExclusion { /** * List of URL query parameter values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from inspecting. Example: If we have query parameter 'argumentName=argumentValue' and args=['argumentName'], both 'argumentName' and 'argumentValue' will not be inspected. */ args: string[]; /** * List of HTTP request cookie values (by cookie name) to exclude from inspecting. Example: If we have cookie 'cookieName=cookieValue' and requestCookies=['cookieName'], both 'cookieName' and 'cookieValue' will not be inspected. */ requestCookies: string[]; } interface GetWebAppFirewallPolicyResponseProtectionRuleProtectionCapabilitySetting { /** * List of allowed HTTP methods. Each value as a RFC7230 formated token string. Used in protection capability 911100: Restrict HTTP Request Methods. */ allowedHttpMethods: string[]; /** * Maximum allowed length of headers in an HTTP request. Used in protection capability: 9200024: Limit length of request header size. */ maxHttpRequestHeaderLength: number; /** * Maximum number of headers allowed in an HTTP request. Used in protection capability 9200014: Limit Number of Request Headers. */ maxHttpRequestHeaders: number; /** * Maximum number of arguments allowed. Used in protection capability 920380: Number of Arguments Limits. */ maxNumberOfArguments: number; /** * Maximum allowed length of a single argument. Used in protection capability 920370: Limit argument value length. */ maxSingleArgumentLength: number; /** * Maximum allowed total length of all arguments. Used in protection capability 920390: Limit arguments total length. */ maxTotalArgumentLength: number; } interface NetworkAddressListVcnAddress { /** * (Updatable) A private IP address or CIDR IP address range. */ addresses: string; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vcnId: string; } } export declare namespace Zpr { interface GetZprPoliciesFilter { /** * A filter to return only resources that match the entire display name given. */ name: string; regex?: boolean; values: string[]; } interface GetZprPoliciesZprPolicy { items: outputs.Zpr.GetZprPoliciesZprPolicyItem[]; } interface GetZprPoliciesZprPolicyItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description you assign to the ZprPolicy during creation. Does not have to be unique, and it's changeable. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; id: string; /** * A message that describes the current state of the ZprPolicy in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * A filter to return only resources that match the entire display name given. */ name: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * An array of ZprPolicy statements (up to 25 statements per ZprPolicy) written in the Zero Trust Packet Routing Policy Language. */ statements: string[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the ZprPolicy was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the ZprPolicy was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } } export declare namespace oci { interface ApiPlatformApiPlatformInstanceIdcsApp { /** * IDCS URL of the app */ url: string; } interface ApiPlatformApiPlatformInstanceUri { /** * Developer's Portal URI of the instance (/developers) */ developersPortalUri: string; /** * Management Portal URI of the instance (/apiplatform) */ managementPortalUri: string; } interface ApiaccesscontrolPrivilegedApiControlApproverGroupLevelList { /** * (Updatable) id of the group. */ groupIds: string[]; /** * (Updatable) level of the group. */ groupLevel: number; } interface ApiaccesscontrolPrivilegedApiControlPrivilegedOperationList { /** * (Updatable) name of the api which needs to be protected. */ apiName: string; /** * (Updatable) list of attributes belonging to the above api which needs to be protected. */ attributeNames: string[]; /** * (Updatable) type of the entity which needs to be protected. */ entityType: string; } interface ApiaccesscontrolPrivilegedApiRequestApproverDetail { /** * The action done by the approver. */ approvalAction: string; /** * Comment specified by the approver of the request. */ approvalComment: string; /** * The group level at which the approver approved. */ approverGroupLevel: number; /** * The userId of the approver. */ approverId: string; /** * Time for when the privilegedApi request should start that is authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeApprovedForAccess: string; /** * Time when the privilegedApi request was authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeOfAuthorization: string; } interface ApiaccesscontrolPrivilegedApiRequestPrivilegedOperationList { /** * name of the api which needs to be protected. */ apiName: string; /** * list of attributes belonging to the above api which needs to be protected. */ attributeNames: string[]; } interface BatchBatchContextFleet { /** * A message that describes the current state of the service managed fleet configuration in more detail. */ details: string; /** * Maximum number of concurrent tasks for the service managed fleet. */ maxConcurrentTasks: number; /** * Name of the service managed fleet. */ name: string; /** * Shape of the fleet. For `SERVICE_MANAGED_FLEET`, provide the CPU fleet shape fields. For `SERVICE_MANAGED_GPU_FLEET`, provide the GPU fleet shape fields. */ shape: outputs.oci.BatchBatchContextFleetShape; /** * (Updatable) The target state for the Batch Context. Could be set to `ACTIVE` or `INACTIVE`. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ state: string; /** * Type of the fleet. Supported values are `SERVICE_MANAGED_FLEET` and `SERVICE_MANAGED_GPU_FLEET`. */ type: string; } interface BatchBatchContextFleetShape { /** * Amount of disk space in GBs required for the shape. */ diskSizeInGbs: number; /** * Amount of memory in GBs required for the shape. */ memoryInGbs: number; /** * Number of OCPUs required for the shape. */ ocpus: number; /** * The name of the shape. */ shapeName: string; /** * Type of the GPU fleet shape. Required when `fleets.type=SERVICE_MANAGED_GPU_FLEET`. Also serves as a discriminator for sub-entities. */ type: string; } interface BatchBatchContextJobPriorityConfiguration { /** * (Updatable) Name of the tag key. */ tagKey: string; /** * (Updatable) Name of the corresponding tag namespace. */ tagNamespace: string; /** * (Updatable) Mapping of tag value to its priority. */ values: { [key: string]: string; }; /** * (Updatable) Weight associated with the tag key. Percentage point is the unit of measurement. */ weight: number; } interface BatchBatchContextLoggingConfiguration { /** * (Updatable) A switch to enable or disable propagation of job and task events to the customer's logs in Oracle Cloud Infrastructure logging service. */ isJobTaskEventsPropagationEnabled: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; /** * (Updatable) Type of the logging configuration. Discriminator for sub-entities. */ type: string; } interface BatchBatchContextNetwork { /** * A list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated network security groups. */ nsgIds: string[]; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated subnet. */ subnetId: string; /** * A list of private endpoint's VNICs. */ vnics: outputs.oci.BatchBatchContextNetworkVnic[]; } interface BatchBatchContextNetworkVnic { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint's VNIC, which resides in the customer's VCN. */ id: string; /** * A list of private IP addresses (in the customer's VCN) that represent access points for the service. */ sourceIps: string[]; } interface BatchBatchTaskEnvironmentSecurityContext { /** * A special supplemental group ID that applies to all containers in a pod. */ fsGroup: number; /** * Group ID for running processes inside the container. */ runAsGroup: number; /** * User ID for running processes inside the container. */ runAsUser: number; } interface BatchBatchTaskEnvironmentVolume { /** * The local path to mount the NFS share to. */ localMountDirectoryPath: string; /** * The path to the directory on the NFS server to be mounted. */ mountTargetExportPath: string; /** * The FQDN of the NFS server to connect to. */ mountTargetFqdn: string; /** * The name of the NfsVolume. */ name: string; /** * Discriminator for sub-entities. */ type: string; } interface BatchBatchTaskProfileExtendedInformation { /** * Type of CPU architecture. */ architecture: string; /** * A name of the CPU shape. */ shapeName: string; /** * Type of extended information. */ type: string; } interface CostadCostAnomalyMonitorCostAlertSubscriptionMap { /** * (Updatable) The costAlertSubscription ocid which the cost monitor alert maps to. */ costAlertSubscriptionId: string; /** * (Updatable) The filter operator. Example: 'AND', 'OR'. */ operator: string; /** * (Updatable) The absolute threshold value. */ thresholdAbsoluteValue: number; /** * (Updatable) The relative percentage threshold value. */ thresholdRelativePercent: number; } interface DataccInfrastructureComputeCapacity { /** * Total CPU cores count allocated.. */ allocatedCores: number; /** * Total available CPU cores count. */ availableCores: number; /** * Available memory, in gigabytes (GB). */ availableMemoryInGbs: string; /** * Total Reserved CPU cores count. */ reservedCores: number; /** * Reserved memory, in gigabytes (GB). */ reservedMemoryInGbs: string; /** * Total CPU cores count. */ totalCores: number; /** * Total memory allocated, in gigabytes (GB). */ totalMemoryInGbs: string; /** * Memory allocated to Oracle database virtual machine cluster or Instance, in gigabytes (GB). */ usedMemoryInGbs: string; } interface DataccInfrastructureContact { /** * (Updatable) The email for the Database Infrastructure contact. */ email: string; /** * (Updatable) If `true`, this Database Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Database Infrastructure contact is not a valid MOS contact. */ isContactMosValidated: boolean; /** * (Updatable) If `true`, this Database Infrastructure contact is a primary contact. If `false`, this Database Infrastructure is a secondary contact. */ isPrimary: boolean; /** * (Updatable) The name of the Database Infrastructure contact. */ name: string; /** * (Updatable) The phone number for the Database Infrastructure contact. */ phoneNumber: string; } interface DataccInfrastructureMaintenanceWindow { /** * (Updatable) Determines the amount of time the system will wait before the start of each Database Infrastructure server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * (Updatable) Days during the week when maintenance should be performed. */ daysOfWeeks: string[]; /** * (Updatable) The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * (Updatable) If true, enables the configuration of a custom action timeout (waiting period) between Database Infrastructure server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * (Updatable) If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * (Updatable) Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * (Updatable) Months during the year when maintenance should be performed. */ months: string[]; /** * (Updatable) Cloud Database Infrastructure node patching method. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Database Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * (Updatable) The maintenance window scheduling preference. */ preference: string; /** * (Updatable) Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week.For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface DataccInfrastructureServer { /** * Number of database virtual machines hosted on the server. */ baseVmCount: number; /** * Capacity details of the Database Infrastructure. */ computeCapacities: outputs.oci.DataccInfrastructureServerComputeCapacity[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Data Server of Infrastructure. */ id: string; /** * Database Infrastructure Server ILOM IP address. */ ilomIpAddress: string; /** * Database Infrastructure Server ILOM name. */ ilomName: string; /** * Number of instances hosted on the server. */ instanceVmCount: number; /** * Database Infrastructure Server IP address. */ serverIpAddress: string; /** * Database Infrastructure Server name. */ serverName: string; /** * The current state of the Database Infrastructure. */ state: string; } interface DataccInfrastructureServerComputeCapacity { /** * Total CPU cores count allocated.. */ allocatedCores: number; /** * Total available CPU cores count. */ availableCores: number; /** * Available memory, in gigabytes (GB). */ availableMemoryInGbs: string; /** * Total Reserved CPU cores count. */ reservedCores: number; /** * Reserved memory, in gigabytes (GB). */ reservedMemoryInGbs: string; /** * Total CPU cores count. */ totalCores: number; /** * Total memory allocated, in gigabytes (GB). */ totalMemoryInGbs: string; /** * Memory allocated to Oracle database virtual machine cluster or Instance, in gigabytes (GB). */ usedMemoryInGbs: string; } interface DataccInfrastructureStorageCapacity { /** * Disk group name. */ diskGroup: string; /** * The total amount of logical disk space that is currently available for use in a disk group, in gigabytes (GB). */ logicalFreeSpaceInGbs: string; /** * The total amount of physical disk space that is currently available for use in a disk group, in gigabytes (GB). */ phyFreeSpaceInGbs: string; /** * The total amount of physical disk space that is reserved for system use in a disk group, in gigabytes (GB). */ phyReservedSpaceInGbs: string; /** * The total amount of physical disk space available in a disk group, in gigabytes (GB). */ phyTotalSpaceInGbs: string; /** * The Disk redundancy for Database Infrastructure storage. */ storageDiskRedundancy: string; } interface DataccInfrastructureSystemStorageCapacity { /** * The amount of storage (in GB) in the DATA disk group that is currently utilized for creating local storage for VM Clusters and application VMs. */ acfs: outputs.oci.DataccInfrastructureSystemStorageCapacityAcf[]; /** * List of storage disk group capacity details. */ diskGroups: outputs.oci.DataccInfrastructureSystemStorageCapacityDiskGroup[]; } interface DataccInfrastructureSystemStorageCapacityAcf { /** * The total amount of logical disk space that is currently available for use, in gigabytes (GB). */ freeSpaceInGbs: number; /** * The total amount of logical disk space available, in gigabytes (GB). */ totalSpaceInGbs: number; } interface DataccInfrastructureSystemStorageCapacityDiskGroup { /** * The total amount of logical disk space that is currently available for use, in gigabytes (GB). */ freeSpaceInGbs: number; /** * The total amount of logical disk space that is reserved for system use, in gigabytes (GB). */ reservedSpaceInGbs: number; /** * The storage type for the Cloud Database Infrastructure. */ storageType: string; /** * The total amount of logical disk space available, in gigabytes (GB). */ totalSpaceInGbs: number; } interface DataccVmClusterNetworkScan { /** * (Updatable) The SCAN hostname. */ hostname: string; /** * (Updatable) The list of SCAN IP addresses. Three addresses should be provided. */ ips: string[]; } interface DataccVmClusterNetworkVmNetwork { /** * (Updatable) The network domain name. */ domainName: string; /** * (Updatable) The network gateway. */ gateway: string; /** * (Updatable) The network netmask. */ netmask: string; /** * (Updatable) The network type. */ networkType: string; /** * (Updatable) The list of node details. */ nodes: outputs.oci.DataccVmClusterNetworkVmNetworkNode[]; /** * (Updatable) The network domain name prefix. */ prefix: string; /** * (Updatable) The network VLAN ID. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ vlanId: string; } interface DataccVmClusterNetworkVmNetworkNode { /** * (Updatable) The node host name. */ hostname: string; /** * (Updatable) The node IP address. */ ip: string; /** * (Updatable) The node virtual IP (VIP) address. */ vip: string; /** * (Updatable) The node virtual IP (VIP) host name. */ vipHostname: string; } interface DbmulticloudMultiCloudResourceDiscoveryResource { /** * The ID of the Discovered Resource. */ id: string; /** * Discovered Resource Location. */ location: string; /** * Discovered Resource Name. */ name: string; /** * Discovered Resource's properties. */ properties: { [key: string]: string; }; /** * Discovered Resource Group Name. */ resourceGroup: string; /** * Discovered Resource Type. */ type: string; } interface DbmulticloudOracleDbAwsIdentityConnectorServiceRoleDetail { /** * Assume role status. */ assumeRoleStatus: string; /** * List of all VMs where AWS Identity Connector is configured for Oracle DB Cloud VM Cluster. */ awsNodes: outputs.oci.DbmulticloudOracleDbAwsIdentityConnectorServiceRoleDetailAwsNode[]; /** * (Updatable) Amazon resource name AWSof the IAM role. */ roleArn: string; /** * (Updatable) Private endpoint of the AWS service. */ servicePrivateEndpoint: string; /** * (Updatable) Type of service. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ serviceType: string; } interface DbmulticloudOracleDbAwsIdentityConnectorServiceRoleDetailAwsNode { /** * AWS host ID. */ hostId: string; /** * AWS Host name or Identity Connector name. */ hostName: string; /** * The current status of the AWS Identity Connector resource. */ status: string; /** * Time when the AWS Identity Connector's status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeLastChecked: string; } interface DbmulticloudOracleDbAwsKeyReplicationMetadata { /** * List of all regions and their respective resource ID. */ replicationDetails: outputs.oci.DbmulticloudOracleDbAwsKeyReplicationMetadataReplicationDetail[]; } interface DbmulticloudOracleDbAwsKeyReplicationMetadataReplicationDetail { /** * The lifecycle state of the Oracle DB Azure Vault resource. */ replicationState: string; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB AWS Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z'. */ timeCreated: string; /** * Time when the DB AWS Key resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z'. */ timeUpdated: string; } interface DbmulticloudOracleDbAzureConnectorArcAgentNode { /** * Current Arc Agent Version installed on this node of Oracle Cloud VM Cluster. */ currentArcAgentVersion: string; /** * Host ID. */ hostId: string; /** * Host name or Azure Arc Agent name. */ hostName: string; /** * The current status of the Azure Arc Agent resource. */ status: string; /** * Time when the Azure Arc Agent's status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeLastChecked: string; } interface DbmulticloudOracleDbAzureVaultReplicationMetadata { /** * List of all regions and their respective resource ID. */ replicationDetails: outputs.oci.DbmulticloudOracleDbAzureVaultReplicationMetadataReplicationDetail[]; } interface DbmulticloudOracleDbAzureVaultReplicationMetadataReplicationDetail { /** * The lifecycle state of the Oracle DB Azure Vault resource. */ replicationState: string; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB Azure Vault resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeCreated: string; /** * Time when the DB Azure Vault resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeUpdated: string; } interface DbmulticloudOracleDbGcpIdentityConnectorGcpNode { /** * Host ID. */ hostId: string; /** * Host Name or Identity Connector name. */ hostName: string; /** * The current status of the GCP Identity Connector resource. */ status: string; /** * time when the GCP Identity Connector's status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeLastChecked: string; } interface DbmulticloudOracleDbGcpKeyRingReplicationMetadata { /** * List of all regions and their respective resource ID. */ replicationDetails: outputs.oci.DbmulticloudOracleDbGcpKeyRingReplicationMetadataReplicationDetail[]; } interface DbmulticloudOracleDbGcpKeyRingReplicationMetadataReplicationDetail { /** * The lifecycle state of the Oracle DB Azure Vault resource. */ replicationState: string; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB GCP Key Ring resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeCreated: string; /** * Time when the DB GCP Key Ring resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeUpdated: string; } interface DifStackAdb { /** * The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID for admin password. */ adminPasswordId: string; artifactObjectStoragePath?: string; /** * (Updatable) The size, in terabytes, of the data volume that will be created and attached to the database. */ dataStorageSizeInTbs: number; /** * DB credential details. */ dbCredentials?: outputs.oci.DifStackAdbDbCredential[]; /** * (Updatable) A valid Oracle Database version for Autonomous Database. */ dbVersion: string; /** * DB Workload to be used with ADB. Accepted values are OLTP, DW. */ dbWorkload: string; /** * (Updatable) The compute amount (ECPUs) available to the database. */ ecpu: number; /** * Id for the adw instance. */ instanceId: string; /** * (Updatable) Specifies if the Autonomous Database requires mTLS connections. */ isMtlsConnectionRequired: boolean; /** * If true then subnetId should not be provided. */ isPublic: boolean; /** * The OCID of the subnet the Autonomous Database is associated with. */ subnetId?: string; /** * This is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Allowed only when subnetId is provided (private ADB). */ toolsPublicAccess?: string; } interface DifStackAdbDbCredential { /** * Vault secret OCID containing the corresponding user password. */ secretId: string; /** * Username for ADB to be created or updated. */ userName: string; /** * Type of the user. Allowed values are "ADMIN" or "CUSTOM" or "GGCS". */ userType: string; } interface DifStackAidataplatform { /** * A default workspace will be created with this name. */ defaultWorkspaceName: string; /** * Identifier for AIDP instance to be provisioned. */ instanceId: string; } interface DifStackDataflow { /** * Contains the archive from object storage bucket which can be added as dependency to data flow application. */ archiveUri?: string; /** * (Updatable) Details for connections to other services from Dataflow. */ connections?: outputs.oci.DifStackDataflowConnections; /** * (Updatable) The VM shape for the driver. Sets the driver cores and memory. */ driverShape: string; /** * (Updatable) This is used to configure the shape of the driver or executor if a flexible shape is used. */ driverShapeConfig: outputs.oci.DifStackDataflowDriverShapeConfig; /** * Contains the main file (py/jar) along with parameters & configuration to be passed to the DataFlow run. */ execute?: string; /** * (Updatable) The VM shape for the executors. Sets the executor cores and memory. */ executorShape: string; /** * (Updatable) This is used to configure the shape of the driver or executor if a flexible shape is used. */ executorShapeConfig: outputs.oci.DifStackDataflowExecutorShapeConfig; /** * Id for dataflow instance */ instanceId: string; /** * (Updatable) InstanceId of log bucket created as part of objectstorage service in stack. Used for storing application run logs. */ logBucketInstanceId: string; /** * (Updatable) The number of executor VMs requested. */ numExecutors: number; /** * (Updatable) OCID of the already provisioned dataflow private endpoint. */ privateEndpointId?: string; /** * (Updatable) The Spark version utilized to run the application. */ sparkVersion: string; /** * (Updatable) InstanceId of warehouse bucket created as part of objectstorage service in stack. Mandatory for SQL applications. */ warehouseBucketInstanceId?: string; } interface DifStackDataflowConnections { /** * (Updatable) Details of services to create private endpoint. */ connectionDetails: outputs.oci.DifStackDataflowConnectionsConnectionDetails; /** * OCID of the private subnet */ subnetId: string; } interface DifStackDataflowConnectionsConnectionDetails { /** * (Updatable) List of DIF Service Dependency Details to create private endpoint. */ difDependencies?: outputs.oci.DifStackDataflowConnectionsConnectionDetailsDifDependency[]; /** * (Updatable) An array of DNS zone names. */ domainNames?: string[]; } interface DifStackDataflowConnectionsConnectionDetailsDifDependency { /** * (Updatable) InstanceId of service which is part of the Stack. */ serviceInstanceId: string; /** * (Updatable) Supported service name. */ serviceType: string; } interface DifStackDataflowDriverShapeConfig { /** * (Updatable) The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs used for the driver or executors. See here for details. */ ocpus: number; } interface DifStackDataflowExecutorShapeConfig { /** * (Updatable) The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * (Updatable) The total number of OCPUs used for the driver or executors. See here for details. */ ocpus: number; } interface DifStackGenai { /** * Name of the base model. */ baseModel: string; /** * The dedicated AI cluster type. */ clusterType: string; /** * (Updatable) List of endpoints to provision for the GENAI cluster. */ endpoints: outputs.oci.DifStackGenaiEndpoint[]; /** * (Updatable) Id for the GenAi instance to be provisioned. */ instanceId: string; /** * Region on which the cluster end endpoint will be provisioned. */ ociRegion: string; /** * (Updatable) No of replicas of base model to be used for hosting. */ unitCount: number; } interface DifStackGenaiEndpoint { /** * (Updatable) Identifier for each endpoint. */ endpointName: string; /** * (Updatable) Helps remove toxic and biased content from responses. */ isContentModerationEnabled: boolean; } interface DifStackGgc { artifactObjectStoragePath?: string; /** * (Updatable) Connection details to be associated with the Goldengate deployment. */ connections?: outputs.oci.DifStackGgcConnection[]; /** * Id for the GGCS instance to provision. */ instanceId: string; /** * (Updatable) The Minimum number of OCPUs to be made available for this Deployment. */ ocpu: number; /** * Version of OGG. */ oggVersion: string; /** * The OCID of the Secret where the deployment password is stored. */ passwordSecretId: string; /** * (Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public GGCS deployments. */ publicSubnetId: string; /** * Source Detail to configure existing or new datasource. */ sources?: outputs.oci.DifStackGgcSource[]; /** * The OCID of the subnet of the GGCS deployment's private endpoint. */ subnetId: string; /** * Target Detail to configure existing or new datasource. */ targets?: outputs.oci.DifStackGgcTarget[]; /** * Ggcs user details to be created or updated. */ users?: outputs.oci.DifStackGgcUser[]; } interface DifStackGgcConnection { /** * (Updatable) OCID of pre-created Oracle GoldenGate connection. */ connectionId?: string; /** * (Updatable) Name of the connection to be created. */ connectionName: string; /** * (Updatable) List of Service Dependency Details for connection creation. */ difDependencies?: outputs.oci.DifStackGgcConnectionDifDependency[]; /** * (Updatable) Vault secret OCID containing password that Oracle GoldenGate uses to connect the associated system of the given technology. */ ggAdminSecretId?: string; } interface DifStackGgcConnectionDifDependency { /** * (Updatable) InstanceId of service which is part of the Stack. */ serviceInstanceId: string; /** * (Updatable) Supported service name. */ serviceType: string; } interface DifStackGgcSource { /** * Action to be done over the user. Allowed values are "CREATE" or "UPDATE". */ action: string; /** * Boolean value that determines source operations should start or not. */ shouldStartSourceOperations: boolean; /** * Ggcs source artifact id. */ sourceId: string; /** * Name of assigned connection for the source. */ targetConnectionName?: string; /** * Target uri for the GoldenGate deployment where distribution path needs to be configured. */ targetUri?: string; } interface DifStackGgcTarget { /** * Action to be done over the user. Allowed values are "CREATE" or "UPDATE". */ action: string; /** * Boolean value that determines target operations should start or not. */ shouldStartTargetOperations: boolean; /** * Name of assigned connection for the target. */ sourceConnectionName?: string; /** * Source uri for the GoldenGate deployment from where the collector path needs to be configured. */ sourceUri?: string; /** * GGCS target artifact id. */ targetId: string; } interface DifStackGgcUser { /** * Action to be done over the user. Allowed values are "CREATE" or "UPDATE". */ action: string; secretId: string; userName: string; userType: string; } interface DifStackObjectstorage { /** * (Updatable) It sets the auto-tiering status on the bucket.Allowed values are "DISABLED" / "INFREQUENTACCESS" */ autoTiering: string; /** * (Updatable) Id for Object Storage instance to be provisioned. */ instanceId: string; /** * (Updatable) Mentions whether the object versioning to be enabled or not,Allowed values are "ENABLED" / "DISABLED"/"SUSPENDED" */ objectVersioning: string; /** * Mentions which storage tier to use for the bucket,Allowed values are "STANDARD" / "ARCHIVE" */ storageTier: string; } interface DifStackOke { /** * OCID of existing OKE cluster. */ clusterId: string; /** * Component overrides for stack specific parameters applied during artifact template rendering. */ componentValueOverrides?: outputs.oci.DifStackOkeComponentValueOverride[]; /** * Unique identifier for an oke instance. */ instanceId: string; /** * Object storage path for the deployment manifest. */ manifestObjectStoragePath?: string; /** * Kubernetes namespace-name of OKE cluster. */ namespaceName: string; /** * List of kubernetes secrets to create or update in the namespace-name of the target cluster. Each entry source secret values from OCI vault. */ secrets?: outputs.oci.DifStackOkeSecret[]; } interface DifStackOkeComponentValueOverride { /** * Logical name of the grouping independently deployable kubernetes resource artifacts for the current deployment. */ componentName: string; /** * Free-form value overrides for the component. Each tag is a simple key-value pair with no predefined name, type, or namespace. * Used for overriding the values in value.yaml artifact of the component. * Example: `{"WORKER_THREADS": "8"}` */ valueOverrides: { [key: string]: string; }; } interface DifStackOkeSecret { /** * List of kubernetes secret data. */ secretDatas: outputs.oci.DifStackOkeSecretSecretData[]; /** * Name of the kubernetes secret of max length 63 and contain only lowercase alphanumeric characters or '-' and start and end with an alphabetic character. */ secretName: string; /** * Object storage path for the secret template to be used for creating secret otherwise it will be created with default template. */ templateObjectStoragePath?: string; } interface DifStackOkeSecretSecretData { /** * Data key in the kubernetes secret. */ key: string; /** * OCID of the Oci vault secret that provides the value for this key. The latest active secret version is used at deploy time unless otherwise configured. */ secretId: string; } interface DifStackOmk { /** * OCID of cluster assigned to OMK cluster-namespace. */ clusterId: string; /** * OCID of existing OMK cluster-namespace. */ clusterNamespaceId: string; /** * Component overrides for stack specific parameters applied during artifact template rendering. */ componentValueOverrides?: outputs.oci.DifStackOmkComponentValueOverride[]; /** * Unique identifier for an omk instance. */ instanceId: string; /** * Object storage path for the deployment manifest. */ manifestObjectStoragePath?: string; /** * Kubernetes namespace-name of OMK cluster-namespace. */ namespaceName: string; /** * List of kubernetes secrets to create or update in the namespace-name of target cluster-namespace. Each entry source secret values from OCI vault. */ secrets?: outputs.oci.DifStackOmkSecret[]; } interface DifStackOmkComponentValueOverride { /** * Logical name of the grouping independently deployable kubernetes resource artifacts for the current deployment. */ componentName: string; /** * Free-form value overrides for the component. Each tag is a simple key-value pair with no predefined name, type, or namespace. * Used for overriding the values in value.yaml artifact of the component. * Example: `{"WORKER_THREADS": "8"}` */ valueOverrides: { [key: string]: string; }; } interface DifStackOmkSecret { /** * List of kubernetes secret data. */ secretDatas: outputs.oci.DifStackOmkSecretSecretData[]; /** * Name of the kubernetes secret of max length 63 and contain only lowercase alphanumeric characters or '-' and start and end with an alphabetic character. */ secretName: string; /** * Object storage path for the secret template to be used for creating secret otherwise it will be created with default template. */ templateObjectStoragePath?: string; } interface DifStackOmkSecretSecretData { /** * Data key in the kubernetes secret. */ key: string; /** * OCID of the Oci vault secret that provides the value for this key. The latest active secret version is used at deploy time unless otherwise configured. */ secretId: string; } interface DifStackServiceDetail { /** * Additional details about the provisioned services */ additionalDetails: outputs.oci.DifStackServiceDetailAdditionalDetail[]; /** * name of the service */ currentArtifactPath: string; /** * A user-friendly name. Should be unique per compartment. Avoid entering confidential information. */ displayName: string; /** * ID for the service instance. */ instanceId: string; /** * ID for the service */ serviceId: string; /** * name of the cloud service */ serviceType: string; /** * url for the service */ serviceUrl: string; /** * state of the service */ status: string; } interface DifStackServiceDetailAdditionalDetail { /** * connections assigned to Golden Gate deployment */ assignedConnections: outputs.oci.DifStackServiceDetailAdditionalDetailAssignedConnection[]; /** * OCID of cluster assigned to OMK cluster-namespace. */ clusterId: string; /** * details of all endpoints assigned to cluster */ endpointDetails: outputs.oci.DifStackServiceDetailAdditionalDetailEndpointDetail[]; /** * OCID of model */ modelId: string; /** * version of model */ modelVersion: string; /** * Kubernetes namespace-name of omk cluster-namespace. */ namespace: string; /** * region of cluster */ ociRegion: string; /** * OCID of model */ privateEndpointId: string; } interface DifStackServiceDetailAdditionalDetailAssignedConnection { /** * OCID of the connection. */ connectionId: string; /** * Name of the connection. */ connectionName: string; /** * Specifies who has made this connection. */ requestedBy: string; } interface DifStackServiceDetailAdditionalDetailEndpointDetail { /** * OCID of the endpoint. */ endpointId: string; /** * Identifier for each endpoint. */ endpointName: string; } interface DistributedDatabaseDistributedAutonomousDatabaseCatalogDetail { /** * Admin password for catalog database. */ adminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud Autonomous VM Cluster. */ cloudAutonomousVmClusterId: string; /** * The compute count for the catalog database. It has to be in multiples of 2. */ computeCount: number; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The data disk group size to be allocated in GBs for the catalog database. */ dataStorageSizeInGbs: number; /** * Determines the auto-scaling mode for the catalog database. */ isAutoScalingEnabled: boolean; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Additional metadata related to Globally distributed autonomous database resources. */ metadatas: outputs.oci.DistributedDatabaseDistributedAutonomousDatabaseCatalogDetailMetadata[]; /** * Name of the shard. */ name: string; /** * The OKV endpoint name. */ okvEndPointGroup: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store used to create the catalog. */ okvKeyStoreId: string; /** * This field is deprecated. This should not be used while creation of new distributed autonomous database. To set the peers on catalog of distributed autonomous database please use peerDetails. */ peerCloudAutonomousVmClusterIds: string[]; /** * The details required for creation of the peer for the autonomous dedicated infrastructure based catalog. */ peerDetails: outputs.oci.DistributedDatabaseDistributedAutonomousDatabaseCatalogDetailPeerDetail[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The source of Globally distributed autonomous database type: Use ADB_D for the Globally distributed autonomous database with autonomous dedicated cloudautonomousvmclusters. */ source: string; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; } interface DistributedDatabaseDistributedAutonomousDatabaseCatalogDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedAutonomousDatabaseCatalogDetailPeerDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud Autonomous VM Cluster for the peer catalog. */ cloudAutonomousVmClusterId: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The lag time preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * This field is deprecated. Support for this field will be removed after one year of deprecation cycle. */ isAutomaticFailoverEnabled: boolean; /** * Additional metadata related to Globally distributed autonomous database resources. */ metadatas: outputs.oci.DistributedDatabaseDistributedAutonomousDatabaseCatalogDetailPeerDetailMetadata[]; /** * The protectionMode for the catalog peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before schedlued maintenance of the primary database. */ standbyMaintenanceBufferInDays: number; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface DistributedDatabaseDistributedAutonomousDatabaseCatalogDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedAutonomousDatabaseConnectionString { /** * Collection of connection strings. */ allConnectionStrings: { [key: string]: string; }; } interface DistributedDatabaseDistributedAutonomousDatabaseDbBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.oci.DistributedDatabaseDistributedAutonomousDatabaseDbBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups. */ recoveryWindowInDays: number; } interface DistributedDatabaseDistributedAutonomousDatabaseDbBackupConfigBackupDestinationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local region. */ isRemote: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface DistributedDatabaseDistributedAutonomousDatabaseGsmDetail { /** * The compute count for the shard database. It has to be in multiples of 2. */ computeCount: number; /** * The data disk group size to be allocated in GBs for the shard database. */ dataStorageSizeInGbs: number; /** * The Global service manager image details. */ gsmImageDetails: outputs.oci.DistributedDatabaseDistributedAutonomousDatabaseGsmDetailGsmImageDetail[]; /** * Additional metadata related to Globally distributed autonomous database resources. */ metadatas: outputs.oci.DistributedDatabaseDistributedAutonomousDatabaseGsmDetailMetadata[]; /** * Name of the shard. */ name: string; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string */ timeSslCertificateExpires: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface DistributedDatabaseDistributedAutonomousDatabaseGsmDetailGsmImageDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface DistributedDatabaseDistributedAutonomousDatabaseGsmDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedAutonomousDatabaseLatestGsmImage { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface DistributedDatabaseDistributedAutonomousDatabaseMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedAutonomousDatabasePatchOperation { /** * (Updatable) The operation can be one of these values: `INSERT`, `MERGE`, `REMOVE` */ operation: string; /** * (Updatable) */ selection: string; /** * (Updatable) */ value: string; } interface DistributedDatabaseDistributedAutonomousDatabaseShardDetail { /** * Admin password for shard database. */ adminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud Autonomous Exadata VM Cluster. */ cloudAutonomousVmClusterId: string; /** * The compute count for the shard database. It has to be in multiples of 2. */ computeCount: number; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The data disk group size to be allocated in GBs for the shard database. */ dataStorageSizeInGbs: number; /** * Determines the auto-scaling mode for the shard database. */ isAutoScalingEnabled: boolean; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Additional metadata related to Globally distributed autonomous database resources. */ metadatas: outputs.oci.DistributedDatabaseDistributedAutonomousDatabaseShardDetailMetadata[]; /** * Name of the shard. */ name: string; /** * The OKV endpoint name. */ okvEndPointGroup: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store used to create the shard. */ okvKeyStoreId: string; /** * This field is deprecated. This should not be used while creation of new distributed autonomous database. To set the peers on new shards of distributed autonomous database please use peerDetails. */ peerCloudAutonomousVmClusterIds: string[]; /** * The details required for creation of the peer for the autonomous dedicated infrastructure based shard. */ peerDetails: outputs.oci.DistributedDatabaseDistributedAutonomousDatabaseShardDetailPeerDetail[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The shard space name for the shard database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. For User defined sharding, every shard must have a unique shard space name. For system defined sharding, shard space name is not required. */ shardSpace: string; /** * The source of Globally distributed autonomous database type: Use ADB_D for the Globally distributed autonomous database with autonomous dedicated cloudautonomousvmclusters. */ source: string; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; } interface DistributedDatabaseDistributedAutonomousDatabaseShardDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedAutonomousDatabaseShardDetailPeerDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloud Autonomous VM Cluster for the peer shard. */ cloudAutonomousVmClusterId: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The lag time preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * This field is deprecated. Support for this field will be removed after one year of deprecation cycle. */ isAutomaticFailoverEnabled: boolean; /** * Additional metadata related to Globally distributed autonomous database resources. */ metadatas: outputs.oci.DistributedDatabaseDistributedAutonomousDatabaseShardDetailPeerDetailMetadata[]; /** * The protectionMode for the shard peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before schedlued maintenance of the primary database. */ standbyMaintenanceBufferInDays: number; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface DistributedDatabaseDistributedAutonomousDatabaseShardDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedAutonomousDatabaseValidateNetworkDetails { isSurrogate?: boolean; resourceName?: string; /** * The name of the shardGroup for the shard. */ shardGroup?: string; } interface DistributedDatabaseDistributedDatabaseCatalogDetail { /** * The admin password for the catalog associated with Globally distributed database. */ adminPassword: string; /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ dbHomeId: string; /** * Details of the request to create exascale db vault storage for shard or catalog of the distributed database. */ dbStorageVaultDetails: outputs.oci.DistributedDatabaseDistributedDatabaseCatalogDetailDbStorageVaultDetails; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Additional metadata related to Globally distributed database resources. */ metadatas: outputs.oci.DistributedDatabaseDistributedDatabaseCatalogDetailMetadata[]; /** * Name of the shard. */ name: string; /** * The details required for creation of the peer for the ExadbXs infrastructure based catalog. */ peerDetails: outputs.oci.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail[]; /** * This field is deprecated. This should not be used while creation of new distributed database. To set the peers on catalog of distributed database please use peerDetails. */ peerVmClusterIds: string[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. */ shardSpace: string; /** * Type of Globally distributed database Shard or Catalog. Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch. Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters. EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle. */ source: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; /** * Details of the request to create exadb vm cluster for shard or catalog of the distributed database. */ vmClusterDetails: outputs.oci.DistributedDatabaseDistributedDatabaseCatalogDetailVmClusterDetails; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; } interface DistributedDatabaseDistributedDatabaseCatalogDetailDbStorageVaultDetails { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * (Updatable) The display name of the Globally distributed database. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface DistributedDatabaseDistributedDatabaseCatalogDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail { /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * Details of the request to create exascale db vault storage for shard or catalog of the distributed database. */ dbStorageVaultDetails: outputs.oci.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailDbStorageVaultDetails; /** * Additional metadata related to Globally distributed database resources. */ metadatas: outputs.oci.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata[]; /** * The protectionMode for the catalog peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The redo transport type to use for this Data Guard association. */ transportType: string; /** * Details of the request to create exadb vm cluster for shard or catalog of the distributed database. */ vmClusterDetails: outputs.oci.DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailVmClusterDetails; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM Cluster for the catalog peer. */ vmClusterId: string; } interface DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailDbStorageVaultDetails { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * (Updatable) The display name of the Globally distributed database. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailVmClusterDetails { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * (Updatable) The display name of the Globally distributed database. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface DistributedDatabaseDistributedDatabaseCatalogDetailVmClusterDetails { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * (Updatable) The display name of the Globally distributed database. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface DistributedDatabaseDistributedDatabaseConnectionString { /** * Collection of connection strings. */ allConnectionStrings: { [key: string]: string; }; } interface DistributedDatabaseDistributedDatabaseDbBackupConfig { /** * Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.oci.DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail[]; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ canRunImmediateFullBackup: boolean; /** * If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ isAutoBackupEnabled: boolean; /** * If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work. */ isRemoteBackupEnabled: boolean; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; } interface DistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup destination. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local region. */ isRemote: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface DistributedDatabaseDistributedDatabaseGsmDetail { /** * The compute count for the Global service manager instance. */ computeCount: number; /** * The data disk group size to be allocated in GBs for the Global service manager instance. */ dataStorageSizeInGbs: number; /** * The Global service manager image details */ gsmImageDetails: outputs.oci.DistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail[]; /** * Additional metadata related to Globally distributed database resources. */ metadatas: outputs.oci.DistributedDatabaseDistributedDatabaseGsmDetailMetadata[]; /** * Name of the shard. */ name: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string */ timeSslCertificateExpires: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface DistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface DistributedDatabaseDistributedDatabaseGsmDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedDatabaseLatestGsmImageDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface DistributedDatabaseDistributedDatabaseMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedDatabasePatchOperation { /** * (Updatable) The operation can be one of these values: `INSERT`, `MERGE`, `REMOVE` */ operation: string; /** * (Updatable) */ selection: string; /** * (Updatable) */ value?: string; } interface DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase { /** * The dbDeploymentType associated with the distributed database. */ dbDeploymentType: string; /** * The identifier of the Private Endpoint. */ id: string; } interface DistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase { /** * The dbDeploymentType associated with the distributed database. */ dbDeploymentType: string; /** * The identifier of the Private Endpoint. */ id: string; } interface DistributedDatabaseDistributedDatabaseShardDetail { /** * The admin password for the shard associated with Globally distributed database. */ adminPassword: string; /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ dbHomeId: string; /** * Details of the request to create exascale db vault storage for shard or catalog of the distributed database. */ dbStorageVaultDetails: outputs.oci.DistributedDatabaseDistributedDatabaseShardDetailDbStorageVaultDetails; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Additional metadata related to Globally distributed database resources. */ metadatas: outputs.oci.DistributedDatabaseDistributedDatabaseShardDetailMetadata[]; /** * Name of the shard. */ name: string; /** * The details required for creation of the peer for the ExadbXs infrastructure based shard. */ peerDetails: outputs.oci.DistributedDatabaseDistributedDatabaseShardDetailPeerDetail[]; /** * This field is deprecated. This should not be used while creation of new distributed database. To set the peers on new shards of distributed database please use peerDetails. */ peerVmClusterIds: string[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. */ shardSpace: string; /** * Type of Globally distributed database Shard or Catalog. Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch. Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters. EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle. */ source: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; /** * Details of the request to create exadb vm cluster for shard or catalog of the distributed database. */ vmClusterDetails: outputs.oci.DistributedDatabaseDistributedDatabaseShardDetailVmClusterDetails; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; } interface DistributedDatabaseDistributedDatabaseShardDetailDbStorageVaultDetails { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * (Updatable) The display name of the Globally distributed database. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface DistributedDatabaseDistributedDatabaseShardDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedDatabaseShardDetailPeerDetail { /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * Details of the request to create exascale db vault storage for shard or catalog of the distributed database. */ dbStorageVaultDetails: outputs.oci.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailDbStorageVaultDetails; /** * Additional metadata related to Globally distributed database resources. */ metadatas: outputs.oci.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata[]; /** * The protectionMode for the shard peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The redo transport type to use for this Data Guard association. */ transportType: string; /** * Details of the request to create exadb vm cluster for shard or catalog of the distributed database. */ vmClusterDetails: outputs.oci.DistributedDatabaseDistributedDatabaseShardDetailPeerDetailVmClusterDetails; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM Cluster for the shard peer. */ vmClusterId: string; } interface DistributedDatabaseDistributedDatabaseShardDetailPeerDetailDbStorageVaultDetails { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * (Updatable) The display name of the Globally distributed database. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface DistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface DistributedDatabaseDistributedDatabaseShardDetailPeerDetailVmClusterDetails { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * (Updatable) The display name of the Globally distributed database. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface DistributedDatabaseDistributedDatabaseShardDetailVmClusterDetails { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * (Updatable) The display name of the Globally distributed database. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface DistributedDatabaseDistributedDatabaseValidateNetworkDetails { isSurrogate?: boolean; resourceName?: string; /** * The name of the shardGroup for the shard. */ shardGroup?: string; } interface GdpGdpPipelineBucketDetail { /** * Type of bucket. SENDER pipelines can be SOURCE, TRANSFER, REJECT, or FAILED. RECEIVER pipelines have a DESTINATION bucket. */ bucketType: string; /** * OCID of the bucket. */ id: string; /** * Name of the bucket. */ name: string; /** * Namespace of the bucket. */ namespace: string; } interface GetAiDataPlatformAiDataPlatformsAiDataPlatformCollection { items: outputs.oci.GetAiDataPlatformAiDataPlatformsAiDataPlatformCollectionItem[]; } interface GetAiDataPlatformAiDataPlatformsAiDataPlatformCollectionItem { /** * The AiDataPlatform type. */ aiDataPlatformType: string; /** * The current aiFeatureStatus of the AiDataPlatform. */ aiFeatureStatus: string; /** * The alias Id of the AiDataPlatform which is the short form of OCID. */ aliasKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IAM user. */ createdBy: string; defaultWorkspaceName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the AiDataPlatform. */ id: string; isEnableAiFeature: boolean; /** * A message that describes the current state of the AiDataPlatform in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the AiDataPlatform was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the AiDataPlatform was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; vectorDbAdminCred: string; vectorDbAdminSecretId: string; vectorDbId: string; /** * The WebSocket URL of the AiDataPlatform. */ webSocketEndpoint: string; } interface GetAiDataPlatformAiDataPlatformsFilter { name: string; regex?: boolean; values: string[]; } interface GetApiPlatformApiPlatformInstanceIdcsApp { /** * IDCS URL of the app */ url: string; } interface GetApiPlatformApiPlatformInstanceUri { /** * Developer's Portal URI of the instance (/developers) */ developersPortalUri: string; /** * Management Portal URI of the instance (/apiplatform) */ managementPortalUri: string; } interface GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollection { items: outputs.oci.GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItem[]; } interface GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * User-provided changeable and non-unique description of the instance */ description: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance */ id: string; /** * IDCS app associated with the instance, that can be used to manage the roles of the users */ idcsApps: outputs.oci.GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemIdcsApp[]; /** * A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state */ lifecycleDetails: string; /** * A filter to return only resources that match the given name exactly */ name: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339) Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339) Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * Service URIs pertaining to the instance */ uris: outputs.oci.GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemUri[]; } interface GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemIdcsApp { /** * IDCS URL of the app */ url: string; } interface GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemUri { /** * Developer's Portal URI of the instance (/developers) */ developersPortalUri: string; /** * Management Portal URI of the instance (/apiplatform) */ managementPortalUri: string; } interface GetApiPlatformApiPlatformInstancesFilter { /** * A filter to return only resources that match the given name exactly */ name: string; regex?: boolean; values: string[]; } interface GetApiaccesscontrolApiMetadataByEntityTypesApiMetadataByEntityTypeCollection { /** * List of apiMetadataByEntityTypeSummary. */ items: outputs.oci.GetApiaccesscontrolApiMetadataByEntityTypesApiMetadataByEntityTypeCollectionItem[]; } interface GetApiaccesscontrolApiMetadataByEntityTypesApiMetadataByEntityTypeCollectionItem { /** * List of apiMetadataSummary. */ apiMetadatas: outputs.oci.GetApiaccesscontrolApiMetadataByEntityTypesApiMetadataByEntityTypeCollectionItemApiMetadata[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The entity Type to which the Api belongs to. */ entityType: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetApiaccesscontrolApiMetadataByEntityTypesApiMetadataByEntityTypeCollectionItemApiMetadata { /** * The name of the api to execute the api request. */ apiName: string; /** * List of the fields that is use while calling post or put for the data. */ attributes: string[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The entity Type to which the Api belongs to. */ entityType: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ApiDetail. */ id: string; /** * A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * The service Name to which the Api belongs to. */ serviceName: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the PrivilegedApiControl was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the PrivilegedApiControl was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetApiaccesscontrolApiMetadataByEntityTypesFilter { name: string; regex?: boolean; values: string[]; } interface GetApiaccesscontrolApiMetadatasApiMetadataCollection { items: outputs.oci.GetApiaccesscontrolApiMetadatasApiMetadataCollectionItem[]; } interface GetApiaccesscontrolApiMetadatasApiMetadataCollectionItem { /** * The name of the api to execute the api request. */ apiName: string; /** * List of the fields that is use while calling post or put for the data. */ attributes: string[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * ResourceType to which the apiMetadata belongs to. */ entityType: string; /** * deprecated; Use attributes field instead. */ fields: string[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ApiDetail. */ id: string; /** * A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * rest path of the api. */ path: string; /** * The service Name to which the api belongs to. */ serviceName: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the PrivilegedApiControl was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the PrivilegedApiControl was marked for delete, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeDeleted: string; /** * The date and time the PrivilegedApiControl was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetApiaccesscontrolApiMetadatasFilter { name: string; regex?: boolean; values: string[]; } interface GetApiaccesscontrolPrivilegedApiControlApproverGroupLevelList { /** * id of the group. */ groupIds: string[]; /** * level of the group. */ groupLevel: number; } interface GetApiaccesscontrolPrivilegedApiControlPrivilegedOperationList { /** * name of the api which needs to be protected. */ apiName: string; /** * list of attributes belonging to the above api which needs to be protected. */ attributeNames: string[]; /** * type of the entity which needs to be protected. */ entityType: string; } interface GetApiaccesscontrolPrivilegedApiControlsFilter { name: string; regex?: boolean; values: string[]; } interface GetApiaccesscontrolPrivilegedApiControlsPrivilegedApiControlCollection { items: outputs.oci.GetApiaccesscontrolPrivilegedApiControlsPrivilegedApiControlCollectionItem[]; } interface GetApiaccesscontrolPrivilegedApiControlsPrivilegedApiControlCollectionItem { /** * List of IAM user group ids who can approve an privilegedApi request associated with a target resource under the governance of this operator control. */ approverGroupIdLists: string[]; /** * List of Group containing the levels at which the users belonging to the group can authorize. */ approverGroupLevelLists: outputs.oci.GetApiaccesscontrolPrivilegedApiControlsPrivilegedApiControlCollectionItemApproverGroupLevelList[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of privilegedApi control. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiControl. */ id: string; /** * A message that describes the current state of the PrivilegedApiControl in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * The OCID of the Oracle Cloud Infrastructure Notification topic to publish messages related to this Privileged Api Control. */ notificationTopicId: string; /** * Number of approvers required to approve an privilegedApi request. */ numberOfApprovers: number; /** * List of privileged operations/apis. These operations/apis will be treaated as secured, once enabled by the Privileged API Managment for a resource. Any of these operations, if needs to be executed, needs to be raised as a PrivilegedApi Request which needs to be approved by customers or it can be pre-approved. */ privilegedOperationLists: outputs.oci.GetApiaccesscontrolPrivilegedApiControlsPrivilegedApiControlCollectionItemPrivilegedOperationList[]; /** * A filter to return only lists of resources that match the entire given service type. */ resourceType: string; /** * contains Resource details */ resources: string[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * A message that describes the current state of the PrivilegedApiControl in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ stateDetails: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the PrivilegedApiControl was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the PrivilegedApiControl was marked for delete, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeDeleted: string; /** * The date and time the PrivilegedApiControl was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetApiaccesscontrolPrivilegedApiControlsPrivilegedApiControlCollectionItemApproverGroupLevelList { /** * id of the group. */ groupIds: string[]; /** * level of the group. */ groupLevel: number; } interface GetApiaccesscontrolPrivilegedApiControlsPrivilegedApiControlCollectionItemPrivilegedOperationList { /** * name of the api which needs to be protected. */ apiName: string; /** * list of attributes belonging to the above api which needs to be protected. */ attributeNames: string[]; /** * type of the entity which needs to be protected. */ entityType: string; } interface GetApiaccesscontrolPrivilegedApiRequestApproverDetail { /** * The action done by the approver. */ approvalAction: string; /** * Comment specified by the approver of the request. */ approvalComment: string; /** * The group level at which the approver approved. */ approverGroupLevel: number; /** * The userId of the approver. */ approverId: string; /** * Time for when the privilegedApi request should start that is authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeApprovedForAccess: string; /** * Time when the privilegedApi request was authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeOfAuthorization: string; } interface GetApiaccesscontrolPrivilegedApiRequestPrivilegedOperationList { /** * name of the api which needs to be protected. */ apiName: string; /** * list of attributes belonging to the above api which needs to be protected. */ attributeNames: string[]; } interface GetApiaccesscontrolPrivilegedApiRequestsFilter { name: string; regex?: boolean; values: string[]; } interface GetApiaccesscontrolPrivilegedApiRequestsPrivilegedApiRequestCollection { items: outputs.oci.GetApiaccesscontrolPrivilegedApiRequestsPrivilegedApiRequestCollectionItem[]; } interface GetApiaccesscontrolPrivilegedApiRequestsPrivilegedApiRequestCollectionItem { /** * Contains the approver details who have approved the privilegedApi Request during the initial request. */ approverDetails: outputs.oci.GetApiaccesscontrolPrivilegedApiRequestsPrivilegedApiRequestCollectionItemApproverDetail[]; /** * The comment entered by the operator while closing the request. */ closureComment: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * Duration in hours for which access is sought on the target resource. */ durationInHrs: number; /** * entityType of resource for which the AccessRequest is applicable */ entityType: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PrivilegedApiRequest. */ id: string; /** * more in detail about the lifeCycleState. */ lifecycleDetails: string; /** * The OCID of the Oracle Cloud Infrastructure Notification topic to publish messages related to this privileged api request. */ notificationTopicId: string; /** * Number of approvers required to approve an privilegedApi request. */ numberOfApproversRequired: number; /** * The OCID of the privilegedApi control governing the target resource. */ privilegedApiControlId: string; /** * Name of the privilegedApi control governing the target resource. */ privilegedApiControlName: string; /** * List of api names, attributes for which approval is sought by the user. */ privilegedOperationLists: outputs.oci.GetApiaccesscontrolPrivilegedApiRequestsPrivilegedApiRequestCollectionItemPrivilegedOperationList[]; /** * Reason in Detail for which the operator is requesting access on the target resource. */ reasonDetail: string; /** * Summary comment by the operator creating the access request. */ reasonSummary: string; /** * This is an automatic identifier generated by the system which is easier for human comprehension. */ requestId: string; /** * List of Users who has created this privilegedApiRequest. */ requestedBies: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource . */ resourceId: string; /** * resourceName for which the PrivilegedApiRequest is applicable */ resourceName: string; /** * A filter to return only lists of resources that match the entire given service type. */ resourceType: string; /** * Priority assigned to the access request by the operator */ severity: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * A message that describes the current state of the PrivilegedApiControl in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ stateDetails: string; /** * The subresource names requested for approval. */ subResourceNameLists: string[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * A list of ticket numbers related to this Privileged Api Access Request, e.g. Service Request (SR) number and JIRA ticket number. */ ticketNumbers: string[]; /** * Time when the privilegedApi request was created in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time in future when the user for the privilegedApi request needs to be created in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeRequestedForFutureAccess: string; /** * Time when the privilegedApi request was last modified in [RFC 3339](https://tools.ietf.org/html/rfc3339)timestamp format. Example: '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } interface GetApiaccesscontrolPrivilegedApiRequestsPrivilegedApiRequestCollectionItemApproverDetail { /** * The action done by the approver. */ approvalAction: string; /** * Comment specified by the approver of the request. */ approvalComment: string; /** * The group level at which the approver approved. */ approverGroupLevel: number; /** * The userId of the approver. */ approverId: string; /** * Time for when the privilegedApi request should start that is authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeApprovedForAccess: string; /** * Time when the privilegedApi request was authorized by the customer in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.Example: '2020-05-22T21:10:29.600Z' */ timeOfAuthorization: string; } interface GetApiaccesscontrolPrivilegedApiRequestsPrivilegedApiRequestCollectionItemPrivilegedOperationList { /** * name of the api which needs to be protected. */ apiName: string; /** * list of attributes belonging to the above api which needs to be protected. */ attributeNames: string[]; } interface GetBatchBatchContextFleet { /** * A message that describes the current state of the service managed fleet configuration in more detail. */ details: string; /** * Maximum number of concurrent tasks for the service managed fleet. */ maxConcurrentTasks: number; /** * Name of the service managed fleet. */ name: string; /** * Shape of the fleet. Describes hardware resources of each node in the fleet. */ shapes: outputs.oci.GetBatchBatchContextFleetShape[]; /** * The current state of the batch context. */ state: string; /** * Type of the logging configuration. Discriminator for sub-entities. */ type: string; } interface GetBatchBatchContextFleetShape { /** * Amount of disk space in GBs required for the shape. */ diskSizeInGbs: number; /** * Amount of memory in GBs required for the shape. */ memoryInGbs: number; /** * Number of OCPUs required for the shape. */ ocpus: number; /** * The name of the shape. */ shapeName: string; /** * Type of the logging configuration. Discriminator for sub-entities. */ type: string; } interface GetBatchBatchContextJobPriorityConfiguration { /** * Name of the tag key. */ tagKey: string; /** * Name of the corresponding tag namespace. */ tagNamespace: string; /** * Mapping of tag value to its priority. */ values: { [key: string]: string; }; /** * Weight associated with the tag key. Percentage point is the unit of measurement. */ weight: number; } interface GetBatchBatchContextLoggingConfiguration { /** * A switch to enable or disable propagation of job and task events to the customer's logs in Oracle Cloud Infrastructure logging service. */ isJobTaskEventsPropagationEnabled: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; /** * Type of the logging configuration. Discriminator for sub-entities. */ type: string; } interface GetBatchBatchContextNetwork { /** * A list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated network security groups. */ nsgIds: string[]; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated subnet. */ subnetId: string; /** * A list of private endpoint's VNICs. */ vnics: outputs.oci.GetBatchBatchContextNetworkVnic[]; } interface GetBatchBatchContextNetworkVnic { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint's VNIC, which resides in the customer's VCN. */ id: string; /** * A list of private IP addresses (in the customer's VCN) that represent access points for the service. */ sourceIps: string[]; } interface GetBatchBatchContextShapesBatchContextShapeCollection { /** * List of shapes. */ items: outputs.oci.GetBatchBatchContextShapesBatchContextShapeCollectionItem[]; } interface GetBatchBatchContextShapesBatchContextShapeCollectionItem { /** * The amount of memory available for container instances that use this shape. */ memoryOptions: outputs.oci.GetBatchBatchContextShapesBatchContextShapeCollectionItemMemoryOption[]; /** * The name identifying the shape. */ name: string; /** * For a flexible shape, the amount of networking bandwidth available for container instances that use this shape. */ networkingBandwidthOptions: outputs.oci.GetBatchBatchContextShapesBatchContextShapeCollectionItemNetworkingBandwidthOption[]; /** * For a flexible shape, the number of OCPUs available for container instances that use this shape. */ ocpuOptions: outputs.oci.GetBatchBatchContextShapesBatchContextShapeCollectionItemOcpuOption[]; /** * A short description of the container instance's processor (CPU). */ processorDescription: string; } interface GetBatchBatchContextShapesBatchContextShapeCollectionItemMemoryOption { /** * The default amount of memory per OCPU available for this shape (GB). */ defaultPerOcpuInGbs: number; /** * The maximum amount of memory (GB). */ maxInGbs: number; /** * For a flexible shape, the maximum amount of memory per OCPU available for this shape (GB). */ maxPerOcpuInGbs: number; /** * The minimum amount of memory (GB). */ minInGbs: number; /** * The minimum amount of memory per OCPU available for this shape (GB). */ minPerOcpuInGbs: number; } interface GetBatchBatchContextShapesBatchContextShapeCollectionItemNetworkingBandwidthOption { /** * The default amount of networking bandwidth per OCPU, in gigabits per second. */ defaultPerOcpuInGbps: number; /** * The maximum amount of networking bandwidth, in gigabits per second. */ maxInGbps: number; /** * The minimum amount of networking bandwidth, in gigabits per second. */ minInGbps: number; } interface GetBatchBatchContextShapesBatchContextShapeCollectionItemOcpuOption { /** * The maximum number of OCPUs. */ maxOcpus: number; /** * The minimum number of OCPUs. */ minOcpus: number; } interface GetBatchBatchContextShapesFilter { /** * The name identifying the shape. */ name: string; regex?: boolean; values: string[]; } interface GetBatchBatchContextsBatchContextCollection { items: outputs.oci.GetBatchBatchContextsBatchContextCollectionItem[]; } interface GetBatchBatchContextsBatchContextCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Summarized information about the batch context. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * Mapping of concurrent/shared resources used in job tasks to their limits. */ entitlements: { [key: string]: string; }; /** * List of fleet configurations related to the batch context. */ fleets: outputs.oci.GetBatchBatchContextsBatchContextCollectionItemFleet[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context. */ id: string; /** * List of job priority configurations related to the batch context. */ jobPriorityConfigurations: outputs.oci.GetBatchBatchContextsBatchContextCollectionItemJobPriorityConfiguration[]; /** * A message that describes the current state in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Logging configuration of the batch context. */ loggingConfigurations: outputs.oci.GetBatchBatchContextsBatchContextCollectionItemLoggingConfiguration[]; /** * Network configuration of the batch context. */ networks: outputs.oci.GetBatchBatchContextsBatchContextCollectionItemNetwork[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the batch context was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the batch context was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetBatchBatchContextsBatchContextCollectionItemFleet { /** * A message that describes the current state of the service managed fleet configuration in more detail. */ details: string; /** * Maximum number of concurrent tasks for the service managed fleet. */ maxConcurrentTasks: number; /** * Name of the service managed fleet. */ name: string; /** * Shape of the fleet. Describes hardware resources of each node in the fleet. */ shapes: outputs.oci.GetBatchBatchContextsBatchContextCollectionItemFleetShape[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Type of the logging configuration. Discriminator for sub-entities. */ type: string; } interface GetBatchBatchContextsBatchContextCollectionItemFleetShape { /** * Amount of disk space in GBs required for the shape. */ diskSizeInGbs: number; /** * Amount of memory in GBs required for the shape. */ memoryInGbs: number; /** * Number of OCPUs required for the shape. */ ocpus: number; /** * The name of the shape. */ shapeName: string; /** * Type of the logging configuration. Discriminator for sub-entities. */ type: string; } interface GetBatchBatchContextsBatchContextCollectionItemJobPriorityConfiguration { /** * Name of the tag key. */ tagKey: string; /** * Name of the corresponding tag namespace. */ tagNamespace: string; /** * Mapping of tag value to its priority. */ values: { [key: string]: string; }; /** * Weight associated with the tag key. Percentage point is the unit of measurement. */ weight: number; } interface GetBatchBatchContextsBatchContextCollectionItemLoggingConfiguration { /** * A switch to enable or disable propagation of job and task events to the customer's logs in Oracle Cloud Infrastructure logging service. */ isJobTaskEventsPropagationEnabled: boolean; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. */ logGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. */ logId: string; /** * Type of the logging configuration. Discriminator for sub-entities. */ type: string; } interface GetBatchBatchContextsBatchContextCollectionItemNetwork { /** * A list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated network security groups. */ nsgIds: string[]; /** * [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated subnet. */ subnetId: string; /** * A list of private endpoint's VNICs. */ vnics: outputs.oci.GetBatchBatchContextsBatchContextCollectionItemNetworkVnic[]; } interface GetBatchBatchContextsBatchContextCollectionItemNetworkVnic { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context. */ id: string; /** * A list of private IP addresses (in the customer's VCN) that represent access points for the service. */ sourceIps: string[]; } interface GetBatchBatchContextsFilter { /** * Name of the service managed fleet. */ name: string; regex?: boolean; /** * Mapping of tag value to its priority. */ values: string[]; } interface GetBatchBatchJobPoolsBatchJobPoolCollection { items: outputs.oci.GetBatchBatchJobPoolsBatchJobPoolCollectionItem[]; } interface GetBatchBatchJobPoolsBatchJobPoolCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context. */ batchContextId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Summarized information about the batch job pool. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool. */ id: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the batch job pool was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the batch job pool was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetBatchBatchJobPoolsFilter { name: string; regex?: boolean; values: string[]; } interface GetBatchBatchTaskEnvironmentSecurityContext { /** * A special supplemental group ID that applies to all containers in a pod. */ fsGroup: number; /** * Group ID for running processes inside the container. */ runAsGroup: number; /** * User ID for running processes inside the container. */ runAsUser: number; } interface GetBatchBatchTaskEnvironmentVolume { /** * The local path to mount the NFS share to. */ localMountDirectoryPath: string; /** * The path to the directory on the NFS server to be mounted. */ mountTargetExportPath: string; /** * The FQDN of the NFS server to connect to. */ mountTargetFqdn: string; /** * The name of the NfsVolume. */ name: string; /** * Discriminator for sub-entities. */ type: string; } interface GetBatchBatchTaskEnvironmentsBatchTaskEnvironmentCollection { items: outputs.oci.GetBatchBatchTaskEnvironmentsBatchTaskEnvironmentCollectionItem[]; } interface GetBatchBatchTaskEnvironmentsBatchTaskEnvironmentCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The batch task environment description. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment. */ id: string; /** * The URL of the ocir image. */ imageUrl: string; /** * Security context for container runtime configuration. */ securityContexts: outputs.oci.GetBatchBatchTaskEnvironmentsBatchTaskEnvironmentCollectionItemSecurityContext[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the batch task environment was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the batch task environment was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output. */ volumes: outputs.oci.GetBatchBatchTaskEnvironmentsBatchTaskEnvironmentCollectionItemVolume[]; /** * Container's working directory. */ workingDirectory: string; } interface GetBatchBatchTaskEnvironmentsBatchTaskEnvironmentCollectionItemSecurityContext { /** * A special supplemental group ID that applies to all containers in a pod. */ fsGroup: number; /** * Group ID for running processes inside the container. */ runAsGroup: number; /** * User ID for running processes inside the container. */ runAsUser: number; } interface GetBatchBatchTaskEnvironmentsBatchTaskEnvironmentCollectionItemVolume { /** * The local path to mount the NFS share to. */ localMountDirectoryPath: string; /** * The path to the directory on the NFS server to be mounted. */ mountTargetExportPath: string; /** * The FQDN of the NFS server to connect to. */ mountTargetFqdn: string; /** * The name of the NfsVolume. */ name: string; /** * Discriminator for sub-entities. */ type: string; } interface GetBatchBatchTaskEnvironmentsFilter { /** * The name of the NfsVolume. */ name: string; regex?: boolean; values: string[]; } interface GetBatchBatchTaskProfileExtendedInformation { /** * Type of CPU architecture. */ architecture: string; /** * A name of the CPU shape. */ shapeName: string; /** * Type of extended information. */ type: string; } interface GetBatchBatchTaskProfilesBatchTaskProfileCollection { items: outputs.oci.GetBatchBatchTaskProfilesBatchTaskProfileCollectionItem[]; } interface GetBatchBatchTaskProfilesBatchTaskProfileCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The batch task profile description. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * Extended information for the task profile. */ extendedInformations: outputs.oci.GetBatchBatchTaskProfilesBatchTaskProfileCollectionItemExtendedInformation[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile. */ id: string; /** * The minimum required size of disk space in GBs. */ minDiskSizeInGbs: number; /** * The minimum required memory. */ minMemoryInGbs: number; /** * The minimum required OCPUs. */ minOcpus: number; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the batch task profile was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the batch task profile was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetBatchBatchTaskProfilesBatchTaskProfileCollectionItemExtendedInformation { /** * Type of CPU architecture. */ architecture: string; /** * A name of the CPU shape. */ shapeName: string; /** * Type of extended information. */ type: string; } interface GetBatchBatchTaskProfilesFilter { name: string; regex?: boolean; values: string[]; } interface GetCostadCostAlertSubscriptionsCostAlertSubscriptionCollection { items: outputs.oci.GetCostadCostAlertSubscriptionsCostAlertSubscriptionCollectionItem[]; } interface GetCostadCostAlertSubscriptionsCostAlertSubscriptionCollectionItem { /** * The notification channels string. */ channels: string; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * List of monitor identifiers */ costAnomalyMonitors: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the cost alert subscription. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Cost Alert Subscription. */ id: string; /** * Unique, non-changeable resource name. */ name: string; /** * The current state of the cost alert subscription. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * The time that the cost alert subscription was created. */ timeCreated: string; /** * The time that the cost alert subscription was updated. */ timeUpdated: string; } interface GetCostadCostAlertSubscriptionsFilter { /** * Unique, non-changeable resource name. */ name: string; regex?: boolean; values: string[]; } interface GetCostadCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollection { /** * The list of CostAnomalyEvent Analytic summary. */ items: outputs.oci.GetCostadCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollectionItem[]; } interface GetCostadCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollectionItem { /** * The average cost impact of the anomaly events in the given time period. */ averageCostImpact: number; /** * The average cost variance of the anomaly events in the given time period. */ averageCostVariance: number; /** * The number of cost anomaly events in the given time period. */ costAnomalyEventAnalyticCount: number; } interface GetCostadCostAnomalyEventAnalyticsFilter { /** * Unique, non-changeable resource name. */ name: string; regex?: boolean; values: string[]; } interface GetCostadCostAnomalyEventsCostAnomalyEventCollection { items: outputs.oci.GetCostadCostAnomalyEventsCostAnomalyEventCollectionItem[]; } interface GetCostadCostAnomalyEventsCostAnomalyEventCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; costAnomalyEventId: string; /** * The name of the associated cost monitor. */ costAnomalyName: string; /** * cost impact (absolute) of the anomaly event. */ costImpact: number; /** * The OCID of the associated cost monitor. */ costMonitorId: string; /** * The name of the associated cost monitor. */ costMonitorName: string; /** * Type of cost monitor */ costMonitorType: string; /** * The cost variance percentage of the detected anomaly. */ costVariancePercentage: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The feedback response for the cost anomaly event. */ feedbackResponse: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Cost Anomaly Event. */ id: string; /** * The root cause details of the cost anomaly event. */ rootCauseDetail: string; /** * The current state of the cost anomaly event. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * 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. */ targetResourceFilter: string; /** * The event date of the anomaly event. */ timeAnomalyEventDate: string; /** * The created time of the cost anomaly event. */ timeCreated: string; /** * The updated time of the cost anomaly event. */ timeUpdated: string; } interface GetCostadCostAnomalyEventsFilter { /** * Unique, non-changeable resource name. */ name: string; regex?: boolean; values: string[]; } interface GetCostadCostAnomalyMonitorCostAlertSubscriptionMap { /** * The costAlertSubscription ocid which the cost monitor alert maps to. */ costAlertSubscriptionId: string; /** * The filter operator. Example: 'AND', 'OR'. */ operator: string; /** * The absolute threshold value. */ thresholdAbsoluteValue: number; /** * The relative percentage threshold value. */ thresholdRelativePercent: number; } interface GetCostadCostAnomalyMonitorsCostAnomalyMonitorCollection { items: outputs.oci.GetCostadCostAnomalyMonitorsCostAnomalyMonitorCollectionItem[]; } interface GetCostadCostAnomalyMonitorsCostAnomalyMonitorCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * The mapping of cost monitor to alert subscription along with thresholds. */ costAlertSubscriptionMaps: outputs.oci.GetCostadCostAnomalyMonitorsCostAnomalyMonitorCollectionItemCostAlertSubscriptionMap[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The description of the budget. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the Cost Anomaly Monitor. */ id: string; /** * The current state details of the cost monitor. */ lifecycleDetails: string; /** * Unique, non-changeable resource name. */ name: string; /** * The current state of the cost monitor. */ state: string; /** * 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"}` */ systemTags: { [key: string]: string; }; /** * 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. */ targetResourceFilter: string; /** * The time that the cost monitor was created. */ timeCreated: string; /** * The time that the cost monitor was last updated. */ timeUpdated: string; /** * Type of cost monitor */ type: string; } interface GetCostadCostAnomalyMonitorsCostAnomalyMonitorCollectionItemCostAlertSubscriptionMap { /** * The costAlertSubscription ocid which the cost monitor alert maps to. */ costAlertSubscriptionId: string; /** * The filter operator. Example: 'AND', 'OR'. */ operator: string; /** * The absolute threshold value. */ thresholdAbsoluteValue: number; /** * The relative percentage threshold value. */ thresholdRelativePercent: number; } interface GetCostadCostAnomalyMonitorsFilter { /** * Unique, non-changeable resource name. */ name: string; regex?: boolean; values: string[]; } interface GetDataccInfrastructureComputeCapacity { /** * Total CPU cores count allocated.. */ allocatedCores: number; /** * Total available CPU cores count. */ availableCores: number; /** * Available memory, in gigabytes (GB). */ availableMemoryInGbs: string; /** * Total Reserved CPU cores count. */ reservedCores: number; /** * Reserved memory, in gigabytes (GB). */ reservedMemoryInGbs: string; /** * Total CPU cores count. */ totalCores: number; /** * Total memory allocated, in gigabytes (GB). */ totalMemoryInGbs: string; /** * Memory allocated to Oracle database virtual machine cluster or Instance, in gigabytes (GB). */ usedMemoryInGbs: string; } interface GetDataccInfrastructureContact { /** * The email for the Database Infrastructure contact. */ email: string; /** * If `true`, this Database Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Database Infrastructure contact is not a valid MOS contact. */ isContactMosValidated: boolean; /** * If `true`, this Database Infrastructure contact is a primary contact. If `false`, this Database Infrastructure is a secondary contact. */ isPrimary: boolean; /** * The name of the Database Infrastructure contact. */ name: string; /** * The phone number for the Database Infrastructure contact. */ phoneNumber: string; } interface GetDataccInfrastructureMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each Database Infrastructure server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: string[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between Database Infrastructure server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: string[]; /** * Cloud Database Infrastructure node patching method. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Database Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week.For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetDataccInfrastructureServer { /** * Number of database virtual machines hosted on the server. */ baseVmCount: number; /** * Capacity details of the Database Infrastructure. */ computeCapacities: outputs.oci.GetDataccInfrastructureServerComputeCapacity[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Data Server of Infrastructure. */ id: string; /** * Database Infrastructure Server ILOM IP address. */ ilomIpAddress: string; /** * Database Infrastructure Server ILOM name. */ ilomName: string; /** * Number of instances hosted on the server. */ instanceVmCount: number; /** * Database Infrastructure Server IP address. */ serverIpAddress: string; /** * Database Infrastructure Server name. */ serverName: string; /** * The current state of the Database Infrastructure. */ state: string; } interface GetDataccInfrastructureServerComputeCapacity { /** * Total CPU cores count allocated.. */ allocatedCores: number; /** * Total available CPU cores count. */ availableCores: number; /** * Available memory, in gigabytes (GB). */ availableMemoryInGbs: string; /** * Total Reserved CPU cores count. */ reservedCores: number; /** * Reserved memory, in gigabytes (GB). */ reservedMemoryInGbs: string; /** * Total CPU cores count. */ totalCores: number; /** * Total memory allocated, in gigabytes (GB). */ totalMemoryInGbs: string; /** * Memory allocated to Oracle database virtual machine cluster or Instance, in gigabytes (GB). */ usedMemoryInGbs: string; } interface GetDataccInfrastructureStorageCapacity { /** * Disk group name. */ diskGroup: string; /** * The total amount of logical disk space that is currently available for use in a disk group, in gigabytes (GB). */ logicalFreeSpaceInGbs: string; /** * The total amount of physical disk space that is currently available for use in a disk group, in gigabytes (GB). */ phyFreeSpaceInGbs: string; /** * The total amount of physical disk space that is reserved for system use in a disk group, in gigabytes (GB). */ phyReservedSpaceInGbs: string; /** * The total amount of physical disk space available in a disk group, in gigabytes (GB). */ phyTotalSpaceInGbs: string; /** * The Disk redundancy for Database Infrastructure storage. */ storageDiskRedundancy: string; } interface GetDataccInfrastructureSystemStorageCapacity { /** * The amount of storage (in GB) in the DATA disk group that is currently utilized for creating local storage for VM Clusters and application VMs. */ acfs: outputs.oci.GetDataccInfrastructureSystemStorageCapacityAcf[]; /** * List of storage disk group capacity details. */ diskGroups: outputs.oci.GetDataccInfrastructureSystemStorageCapacityDiskGroup[]; } interface GetDataccInfrastructureSystemStorageCapacityAcf { /** * The total amount of logical disk space that is currently available for use, in gigabytes (GB). */ freeSpaceInGbs: number; /** * The total amount of logical disk space available, in gigabytes (GB). */ totalSpaceInGbs: number; } interface GetDataccInfrastructureSystemStorageCapacityDiskGroup { /** * The total amount of logical disk space that is currently available for use, in gigabytes (GB). */ freeSpaceInGbs: number; /** * The total amount of logical disk space that is reserved for system use, in gigabytes (GB). */ reservedSpaceInGbs: number; /** * The storage type for the Cloud Database Infrastructure. */ storageType: string; /** * The total amount of logical disk space available, in gigabytes (GB). */ totalSpaceInGbs: number; } interface GetDataccInfrastructuresFilter { /** * The name of the Database Infrastructure contact. */ name: string; regex?: boolean; values: string[]; } interface GetDataccInfrastructuresInfrastructureCollection { items: outputs.oci.GetDataccInfrastructuresInfrastructureCollectionItem[]; } interface GetDataccInfrastructuresInfrastructureCollectionItem { /** * The amount of storage (in GB) in the DATA disk group that is reserved for creating local storage for VM Clusters and application VMs. */ acfsFileSystemStorageInGbs: number; /** * The amount of storage (in GB) in the DATA disk group that is currently utilized for creating local storage for VM Clusters and application VMs. This attribute is deprecated and will be removed in a subsequent release. Please read from systemStorageCapacity instead. */ acfsFileSystemUsedStorageInGbs: number; /** * The CIDR block for the system network. The system network is a private network in Database Infrastructure and is not connected to your corporate network. The system network is used for storage (ASM) traffic, high-performance interconnect traffic and administration of infrastructure components. */ adminNetworkcidr: string; /** * The network bonding interface for backup network for the Database Infrastructure. */ backupNetworkBondingInterface: string; /** * The network bonding mode for Backup networks for the Database Infrastructure. */ backupNetworkBondingMode: string; /** * The network bonding interface for client network for the Database Infrastructure. */ clientNetworkBondingInterface: string; /** * The network bonding mode for Client networks for the Database Infrastructure. */ clientNetworkBondingMode: string; /** * The IP address for the first control plane server. */ cloudControlPlaneServer1: string; /** * The IP address for the second control plane server. */ cloudControlPlaneServer2: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. For list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided, it will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied). */ compartmentId: string; /** * Capacity details of the Database Infrastructure. */ computeCapacities: outputs.oci.GetDataccInfrastructuresInfrastructureCollectionItemComputeCapacity[]; /** * The list of contacts for the Database Infrastructure. */ contacts: outputs.oci.GetDataccInfrastructuresInfrastructureCollectionItemContact[]; /** * The corporate network proxy for access to the control plane network. Oracle recommends using an HTTPS proxy when possible for enhanced security. */ corporateProxy: string; /** * The network bonding interface for CPS network for the Database Infrastructure. */ cpsNetworkBondingInterface: string; /** * The network bonding mode for CPS networks for the Database Infrastructure. */ cpsNetworkBondingMode: string; /** * Percentage of disk space assigned for DATA disk group. */ dataDiskPercentage: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Database Infrastructure description. */ description: string; /** * A filter to return resources that match the entire display name given. The match is case sensitive. */ displayName: string; /** * The list of DNS server IP addresses. Maximum of 3 allowed. */ dnsServers: string[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The gateway for the control plane network. */ gateway: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Data Server of Infrastructure. */ id: string; /** * Lifecycle state details of the Database Infrastructure. */ lifecycleStateDetails: string; /** * The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. */ maintenanceWindows: outputs.oci.GetDataccInfrastructuresInfrastructureCollectionItemMaintenanceWindow[]; /** * The netmask for the control plane network. */ netmask: string; /** * The network adapter, transceiver and cable configuration for the client and backup networks. */ networkAdapterConfiguration: string; /** * The list of NTP server IP addresses. Maximum of 3 allowed. */ ntpServers: string[]; /** * The serial number for the Database Infrastructure. */ rackSerialNumber: string; /** * Percentage of disk space assigned for RECO disk group. */ recoDiskPercentage: number; scaleStorageTrigger: number; /** * A list of Database Infrastructure nodes. */ servers: outputs.oci.GetDataccInfrastructuresInfrastructureCollectionItemServer[]; /** * The shape of the Database Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. */ shape: string; /** * SSD configuration requested for the infrastructure. */ ssdConfigurationRequested: string; /** * A filter to return resources that match the specified lifecycle state. */ state: string; /** * Capacity details of the Storage disk group. This attribute is deprecated and will be removed in a subsequent release. Please use systemStorageCapacity instead. */ storageCapacities: outputs.oci.GetDataccInfrastructuresInfrastructureCollectionItemStorageCapacity[]; /** * The unique identifier for the subscription plan number. */ subscriptionPlanNumber: string; /** * Database Infrastructure System Model specification. The system model determines the model of the Database Infrastructure hardware to be used. */ systemModel: string; /** * Capacity details of different storage types. */ systemStorageCapacities: outputs.oci.GetDataccInfrastructuresInfrastructureCollectionItemSystemStorageCapacity[]; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time, in RFC3339 format, when the Database Infrastructure was activated. */ timeActivated: string; /** * The time that the Database Infrastructure cluster was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time, in RFC3339 format, when the lifecycle state was last updated. */ timeLastStateUpdated: string; /** * The time that the Database Infrastructure was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The time, in RFC3339 format, when the Database Infrastructure network was validated. */ timeValidated: string; /** * The version of the system software on the Database Infrastructure. */ version: string; /** * The CPS network VLAN ID. */ vlanId: string; } interface GetDataccInfrastructuresInfrastructureCollectionItemComputeCapacity { /** * Total CPU cores count allocated.. */ allocatedCores: number; /** * Total available CPU cores count. */ availableCores: number; /** * Available memory, in gigabytes (GB). */ availableMemoryInGbs: string; /** * Total Reserved CPU cores count. */ reservedCores: number; /** * Reserved memory, in gigabytes (GB). */ reservedMemoryInGbs: string; /** * Total CPU cores count. */ totalCores: number; /** * Total memory allocated, in gigabytes (GB). */ totalMemoryInGbs: string; /** * Memory allocated to Oracle database virtual machine cluster or Instance, in gigabytes (GB). */ usedMemoryInGbs: string; } interface GetDataccInfrastructuresInfrastructureCollectionItemContact { /** * The email for the Database Infrastructure contact. */ email: string; /** * If `true`, this Database Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Database Infrastructure contact is not a valid MOS contact. */ isContactMosValidated: boolean; /** * If `true`, this Database Infrastructure contact is a primary contact. If `false`, this Database Infrastructure is a secondary contact. */ isPrimary: boolean; /** * The name of the Database Infrastructure contact. */ name: string; /** * The phone number for the Database Infrastructure contact. */ phoneNumber: string; } interface GetDataccInfrastructuresInfrastructureCollectionItemMaintenanceWindow { /** * Determines the amount of time the system will wait before the start of each Database Infrastructure server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). */ customActionTimeoutInMins: number; /** * Days during the week when maintenance should be performed. */ daysOfWeeks: string[]; /** * The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC */ hoursOfDays: number[]; /** * If true, enables the configuration of a custom action timeout (waiting period) between Database Infrastructure server patching operations. */ isCustomActionTimeoutEnabled: boolean; /** * If true, enables the monthly patching option. */ isMonthlyPatchingEnabled: boolean; /** * Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. */ leadTimeInWeeks: number; /** * Months during the year when maintenance should be performed. */ months: string[]; /** * Cloud Database Infrastructure node patching method. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Database Infrastructure Maintenance Updates](https://docs.cloud.oracle.com/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. */ patchingMode: string; /** * The maintenance window scheduling preference. */ preference: string; /** * Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week.For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. */ weeksOfMonths: number[]; } interface GetDataccInfrastructuresInfrastructureCollectionItemServer { /** * Number of database virtual machines hosted on the server. */ baseVmCount: number; /** * Capacity details of the Database Infrastructure. */ computeCapacities: outputs.oci.GetDataccInfrastructuresInfrastructureCollectionItemServerComputeCapacity[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Data Server of Infrastructure. */ id: string; /** * Database Infrastructure Server ILOM IP address. */ ilomIpAddress: string; /** * Database Infrastructure Server ILOM name. */ ilomName: string; /** * Number of instances hosted on the server. */ instanceVmCount: number; /** * Database Infrastructure Server IP address. */ serverIpAddress: string; /** * Database Infrastructure Server name. */ serverName: string; /** * A filter to return resources that match the specified lifecycle state. */ state: string; } interface GetDataccInfrastructuresInfrastructureCollectionItemServerComputeCapacity { /** * Total CPU cores count allocated.. */ allocatedCores: number; /** * Total available CPU cores count. */ availableCores: number; /** * Available memory, in gigabytes (GB). */ availableMemoryInGbs: string; /** * Total Reserved CPU cores count. */ reservedCores: number; /** * Reserved memory, in gigabytes (GB). */ reservedMemoryInGbs: string; /** * Total CPU cores count. */ totalCores: number; /** * Total memory allocated, in gigabytes (GB). */ totalMemoryInGbs: string; /** * Memory allocated to Oracle database virtual machine cluster or Instance, in gigabytes (GB). */ usedMemoryInGbs: string; } interface GetDataccInfrastructuresInfrastructureCollectionItemStorageCapacity { /** * Disk group name. */ diskGroup: string; /** * The total amount of logical disk space that is currently available for use in a disk group, in gigabytes (GB). */ logicalFreeSpaceInGbs: string; /** * The total amount of physical disk space that is currently available for use in a disk group, in gigabytes (GB). */ phyFreeSpaceInGbs: string; /** * The total amount of physical disk space that is reserved for system use in a disk group, in gigabytes (GB). */ phyReservedSpaceInGbs: string; /** * The total amount of physical disk space available in a disk group, in gigabytes (GB). */ phyTotalSpaceInGbs: string; /** * The Disk redundancy for Database Infrastructure storage. */ storageDiskRedundancy: string; } interface GetDataccInfrastructuresInfrastructureCollectionItemSystemStorageCapacity { /** * The amount of storage (in GB) in the DATA disk group that is currently utilized for creating local storage for VM Clusters and application VMs. */ acfs: outputs.oci.GetDataccInfrastructuresInfrastructureCollectionItemSystemStorageCapacityAcf[]; /** * List of storage disk group capacity details. */ diskGroups: outputs.oci.GetDataccInfrastructuresInfrastructureCollectionItemSystemStorageCapacityDiskGroup[]; } interface GetDataccInfrastructuresInfrastructureCollectionItemSystemStorageCapacityAcf { /** * The total amount of logical disk space that is currently available for use, in gigabytes (GB). */ freeSpaceInGbs: number; /** * The total amount of logical disk space available, in gigabytes (GB). */ totalSpaceInGbs: number; } interface GetDataccInfrastructuresInfrastructureCollectionItemSystemStorageCapacityDiskGroup { /** * The total amount of logical disk space that is currently available for use, in gigabytes (GB). */ freeSpaceInGbs: number; /** * The total amount of logical disk space that is reserved for system use, in gigabytes (GB). */ reservedSpaceInGbs: number; /** * The storage type for the Cloud Database Infrastructure. */ storageType: string; /** * The total amount of logical disk space available, in gigabytes (GB). */ totalSpaceInGbs: number; } interface GetDataccMaintenanceExecutionsFilter { name: string; regex?: boolean; values: string[]; } interface GetDataccMaintenanceExecutionsMaintenanceExecutionCollection { items: outputs.oci.GetDataccMaintenanceExecutionsMaintenanceExecutionCollectionItem[]; } interface GetDataccMaintenanceExecutionsMaintenanceExecutionCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. For list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided, it will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied). */ compartmentId: string; /** * Determines the amount of time the system will wait before the start of each compute server patching operation. Supported values are 15 to 120 minutes. */ customActionTimeoutInMins: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Description of the maintenance run execution. */ description: string; /** * A filter to return resources that match the entire display name given. The match is case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance run execution. */ id: string; /** * The Database Infrastructure ID. */ infrastructureId: string; /** * At the time of execution whether the custom action time out is enabled for the maintenance run that is being executed. */ isCustomActionTimeoutEnabled: boolean; /** * Additional information about the current lifecycle state. */ lifecycleDetails: string; /** * The maintenance run OCID. */ maintenanceRunId: string; /** * The sub-type of the maintenance run. */ maintenanceSubtype: string; /** * The maintenance type. */ maintenanceType: string; /** * The patching mode for the maintenance run that is being executed. */ patchingMode: string; /** * The source software version for the Oracle infrastructure. */ sourceVersion: string; /** * A filter to return only resources that match the given lifecycle state exactly. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The type of the target resource. */ targetResourceType: string; /** * The target software version for the Database Infrastructure patching operation. */ targetVersion: string; /** * The date and time the maintenance run was completed. */ timeEnded: string; /** * The date and time the maintenance run execution started. */ timeStarted: string; /** * The total time taken by this execution in minutes. */ totalTimeTakenInMins: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request executed by this execution. */ workflowId: string; } interface GetDataccVmClusterNetworkScan { /** * The node host name. */ hostname: string; /** * The list of SCAN IP addresses. Three addresses should be provided. */ ips: string[]; } interface GetDataccVmClusterNetworkVmNetwork { /** * The network domain name. */ domainName: string; /** * The network gateway. */ gateway: string; /** * The network netmask. */ netmask: string; /** * The network type. */ networkType: string; /** * The list of node details. */ nodes: outputs.oci.GetDataccVmClusterNetworkVmNetworkNode[]; /** * The network domain name prefix. */ prefix: string; /** * The network VLAN ID. */ vlanId: string; } interface GetDataccVmClusterNetworkVmNetworkNode { /** * The node host name. */ hostname: string; /** * The node IP address. */ ip: string; /** * The node virtual IP (VIP) address. */ vip: string; /** * The node virtual IP (VIP) host name. */ vipHostname: string; } interface GetDataccVmClusterNetworksFilter { name: string; regex?: boolean; values: string[]; } interface GetDataccVmClusterNetworksVmClusterNetworkCollection { items: outputs.oci.GetDataccVmClusterNetworksVmClusterNetworkCollectionItem[]; } interface GetDataccVmClusterNetworksVmClusterNetworkCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated resource. */ associatedResourceId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated VM cluster. */ baseVmClusterId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. For list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided, it will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied). */ compartmentId: string; /** * Consumer type for the VM cluster network. */ consumerType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return resources that match the entire display name given. The match is case sensitive. */ displayName: string; /** * The list of DNS server IP addresses. Maximum of 3 allowed. */ dnsServers: string[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM cluster network. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Infrastructure. */ infrastructureId: string; /** * A filter to return VM cluster network resources that matches the specified value. */ isScanEnabled: boolean; /** * Lifecycle state details of the VM cluster network. */ lifecycleDetails: string; /** * The listener TCP/IP port. */ listenerPort: number; /** * The listener TCP/IP SSL port. */ listenerPortSsl: number; /** * Count of virtual machines in this VM cluster. */ nodeCount: number; /** * The list of NTP server IP addresses. Maximum of 3 allowed. */ ntpServers: string[]; /** * The SCAN details. */ scans: outputs.oci.GetDataccVmClusterNetworksVmClusterNetworkCollectionItemScan[]; /** * A filter to return resources that match the specified lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time that the VM cluster network was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time that the VM cluster network was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * Details of the client and backup networks. */ vmNetworks: outputs.oci.GetDataccVmClusterNetworksVmClusterNetworkCollectionItemVmNetwork[]; } interface GetDataccVmClusterNetworksVmClusterNetworkCollectionItemScan { /** * The node host name. */ hostname: string; /** * The list of SCAN IP addresses. Three addresses should be provided. */ ips: string[]; } interface GetDataccVmClusterNetworksVmClusterNetworkCollectionItemVmNetwork { /** * The network domain name. */ domainName: string; /** * The network gateway. */ gateway: string; /** * The network netmask. */ netmask: string; /** * The network type. */ networkType: string; /** * The list of node details. */ nodes: outputs.oci.GetDataccVmClusterNetworksVmClusterNetworkCollectionItemVmNetworkNode[]; /** * The network domain name prefix. */ prefix: string; /** * The network VLAN ID. */ vlanId: string; } interface GetDataccVmClusterNetworksVmClusterNetworkCollectionItemVmNetworkNode { /** * The node host name. */ hostname: string; /** * The node IP address. */ ip: string; /** * The node virtual IP (VIP) address. */ vip: string; /** * The node virtual IP (VIP) host name. */ vipHostname: string; } interface GetDataccVmInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetDataccVmInstancesVmInstanceCollection { items: outputs.oci.GetDataccVmInstancesVmInstanceCollectionItem[]; } interface GetDataccVmInstancesVmInstanceCollectionItem { /** * Boot storage memory to be allocated in GBs. */ bootStorageSizeInGbs: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. For list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided, it will be validated against the caller's tenant and then treated as tenant scope (compartmentId filtering is not applied). */ compartmentId: string; /** * The number of CPU cores enabled for each VM instance. */ cpusEnabled: number; /** * Data storage to be allocated in GBs. */ dataStorageSizeInGb: number; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * VM instance description. */ description: string; /** * A filter to return resources that match the entire display name given. The match is case sensitive. */ displayName: string; /** * The list of DNS server IP addresses. Maximum of 3 allowed. */ dnsServers: string[]; /** * The domain name of the VM instance. */ domainName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The gateway IP address of the VM instance network. */ gateway: string; /** * The host name of the instance. */ hostname: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM instance. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM custom instance uploaded. */ imageId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Infrastructure. */ infrastructureId: string; /** * The IP address of the instance. */ ipAddress: string; /** * Lifecycle state details of the VM instance. */ lifecycleDetails: string; /** * The memory to be allocated in GBs. */ memorySizeInGbs: number; /** * Custom metadata key/value pairs which can be used to: * * Provide information to [Cloud-Init](https://cloudinit.readthedocs.org/en/latest/) to be used for various system initialization tasks. * * Provide additional information which is exposed inside the instance context and can be queried or referenced by user-data scripts for dynamic configuration. */ metadata: { [key: string]: string; }; /** * The netmask of the VM instance network. */ netmask: string; /** * The list of NTP server addresses. Maximum of 3 allowed. */ ntpServers: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute node on which VM instance should be launched. */ serverId: string; /** * List of public key used for SSH access to the VM instance. */ sshPublicKeys: string[]; /** * A filter to return resources that match the specified lifecycle state. */ state: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time that the VM instance was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time that the VM instance was last updated. An RFC3339 formatted datetime string. */ timeUpdated: string; /** * The time zone to use for the VM instance. */ timeZone: string; /** * 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). */ userdata: string; /** * The network VLAN ID. */ vlanId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VM Network. */ vmNetworkId: string; } interface GetDbmulticloudMultiCloudResourceDiscoveriesFilter { /** * Discovered Resource Name. */ name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudMultiCloudResourceDiscoveriesMultiCloudResourceDiscoverySummaryCollection { items: outputs.oci.GetDbmulticloudMultiCloudResourceDiscoveriesMultiCloudResourceDiscoverySummaryCollectionItem[]; } interface GetDbmulticloudMultiCloudResourceDiscoveriesMultiCloudResourceDiscoverySummaryCollectionItem { /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB Multicloud Discovery resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The ID of the Discovered Resource. */ id: string; /** * Description of the latest modification of the Multicloud Resource Discovery resource. */ lastModification: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource. */ oracleDbConnectorId: string; /** * The type of Multicloud Resource. */ resourceType: string; /** * List of All Discovered resources. */ resources: outputs.oci.GetDbmulticloudMultiCloudResourceDiscoveriesMultiCloudResourceDiscoverySummaryCollectionItemResource[]; /** * Specifies the type(s) of resources to discover in the target cloud provider. */ resourcesFilter: { [key: string]: string; }; /** * A filter to return only resources that match the specified lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Multicloud Discovery Resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Multicloud Discovery Resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudMultiCloudResourceDiscoveriesMultiCloudResourceDiscoverySummaryCollectionItemResource { /** * The ID of the Discovered Resource. */ id: string; /** * Discovered Resource Location. */ location: string; /** * Discovered Resource Name. */ name: string; /** * Discovered Resource's properties. */ properties: { [key: string]: string; }; /** * Discovered Resource Group Name. */ resourceGroup: string; /** * Discovered Resource Type. */ type: string; } interface GetDbmulticloudMultiCloudResourceDiscoveryResource { /** * The ID of the Discovered Resource. */ id: string; /** * Discovered Resource Location. */ location: string; /** * Discovered Resource Name. */ name: string; /** * Discovered Resource's properties. */ properties: { [key: string]: string; }; /** * Discovered Resource Group Name. */ resourceGroup: string; /** * Discovered Resource Type. */ type: string; } interface GetDbmulticloudOracleDbAwsIdentityConnectorServiceRoleDetail { /** * Assume role status. */ assumeRoleStatus: string; /** * List of all VMs where AWS Identity Connector is configured for Oracle DB Cloud VM Cluster. */ awsNodes: outputs.oci.GetDbmulticloudOracleDbAwsIdentityConnectorServiceRoleDetailAwsNode[]; /** * Amazon resource name AWSof the IAM role. */ roleArn: string; /** * Private endpoint of the AWS service. */ servicePrivateEndpoint: string; /** * Type of service. */ serviceType: string; } interface GetDbmulticloudOracleDbAwsIdentityConnectorServiceRoleDetailAwsNode { /** * AWS host ID. */ hostId: string; /** * AWS Host name or Identity Connector name. */ hostName: string; /** * The current status of the AWS Identity Connector resource. */ status: string; /** * Time when the AWS Identity Connector's status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeLastChecked: string; } interface GetDbmulticloudOracleDbAwsIdentityConnectorsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbAwsIdentityConnectorsOracleDbAwsIdentityConnectorSummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbAwsIdentityConnectorsOracleDbAwsIdentityConnectorSummaryCollectionItem[]; } interface GetDbmulticloudOracleDbAwsIdentityConnectorsOracleDbAwsIdentityConnectorSummaryCollectionItem { /** * AWS Account ID. */ awsAccountId: string; /** * AWS resource location. */ awsLocation: string; /** * Private endpoint of AWS Security Token Service. */ awsStsPrivateEndpoint: string; /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB AWS Identity Connector Resource that match the given display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB AWS Identity Connector resource. */ id: string; /** * OIDC token issuer Url. */ issuerUrl: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * Oracle Cloud Infrastructure IAM Domain scope for issuer URL. */ oidcScope: string; /** * A filter to return Oracle DB Identity Connector resource that match the given resource [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ resourceId: string; /** * Service role details and respective Amazon resource nam of Role. */ serviceRoleDetails: outputs.oci.GetDbmulticloudOracleDbAwsIdentityConnectorsOracleDbAwsIdentityConnectorSummaryCollectionItemServiceRoleDetail[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Oracle DB AWS Identity Connector resource was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeCreated: string; /** * Time when the Oracle DB AWS Identity Connector resource was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeUpdated: string; } interface GetDbmulticloudOracleDbAwsIdentityConnectorsOracleDbAwsIdentityConnectorSummaryCollectionItemServiceRoleDetail { /** * Assume role status. */ assumeRoleStatus: string; /** * List of all VMs where AWS Identity Connector is configured for Oracle DB Cloud VM Cluster. */ awsNodes: outputs.oci.GetDbmulticloudOracleDbAwsIdentityConnectorsOracleDbAwsIdentityConnectorSummaryCollectionItemServiceRoleDetailAwsNode[]; /** * Amazon resource name AWSof the IAM role. */ roleArn: string; /** * Private endpoint of the AWS service. */ servicePrivateEndpoint: string; /** * Type of service. */ serviceType: string; } interface GetDbmulticloudOracleDbAwsIdentityConnectorsOracleDbAwsIdentityConnectorSummaryCollectionItemServiceRoleDetailAwsNode { /** * AWS host ID. */ hostId: string; /** * AWS Host name or Identity Connector name. */ hostName: string; /** * The current status of the AWS Identity Connector resource. */ status: string; /** * Time when the AWS Identity Connector's status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z'. */ timeLastChecked: string; } interface GetDbmulticloudOracleDbAwsKeyReplicationMetadata { /** * List of all regions and their respective resource ID. */ replicationDetails: outputs.oci.GetDbmulticloudOracleDbAwsKeyReplicationMetadataReplicationDetail[]; } interface GetDbmulticloudOracleDbAwsKeyReplicationMetadataReplicationDetail { /** * The lifecycle state of the Oracle DB Azure Vault resource. */ replicationState: string; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB AWS Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z'. */ timeCreated: string; /** * Time when the DB AWS Key resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z'. */ timeUpdated: string; } interface GetDbmulticloudOracleDbAwsKeysFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbAwsKeysOracleDbAwsKeySummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbAwsKeysOracleDbAwsKeySummaryCollectionItem[]; } interface GetDbmulticloudOracleDbAwsKeysOracleDbAwsKeySummaryCollectionItem { action: string; /** * AWS Account ID. */ awsAccountId: string; /** * Amazon resource name of AWS Key. */ awsKeyArn: string; /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB AWS Key Resource that match the given display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB AWS Key Ring resource. */ id: string; /** * The Oracle AWS Key resource is enabled or disabled at AWS. */ isAwsKeyEnabled: boolean; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * AWS Key resource location. */ location: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource. */ oracleDbConnectorId: string; /** * AWS Key resource's properties. */ properties: { [key: string]: string; }; /** * Replication metadata, it has information about replication and target region. */ replicationMetadatas: outputs.oci.GetDbmulticloudOracleDbAwsKeysOracleDbAwsKeySummaryCollectionItemReplicationMetadata[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB AWS Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z'. */ timeCreated: string; /** * Time when the DB AWS Key resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z'. */ timeUpdated: string; /** * Key resource type. */ type: string; } interface GetDbmulticloudOracleDbAwsKeysOracleDbAwsKeySummaryCollectionItemReplicationMetadata { /** * List of all regions and their respective resource ID. */ replicationDetails: outputs.oci.GetDbmulticloudOracleDbAwsKeysOracleDbAwsKeySummaryCollectionItemReplicationMetadataReplicationDetail[]; } interface GetDbmulticloudOracleDbAwsKeysOracleDbAwsKeySummaryCollectionItemReplicationMetadataReplicationDetail { /** * The lifecycle state of the Oracle DB Azure Vault resource. */ replicationState: string; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB AWS Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z'. */ timeCreated: string; /** * Time when the DB AWS Key resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z'. */ timeUpdated: string; } interface GetDbmulticloudOracleDbAzureBlobContainersFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbAzureBlobContainersOracleDbAzureBlobContainerSummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbAzureBlobContainersOracleDbAzureBlobContainerSummaryCollectionItem[]; } interface GetDbmulticloudOracleDbAzureBlobContainersOracleDbAzureBlobContainerSummaryCollectionItem { /** * A filter to return Oracle DB Azure Blob Container resources that match the specified Azure Account name. */ azureStorageAccountName: string; /** * A filter to return Oracle DB Azure Blob Container resources that match the specified Azure Storage name. */ azureStorageContainerName: string; /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB Azure Blob Container resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Oracle DB Azure Blob Container resource. */ id: string; /** * Description of the latest modification of the Oracle DB Azure Blob Container resource. */ lastModification: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * Private endpoint's DNS Alias. */ privateEndpointDnsAlias: string; /** * Private endpoint IP. */ privateEndpointIpAddress: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Oracle DB Azure Blob Container was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Oracle DB Azure Blob Container was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudOracleDbAzureBlobMountsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbAzureBlobMountsOracleDbAzureBlobMountSummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbAzureBlobMountsOracleDbAzureBlobMountSummaryCollectionItem[]; } interface GetDbmulticloudOracleDbAzureBlobMountsOracleDbAzureBlobMountSummaryCollectionItem { /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB Azure Blob Mount resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Blob Mount resource. */ id: string; /** * Description of the latest modification of the Oracle DB Azure Blob Mount resource. */ lastModification: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * Oracle DB Azure Blob Mount path. */ mountPath: string; /** * A filter to return Oracle DB Azure Blob Container resource. */ oracleDbAzureBlobContainerId: string; /** * A filter to return Oracle DB Azure Azure Identity Connector resources. */ oracleDbAzureConnectorId: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Oracle DB Azure Blob Mount was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Oracle DB Azure Blob Mount was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudOracleDbAzureConnectorArcAgentNode { /** * Current Arc Agent Version installed on this node of Oracle Cloud VM Cluster. */ currentArcAgentVersion: string; /** * Host ID. */ hostId: string; /** * Host name or Azure Arc Agent name. */ hostName: string; /** * The current status of the Azure Arc Agent resource. */ status: string; /** * Time when the Azure Arc Agent's status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeLastChecked: string; } interface GetDbmulticloudOracleDbAzureConnectorsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbAzureConnectorsOracleDbAzureConnectorSummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbAzureConnectorsOracleDbAzureConnectorSummaryCollectionItem[]; } interface GetDbmulticloudOracleDbAzureConnectorsOracleDbAzureConnectorSummaryCollectionItem { /** * Azure bearer access token. */ accessToken: string; /** * List of all VMs where Arc Agent is installed under Cloud VM Cluster. */ arcAgentNodes: outputs.oci.GetDbmulticloudOracleDbAzureConnectorsOracleDbAzureConnectorSummaryCollectionItemArcAgentNode[]; /** * The current Connectivity status of Azure Identity Connector resource. */ azureIdentityConnectivityStatus: string; /** * Azure Identity mechanism. */ azureIdentityMechanism: string; /** * Azure Resource group name. */ azureResourceGroup: string; /** * Azure Subscription ID. */ azureSubscriptionId: string; /** * Azure Tenant ID. */ azureTenantId: string; /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database resource. */ dbClusterResourceId: string; /** * A filter to return Oracle DB Azure Connector resources that match the specified display name. */ displayName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Connector resource. */ id: string; /** * Description of the latest modification of the Oracle DB Azure Connector resource. */ lastModification: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * Time when the Oracle DB Azure Connector resource was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Oracle DB Azure Connector resource was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudOracleDbAzureConnectorsOracleDbAzureConnectorSummaryCollectionItemArcAgentNode { /** * Current Arc Agent Version installed on this node of Oracle Cloud VM Cluster. */ currentArcAgentVersion: string; /** * Host ID. */ hostId: string; /** * Host name or Azure Arc Agent name. */ hostName: string; /** * The current status of the Azure Arc Agent resource. */ status: string; /** * Time when the Azure Arc Agent's status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeLastChecked: string; } interface GetDbmulticloudOracleDbAzureKeysFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbAzureKeysOracleDbAzureKeySummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbAzureKeysOracleDbAzureKeySummaryCollectionItem[]; } interface GetDbmulticloudOracleDbAzureKeysOracleDbAzureKeySummaryCollectionItem { /** * The ID of the Azure Key resource. */ azureKeyId: string; /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB Azure Vault Keys resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Vault Key resource. */ id: string; /** * Key properties */ keyProperties: { [key: string]: string; }; /** * Description of the latest modification of the Oracle DB Azure Vault Key resource. */ lastModification: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * A filter to return Oracle DB Azure Vault resources that match the specified [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Vault resource. */ oracleDbAzureVaultId: string; /** * Key Resource type. */ resourceType: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Oracle DB Azure Vault Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Oracle DB Azure Vault Key resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudOracleDbAzureVaultAssociationsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbAzureVaultAssociationsOracleDbAzureVaultAssociationSummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbAzureVaultAssociationsOracleDbAzureVaultAssociationSummaryCollectionItem[]; } interface GetDbmulticloudOracleDbAzureVaultAssociationsOracleDbAzureVaultAssociationSummaryCollectionItem { /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB Azure Vault Association resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Vault Association resource. */ id: string; /** * The Associated resource is accessible or not. */ isResourceAccessible: boolean; /** * Description of the latest modification of the Oracle DB Azure Vault Association resource. */ lastModification: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * A filter to return Oracle DB Azure Azure Identity Connector resources. */ oracleDbAzureConnectorId: string; /** * A filter to return Oracle DB Azure Vault resources that match the specified [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Vault resource. */ oracleDbAzureVaultId: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Oracle DB Azure Vault Association resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Oracle DB Azure Vault Association resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudOracleDbAzureVaultReplicationMetadata { /** * List of all regions and their respective resource ID. */ replicationDetails: outputs.oci.GetDbmulticloudOracleDbAzureVaultReplicationMetadataReplicationDetail[]; } interface GetDbmulticloudOracleDbAzureVaultReplicationMetadataReplicationDetail { /** * The lifecycle state of the Oracle DB Azure Vault resource. */ replicationState: string; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB Azure Vault resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeCreated: string; /** * Time when the DB Azure Vault resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudOracleDbAzureVaultsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbAzureVaultsOracleDbAzureVaultSummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbAzureVaultsOracleDbAzureVaultSummaryCollectionItem[]; } interface GetDbmulticloudOracleDbAzureVaultsOracleDbAzureVaultSummaryCollectionItem { action: string; /** * Azure Vault ID. */ azureVaultId: string; /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB Azure Vault resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the oracle DB Azure Vault resource. */ id: string; /** * Description of the latest modification of the Oracle DB Azure Vault resource. */ lastModification: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * Oracle DB Azure Vault resource location. */ location: string; /** * A filter to return Oracle DB Azure Vault resources that match the specified Oracle DB Azure resource group name. */ oracleDbAzureResourceGroup: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource that contains Oracle DB Azure Vault resource. */ oracleDbConnectorId: string; /** * Oracle DB Azure Vault resource's properties. */ properties: { [key: string]: string; }; /** * Replication metadata, it has information about replication and target region. */ replicationMetadatas: outputs.oci.GetDbmulticloudOracleDbAzureVaultsOracleDbAzureVaultSummaryCollectionItemReplicationMetadata[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB Azure Vault resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeCreated: string; /** * Time when the DB Azure Vault resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeUpdated: string; /** * Oracle DB Azure Vault resource type. */ type: string; } interface GetDbmulticloudOracleDbAzureVaultsOracleDbAzureVaultSummaryCollectionItemReplicationMetadata { /** * List of all regions and their respective resource ID. */ replicationDetails: outputs.oci.GetDbmulticloudOracleDbAzureVaultsOracleDbAzureVaultSummaryCollectionItemReplicationMetadataReplicationDetail[]; } interface GetDbmulticloudOracleDbAzureVaultsOracleDbAzureVaultSummaryCollectionItemReplicationMetadataReplicationDetail { /** * The lifecycle state of the Oracle DB Azure Vault resource. */ replicationState: string; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB Azure Vault resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeCreated: string; /** * Time when the DB Azure Vault resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudOracleDbGcpIdentityConnectorGcpNode { /** * Host ID. */ hostId: string; /** * Host Name or Identity Connector name. */ hostName: string; /** * The current status of the GCP Identity Connector resource. */ status: string; /** * time when the GCP Identity Connector's status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeLastChecked: string; } interface GetDbmulticloudOracleDbGcpIdentityConnectorsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbGcpIdentityConnectorsOracleDbGcpIdentityConnectorSummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbGcpIdentityConnectorsOracleDbGcpIdentityConnectorSummaryCollectionItem[]; } interface GetDbmulticloudOracleDbGcpIdentityConnectorsOracleDbGcpIdentityConnectorSummaryCollectionItem { /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB GCP Identity Connector resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The current Connectivity status of GCP Identity Connector resource. */ gcpIdentityConnectivityStatus: string; /** * GCP Location. */ gcpLocation: string; /** * List of All VMs where GCP Identity Connector is configured for this VMCluster. */ gcpNodes: outputs.oci.GetDbmulticloudOracleDbGcpIdentityConnectorsOracleDbGcpIdentityConnectorSummaryCollectionItemGcpNode[]; /** * The ID of the GCP resource service agent. */ gcpResourceServiceAgentId: string; /** * The ID of the cloud GCP Workload Identity Pool. */ gcpWorkloadIdentityPoolId: string; /** * The ID of the GCP Workload Identity Provider. */ gcpWorkloadIdentityProviderId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB GCP Identity Connector resource. */ id: string; /** * OIDC token issuer Url. */ issuerUrl: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * Project id of the customer project. */ projectId: string; /** * A filter to return Oracle DB Identity Connector resource that match the given resource [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). */ resourceId: string; /** * A filter to return only resources that match the specified lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Oracle DB GCP Identity Connector resource was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Oracle DB GCP Identity Connector resource was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudOracleDbGcpIdentityConnectorsOracleDbGcpIdentityConnectorSummaryCollectionItemGcpNode { /** * Host ID. */ hostId: string; /** * Host Name or Identity Connector name. */ hostName: string; /** * The current status of the GCP Identity Connector resource. */ status: string; /** * time when the GCP Identity Connector's status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeLastChecked: string; } interface GetDbmulticloudOracleDbGcpKeyRingReplicationMetadata { /** * List of all regions and their respective resource ID. */ replicationDetails: outputs.oci.GetDbmulticloudOracleDbGcpKeyRingReplicationMetadataReplicationDetail[]; } interface GetDbmulticloudOracleDbGcpKeyRingReplicationMetadataReplicationDetail { /** * The lifecycle state of the Oracle DB Azure Vault resource. */ replicationState: string; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB GCP Key Ring resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeCreated: string; /** * Time when the DB GCP Key Ring resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudOracleDbGcpKeyRingsFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbGcpKeyRingsOracleDbGcpKeyRingSummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbGcpKeyRingsOracleDbGcpKeyRingSummaryCollectionItem[]; } interface GetDbmulticloudOracleDbGcpKeyRingsOracleDbGcpKeyRingSummaryCollectionItem { action: string; /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB GCP Key Ring resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * GCP Key Ring ID. */ gcpKeyRingId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DB GCP Key Ring resource. */ id: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * Location of the GCP Key Ring resource. */ location: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the Oracle DB GCP Identity Connector resource resides. */ oracleDbConnectorId: string; /** * Oracle DB GCP Key Ring resource's properties. */ properties: { [key: string]: string; }; /** * Replication metadata, it has information about replication and target region. */ replicationMetadatas: outputs.oci.GetDbmulticloudOracleDbGcpKeyRingsOracleDbGcpKeyRingSummaryCollectionItemReplicationMetadata[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB GCP Key Ring resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeCreated: string; /** * Time when the DB GCP Key Ring resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeUpdated: string; /** * Oracle DB GCP Key Ring resource Type. */ type: string; } interface GetDbmulticloudOracleDbGcpKeyRingsOracleDbGcpKeyRingSummaryCollectionItemReplicationMetadata { /** * List of all regions and their respective resource ID. */ replicationDetails: outputs.oci.GetDbmulticloudOracleDbGcpKeyRingsOracleDbGcpKeyRingSummaryCollectionItemReplicationMetadataReplicationDetail[]; } interface GetDbmulticloudOracleDbGcpKeyRingsOracleDbGcpKeyRingSummaryCollectionItemReplicationMetadataReplicationDetail { /** * The lifecycle state of the Oracle DB Azure Vault resource. */ replicationState: string; /** * The target region, where resource is replicated. */ targetRegion: string; /** * Time when the DB GCP Key Ring resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeCreated: string; /** * Time when the DB GCP Key Ring resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-23T21:10:29.600Z' */ timeUpdated: string; } interface GetDbmulticloudOracleDbGcpKeysFilter { name: string; regex?: boolean; values: string[]; } interface GetDbmulticloudOracleDbGcpKeysOracleDbGcpKeySummaryCollection { items: outputs.oci.GetDbmulticloudOracleDbGcpKeysOracleDbGcpKeySummaryCollectionItem[]; } interface GetDbmulticloudOracleDbGcpKeysOracleDbGcpKeySummaryCollectionItem { /** * The [ID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return Oracle DB Google Cloud Key resources that match the specified display name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * TThe Google Cloud Key ID and Key URL associated with the Google Key under the specified Key Ring resource. */ gcpKeyId: string; /** * Gcp Key properties */ gcpKeyProperties: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Google Key resource. */ id: string; /** * Description of the current lifecycle state in more detail. */ lifecycleStateDetails: string; /** * A filter to return Oracle DB GCP Key Rings. */ oracleDbGcpKeyRingId: string; /** * Key resource type. */ resourceType: string; /** * A filter to return only resources that match the specified lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Time when the Oracle DB Google Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeCreated: string; /** * Time when the Oracle DB Google Key resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. '2020-05-22T21:10:29.600Z' */ timeUpdated: string; } interface GetDdfsInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetDdfsInstancesInstanceCollection { items: outputs.oci.GetDdfsInstancesInstanceCollectionItem[]; } interface GetDdfsInstancesInstanceCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The HTTPS endpoint for the instance's Fast Healthcare Interoperability Resources (FHIR) service. Example: `https://example.ddfs.oraclecloud.com/api/fhir` */ fhirServiceEndpoint: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Instance. */ id: string; /** * The Oracle Identity Cloud Service (IDCS) URL for the identity domain associated with the instance. Use the IDCS tenant URL from your identity domain configuration. Example: `https://idcs-1234567890.identity.oraclecloud.com` */ idcsUrl: string; /** * A message that describes the current state of the Instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * The public IP address for the instance's FHIR service endpoint. */ publicIp: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.example-key": "example-value"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetDifStackAdb { /** * The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID for admin password. */ adminPasswordId: string; artifactObjectStoragePath: string; /** * The size, in terabytes, of the data volume that will be created and attached to the database. */ dataStorageSizeInTbs: number; dbCredentials: outputs.oci.GetDifStackAdbDbCredential[]; /** * A valid Oracle Database version for Autonomous Database. */ dbVersion: string; /** * DB Workload to be used with ADB. Accepted values are OLTP, DW. */ dbWorkload: string; /** * The compute amount (ECPUs) available to the database. */ ecpu: number; /** * ID for the service instance. */ instanceId: string; /** * Specifies if the Autonomous Database requires mTLS connections. */ isMtlsConnectionRequired: boolean; /** * If true then subnetId should not be provided. */ isPublic: boolean; /** * The OCID of the subnet of the GGCS deployment's private endpoint. */ subnetId: string; /** * This is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Allowed only when subnetId is provided (private ADB). */ toolsPublicAccess: string; } interface GetDifStackAdbDbCredential { secretId: string; userName: string; userType: string; } interface GetDifStackAidataplatform { /** * A default workspace will be created with this name. */ defaultWorkspaceName: string; /** * ID for the service instance. */ instanceId: string; } interface GetDifStackDataflow { archiveUri: string; /** * Connection details to be associated with the Goldengate deployment. */ connections: outputs.oci.GetDifStackDataflowConnection[]; /** * The VM shape for the driver. Sets the driver cores and memory. */ driverShape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ driverShapeConfigs: outputs.oci.GetDifStackDataflowDriverShapeConfig[]; execute: string; /** * The VM shape for the executors. Sets the executor cores and memory. */ executorShape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ executorShapeConfigs: outputs.oci.GetDifStackDataflowExecutorShapeConfig[]; /** * ID for the service instance. */ instanceId: string; /** * InstanceId of log bucket created as part of objectstorage service in stack. Used for storing application run logs. */ logBucketInstanceId: string; /** * The number of executor VMs requested. */ numExecutors: number; /** * OCID of model */ privateEndpointId: string; /** * The Spark version utilized to run the application. */ sparkVersion: string; /** * InstanceId of warehouse bucket created as part of objectstorage service in stack. Mandatory for SQL applications. */ warehouseBucketInstanceId: string; } interface GetDifStackDataflowConnection { /** * Details of services to create private endpoint. */ connectionDetails: outputs.oci.GetDifStackDataflowConnectionConnectionDetail[]; /** * The OCID of the subnet of the GGCS deployment's private endpoint. */ subnetId: string; } interface GetDifStackDataflowConnectionConnectionDetail { /** * List of Service Dependency Details for connection creation. */ difDependencies: outputs.oci.GetDifStackDataflowConnectionConnectionDetailDifDependency[]; /** * An array of DNS zone names. */ domainNames: string[]; } interface GetDifStackDataflowConnectionConnectionDetailDifDependency { /** * InstanceId of service which is part of the Stack. */ serviceInstanceId: string; /** * name of the cloud service */ serviceType: string; } interface GetDifStackDataflowDriverShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See here for details. */ ocpus: number; } interface GetDifStackDataflowExecutorShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See here for details. */ ocpus: number; } interface GetDifStackGenai { /** * Name of the base model. */ baseModel: string; /** * The dedicated AI cluster type. */ clusterType: string; /** * List of endpoints to provision for the GENAI cluster. */ endpoints: outputs.oci.GetDifStackGenaiEndpoint[]; /** * ID for the service instance. */ instanceId: string; /** * region of cluster */ ociRegion: string; /** * No of replicas of base model to be used for hosting. */ unitCount: number; } interface GetDifStackGenaiEndpoint { /** * Identifier for each endpoint. */ endpointName: string; /** * Helps remove toxic and biased content from responses. */ isContentModerationEnabled: boolean; } interface GetDifStackGgc { artifactObjectStoragePath: string; /** * Connection details to be associated with the Goldengate deployment. */ connections: outputs.oci.GetDifStackGgcConnection[]; /** * ID for the service instance. */ instanceId: string; /** * The Minimum number of OCPUs to be made available for this Deployment. */ ocpu: number; /** * Version of OGG. */ oggVersion: string; /** * The OCID of the Secret where the deployment password is stored. */ passwordSecretId: string; /** * The OCID of a public subnet in the customer tenancy. Can be provided only for public GGCS deployments. */ publicSubnetId: string; sources: outputs.oci.GetDifStackGgcSource[]; /** * The OCID of the subnet of the GGCS deployment's private endpoint. */ subnetId: string; targets: outputs.oci.GetDifStackGgcTarget[]; users: outputs.oci.GetDifStackGgcUser[]; } interface GetDifStackGgcConnection { /** * OCID of the connection. */ connectionId: string; /** * Name of the connection. */ connectionName: string; /** * List of Service Dependency Details for connection creation. */ difDependencies: outputs.oci.GetDifStackGgcConnectionDifDependency[]; /** * Vault secret OCID containing password that Oracle GoldenGate uses to connect the associated system of the given technology. */ ggAdminSecretId: string; } interface GetDifStackGgcConnectionDifDependency { /** * InstanceId of service which is part of the Stack. */ serviceInstanceId: string; /** * name of the cloud service */ serviceType: string; } interface GetDifStackGgcSource { action: string; shouldStartSourceOperations: boolean; sourceId: string; targetConnectionName: string; targetUri: string; } interface GetDifStackGgcTarget { action: string; shouldStartTargetOperations: boolean; sourceConnectionName: string; sourceUri: string; targetId: string; } interface GetDifStackGgcUser { action: string; secretId: string; userName: string; userType: string; } interface GetDifStackObjectstorage { /** * It sets the auto-tiering status on the bucket.Allowed values are "DISABLED" / "INFREQUENTACCESS" */ autoTiering: string; /** * ID for the service instance. */ instanceId: string; /** * Mentions whether the object versioning to be enabled or not,Allowed values are "ENABLED" / "DISABLED"/"SUSPENDED" */ objectVersioning: string; /** * Mentions which storage tier to use for the bucket,Allowed values are "STANDARD" / "ARCHIVE" */ storageTier: string; } interface GetDifStackOke { /** * OCID of cluster assigned to OMK cluster-namespace. */ clusterId: string; componentValueOverrides: outputs.oci.GetDifStackOkeComponentValueOverride[]; /** * ID for the service instance. */ instanceId: string; manifestObjectStoragePath: string; namespaceName: string; secrets: outputs.oci.GetDifStackOkeSecret[]; } interface GetDifStackOkeComponentValueOverride { componentName: string; valueOverrides: { [key: string]: string; }; } interface GetDifStackOkeSecret { secretDatas: outputs.oci.GetDifStackOkeSecretSecretData[]; secretName: string; templateObjectStoragePath: string; } interface GetDifStackOkeSecretSecretData { key: string; secretId: string; } interface GetDifStackOmk { /** * OCID of cluster assigned to OMK cluster-namespace. */ clusterId: string; /** * OCID of existing OMK cluster-namespace. */ clusterNamespaceId: string; componentValueOverrides: outputs.oci.GetDifStackOmkComponentValueOverride[]; /** * ID for the service instance. */ instanceId: string; manifestObjectStoragePath: string; namespaceName: string; secrets: outputs.oci.GetDifStackOmkSecret[]; } interface GetDifStackOmkComponentValueOverride { componentName: string; valueOverrides: { [key: string]: string; }; } interface GetDifStackOmkSecret { secretDatas: outputs.oci.GetDifStackOmkSecretSecretData[]; secretName: string; templateObjectStoragePath: string; } interface GetDifStackOmkSecretSecretData { key: string; secretId: string; } interface GetDifStackServiceDetail { /** * Additional details about the provisioned services */ additionalDetails: outputs.oci.GetDifStackServiceDetailAdditionalDetail[]; /** * name of the service */ currentArtifactPath: string; /** * name of the service */ displayName: string; /** * ID for the service instance. */ instanceId: string; /** * ID for the service */ serviceId: string; /** * name of the cloud service */ serviceType: string; /** * url for the service */ serviceUrl: string; /** * state of the service */ status: string; } interface GetDifStackServiceDetailAdditionalDetail { /** * connections assigned to Golden Gate deployment */ assignedConnections: outputs.oci.GetDifStackServiceDetailAdditionalDetailAssignedConnection[]; /** * OCID of cluster assigned to OMK cluster-namespace. */ clusterId: string; /** * details of all endpoints assigned to cluster */ endpointDetails: outputs.oci.GetDifStackServiceDetailAdditionalDetailEndpointDetail[]; /** * OCID of model */ modelId: string; /** * version of model */ modelVersion: string; /** * Kubernetes namespace-name of omk cluster-namespace. */ namespace: string; /** * region of cluster */ ociRegion: string; /** * OCID of model */ privateEndpointId: string; } interface GetDifStackServiceDetailAdditionalDetailAssignedConnection { /** * OCID of the connection. */ connectionId: string; /** * Name of the connection. */ connectionName: string; /** * Specifies who has made this connection. */ requestedBy: string; } interface GetDifStackServiceDetailAdditionalDetailEndpointDetail { /** * OCID of the endpoint. */ endpointId: string; /** * Identifier for each endpoint. */ endpointName: string; } interface GetDifStacksFilter { name: string; regex?: boolean; values: string[]; } interface GetDifStacksStackCollection { items: outputs.oci.GetDifStacksStackCollectionItem[]; } interface GetDifStacksStackCollectionItem { /** * ADB details if adb is included in the services. */ adbs: outputs.oci.GetDifStacksStackCollectionItemAdb[]; addServiceTrigger: number; /** * AI Data Platform Details if aidataplatform is included in services. */ aidataplatforms: outputs.oci.GetDifStacksStackCollectionItemAidataplatform[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * DATAFLOW details if dataflow is included in the services. */ dataflows: outputs.oci.GetDifStacksStackCollectionItemDataflow[]; /** * 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"}` */ definedTags: { [key: string]: string; }; deployArtifactsTrigger: number; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * GenAI Details if genai is included in services. */ genais: outputs.oci.GetDifStacksStackCollectionItemGenai[]; /** * GGCS details if ggcs is included in the services. */ ggcs: outputs.oci.GetDifStacksStackCollectionItemGgc[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Stack. */ id: string; /** * A message that describes the current state of the Stack in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * email id to which the stack notifications would be sent. */ notificationEmail: string; /** * Object Storage Details if object storage is included in services. */ objectstorages: outputs.oci.GetDifStacksStackCollectionItemObjectstorage[]; /** * OKE Details if oke is included in services. */ okes: outputs.oci.GetDifStacksStackCollectionItemOke[]; /** * OMK Details if omk is included in services. */ omks: outputs.oci.GetDifStacksStackCollectionItemOmk[]; /** * Details of the service onboarded for the data intelligence stack. */ serviceDetails: outputs.oci.GetDifStacksStackCollectionItemServiceDetail[]; /** * List of services to be onboarded for the stack. */ services: string[]; /** * List of templates to be onboarded for the stack. */ stackTemplates: string[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The OCID of the subnet of the GGCS deployment's private endpoint. */ subnetId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Stack was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Stack was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetDifStacksStackCollectionItemAdb { /** * The Oracle Cloud Infrastructure vault secret [/Content/General/Concepts/identifiers.htm]OCID for admin password. */ adminPasswordId: string; artifactObjectStoragePath: string; /** * The size, in terabytes, of the data volume that will be created and attached to the database. */ dataStorageSizeInTbs: number; dbCredentials: outputs.oci.GetDifStacksStackCollectionItemAdbDbCredential[]; /** * A valid Oracle Database version for Autonomous Database. */ dbVersion: string; /** * DB Workload to be used with ADB. Accepted values are OLTP, DW. */ dbWorkload: string; /** * The compute amount (ECPUs) available to the database. */ ecpu: number; /** * ID for the service instance. */ instanceId: string; /** * Specifies if the Autonomous Database requires mTLS connections. */ isMtlsConnectionRequired: boolean; /** * If true then subnetId should not be provided. */ isPublic: boolean; /** * The OCID of the subnet of the GGCS deployment's private endpoint. */ subnetId: string; /** * This is an array of CIDR (classless inter-domain routing) notations for a subnet or VCN OCID (virtual cloud network Oracle Cloud ID). Allowed only when subnetId is provided (private ADB). */ toolsPublicAccess: string; } interface GetDifStacksStackCollectionItemAdbDbCredential { secretId: string; userName: string; userType: string; } interface GetDifStacksStackCollectionItemAidataplatform { /** * A default workspace will be created with this name. */ defaultWorkspaceName: string; /** * ID for the service instance. */ instanceId: string; } interface GetDifStacksStackCollectionItemDataflow { archiveUri: string; /** * Connection details to be associated with the Goldengate deployment. */ connections: outputs.oci.GetDifStacksStackCollectionItemDataflowConnection[]; /** * The VM shape for the driver. Sets the driver cores and memory. */ driverShape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ driverShapeConfigs: outputs.oci.GetDifStacksStackCollectionItemDataflowDriverShapeConfig[]; execute: string; /** * The VM shape for the executors. Sets the executor cores and memory. */ executorShape: string; /** * This is used to configure the shape of the driver or executor if a flexible shape is used. */ executorShapeConfigs: outputs.oci.GetDifStacksStackCollectionItemDataflowExecutorShapeConfig[]; /** * ID for the service instance. */ instanceId: string; /** * InstanceId of log bucket created as part of objectstorage service in stack. Used for storing application run logs. */ logBucketInstanceId: string; /** * The number of executor VMs requested. */ numExecutors: number; /** * OCID of model */ privateEndpointId: string; /** * The Spark version utilized to run the application. */ sparkVersion: string; /** * InstanceId of warehouse bucket created as part of objectstorage service in stack. Mandatory for SQL applications. */ warehouseBucketInstanceId: string; } interface GetDifStacksStackCollectionItemDataflowConnection { /** * Details of services to create private endpoint. */ connectionDetails: outputs.oci.GetDifStacksStackCollectionItemDataflowConnectionConnectionDetail[]; /** * The OCID of the subnet of the GGCS deployment's private endpoint. */ subnetId: string; } interface GetDifStacksStackCollectionItemDataflowConnectionConnectionDetail { /** * List of Service Dependency Details for connection creation. */ difDependencies: outputs.oci.GetDifStacksStackCollectionItemDataflowConnectionConnectionDetailDifDependency[]; /** * An array of DNS zone names. */ domainNames: string[]; } interface GetDifStacksStackCollectionItemDataflowConnectionConnectionDetailDifDependency { /** * InstanceId of service which is part of the Stack. */ serviceInstanceId: string; /** * name of the cloud service */ serviceType: string; } interface GetDifStacksStackCollectionItemDataflowDriverShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See here for details. */ ocpus: number; } interface GetDifStacksStackCollectionItemDataflowExecutorShapeConfig { /** * The amount of memory used for the driver or executors. */ memoryInGbs: number; /** * The total number of OCPUs used for the driver or executors. See here for details. */ ocpus: number; } interface GetDifStacksStackCollectionItemGenai { /** * Name of the base model. */ baseModel: string; /** * The dedicated AI cluster type. */ clusterType: string; /** * List of endpoints to provision for the GENAI cluster. */ endpoints: outputs.oci.GetDifStacksStackCollectionItemGenaiEndpoint[]; /** * ID for the service instance. */ instanceId: string; /** * region of cluster */ ociRegion: string; /** * No of replicas of base model to be used for hosting. */ unitCount: number; } interface GetDifStacksStackCollectionItemGenaiEndpoint { /** * Identifier for each endpoint. */ endpointName: string; /** * Helps remove toxic and biased content from responses. */ isContentModerationEnabled: boolean; } interface GetDifStacksStackCollectionItemGgc { artifactObjectStoragePath: string; /** * Connection details to be associated with the Goldengate deployment. */ connections: outputs.oci.GetDifStacksStackCollectionItemGgcConnection[]; /** * ID for the service instance. */ instanceId: string; /** * The Minimum number of OCPUs to be made available for this Deployment. */ ocpu: number; /** * Version of OGG. */ oggVersion: string; /** * The OCID of the Secret where the deployment password is stored. */ passwordSecretId: string; /** * The OCID of a public subnet in the customer tenancy. Can be provided only for public GGCS deployments. */ publicSubnetId: string; sources: outputs.oci.GetDifStacksStackCollectionItemGgcSource[]; /** * The OCID of the subnet of the GGCS deployment's private endpoint. */ subnetId: string; targets: outputs.oci.GetDifStacksStackCollectionItemGgcTarget[]; users: outputs.oci.GetDifStacksStackCollectionItemGgcUser[]; } interface GetDifStacksStackCollectionItemGgcConnection { /** * OCID of the connection. */ connectionId: string; /** * Name of the connection. */ connectionName: string; /** * List of Service Dependency Details for connection creation. */ difDependencies: outputs.oci.GetDifStacksStackCollectionItemGgcConnectionDifDependency[]; /** * Vault secret OCID containing password that Oracle GoldenGate uses to connect the associated system of the given technology. */ ggAdminSecretId: string; } interface GetDifStacksStackCollectionItemGgcConnectionDifDependency { /** * InstanceId of service which is part of the Stack. */ serviceInstanceId: string; /** * name of the cloud service */ serviceType: string; } interface GetDifStacksStackCollectionItemGgcSource { action: string; shouldStartSourceOperations: boolean; sourceId: string; targetConnectionName: string; targetUri: string; } interface GetDifStacksStackCollectionItemGgcTarget { action: string; shouldStartTargetOperations: boolean; sourceConnectionName: string; sourceUri: string; targetId: string; } interface GetDifStacksStackCollectionItemGgcUser { action: string; secretId: string; userName: string; userType: string; } interface GetDifStacksStackCollectionItemObjectstorage { /** * It sets the auto-tiering status on the bucket.Allowed values are "DISABLED" / "INFREQUENTACCESS" */ autoTiering: string; /** * ID for the service instance. */ instanceId: string; /** * Mentions whether the object versioning to be enabled or not,Allowed values are "ENABLED" / "DISABLED"/"SUSPENDED" */ objectVersioning: string; /** * Mentions which storage tier to use for the bucket,Allowed values are "STANDARD" / "ARCHIVE" */ storageTier: string; } interface GetDifStacksStackCollectionItemOke { /** * OCID of cluster assigned to OMK cluster-namespace. */ clusterId: string; componentValueOverrides: outputs.oci.GetDifStacksStackCollectionItemOkeComponentValueOverride[]; /** * ID for the service instance. */ instanceId: string; manifestObjectStoragePath: string; namespaceName: string; secrets: outputs.oci.GetDifStacksStackCollectionItemOkeSecret[]; } interface GetDifStacksStackCollectionItemOkeComponentValueOverride { componentName: string; valueOverrides: { [key: string]: string; }; } interface GetDifStacksStackCollectionItemOkeSecret { secretDatas: outputs.oci.GetDifStacksStackCollectionItemOkeSecretSecretData[]; secretName: string; templateObjectStoragePath: string; } interface GetDifStacksStackCollectionItemOkeSecretSecretData { key: string; secretId: string; } interface GetDifStacksStackCollectionItemOmk { /** * OCID of cluster assigned to OMK cluster-namespace. */ clusterId: string; /** * OCID of existing OMK cluster-namespace. */ clusterNamespaceId: string; componentValueOverrides: outputs.oci.GetDifStacksStackCollectionItemOmkComponentValueOverride[]; /** * ID for the service instance. */ instanceId: string; manifestObjectStoragePath: string; namespaceName: string; secrets: outputs.oci.GetDifStacksStackCollectionItemOmkSecret[]; } interface GetDifStacksStackCollectionItemOmkComponentValueOverride { componentName: string; valueOverrides: { [key: string]: string; }; } interface GetDifStacksStackCollectionItemOmkSecret { secretDatas: outputs.oci.GetDifStacksStackCollectionItemOmkSecretSecretData[]; secretName: string; templateObjectStoragePath: string; } interface GetDifStacksStackCollectionItemOmkSecretSecretData { key: string; secretId: string; } interface GetDifStacksStackCollectionItemServiceDetail { /** * Additional details about the provisioned services */ additionalDetails: outputs.oci.GetDifStacksStackCollectionItemServiceDetailAdditionalDetail[]; /** * name of the service */ currentArtifactPath: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * ID for the service instance. */ instanceId: string; /** * ID for the service */ serviceId: string; /** * name of the cloud service */ serviceType: string; /** * url for the service */ serviceUrl: string; /** * state of the service */ status: string; } interface GetDifStacksStackCollectionItemServiceDetailAdditionalDetail { /** * connections assigned to Golden Gate deployment */ assignedConnections: outputs.oci.GetDifStacksStackCollectionItemServiceDetailAdditionalDetailAssignedConnection[]; /** * OCID of cluster assigned to OMK cluster-namespace. */ clusterId: string; /** * details of all endpoints assigned to cluster */ endpointDetails: outputs.oci.GetDifStacksStackCollectionItemServiceDetailAdditionalDetailEndpointDetail[]; /** * OCID of model */ modelId: string; /** * version of model */ modelVersion: string; /** * Kubernetes namespace-name of omk cluster-namespace. */ namespace: string; /** * region of cluster */ ociRegion: string; /** * OCID of model */ privateEndpointId: string; } interface GetDifStacksStackCollectionItemServiceDetailAdditionalDetailAssignedConnection { /** * OCID of the connection. */ connectionId: string; /** * Name of the connection. */ connectionName: string; /** * Specifies who has made this connection. */ requestedBy: string; } interface GetDifStacksStackCollectionItemServiceDetailAdditionalDetailEndpointDetail { /** * OCID of the endpoint. */ endpointId: string; /** * Identifier for each endpoint. */ endpointName: string; } interface GetDistributedDatabaseDistributedAutonomousDatabaseCatalogDetail { adminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloudAutonomousVmCluster. */ cloudAutonomousVmClusterId: string; /** * The compute count for the shard database. It has to be in multiples of 2. */ computeCount: number; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The data disk group size to be allocated in GBs for the shard database. */ dataStorageSizeInGbs: number; /** * Determines the auto-scaling mode for the shard database. */ isAutoScalingEnabled: boolean; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabaseCatalogDetailMetadata[]; /** * Name of the shard. */ name: string; /** * The OKV endpoint name. */ okvEndPointGroup: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store used to create the shard. */ okvKeyStoreId: string; /** * This field is deprecated. For shard peer details please refer peerDetails attribute. */ peerCloudAutonomousVmClusterIds: string[]; /** * Peer details for the shard with dedicated infrastructure. */ peerDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabaseCatalogDetailPeerDetail[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The source of Globally distributed autonomous database type: Use ADB_D for the Globally distributed autonomous database with autonomous dedicated cloudautonomousvmclusters. */ source: string; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; } interface GetDistributedDatabaseDistributedAutonomousDatabaseCatalogDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabaseCatalogDetailPeerDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloudAutonomousVmCluster. */ cloudAutonomousVmClusterId: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * This field is deprecated. Support for this field will be removed after one year of deprecation cycle. */ isAutomaticFailoverEnabled: boolean; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabaseCatalogDetailPeerDetailMetadata[]; /** * The protectionMode for the shard peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before schedlued maintenance of the primary database. */ standbyMaintenanceBufferInDays: number; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetDistributedDatabaseDistributedAutonomousDatabaseCatalogDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabaseConnectionString { /** * Collection of connection strings. */ allConnectionStrings: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabaseDbBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabaseDbBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups. */ recoveryWindowInDays: number; } interface GetDistributedDatabaseDistributedAutonomousDatabaseDbBackupConfigBackupDestinationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local region. */ isRemote: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetDistributedDatabaseDistributedAutonomousDatabaseGsmDetail { /** * The compute count for the shard database. It has to be in multiples of 2. */ computeCount: number; /** * The data disk group size to be allocated in GBs for the shard database. */ dataStorageSizeInGbs: number; /** * The Global service manager image details. */ gsmImageDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabaseGsmDetailGsmImageDetail[]; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabaseGsmDetailMetadata[]; /** * Name of the shard. */ name: string; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string */ timeSslCertificateExpires: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetDistributedDatabaseDistributedAutonomousDatabaseGsmDetailGsmImageDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface GetDistributedDatabaseDistributedAutonomousDatabaseGsmDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabaseLatestGsmImage { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface GetDistributedDatabaseDistributedAutonomousDatabaseMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabasePatchOperation { operation: string; selection: string; value: string; } interface GetDistributedDatabaseDistributedAutonomousDatabaseShardDetail { adminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloudAutonomousVmCluster. */ cloudAutonomousVmClusterId: string; /** * The compute count for the shard database. It has to be in multiples of 2. */ computeCount: number; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The data disk group size to be allocated in GBs for the shard database. */ dataStorageSizeInGbs: number; /** * Determines the auto-scaling mode for the shard database. */ isAutoScalingEnabled: boolean; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabaseShardDetailMetadata[]; /** * Name of the shard. */ name: string; /** * The OKV endpoint name. */ okvEndPointGroup: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store used to create the shard. */ okvKeyStoreId: string; /** * This field is deprecated. For shard peer details please refer peerDetails attribute. */ peerCloudAutonomousVmClusterIds: string[]; /** * Peer details for the shard with dedicated infrastructure. */ peerDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabaseShardDetailPeerDetail[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The shard space name for the Globally distributed autonomous database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. */ shardSpace: string; /** * The source of Globally distributed autonomous database type: Use ADB_D for the Globally distributed autonomous database with autonomous dedicated cloudautonomousvmclusters. */ source: string; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; } interface GetDistributedDatabaseDistributedAutonomousDatabaseShardDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabaseShardDetailPeerDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloudAutonomousVmCluster. */ cloudAutonomousVmClusterId: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * This field is deprecated. Support for this field will be removed after one year of deprecation cycle. */ isAutomaticFailoverEnabled: boolean; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabaseShardDetailPeerDetailMetadata[]; /** * The protectionMode for the shard peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before schedlued maintenance of the primary database. */ standbyMaintenanceBufferInDays: number; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetDistributedDatabaseDistributedAutonomousDatabaseShardDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabaseValidateNetworkDetail { isSurrogate: boolean; resourceName: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollection { items: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItem[]; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItem { caBundleId: string; /** * Collection of catalogs associated with the Globally distributed autonomous database. */ catalogDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemCatalogDetail[]; certificateId: string; changeDbBackupConfigTrigger: number; /** * The character set for the database. */ characterSet: string; /** * The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. */ chunks: number; /** * The ID of the compartment in which to list resources. */ compartmentId: string; configureGsmWalletTrigger: number; configureShardingIsRebalanceRequired: boolean; configureShardingTrigger: number; /** * Details of Globally distributed autonomous database connection String. */ connectionStrings: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemConnectionString[]; /** * Oracle Database version for the shards and catalog used in Globally distributed autonomous database. */ databaseVersion: string; /** * Backup options for the Distributed Autonomous Database. */ dbBackupConfigs: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemDbBackupConfig[]; /** * A filter to return only resources their dbDeploymentType matches the given dbDeploymentType. */ dbDeploymentType: string; /** * Possible workload types. Currently only OLTP workload type is supported. */ dbWorkload: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only Globally distributed autonomous databases that match the entire name given. The match is not case sensitive. */ displayName: string; downloadGsmCertificateSigningRequestTrigger: number; downloadedGsmCsrPem: string; effectiveReplicationUnit: number; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; generateGsmCertificateSigningRequestTrigger: number; generateGsmCertificateSigningRequestTriggerCaBundleId: string; generateWalletDownloadedWalletContentLength: number; generateWalletDownloadedWalletEtag: string; generateWalletDownloadedWalletLastModified: string; generateWalletDownloadedWalletZipBase64: string; generateWalletPassword: string; generateWalletTrigger: number; /** * Collection of catalogs associated with the Globally distributed autonomous database. */ gsmDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemGsmDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The Global service manager image details. */ latestGsmImages: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemLatestGsmImage[]; /** * The lifecycleDetails for the Globally distributed autonomous database. */ lifecycleDetails: string; /** * The listener port number for the Globally distributed autonomous database. */ listenerPort: number; /** * The TLS listener port number for Globally distributed autonomous database. */ listenerPortTls: number; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemMetadata[]; moveReplicationUnitTrigger: number; /** * The national character set for the database. */ ncharacterSet: string; /** * Ons local port number for Globally distributed autonomous database. */ onsPortLocal: number; /** * Ons remote port number for Globally distributed autonomous database. */ onsPortRemote: number; patchOperations: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemPatchOperation[]; /** * Unique name prefix for the Globally distributed autonomous databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number. */ prefix: string; /** * The collection of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint associated with Globally distributed autonomous database. */ privateEndpointIds: string[]; recreateFailedResourceTrigger: number; /** * The Replication factor for RAFT replication based Globally distributed autonomous database. Currently supported values are 3, 5 and 7. */ replicationFactor: number; /** * The Replication method for Globally distributed autonomous database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG. */ replicationMethod: string; /** * The replication unit count for RAFT based distributed autonomous database. For RAFT replication based Globally distributed autonomous database, the value should be at least twice the number of shards. */ replicationUnit: number; /** * Collection of shards associated with the Globally distributed autonomous database. */ shardDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemShardDetail[]; /** * Sharding Methods for the Globally distributed autonomous database. */ shardingMethod: string; /** * Increment this value to trigger StartDistributedAutonomousDatabase action. */ startDatabaseTrigger: number; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * Increment this value to trigger StopDistributedAutonomousDatabase action. */ stopDatabaseTrigger: number; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; uploadCaSignedCertificate: string; uploadSignedCertificateAndGenerateWalletTrigger: number; validateCaBundleTrigger: number; validateNetworkDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemValidateNetworkDetail[]; validateNetworkTrigger: number; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemCatalogDetail { adminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloudAutonomousVmCluster. */ cloudAutonomousVmClusterId: string; /** * The compute count for the shard database. It has to be in multiples of 2. */ computeCount: number; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The data disk group size to be allocated in GBs for the shard database. */ dataStorageSizeInGbs: number; /** * Determines the auto-scaling mode for the shard database. */ isAutoScalingEnabled: boolean; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemCatalogDetailMetadata[]; /** * Name of the shard. */ name: string; /** * The OKV endpoint name. */ okvEndPointGroup: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store used to create the shard. */ okvKeyStoreId: string; /** * This field is deprecated. For shard peer details please refer peerDetails attribute. */ peerCloudAutonomousVmClusterIds: string[]; /** * Peer details for the shard with dedicated infrastructure. */ peerDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemCatalogDetailPeerDetail[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The source of Globally distributed autonomous database type: Use ADB_D for the Globally distributed autonomous database with autonomous dedicated cloudautonomousvmclusters. */ source: string; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemCatalogDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemCatalogDetailPeerDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloudAutonomousVmCluster. */ cloudAutonomousVmClusterId: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * This field is deprecated. Support for this field will be removed after one year of deprecation cycle. */ isAutomaticFailoverEnabled: boolean; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemCatalogDetailPeerDetailMetadata[]; /** * The protectionMode for the shard peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before schedlued maintenance of the primary database. */ standbyMaintenanceBufferInDays: number; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemCatalogDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemConnectionString { /** * Collection of connection strings. */ allConnectionStrings: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemDbBackupConfig { /** * Backup destination details. */ backupDestinationDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemDbBackupConfigBackupDestinationDetail[]; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups. */ recoveryWindowInDays: number; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemDbBackupConfigBackupDestinationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local region. */ isRemote: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemGsmDetail { /** * The compute count for the shard database. It has to be in multiples of 2. */ computeCount: number; /** * The data disk group size to be allocated in GBs for the shard database. */ dataStorageSizeInGbs: number; /** * The Global service manager image details. */ gsmImageDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemGsmDetailGsmImageDetail[]; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemGsmDetailMetadata[]; /** * Name of the shard. */ name: string; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string */ timeSslCertificateExpires: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemGsmDetailGsmImageDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemGsmDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemLatestGsmImage { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemPatchOperation { operation: string; selection: string; value: string; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemShardDetail { adminPassword: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloudAutonomousVmCluster. */ cloudAutonomousVmClusterId: string; /** * The compute count for the shard database. It has to be in multiples of 2. */ computeCount: number; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The data disk group size to be allocated in GBs for the shard database. */ dataStorageSizeInGbs: number; /** * Determines the auto-scaling mode for the shard database. */ isAutoScalingEnabled: boolean; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemShardDetailMetadata[]; /** * Name of the shard. */ name: string; /** * The OKV endpoint name. */ okvEndPointGroup: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the key store used to create the shard. */ okvKeyStoreId: string; /** * This field is deprecated. For shard peer details please refer peerDetails attribute. */ peerCloudAutonomousVmClusterIds: string[]; /** * Peer details for the shard with dedicated infrastructure. */ peerDetails: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemShardDetailPeerDetail[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The shard space name for the Globally distributed autonomous database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. */ shardSpace: string; /** * The source of Globally distributed autonomous database type: Use ADB_D for the Globally distributed autonomous database with autonomous dedicated cloudautonomousvmclusters. */ source: string; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemShardDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemShardDetailPeerDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cloudAutonomousVmCluster. */ cloudAutonomousVmClusterId: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The lag time for my preference based on data loss tolerance in seconds. */ fastStartFailOverLagLimitInSeconds: number; /** * This field is deprecated. Support for this field will be removed after one year of deprecation cycle. */ isAutomaticFailoverEnabled: boolean; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemShardDetailPeerDetailMetadata[]; /** * The protectionMode for the shard peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The scheduling detail for the quarterly maintenance window of the standby Autonomous Container Database. This value represents the number of days before schedlued maintenance of the primary database. */ standbyMaintenanceBufferInDays: number; /** * Status of shard with dedicated infrastructure for the Globally distributed autonomous database. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed autonomous database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed autonomous database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemShardDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedAutonomousDatabasesDistributedAutonomousDatabaseCollectionItemValidateNetworkDetail { isSurrogate: boolean; resourceName: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; } interface GetDistributedDatabaseDistributedAutonomousDatabasesFilter { /** * Name of the shard. */ name: string; regex?: boolean; values: string[]; } interface GetDistributedDatabaseDistributedAutonomousDatabasesMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabaseCatalogDetail { adminPassword: string; /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ dbHomeId: string; /** * The Storage Vault for Distributed Database Resource */ dbStorageVaultDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseCatalogDetailDbStorageVaultDetail[]; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabaseCatalogDetailMetadata[]; /** * Name of the shard. */ name: string; /** * Peer details for the shard. */ peerDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail[]; peerVmClusterIds: string[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. */ shardSpace: string; /** * Type of Globally distributed database Shard or Catalog. Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch. Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters. EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle. */ source: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; /** * The Exadata VM cluster for Distributed Database Resource */ vmClusterDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseCatalogDetailVmClusterDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; } interface GetDistributedDatabaseDistributedDatabaseCatalogDetailDbStorageVaultDetail { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface GetDistributedDatabaseDistributedDatabaseCatalogDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetail { /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The Storage Vault for Distributed Database Resource */ dbStorageVaultDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailDbStorageVaultDetail[]; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata[]; /** * The protectionMode for the shard peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The redo transport type to use for this Data Guard association. */ transportType: string; /** * The Exadata VM cluster for Distributed Database Resource */ vmClusterDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailVmClusterDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; } interface GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailDbStorageVaultDetail { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabaseCatalogDetailPeerDetailVmClusterDetail { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface GetDistributedDatabaseDistributedDatabaseCatalogDetailVmClusterDetail { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface GetDistributedDatabaseDistributedDatabaseConnectionString { /** * Collection of connection strings. */ allConnectionStrings: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabaseDbBackupConfig { /** * Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail[]; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ canRunImmediateFullBackup: boolean; /** * If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ isAutoBackupEnabled: boolean; /** * If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work. */ isRemoteBackupEnabled: boolean; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; } interface GetDistributedDatabaseDistributedDatabaseDbBackupConfigBackupDestinationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local region. */ isRemote: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetDistributedDatabaseDistributedDatabaseGsmDetail { /** * The compute count for the Global service manager instance. */ computeCount: number; /** * The data disk group size to be allocated in GBs for the Global service manager instance. */ dataStorageSizeInGbs: number; /** * The Global service manager image details */ gsmImageDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail[]; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabaseGsmDetailMetadata[]; /** * Name of the shard. */ name: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string */ timeSslCertificateExpires: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetDistributedDatabaseDistributedDatabaseGsmDetailGsmImageDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface GetDistributedDatabaseDistributedDatabaseGsmDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabaseLatestGsmImageDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface GetDistributedDatabaseDistributedDatabasePatchOperation { operation: string; selection: string; value: string; } interface GetDistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedAutonomousDatabase { /** * The dbDeploymentType associated with the distributed database. */ dbDeploymentType: string; /** * The identifier of the Private Endpoint. */ id: string; } interface GetDistributedDatabaseDistributedDatabasePrivateEndpointGloballyDistributedDatabase { /** * The dbDeploymentType associated with the distributed database. */ dbDeploymentType: string; /** * The identifier of the Private Endpoint. */ id: string; } interface GetDistributedDatabaseDistributedDatabasePrivateEndpointsDistributedDatabasePrivateEndpointCollection { items: outputs.oci.GetDistributedDatabaseDistributedDatabasePrivateEndpointsDistributedDatabasePrivateEndpointCollectionItem[]; } interface GetDistributedDatabaseDistributedDatabasePrivateEndpointsDistributedDatabasePrivateEndpointCollectionItem { /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * DistributedDatabasePrivateEndpoint description. */ description: string; /** * A filter to return only private endpoint that match the entire name given. The match is not case sensitive. */ displayName: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * This field is deprecated. Support for this field will be removed after Mon, 1 Mar 2027 00:00:00 GMT. */ globallyDistributedAutonomousDatabases: outputs.oci.GetDistributedDatabaseDistributedDatabasePrivateEndpointsDistributedDatabasePrivateEndpointCollectionItemGloballyDistributedAutonomousDatabase[]; /** * This field is deprecated. Support for this field will be removed after Mon, 1 Mar 2027 00:00:00 GMT. */ globallyDistributedDatabases: outputs.oci.GetDistributedDatabaseDistributedDatabasePrivateEndpointsDistributedDatabasePrivateEndpointCollectionItemGloballyDistributedDatabase[]; /** * The identifier of the Private Endpoint. */ id: string; /** * Detailed message for the lifecycle state. */ lifecycleDetails: string; /** * The OCIDs of the network security groups that the private endpoint belongs to. */ nsgIds: string[]; /** * IP address of the Private Endpoint. */ privateIp: string; /** * The identifier of the proxy compute instance. */ proxyComputeInstanceId: string; reinstateProxyInstanceTrigger: number; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * Identifier of the subnet in which private endpoint exists. */ subnetId: string; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Private Endpoint was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * Identifier of the VCN in which subnet exists. */ vcnId: string; } interface GetDistributedDatabaseDistributedDatabasePrivateEndpointsDistributedDatabasePrivateEndpointCollectionItemGloballyDistributedAutonomousDatabase { /** * The dbDeploymentType associated with the distributed database. */ dbDeploymentType: string; /** * The identifier of the Private Endpoint. */ id: string; } interface GetDistributedDatabaseDistributedDatabasePrivateEndpointsDistributedDatabasePrivateEndpointCollectionItemGloballyDistributedDatabase { /** * The dbDeploymentType associated with the distributed database. */ dbDeploymentType: string; /** * The identifier of the Private Endpoint. */ id: string; } interface GetDistributedDatabaseDistributedDatabasePrivateEndpointsFilter { name: string; regex?: boolean; values: string[]; } interface GetDistributedDatabaseDistributedDatabaseShardDetail { adminPassword: string; /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ dbHomeId: string; /** * The Storage Vault for Distributed Database Resource */ dbStorageVaultDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseShardDetailDbStorageVaultDetail[]; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabaseShardDetailMetadata[]; /** * Name of the shard. */ name: string; /** * Peer details for the shard. */ peerDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetail[]; peerVmClusterIds: string[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. */ shardSpace: string; /** * Type of Globally distributed database Shard or Catalog. Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch. Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters. EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle. */ source: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; /** * The Exadata VM cluster for Distributed Database Resource */ vmClusterDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseShardDetailVmClusterDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; } interface GetDistributedDatabaseDistributedDatabaseShardDetailDbStorageVaultDetail { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface GetDistributedDatabaseDistributedDatabaseShardDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetail { /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The Storage Vault for Distributed Database Resource */ dbStorageVaultDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailDbStorageVaultDetail[]; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata[]; /** * The protectionMode for the shard peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The redo transport type to use for this Data Guard association. */ transportType: string; /** * The Exadata VM cluster for Distributed Database Resource */ vmClusterDetails: outputs.oci.GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailVmClusterDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; } interface GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailDbStorageVaultDetail { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabaseShardDetailPeerDetailVmClusterDetail { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface GetDistributedDatabaseDistributedDatabaseShardDetailVmClusterDetail { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * The user-friendly name for the Exadata VM cluster on Exascale Infrastructure. The name does not need to be unique. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface GetDistributedDatabaseDistributedDatabaseValidateNetworkDetail { isSurrogate: boolean; resourceName: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollection { items: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItem[]; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItem { /** * Collection of catalogs associated with the Globally distributed database. */ catalogDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetail[]; changeDbBackupConfigTrigger: number; /** * The character set for the database. */ characterSet: string; /** * The default number of unique chunks in a shardspace. The value of chunks must be greater than 2 times the size of the largest shardgroup in any shardspace. */ chunks: number; /** * The ID of the compartment in which to list resources. */ compartmentId: string; configureShardingIsRebalanceRequired: boolean; configureShardingTrigger: number; /** * Details of Globally distributed database connection String. */ connectionStrings: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemConnectionString[]; /** * Oracle Database version for the shards and catalog used in Globally distributed database. */ databaseVersion: string; /** * Backup Options To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). */ dbBackupConfigs: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemDbBackupConfig[]; /** * A filter to return only resources their dbDeploymentType matches the given dbDeploymentType. */ dbDeploymentType: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive. */ displayName: string; /** * @deprecated This trigger/action API is deprecated. */ downloadGsmCertificateSigningRequestTrigger: number; effectiveReplicationUnit: number; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * @deprecated This trigger/action API is deprecated. */ generateGsmCertificateSigningRequestTrigger: number; generateWalletDownloadedWalletContentLength: number; generateWalletDownloadedWalletEtag: string; generateWalletDownloadedWalletLastModified: string; generateWalletDownloadedWalletZipBase64: string; generateWalletPassword: string; generateWalletTrigger: number; /** * Collection of catalogs associated with the Globally distributed database. */ gsmDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemGsmDetail[]; /** * The SSH public key for Global service manager instances. */ gsmSshPublicKey: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The Global service manager image details */ latestGsmImageDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemLatestGsmImageDetail[]; /** * The lifecycleDetails for the Globally distributed database. */ lifecycleDetails: string; /** * The Global service manager listener port number for the Globally distributed database. */ listenerPort: number; /** * The TLS listener port number for Globally distributed database. */ listenerPortTls: number; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemMetadata[]; moveReplicationUnitTrigger: number; /** * The national character set for the database. */ ncharacterSet: string; /** * Ons local port number. */ onsPortLocal: number; /** * Ons remote port number. */ onsPortRemote: number; patchOperations: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemPatchOperation[]; /** * Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character has to be a letter followed by any combination of letter and number. */ prefix: string; /** * The collection of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint associated with Globally distributed autonomous database. */ privateEndpointIds: string[]; recreateFailedResourceTrigger: number; /** * The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7. */ replicationFactor: number; /** * The Replication method for Globally distributed database. Use RAFT for Raft replication, and DG for DataGuard. If replicationMethod is not provided, it defaults to DG. */ replicationMethod: string; /** * The replication unit count for RAFT based distributed database. For RAFT replication based Globally distributed database, the value should be at least twice the number of shards. */ replicationUnit: number; /** * The TCP Single Client Access Name (SCAN) port for Globally distributed database clusters. */ scanListenerPort: number; /** * Collection of shards associated with the Globally distributed database. */ shardDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetail[]; /** * Sharding Methods for the Globally distributed database. */ shardingMethod: string; /** * Increment this value to trigger StartDistributedDatabase action. */ startDatabaseTrigger: number; /** * A filter to return only resources their lifecycleState matches the given lifecycleState. */ state: string; /** * Increment this value to trigger StopDistributedDatabase action. */ stopDatabaseTrigger: number; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * @deprecated This trigger/action API is deprecated. */ uploadSignedCertificateAndGenerateWalletTrigger: number; validateNetworkDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemValidateNetworkDetail[]; validateNetworkTrigger: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetail { adminPassword: string; /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ dbHomeId: string; /** * The Storage Vault for Distributed Database Resource */ dbStorageVaultDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailDbStorageVaultDetail[]; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailMetadata[]; /** * Name of the shard. */ name: string; /** * Peer details for the shard. */ peerDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailPeerDetail[]; peerVmClusterIds: string[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. */ shardSpace: string; /** * Type of Globally distributed database Shard or Catalog. Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch. Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters. EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle. */ source: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; /** * The Exadata VM cluster for Distributed Database Resource */ vmClusterDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailVmClusterDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailDbStorageVaultDetail { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailPeerDetail { /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The Storage Vault for Distributed Database Resource */ dbStorageVaultDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailPeerDetailDbStorageVaultDetail[]; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailPeerDetailMetadata[]; /** * The protectionMode for the shard peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The redo transport type to use for this Data Guard association. */ transportType: string; /** * The Exadata VM cluster for Distributed Database Resource */ vmClusterDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailPeerDetailVmClusterDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailPeerDetailDbStorageVaultDetail { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailPeerDetailVmClusterDetail { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemCatalogDetailVmClusterDetail { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemConnectionString { /** * Collection of connection strings. */ allConnectionStrings: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemDbBackupConfig { /** * Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoBackupWindow: string; /** * Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday. */ autoFullBackupDay: string; /** * Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive). Example: `SLOT_TWO` */ autoFullBackupWindow: string; /** * This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups. */ backupDeletionPolicy: string; /** * Backup destination details. */ backupDestinationDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemDbBackupConfigBackupDestinationDetail[]; /** * If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately. */ canRunImmediateFullBackup: boolean; /** * If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work. */ isAutoBackupEnabled: boolean; /** * If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour. If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli. This means that you can no longer rely on your previously configured unmanaged backups to work. */ isRemoteBackupEnabled: boolean; /** * Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window. When the value is updated, it is applied to all existing automatic backups. */ recoveryWindowInDays: number; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemDbBackupConfigBackupDestinationDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup. */ dbrsPolicyId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * Proxy URL to connect to object store. */ internetProxy: string; /** * Indicates whether the backup destination is cross-region or local region. */ isRemote: boolean; /** * Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given. */ isZeroDataLossEnabled: boolean; /** * The name of the remote region where the remote automatic incremental backups will be stored. For information about valid region names, see [Regions and Availability Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm). */ remoteRegion: string; /** * Type of the database backup destination. */ type: string; /** * For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance. */ vpcPassword: string; /** * For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance. */ vpcUser: string; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemGsmDetail { /** * The compute count for the Global service manager instance. */ computeCount: number; /** * The data disk group size to be allocated in GBs for the Global service manager instance. */ dataStorageSizeInGbs: number; /** * The Global service manager image details */ gsmImageDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemGsmDetailGsmImageDetail[]; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemGsmDetailMetadata[]; /** * Name of the shard. */ name: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string */ timeSslCertificateExpires: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemGsmDetailGsmImageDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemGsmDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemLatestGsmImageDetail { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Global service manager software image. */ id: string; /** * The version number associated with the image identified by id. */ versionNumber: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemPatchOperation { operation: string; selection: string; value: string; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetail { adminPassword: string; /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Home. */ dbHomeId: string; /** * The Storage Vault for Distributed Database Resource */ dbStorageVaultDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailDbStorageVaultDetail[]; /** * The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. */ kmsKeyId: string; /** * The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. */ kmsKeyVersionId: string; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailMetadata[]; /** * Name of the shard. */ name: string; /** * Peer details for the shard. */ peerDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailPeerDetail[]; peerVmClusterIds: string[]; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards. */ shardSpace: string; /** * Type of Globally distributed database Shard or Catalog. Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch. Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters. EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle. */ source: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and `kmsKeyId` are required for Customer Managed Keys. */ vaultId: string; /** * The Exadata VM cluster for Distributed Database Resource */ vmClusterDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailVmClusterDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailDbStorageVaultDetail { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailPeerDetail { /** * The name of the availability domain that the distributed database shard will be located in. */ availabilityDomain: string; /** * the identifier of the container database for underlying supporting resource. */ containerDatabaseId: string; /** * The Storage Vault for Distributed Database Resource */ dbStorageVaultDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailPeerDetailDbStorageVaultDetail[]; /** * Comma separated names of argument corresponding to which metadata need to be retrived. */ metadatas: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailPeerDetailMetadata[]; /** * The protectionMode for the shard peer. */ protectionMode: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; /** * Status of EXADB_XS based shard. */ status: string; /** * the identifier of the underlying supporting resource. */ supportingResourceId: string; /** * The time the Globally distributed database was created. An RFC3339 formatted datetime string */ timeCreated: string; /** * The time the Globally distributed database was last updated. An RFC3339 formatted datetime string */ timeUpdated: string; /** * The redo transport type to use for this Data Guard association. */ transportType: string; /** * The Exadata VM cluster for Distributed Database Resource */ vmClusterDetails: outputs.oci.GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailPeerDetailVmClusterDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailPeerDetailDbStorageVaultDetail { /** * The size of additional Flash Cache in percentage of High Capacity database storage. */ additionalFlashCacheInPercent: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Database Vault Storage. */ dbStorageVaultId: string; /** * A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive. */ displayName: string; /** * Total storage capacity in GB for vault storage. */ highCapacityDatabaseStorage: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailPeerDetailMetadata { /** * The map containing key-value pair of additional metadata. */ map: { [key: string]: string; }; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailPeerDetailVmClusterDetail { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemShardDetailVmClusterDetail { /** * A list of the [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. */ backupNetworkNsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup network subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ backupSubnetId: string; /** * A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive. */ displayName: string; /** * A domain name used for the Exadata VM cluster on Exascale Infrastructure. If the Oracle-provided internet and VCN resolver is enabled for the specified subnet, then the domain name for the subnet is used (do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted. Applies to Exadata Database Service on Exascale Infrastructure only. */ domain: string; /** * The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. */ enabledEcpuCount: number; /** * Indicates whether diagnostic collection is enabled for the VM cluster. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster provisioning. You can also disable or enable it at any time using the `UpdateVmCluster` API. */ isDiagnosticsEventsEnabled: boolean; /** * Indicates whether health monitoring is enabled for the VM cluster. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the `UpdateVmCluster` API. */ isHealthMonitoringEnabled: boolean; /** * Indicates whether incident logs and trace collection are enabled for the VM cluster. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the `UpdateVmCluster` API. */ isIncidentLogsEnabled: boolean; /** * The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is BRING_YOUR_OWN_LICENSE. */ licenseModel: string; /** * The list of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see [Security Rules](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securityrules.htm). */ nsgIds: string[]; /** * The private zone ID in which you want DNS records to be created. */ privateZoneId: string; /** * The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. */ sshPublicKeys: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet associated with the Exadata VM cluster on Exascale Infrastructure. */ subnetId: string; /** * The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. */ totalEcpuCount: number; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VmCluster. */ vmClusterId: string; /** * File System Storage Size in GBs for Exadata VM cluster. */ vmFileSystemStorageSize: number; } interface GetDistributedDatabaseDistributedDatabasesDistributedDatabaseCollectionItemValidateNetworkDetail { isSurrogate: boolean; resourceName: string; /** * The name of the shardGroup for the shard. */ shardGroup: string; } interface GetDistributedDatabaseDistributedDatabasesFilter { /** * Name of the shard. */ name: string; regex?: boolean; values: string[]; } interface GetGdpGdpPipelineBucketDetail { /** * Type of bucket. SENDER pipelines can be SOURCE, TRANSFER, REJECT, or FAILED. RECEIVER pipelines have a DESTINATION bucket. */ bucketType: string; /** * The OCID of the pipeline. */ id: string; /** * Name of the bucket. */ name: string; /** * Namespace of the bucket. */ namespace: string; } interface GetGdpGdpPipelinesFilter { /** * Name of the bucket. */ name: string; regex?: boolean; values: string[]; } interface GetGdpGdpPipelinesGdpPipelineCollection { items: outputs.oci.GetGdpGdpPipelinesGdpPipelineCollectionItem[]; } interface GetGdpGdpPipelinesGdpPipelineCollectionItem { /** * The KMS vault OCID used for cryptographic approvals of transfers. */ approvalKeyVaultId: string; /** * Authorization information about the pipeline being configured. */ authorizationDetails: string; /** * Configuration information about the buckets used for this pipeline. */ bucketDetails: outputs.oci.GetGdpGdpPipelinesGdpPipelineCollectionItemBucketDetail[]; /** * The ID of the compartment in which to list resources. */ compartmentId: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ definedTags: { [key: string]: string; }; /** * Short field input by customer for a description of the data pipeline use-case. */ description: string; /** * A filter to return only resources that match the entire display name given. */ displayName: string; /** * The environment where the pipeline resides. Valid values are COMMERCIAL or USGOV. Defaults to COMMERCIAL. */ env: string; /** * List of file types allowed to be transferred in the pipeline according to the authorization details (e.g. .pdf, .xml, .doc). */ fileTypes: string[]; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ freeformTags: { [key: string]: string; }; /** * The OCID of the pipeline. */ id: string; /** * Determines whether file transfers need to go through an approval workflow. */ isApprovalNeeded: boolean; /** * Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines. */ isChunkingEnabled: boolean; /** * Enable file override feature in destination bucket. If 2 files with same name exist in destination bucket, original file will be overwritten. */ isFileOverrideInDestinationEnabled: boolean; /** * Determines whether GDP Scanning should be enabled for the pipeline. */ isScanningEnabled: boolean; /** * Additional details about the current state of the pipeline. */ lifecycleDetails: string; /** * OCID of the peered pipeline. This null for SENDER pipeline. */ peeredGdpPipelineId: string; /** * Public region name where the peered pipeline exists. */ peeringRegion: string; /** * Type of pipeline. Can be SENDER or RECEIVER. */ pipelineType: string; /** * the OCID of the service log group. */ serviceLogGroupId: string; /** * The current state of the pipeline. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The time the the pipeline was created. An RFC3339 formatted datetime string. */ timeCreated: string; /** * The time the pipeline was updated. An RFC3339 formatted datetime string. */ timeUpdated: string; } interface GetGdpGdpPipelinesGdpPipelineCollectionItemBucketDetail { /** * Type of bucket. SENDER pipelines can be SOURCE, TRANSFER, REJECT, or FAILED. RECEIVER pipelines have a DESTINATION bucket. */ bucketType: string; /** * The OCID of the pipeline. */ id: string; /** * Name of the bucket. */ name: string; /** * Namespace of the bucket. */ namespace: string; } interface GetIotDigitalTwinAdapterInboundEnvelope { /** * Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions. */ envelopeMappings: outputs.oci.GetIotDigitalTwinAdapterInboundEnvelopeEnvelopeMapping[]; /** * The device endpoint. */ referenceEndpoint: string; /** * Reference payload structure template received from IoT device. This payload must specify its content type using the `dataFormat` property. */ referencePayloads: outputs.oci.GetIotDigitalTwinAdapterInboundEnvelopeReferencePayload[]; } interface GetIotDigitalTwinAdapterInboundEnvelopeEnvelopeMapping { /** * JSON Path string to override the context root before delegating to the adapter of the target digital twin instance. */ contentRoot: string; /** * Optional. JQ expression to map the target resource, which is externalKey of digital twin instance, the incoming data belongs to. */ target: string; /** * JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using `timeReceived` as the timestamp. Example: For payload `{"time": "","temp": 65,"hum": 55}` 'timeObserved' can be mapped as [JQ Expression](https://jqplay.org/) `$.time`. */ timeObserved: string; } interface GetIotDigitalTwinAdapterInboundEnvelopeReferencePayload { /** * JSON raw data. */ data: { [key: string]: string; }; /** * Data format of the payload. */ dataFormat: string; } interface GetIotDigitalTwinAdapterInboundRoute { /** * A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the `payloadMapping`. */ condition: string; /** * Meaningful write up about the inbound route. */ description: string; /** * A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema. */ payloadMapping: { [key: string]: string; }; /** * Reference payload structure template received from IoT device. This payload must specify its content type using the `dataFormat` property. */ referencePayloads: outputs.oci.GetIotDigitalTwinAdapterInboundRouteReferencePayload[]; } interface GetIotDigitalTwinAdapterInboundRouteReferencePayload { /** * JSON raw data. */ data: { [key: string]: string; }; /** * Data format of the payload. */ dataFormat: string; } interface GetIotDigitalTwinAdaptersDigitalTwinAdapterCollection { items: outputs.oci.GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItem[]; } interface GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Meaningful write up about the inbound route. */ description: string; /** * Filter resources that match the specified [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. */ digitalTwinModelId: string; /** * Filter resources that match the specified URI (DTMI) of the digital twin model. */ digitalTwinModelSpecUri: string; /** * Filter resources whose display name matches the specified value. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter resources by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type. */ id: string; /** * Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies [JQ](https://stedolan.github.io/jq/) expressions to extract or reshape the data as needed. */ inboundEnvelopes: outputs.oci.GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItemInboundEnvelope[]; /** * list of routes */ inboundRoutes: outputs.oci.GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItemInboundRoute[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources. */ iotDomainId: string; /** * Filter resources whose lifecycleState matches the specified value. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItemInboundEnvelope { /** * Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions. */ envelopeMappings: outputs.oci.GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItemInboundEnvelopeEnvelopeMapping[]; /** * The device endpoint. */ referenceEndpoint: string; /** * Reference payload structure template received from IoT device. This payload must specify its content type using the `dataFormat` property. */ referencePayloads: outputs.oci.GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItemInboundEnvelopeReferencePayload[]; } interface GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItemInboundEnvelopeEnvelopeMapping { /** * JSON Path string to override the context root before delegating to the adapter of the target digital twin instance. */ contentRoot: string; /** * Optional. JQ expression to map the target resource, which is externalKey of digital twin instance, the incoming data belongs to. */ target: string; /** * JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using `timeReceived` as the timestamp. Example: For payload `{"time": "","temp": 65,"hum": 55}` 'timeObserved' can be mapped as [JQ Expression](https://jqplay.org/) `$.time`. */ timeObserved: string; } interface GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItemInboundEnvelopeReferencePayload { /** * JSON raw data. */ data: { [key: string]: string; }; /** * Data format of the payload. */ dataFormat: string; } interface GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItemInboundRoute { /** * A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the `payloadMapping`. */ condition: string; /** * Meaningful write up about the inbound route. */ description: string; /** * A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema. */ payloadMapping: { [key: string]: string; }; /** * Reference payload structure template received from IoT device. This payload must specify its content type using the `dataFormat` property. */ referencePayloads: outputs.oci.GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItemInboundRouteReferencePayload[]; } interface GetIotDigitalTwinAdaptersDigitalTwinAdapterCollectionItemInboundRouteReferencePayload { /** * JSON raw data. */ data: { [key: string]: string; }; /** * Data format of the payload. */ dataFormat: string; } interface GetIotDigitalTwinAdaptersFilter { name: string; regex?: boolean; values: string[]; } interface GetIotDigitalTwinInstancesDigitalTwinInstanceCollection { items: outputs.oci.GetIotDigitalTwinInstancesDigitalTwinInstanceCollectionItem[]; } interface GetIotDigitalTwinInstancesDigitalTwinInstanceCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance. */ authId: string; /** * Filter resources whose connectivityType matches the specified value. */ connectivityType: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A short description of the resource. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter. */ digitalTwinAdapterId: string; /** * Filter resources that match the specified [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model. */ digitalTwinModelId: string; /** * Filter resources that match the specified URI (DTMI) of the digital twin model. */ digitalTwinModelSpecUri: string; /** * Filter resources whose display name matches the specified value. */ displayName: string; /** * A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one. */ externalKey: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * An array of unique ids ([OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the IoT digital twin instances with connectivityType equals to GATEWAY. */ gateways: string[]; /** * Filter resources by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources. */ iotDomainId: string; /** * Filter resources whose lifecycleState matches the specified value. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetIotDigitalTwinInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetIotDigitalTwinModelsDigitalTwinModelCollection { items: outputs.oci.GetIotDigitalTwinModelsDigitalTwinModelCollectionItem[]; } interface GetIotDigitalTwinModelsDigitalTwinModelCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A short description of the resource. If left blank, the description will be derived from the spec. */ description: string; /** * Filter resources whose display name matches the specified value. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter resources by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources. */ iotDomainId: string; spec: string; /** * This is the DTMI (Digital Twin Model Identifier) of the digital twin model as defined in DTDL specification. */ specUri: string; /** * Filter resources whose lifecycleState matches the specified value. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetIotDigitalTwinModelsFilter { name: string; regex?: boolean; values: string[]; } interface GetIotDigitalTwinRelationshipsDigitalTwinRelationshipCollection { items: outputs.oci.GetIotDigitalTwinRelationshipsDigitalTwinRelationshipCollectionItem[]; } interface GetIotDigitalTwinRelationshipsDigitalTwinRelationshipCollectionItem { /** * The value(s) of the relationship properties defined in the source digital twin model. */ content: string; /** * Filters resources that match the content path of the digital twin relationship. */ contentPath: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A short description of the resource. */ description: string; /** * Filter resources whose display name matches the specified value. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter resources by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type. */ id: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources. */ iotDomainId: string; /** * Filter resources that match the specified [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance. */ sourceDigitalTwinInstanceId: string; /** * Filter resources whose lifecycleState matches the specified value. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Filter resources that match the specified [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance. */ targetDigitalTwinInstanceId: string; /** * The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetIotDigitalTwinRelationshipsFilter { name: string; regex?: boolean; values: string[]; } interface GetIotIotDomainDataRetentionPeriodsInDay { /** * Number of days for which any normalized data sent to IoT devices would be retained for. */ historizedData: number; /** * Number of days for which any raw command data sent to IoT devices would be retained for. */ rawCommandData: number; /** * Number of days for which any raw data sent to IoT devices would be retained for. */ rawData: number; /** * Number of days for which any data sent to IoT devices would be retained for. */ rejectedData: number; } interface GetIotIotDomainGroupsFilter { name: string; regex?: boolean; values: string[]; } interface GetIotIotDomainGroupsIotDomainGroupCollection { items: outputs.oci.GetIotIotDomainGroupsIotDomainGroupCollectionItem[]; } interface GetIotIotDomainGroupsIotDomainGroupCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The host name of the database corresponding to the IoT Domain group. */ dataHost: string; /** * This is an array of VCN OCID (virtual cloud network Oracle Cloud ID) that is allowed to connect the data host. */ dbAllowListedVcnIds: string[]; /** * The connection string used to connect to the data host associated with the IoT domain group. */ dbConnectionString: string; /** * The token scope used to connect to the data host associated with the IoT domain group. */ dbTokenScope: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A short description of the resource. */ description: string; /** * Filter resources whose display name matches the specified value. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter resources by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type. */ id: string; /** * Filter resources whose lifecycleState matches the specified value. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * Filter resources by type. Valid values are LIGHTWEIGHT or STANDARD. */ type: string; } interface GetIotIotDomainsFilter { name: string; regex?: boolean; values: string[]; } interface GetIotIotDomainsIotDomainCollection { items: outputs.oci.GetIotIotDomainsIotDomainCollectionItem[]; } interface GetIotIotDomainsIotDomainCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Data Retention periods */ dataRetentionPeriodsInDays: outputs.oci.GetIotIotDomainsIotDomainCollectionItemDataRetentionPeriodsInDay[]; /** * List of IAM groups of form described in [here](https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/mnqmn/#GUID-3634D6C9-A7F1-4875-9925-BAEA2D3C5197) that are allowed to directly connect to the data host. */ dbAllowListedIdentityGroupNames: string[]; /** * Host name of identity domain that is used for authenticating connect to data host via ORDS. */ dbAllowedIdentityDomainHost: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A short description of the resource. */ description: string; /** * Host name of an IoT domain, where IoT devices can connect to. */ deviceHost: string; /** * Filter resources whose display name matches the specified value. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Filter resources by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type. */ id: string; /** * Filter resources that match the specified [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group. */ iotDomainGroupId: string; /** * Filter resources whose lifecycleState matches the specified value. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time when the resource was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time when the resource was last updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetIotIotDomainsIotDomainCollectionItemDataRetentionPeriodsInDay { /** * Number of days for which any normalized data sent to IoT devices would be retained for. */ historizedData: number; /** * Number of days for which any raw command data sent to IoT devices would be retained for. */ rawCommandData: number; /** * Number of days for which any raw data sent to IoT devices would be retained for. */ rawData: number; /** * Number of days for which any data sent to IoT devices would be retained for. */ rejectedData: number; } interface GetManagedKafkaAddonOptionsAddonOptionCollection { /** * List of kafka Cluster AddonOptions. */ items: outputs.oci.GetManagedKafkaAddonOptionsAddonOptionCollectionItem[]; } interface GetManagedKafkaAddonOptionsAddonOptionCollectionItem { /** * The name to filter on. */ name: string; /** * The current state of the KafkaClusterAddon. */ state: string; } interface GetManagedKafkaAddonOptionsFilter { /** * The name to filter on. */ name: string; regex?: boolean; values: string[]; } interface GetManagedKafkaKafkaClusterAccessSubnet { /** * Subnets OCIDs */ subnets: string[]; } interface GetManagedKafkaKafkaClusterAddonsAddonCollection { items: outputs.oci.GetManagedKafkaKafkaClusterAddonsAddonCollectionItem[]; } interface GetManagedKafkaKafkaClusterAddonsAddonCollectionItem { /** * The type of addon */ addonType: string; /** * Authentication mechanism. */ authenticationMechanism: string; /** * The bootstrap url of the kafka cluster. */ bootstrapUrl: string; /** * Description of the add on */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster. */ kafkaClusterId: string; /** * The name to filter on. */ name: string; /** * A list of CIDR ranges for ingress/egress traffic. */ networkCidrs: string[]; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * The time the addon was created. */ timeCreated: string; /** * The time the addon was updated. */ timeUpdated: string; } interface GetManagedKafkaKafkaClusterAddonsFilter { /** * The name to filter on. */ name: string; regex?: boolean; values: string[]; } interface GetManagedKafkaKafkaClusterBrokerShape { /** * Number of Kafka broker nodes */ nodeCount: number; /** * Node shape for broker is passed as part of cluster creation, similar to VM.Standard.A1.Flex */ nodeShape: string; /** * Number of OCPUs per nodes */ ocpuCount: number; /** * Size of the storage per nodes. */ storageSizeInGbs: number; } interface GetManagedKafkaKafkaClusterConfigLatestConfig { /** * ID cluster configuration */ configId: string; /** * Cluster configuration key-value pairs */ properties: { [key: string]: string; }; /** * The date and time the KafkaClusterConfig was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Version of the cluster configuration */ versionNumber: number; } interface GetManagedKafkaKafkaClusterConfigVersionsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedKafkaKafkaClusterConfigVersionsKafkaClusterConfigVersionCollection { items: outputs.oci.GetManagedKafkaKafkaClusterConfigVersionsKafkaClusterConfigVersionCollectionItem[]; } interface GetManagedKafkaKafkaClusterConfigVersionsKafkaClusterConfigVersionCollectionItem { /** * ID cluster configuration */ configId: string; /** * The date and time the KafkaClusterConfigVersion was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Version of the cluster configuration */ versionNumber: number; } interface GetManagedKafkaKafkaClusterConfigsFilter { name: string; regex?: boolean; values: string[]; } interface GetManagedKafkaKafkaClusterConfigsKafkaClusterConfigCollection { items: outputs.oci.GetManagedKafkaKafkaClusterConfigsKafkaClusterConfigCollectionItem[]; } interface GetManagedKafkaKafkaClusterConfigsKafkaClusterConfigCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaClusterConfig. */ id: string; /** * A shared configuration object used by 0 or more kafka clusters. */ latestConfigs: outputs.oci.GetManagedKafkaKafkaClusterConfigsKafkaClusterConfigCollectionItemLatestConfig[]; /** * A message that describes the current state of the KafkaClusterConfig in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the KafkaClusterConfig was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the KafkaClusterConfig was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetManagedKafkaKafkaClusterConfigsKafkaClusterConfigCollectionItemLatestConfig { /** * ID cluster configuration */ configId: string; /** * Cluster configuration key-value pairs */ properties: { [key: string]: string; }; /** * The date and time the KafkaClusterConfig was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * Version of the cluster configuration */ versionNumber: number; } interface GetManagedKafkaKafkaClusterKafkaBootstrapUrl { /** * Name of the Kafka listener providing this bootstrap URL */ name: string; /** * Bootstrap URL */ url: string; } interface GetManagedKafkaKafkaClustersFilter { /** * Name of the Kafka listener providing this bootstrap URL */ name: string; regex?: boolean; values: string[]; } interface GetManagedKafkaKafkaClustersKafkaClusterCollection { items: outputs.oci.GetManagedKafkaKafkaClustersKafkaClusterCollectionItem[]; } interface GetManagedKafkaKafkaClustersKafkaClusterCollectionItem { /** * Subnets where broker/coordinator VNICs will be created. */ accessSubnets: outputs.oci.GetManagedKafkaKafkaClustersKafkaClusterCollectionItemAccessSubnet[]; /** * Configuration of the broker node. */ brokerShapes: outputs.oci.GetManagedKafkaKafkaClustersKafkaClusterCollectionItemBrokerShape[]; /** * CA certificate bundle for mTLS broker authentication. */ clientCertificateBundle: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of Kafka Cluster configuration object */ clusterConfigId: string; /** * The version of configuration object */ clusterConfigVersion: number; /** * Type of the cluster to spin up. DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on a single node PRODUCTION - Minimum allowed broker count is 3 */ clusterType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Kafka coordination type. Set of available types depends on Kafka version */ coordinationType: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the KafkaCluster. */ id: string; /** * Bootstrap URL that can be used to connect to Kafka */ kafkaBootstrapUrls: outputs.oci.GetManagedKafkaKafkaClustersKafkaClusterCollectionItemKafkaBootstrapUrl[]; /** * Version of Kafka to use to spin up the cluster */ kafkaVersion: string; /** * A message that describes the current state of the KafkaCluster in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret that contains superuser password. */ secretId: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the KafkaCluster was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the KafkaCluster was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetManagedKafkaKafkaClustersKafkaClusterCollectionItemAccessSubnet { /** * Subnets OCIDs */ subnets: string[]; } interface GetManagedKafkaKafkaClustersKafkaClusterCollectionItemBrokerShape { /** * Number of Kafka broker nodes */ nodeCount: number; /** * Node shape for broker is passed as part of cluster creation, similar to VM.Standard.A1.Flex */ nodeShape: string; /** * Number of OCPUs per nodes */ ocpuCount: number; /** * Size of the storage per nodes. */ storageSizeInGbs: number; } interface GetManagedKafkaKafkaClustersKafkaClusterCollectionItemKafkaBootstrapUrl { /** * Name of the Kafka listener providing this bootstrap URL */ name: string; /** * Bootstrap URL */ url: string; } interface GetManagedKafkaNodeShapesFilter { /** * The name to filter on. */ name: string; regex?: boolean; values: string[]; } interface GetManagedKafkaNodeShapesNodeShapeCollection { /** * List of NodeShapeSummary. */ items: outputs.oci.GetManagedKafkaNodeShapesNodeShapeCollectionItem[]; } interface GetManagedKafkaNodeShapesNodeShapeCollectionItem { /** * The name to filter on. */ name: string; } interface GetMulticloudExternalLocationMappingMetadataExternalLocationMappingMetadatumSummaryCollection { /** * List of ExternalLocationMappingMetadatumSummary */ items: outputs.oci.GetMulticloudExternalLocationMappingMetadataExternalLocationMappingMetadatumSummaryCollectionItem[]; } interface GetMulticloudExternalLocationMappingMetadataExternalLocationMappingMetadatumSummaryCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * External location for CSP Region, CSP-Physical-AZ */ externalLocations: outputs.oci.GetMulticloudExternalLocationMappingMetadataExternalLocationMappingMetadatumSummaryCollectionItemExternalLocation[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Oracle Cloud Infrastructure logical ad name */ ociLogicalAd: string; /** * Oracle Cloud Infrastructure physical ad name */ ociPhysicalAd: string; /** * Oracle Cloud Infrastructure region identifier https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm */ ociRegion: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"} */ systemTags: { [key: string]: string; }; } interface GetMulticloudExternalLocationMappingMetadataExternalLocationMappingMetadatumSummaryCollectionItemExternalLocation { /** * A mapping of Oracle Cloud Infrastructure site group name to CSP physical availability zone name */ cspPhysicalAz: string; /** * User friendly display name for cspPhysicalAZ */ cspPhysicalAzDisplayName: string; /** * CSP region corresponding to the given Oracle Cloud Infrastructure region */ cspRegion: string; /** * CSP region display Name corresponding to the given Oracle Cloud Infrastructure region */ cspRegionDisplayName: string; /** * The serviceName that externalLocation map object belongs to */ serviceName: string; } interface GetMulticloudExternalLocationMappingMetadataFilter { name: string; regex?: boolean; values: string[]; } interface GetMulticloudExternalLocationSummariesMetadataExternalLocationSummariesMetadatumSummaryCollection { /** * List of ExternalLocationSummariesMetadatumSummary */ items: outputs.oci.GetMulticloudExternalLocationSummariesMetadataExternalLocationSummariesMetadatumSummaryCollectionItem[]; } interface GetMulticloudExternalLocationSummariesMetadataExternalLocationSummariesMetadatumSummaryCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * External location for CSP Region */ externalLocations: outputs.oci.GetMulticloudExternalLocationSummariesMetadataExternalLocationSummariesMetadatumSummaryCollectionItemExternalLocation[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Oracle Cloud Infrastructure region identifier https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm */ ociRegion: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetMulticloudExternalLocationSummariesMetadataExternalLocationSummariesMetadatumSummaryCollectionItemExternalLocation { /** * CSP region corresponding to the given Oracle Cloud Infrastructure region */ cspRegion: string; /** * CSP region display Name corresponding to the given Oracle Cloud Infrastructure region */ cspRegionDisplayName: string; } interface GetMulticloudExternalLocationSummariesMetadataFilter { name: string; regex?: boolean; values: string[]; } interface GetMulticloudExternalLocationsMetadataExternalLocationsMetadatumCollection { /** * List of ExternalLocationsMetadatumSummary */ items: outputs.oci.GetMulticloudExternalLocationsMetadataExternalLocationsMetadatumCollectionItem[]; } interface GetMulticloudExternalLocationsMetadataExternalLocationsMetadatumCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cluster placement group. */ clusterPlacementGroupId: string; /** * Cluster Placement Group OCID (deprecated representation) */ cpgId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The cloud service provider region. */ externalLocations: outputs.oci.GetMulticloudExternalLocationsMetadataExternalLocationsMetadatumCollectionItemExternalLocation[]; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Oracle Cloud Infrastructure logical ad name */ ociLogicalAd: string; /** * Oracle Cloud Infrastructure physical ad name */ ociPhysicalAd: string; /** * Oracle Cloud Infrastructure region identifier https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm */ ociRegion: string; /** * User friendly name of account name for customer's subscription */ partnerCloudAccountName: string; /** * Direct URL to partner cloud for customer's account */ partnerCloudAccountUrl: string; /** * Partner Cloud Name based on service name */ partnerCloudName: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetMulticloudExternalLocationsMetadataExternalLocationsMetadatumCollectionItemExternalLocation { /** * A mapping of CSP physical availability zone to CSP logical availability zone. */ cspLogicalAz: string; /** * User friendly display name for cspLogicalAZ */ cspLogicalAzDisplayName: string; /** * A mapping of Oracle Cloud Infrastructure site group name to CSP physical availability zone name */ cspPhysicalAz: string; /** * User friendly display name for cspPhysicalAZ */ cspPhysicalAzDisplayName: string; /** * CSP region corresponding to the given Oracle Cloud Infrastructure region */ cspRegion: string; /** * CSP region display Name corresponding to the given Oracle Cloud Infrastructure region */ cspRegionDisplayName: string; /** * This is CSP zone key reference */ cspZoneKeyReferenceIds: outputs.oci.GetMulticloudExternalLocationsMetadataExternalLocationsMetadatumCollectionItemExternalLocationCspZoneKeyReferenceId[]; /** * The serviceName that externalLocation map object belongs to. */ serviceName: string; } interface GetMulticloudExternalLocationsMetadataExternalLocationsMetadatumCollectionItemExternalLocationCspZoneKeyReferenceId { /** * KeyName for Azure=AzureSubscriptionId Aws=AwsAccountId GCP=GcpProjectName */ keyName: string; /** * Value of keyName GcpProjectName: A human-readable name for your project. The project name isn't used by any Google APIs. You can edit the project name at any time during or after project creation. Project names do not need to be unique. AzureSubscriptionId: A unique alphanumeric string that identifies your Azure subscription. AwsAccountId: a unique 12-digit number that identifies an Amazon Web Services (AWS) account */ keyValue: string; } interface GetMulticloudExternalLocationsMetadataFilter { name: string; regex?: boolean; values: string[]; } interface GetMulticloudMulticloudalertsFilter { name: string; regex?: boolean; values: string[]; } interface GetMulticloudMulticloudalertsMulticloudAlertCollection { /** * List of MulticloudAlertSummary. */ items: outputs.oci.GetMulticloudMulticloudalertsMulticloudAlertCollectionItem[]; } interface GetMulticloudMulticloudalertsMulticloudAlertCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The current state of the Multicloud Network Alert. */ lifecycleState: string; /** * List of Multicloud Alerts. */ multicloudAlerts: outputs.oci.GetMulticloudMulticloudalertsMulticloudAlertCollectionItemMulticloudAlert[]; /** * Total number of alerts */ multicloudalertCount: number; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetMulticloudMulticloudalertsMulticloudAlertCollectionItemMulticloudAlert { /** * Alert-specific contextual parameters. */ additionalParameters: { [key: string]: string; }; /** * External or human-friendly alert identifier. */ alertId: string; /** * Filter alerts by alert status. User interaction: ACKNOWLEDGED, UNACKNOWLEDGED System lifecycle: RESOLVED */ alertStatus: string; /** * Filter alerts by alert type (e.g. IAM_POLICY_GAP). */ alertType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of the alert and its purpose. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Internal service or function type generating the alert (e.g. ORP, ODBG_NETWORK, BILLING, OBSERVABILITY). */ functionType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the multicloud alert. */ id: string; /** * The current state of the Multicloud Network Alert. */ lifecycleState: string; /** * Filter alerts associated with a specific resource OCID. */ resourceId: string; /** * Filter alerts by resource type (e.g. ADBD, VMCluster). */ resourceType: string; /** * Filter alerts by severity. */ severity: string; /** * Source subsystem that generated the alert. (Azure Tag Validation) */ source: string; /** * Oracle Cloud Infrastructure region where the alert originated (e.g. us-phoenix-1) */ sourceRegion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud subscription in which to list resources. */ subscriptionId: string; /** * Oracle Cloud Infrastructure Subscription Type. */ subscriptionType: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * Timestamp when the alert was created. */ timeCreated: string; /** * Timestamp when the alert was last updated. */ timeUpdated: string; } interface GetMulticloudMulticloudpoliciesFilter { /** * Name of the missing policy. */ name: string; regex?: boolean; values: string[]; } interface GetMulticloudMulticloudpoliciesMulticloudPolicyCollection { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * List of MulticloudPolicySummary. */ items: outputs.oci.GetMulticloudMulticloudpoliciesMulticloudPolicyCollectionItem[]; } interface GetMulticloudMulticloudpoliciesMulticloudPolicyCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * groups required for the particular subscriptionType IAM policy statements required. */ groups: string[]; /** * The current state of the Multicloud Network Alert. */ lifecycleState: string; /** * Missing policy definitions. */ policies: outputs.oci.GetMulticloudMulticloudpoliciesMulticloudPolicyCollectionItemPolicy[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud subscription in which to list resources. */ subscriptionId: string; /** * Oracle Cloud Infrastructure Subscription Type. */ subscriptionType: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetMulticloudMulticloudpoliciesMulticloudPolicyCollectionItemPolicy { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Description of the compartment e.g. Base Compartment, Root Compartment */ compartmentName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * Description of the policy purpose. */ description: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The current state of the Multicloud Network Alert. */ lifecycleState: string; /** * Name of the missing policy. */ name: string; /** * IAM policy statements required. */ statements: string[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; } interface GetMulticloudMulticloudsubscriptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetMulticloudMulticloudsubscriptionsMulticloudSubscriptionCollection { /** * List of MulticloudSubscriptionSummary. */ items: outputs.oci.GetMulticloudMulticloudsubscriptionsMulticloudSubscriptionCollectionItem[]; } interface GetMulticloudMulticloudsubscriptionsMulticloudSubscriptionCollectionItem { /** * Total value for the subscription. */ activeCommitment: string; /** * Subscription ID for Oracle Cloud Infrastructure and partner cloud in classic format. */ classicSubscriptionId: string; /** * Properties specific to the cloud service provider. For example, AzureSubnetId for Azure. */ cspAdditionalProperties: { [key: string]: string; }; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The current state of the subscription. */ lifecycleState: string; /** * The partner cloud account ID. */ partnerCloudAccountIdentifier: string; /** * The partner cloud tenant ID. */ partnerCloudTenantIdentifier: string; /** * Payment plan for the subscription. */ paymentPlan: string; /** * The cloud service provider. */ serviceName: string; /** * URL to the subscription details page. Example: `https://{console-url}/org-mgmt/subscription/ocid1.organizationssubscription.oc1.iad.exampleuniqueid?region=us-ashburn-1`. */ subscriptionId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time that the subscription was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; /** * The end date and time for the subscription, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeEndDate: string; /** * The date and time that the Multicloud base compartment was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeLinkedDate: string; /** * The date and time that the subscription was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; } interface GetMulticloudNetworkAnchorCloudServiceProviderMetadataItem { /** * An Azure/GCP/AWS cidrBlocks */ cidrBlocks: string[]; /** * CSP Specific Additional Properties, AzureSubnetId for Azure */ cspAdditionalProperties: { [key: string]: string; }; /** * DNS domain ip mapping forwarding configuration */ dnsForwardingConfigs: any[]; /** * CSP network anchor Uri */ networkAnchorUri: string; /** * CSP oracle database network anchor unique ID/name */ odbNetworkId: string; /** * Azure/GCP/AWS region */ region: string; } interface GetMulticloudNetworkAnchorOciMetadataItem { /** * Oracle Cloud Infrastructure network anchor related meta data items */ dns: outputs.oci.GetMulticloudNetworkAnchorOciMetadataItemDn[]; /** * DNS domain ip mapping forwarding configuration */ dnsForwardingConfigs: any[]; /** * The DNS Listener Forwarding Address. */ dnsForwardingEndpointIpAddress: string; /** * The DNS Listener Endpoint Address. */ dnsListeningEndpointIpAddress: string; /** * This can be merge to lifecycleState CONNECTED - Partner and CSI information is assigned and MulticloudLink provisioned. DISCONNECTED - Only partner cloud information is assigned. CONNECTING - Oracle Cloud Infrastructure information is assigned and the control plane is provisioning resources. ACTIVE - Network anchor is connected and resources (VNICs) exist within a subnet. ERROR - DRG attach fails during connection. FAILED - Network anchor creation failed NEEDS_ATTENTION - Network anchor is in temporary bad state UPDATING - Network anchor is getting updated. DELETING - Network anchor is getting deleted DELETED - A connected network anchor is deleted. */ networkAnchorConnectionStatus: string; /** * Network subnets */ subnets: outputs.oci.GetMulticloudNetworkAnchorOciMetadataItemSubnet[]; /** * Oracle Cloud Infrastructure VCN basic information object. It is optional and planned to used for future for network anchor */ vcns: outputs.oci.GetMulticloudNetworkAnchorOciMetadataItemVcn[]; } interface GetMulticloudNetworkAnchorOciMetadataItemDn { /** * Full custom domain name. If this field is passed dnsLabel will be ignored */ customDomainName: string; } interface GetMulticloudNetworkAnchorOciMetadataItemSubnet { /** * Subnet label. CSP can set this property */ label: string; /** * OCID for existing the subnet. CSP can not set this property. */ subnetId: string; /** * Defines if the subnet is the primary or backup for the network */ type: string; } interface GetMulticloudNetworkAnchorOciMetadataItemVcn { /** * Oracle Cloud Infrastructure backup cidr block. CSP can set this property It's optional only if disconnect anchor is allowed. IPv4 CIDR blocks for the VCN that meet the following criteria Type: [string (length: 1–32), ...] The CIDR blocks must be valid. They must not overlap with each other or with the on-premises network CIDR block. */ backupCidrBlocks: string[]; /** * An Azure/GCP/AWS cidrBlocks */ cidrBlocks: string[]; /** * Oracle Cloud Infrastructure DNS label. This is optional if DNS config is provided. */ dnsLabel: string; /** * Oracle Cloud Infrastructure VCN OCID. CSP can not set this property. */ vcnId: string; /** * Name of the VCN associated to the Network Anchor. */ vcnName: string; } interface GetMulticloudNetworkAnchorsNetworkAnchorCollection { /** * List of NetworkAnchorSummary */ items: outputs.oci.GetMulticloudNetworkAnchorsNetworkAnchorCollectionItem[]; } interface GetMulticloudNetworkAnchorsNetworkAnchorCollectionItem { /** * An Azure/GCP/AWS cidrBlocks */ cidrBlocks: any[]; /** * The CPG ID in which Network Anchor will be created. */ clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud base compartment or sub-compartment in which to list resources. A Multicloud base compartment is an Oracle Cloud Infrastructure compartment that maps to a subscription in a cloud service provider (such as Azure or AWS). */ compartmentId: string; /** * CSP Specific Additional Properties, AzureSubnetId for Azure */ cspAdditionalProperties: { [key: string]: string; }; /** * Network Anchor Id in the Cloud Service Provider. */ cspNetworkAnchorId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the NetworkAnchor. */ id: string; /** * A message that describes the current state of the NetworkAnchor in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * Defines status of the Network Anchor. */ networkAnchorConnectionStatus: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ networkAnchorLifecycleState: string; /** * CSP network anchor Uri */ networkAnchorUri: string; /** * Oracle Cloud Infrastructure resource anchor Id (OCID). */ resourceAnchorId: string; /** * Oracle Cloud Infrastructure Subscription Type. */ subscriptionType: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the NetworkAnchor was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the NetworkAnchor was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * Oracle Cloud Infrastructure VCN OCID. CSP can not set this property. */ vcnId: string; /** * Name of the VCN associated to the Network Anchor. */ vcnName: string; } interface GetMulticloudOmHubMultiCloudsMetadataMultiCloudMetadataCollection { /** * List of MultiCloudMetadataSummary */ items: outputs.oci.GetMulticloudOmHubMultiCloudsMetadataMultiCloudMetadataCollectionItem[]; } interface GetMulticloudOmHubMultiCloudsMetadataMultiCloudMetadataCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the root compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * Oracle Cloud Infrastructure subscriptionId. */ subscriptionId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the multicloud compartment was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; } interface GetMulticloudOmHubMulticloudResourcesFilter { name: string; regex?: boolean; values: string[]; } interface GetMulticloudOmHubMulticloudResourcesMulticloudResourceCollection { /** * List of MulticloudResourceSummary. */ items: outputs.oci.GetMulticloudOmHubMulticloudResourcesMulticloudResourceCollectionItem[]; } interface GetMulticloudOmHubMulticloudResourcesMulticloudResourceCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * Name of the compartment associated with the resource. */ compartmentName: string; /** * Properties specific to the cloud service provider. For example, AzureSubnetId for Azure. */ cspAdditionalProperties: { [key: string]: string; }; /** * The resource Id that comes from the Multicloud control plane. */ cspResourceId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The current state of the Multicloud resource. */ lifecycleState: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network anchor associated with the resource. */ networkAnchorId: string; /** * Name of the network anchor associated with the resource. */ networkAnchorName: string; /** * Additional attributes specific to certain resource types, used to construct a URL for accessing the resource in the Oracle Cloud Infrastructure console. */ resourceAdditionalProperties: { [key: string]: string; }; /** * Endpoint used to retrieve the resource's display name and lifecycle state. */ resourceDisplayName: string; /** * The Id of the multicloud resource. */ resourceId: string; /** * Filter alerts by resource type (e.g. ADBD, VMCluster). */ resourceType: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the subscription was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeCreated: string; /** * The date and time the subscription was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; /** * Id of the virtual cloud network (VCN) associated with the resource. */ vcnId: string; /** * Name of the virtual cloud network (VCN) associated with the resource. */ vcnName: string; } interface GetMulticloudResourceAnchorCloudServiceProviderMetadataItem { /** * AWS accountId that was used for creating this resource anchor resource. */ accountId: string; /** * CSP Specific Additional Properties, AzureSubnetId for Azure */ cspAdditionalProperties: { [key: string]: string; }; /** * CSP resource anchor ID. */ cspResourceAnchorId: string; /** * CSP resource anchor name. */ cspResourceAnchorName: string; /** * GCP project number that was used for creating this resource anchor resource. */ projectNumber: string; /** * Oracle Cloud Infrastructure Region that resource is created. */ region: string; /** * Oracle Cloud Infrastructure resource anchor name. */ resourceAnchorName: string; /** * CSP resource anchor Uri. */ resourceAnchorUri: string; /** * Azure resource group that was used for creating this resource. */ resourceGroup: string; /** * Azure subscription that was used for creating this resource. */ subscription: string; /** * subscription type */ subscriptionType: string; } interface GetMulticloudResourceAnchorsFilter { name: string; regex?: boolean; values: string[]; } interface GetMulticloudResourceAnchorsResourceAnchorCollection { /** * List of ResourceAnchorSummary */ items: outputs.oci.GetMulticloudResourceAnchorsResourceAnchorCollectionItem[]; } interface GetMulticloudResourceAnchorsResourceAnchorCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud base compartment or sub-compartment in which to list resources. A Multicloud base compartment is an Oracle Cloud Infrastructure compartment that maps to a subscription in a cloud service provider (such as Azure or AWS). */ compartmentId: string; /** * The name assigned to the compartment during creation. */ compartmentName: string; /** * CSP Specific Additional Properties, AzureSubnetId for Azure */ cspAdditionalProperties: { [key: string]: string; }; /** * CSP resource anchor ID. */ cspResourceAnchorId: string; /** * CSP resource anchor name. */ cspResourceAnchorName: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource anchor. */ id: string; /** * A message that describes the current state of the ResourceAnchor in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * The current state of the ResourceAnchor. */ lifecycleState: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment linked to the resource. */ linkedCompartmentId: string; /** * The name assigned to the compartment which was created or linked by customer with resource anchor. This compartment is different from where resource Anchor live. */ linkedCompartmentName: string; /** * Partner Cloud Account Identifier of the Cloud Service Provider. */ partnerCloudAccountIdentifier: string; resourceAnchorUri: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Multicloud subscription in which to list resources. */ subscriptionId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the ResourceAnchor was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the ResourceAnchor was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetPsaPrivateServiceAccessesFilter { name: string; regex?: boolean; values: string[]; } interface GetPsaPrivateServiceAccessesPrivateServiceAccessCollection { items: outputs.oci.GetPsaPrivateServiceAccessesPrivateServiceAccessCollectionItem[]; } interface GetPsaPrivateServiceAccessesPrivateServiceAccessCollectionItem { compartmentId: string; definedTags: { [key: string]: string; }; description: string; displayName: string; fqdns: string[]; freeformTags: { [key: string]: string; }; id: string; ipv4ip: string; nsgIds: string[]; securityAttributes: { [key: string]: string; }; serviceId: string; state: string; subnetId: string; systemTags: { [key: string]: string; }; timeCreated: string; timeUpdated: string; vcnId: string; vnicId: string; } interface GetPsaPsaServicesFilter { name: string; regex?: boolean; values: string[]; } interface GetPsaPsaServicesPsaServiceCollection { /** * List of PsaServiceSummary. */ items: outputs.oci.GetPsaPsaServicesPsaServiceCollectionItem[]; } interface GetPsaPsaServicesPsaServiceCollectionItem { /** * A description of the Oracle Cloud Infrastructure service. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * The public facing service FQDNs, which are going to be used to access the service. Example: `xyz.oraclecloud.com` */ fqdns: string[]; /** * A unique Oracle Cloud Infrastructure service identifier. Example: `object-storage-api` */ id: string; /** * This optional field will indicate that whether service is IPv6 enabled. */ isV6enabled: boolean; } interface GetPsaPsaWorkRequestErrorsFilter { name: string; regex?: boolean; values: string[]; } interface GetPsaPsaWorkRequestErrorsWorkRequestError { code: string; message: string; timestamp: string; } interface GetPsaPsaWorkRequestLogsFilter { name: string; regex?: boolean; values: string[]; } interface GetPsaPsaWorkRequestLogsWorkRequestLogEntry { message: string; timestamp: string; } interface GetPsaPsaWorkRequestResource { /** * The way in which this resource is affected by the operation tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point it transitions to CREATED, UPDATED, or DELETED, respectively. */ actionType: string; /** * The resource type that the work request affects. */ entityType: string; /** * The URI path that you can use for a GET request to access the resource metadata. */ entityUri: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. */ identifier: string; /** * Additional information that helps to explain the resource. */ metadata: { [key: string]: string; }; } interface GetPsaPsaWorkRequestsFilter { name: string; regex?: boolean; values: string[]; } interface GetPsaPsaWorkRequestsWorkRequestSummaryCollection { items: outputs.oci.GetPsaPsaWorkRequestsWorkRequestSummaryCollectionItem[]; } interface GetPsaPsaWorkRequestsWorkRequestSummaryCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request. */ id: string; /** * The asynchronous operation tracked by this work request. */ operationType: string; /** * Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. */ percentComplete: number; /** * The resources that are affected by the work request. */ resources: outputs.oci.GetPsaPsaWorkRequestsWorkRequestSummaryCollectionItemResource[]; /** * A filter to return only the resources that match the given lifecycle state. */ status: string; /** * The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). */ timeAccepted: string; /** * The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeFinished: string; /** * The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). */ timeStarted: string; /** * The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). */ timeUpdated: string; } interface GetPsaPsaWorkRequestsWorkRequestSummaryCollectionItemResource { /** * The way in which this resource is affected by the operation tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point it transitions to CREATED, UPDATED, or DELETED, respectively. */ actionType: string; /** * The resource type that the work request affects. */ entityType: string; /** * The URI path that you can use for a GET request to access the resource metadata. */ entityUri: string; /** * An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. */ identifier: string; /** * Additional information that helps to explain the resource. */ metadata: { [key: string]: string; }; } interface GetResourceAnalyticsMonitoredRegionsFilter { name: string; regex?: boolean; values: string[]; } interface GetResourceAnalyticsMonitoredRegionsMonitoredRegionCollection { items: outputs.oci.GetResourceAnalyticsMonitoredRegionsMonitoredRegionCollectionItem[]; } interface GetResourceAnalyticsMonitoredRegionsMonitoredRegionCollectionItem { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the MonitoredRegion. */ id: string; /** * A message that describes the current state of the MonitoredRegion in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * The [Region Identifier](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) of this MonitoredRegion. */ regionId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a ResourceAnalyticsInstance. */ resourceAnalyticsInstanceId: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the MonitoredRegion was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the MonitoredRegion was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetResourceAnalyticsResourceAnalyticsInstanceAdwAdminPassword { password: string; passwordType: string; secretId: string; } interface GetResourceAnalyticsResourceAnalyticsInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetResourceAnalyticsResourceAnalyticsInstancesResourceAnalyticsInstanceCollection { items: outputs.oci.GetResourceAnalyticsResourceAnalyticsInstancesResourceAnalyticsInstanceCollectionItem[]; } interface GetResourceAnalyticsResourceAnalyticsInstancesResourceAnalyticsInstanceCollectionItem { adwAdminPasswords: outputs.oci.GetResourceAnalyticsResourceAnalyticsInstancesResourceAnalyticsInstanceCollectionItemAdwAdminPassword[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the created ADW instance. */ adwId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; computeCount: number; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A description of the ResourceAnalyticsInstance instance. */ description: string; /** * A filter to return only resources that match the given display name exactly. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ResourceAnalyticsInstance. */ id: string; isMutualTlsRequired: boolean; licenseModel: string; /** * A message that describes the current state of the ResourceAnalyticsInstance in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; nsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OAC enabled for the ResourceAnalyticsInstance. */ oacId: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; subnetId: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the ResourceAnalyticsInstance was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the ResourceAnalyticsInstance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetResourceAnalyticsResourceAnalyticsInstancesResourceAnalyticsInstanceCollectionItemAdwAdminPassword { password: string; passwordType: string; secretId: string; } interface GetResourceAnalyticsTenancyAttachmentMonitoredRegion { /** * Data population status for a monitored region in the tenancy. */ dataPopulations: outputs.oci.GetResourceAnalyticsTenancyAttachmentMonitoredRegionDataPopulation[]; /** * The [Region Identifier](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) of the monitored region. E.g. us-ashburn-1 */ regionId: string; } interface GetResourceAnalyticsTenancyAttachmentMonitoredRegionDataPopulation { /** * The number of data population tasks currently in progress. */ inProgressCount: number; /** * The overall status of the data population from the monitored region of the tenancy. */ status: string; /** * The number of data population tasks that have succeeded. */ succeededCount: number; /** * The date and time the data population task completed, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeEnded: string; /** * The date and time the data population task was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeStarted: string; /** * The total number of data population tasks. */ totalCount: number; } interface GetResourceAnalyticsTenancyAttachmentsFilter { name: string; regex?: boolean; values: string[]; } interface GetResourceAnalyticsTenancyAttachmentsTenancyAttachmentCollection { items: outputs.oci.GetResourceAnalyticsTenancyAttachmentsTenancyAttachmentCollectionItem[]; } interface GetResourceAnalyticsTenancyAttachmentsTenancyAttachmentCollectionItem { /** * The overall status of the data population from the tenancy. */ dataPopulationStatus: string; /** * A description of the tenancy. */ description: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the TenancyAttachment. */ id: string; /** * Whether the tenancy is the tenancy used when creating Resource Analytics Instance. */ isReportingTenancy: boolean; /** * A message that describes the current state of the TenancyAttachment in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * List of monitored regions with their data population status. */ monitoredRegions: outputs.oci.GetResourceAnalyticsTenancyAttachmentsTenancyAttachmentCollectionItemMonitoredRegion[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a ResourceAnalyticsInstance. */ resourceAnalyticsInstanceId: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenancy associated with this TenancyAttachment. */ tenancyId: string; /** * The date and time the TenancyAttachment was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the data population tasks completed, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeDataPopulationEnded: string; /** * The date and time the data population tasks started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeDataPopulationStarted: string; /** * The date and time the TenancyAttachment was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetResourceAnalyticsTenancyAttachmentsTenancyAttachmentCollectionItemMonitoredRegion { /** * Data population status for a monitored region in the tenancy. */ dataPopulations: outputs.oci.GetResourceAnalyticsTenancyAttachmentsTenancyAttachmentCollectionItemMonitoredRegionDataPopulation[]; /** * The [Region Identifier](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) of the monitored region. E.g. us-ashburn-1 */ regionId: string; } interface GetResourceAnalyticsTenancyAttachmentsTenancyAttachmentCollectionItemMonitoredRegionDataPopulation { /** * The number of data population tasks currently in progress. */ inProgressCount: number; /** * The overall status of the data population from the monitored region of the tenancy. */ status: string; /** * The number of data population tasks that have succeeded. */ succeededCount: number; /** * The date and time the data population task completed, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeEnded: string; /** * The date and time the data population task was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeStarted: string; /** * The total number of data population tasks. */ totalCount: number; } interface GetResourceSearchResult { additionalDetails: { [key: string]: string; }; availabilityDomain: string; compartmentId: string; definedTags: { [key: string]: string; }; displayName: string; freeformTags: { [key: string]: string; }; identifier: string; resourceType: string; state: string; systemTags: { [key: string]: string; }; timeCreated: string; } interface GetSelfPartnerSubscriptionsFilter { name: string; regex?: boolean; values: string[]; } interface GetSelfPartnerSubscriptionsListingSubscriptionsCollection { /** * List of subscriptions for particular listing. */ items: outputs.oci.GetSelfPartnerSubscriptionsListingSubscriptionsCollectionItem[]; } interface GetSelfPartnerSubscriptionsListingSubscriptionsCollectionItem { /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * A message that describes the current state of the Subscription in more detail. For example, can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * The unique identifier of marketplace listing in Oracle Cloud Infrastructure. */ productId: string; /** * The current state of the Subscription. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the Subscription was ended, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeEnded: string; /** * The date and time the Subscription was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeStarted: string; } interface GetSelfSubscriptionAdditionalDetail { /** * Additional attribute for extendedMetadata. */ key: string; /** * It contains the value of above key. */ value: string; } interface GetSelfSubscriptionSubscriptionDetail { /** * Tha amount for the currency type. */ amount: number; /** * Sku details for billing subscription. */ billingDetails: outputs.oci.GetSelfSubscriptionSubscriptionDetailBillingDetail[]; /** * The currency supported, in the format specified by ISO-4217 */ currency: string; /** * Whether subscription should be auto-renewed at the end of cycle. */ isAutoRenew: boolean; /** * The activation link given by the partner. */ partnerRegistrationUrl: string; /** * A pricing plan details provided by the Publisher. */ pricingPlans: outputs.oci.GetSelfSubscriptionSubscriptionDetailPricingPlan[]; } interface GetSelfSubscriptionSubscriptionDetailBillingDetail { /** * Whether this sku is assign to gov product. */ hasGovSku: boolean; /** * The meters associated with sku. */ meters: outputs.oci.GetSelfSubscriptionSubscriptionDetailBillingDetailMeter[]; /** * The part's metric. */ metricType: string; /** * Tha rate of this sku meter. */ rateAllocation: number; /** * Sku for service. */ sku: string; } interface GetSelfSubscriptionSubscriptionDetailBillingDetailMeter { /** * Additional data give by sku. */ extendedMetadatas: outputs.oci.GetSelfSubscriptionSubscriptionDetailBillingDetailMeterExtendedMetadata[]; /** * Name of meter. */ name: string; /** * Tha rate of this sku meter. */ rateAllocation: number; } interface GetSelfSubscriptionSubscriptionDetailBillingDetailMeterExtendedMetadata { /** * Additional attribute for extendedMetadata. */ key: string; /** * It contains the value of above key. */ value: string; } interface GetSelfSubscriptionSubscriptionDetailPricingPlan { /** * Specifies the interval at which billing occurs for the subscription plan. */ billingFrequency: string; /** * A detailed explanation of the subscription plan. */ planDescription: string; /** * Specifies the interval at which billing occurs for the subscription plan. */ planDuration: string; /** * The name of the subscription plan used to identify the plan. */ planName: string; /** * The type of the subscription plan. */ planType: string; /** * The pricing details of the subscription plan in various supported currencies. */ rates: outputs.oci.GetSelfSubscriptionSubscriptionDetailPricingPlanRate[]; } interface GetSelfSubscriptionSubscriptionDetailPricingPlanRate { /** * The currency supported, in the format specified by ISO-4217 */ currency: string; /** * The amount charged for the plan in the specified currency. */ rate: number; } interface GetSelfSubscriptionsFilter { /** * Name of meter. */ name: string; regex?: boolean; values: string[]; } interface GetSelfSubscriptionsSubscriptionCollection { items: outputs.oci.GetSelfSubscriptionsSubscriptionCollectionItem[]; } interface GetSelfSubscriptionsSubscriptionCollectionItem { /** * Additional details that are specific for this subscription such as activation details. */ additionalDetails: outputs.oci.GetSelfSubscriptionsSubscriptionCollectionItemAdditionalDetail[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. */ compartmentId: string; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * A filter to return only resources that match the given name. */ displayName: string; /** * 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Subscription. */ id: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ lifecycleDetails: string; /** * The unique OCID of the product, effectively functioning as the listing ID. */ productId: string; /** * The realm from where customer is buying the subscription. */ realm: string; /** * The region from where customer is buying the subscription. */ region: string; /** * The OCID that identifies the seller within the platform. */ sellerId: string; /** * The type of seller in SELF Service. */ sourceType: string; /** * The current lifecycle state of the Subscription. */ state: string; /** * The details of a subscription */ subscriptionDetails: outputs.oci.GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetail[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The unique identifier for the tenant where the subscription was purchased. */ tenantId: string; /** * The date and time the Subscription was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the Subscription was ended, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeEnded: string; /** * The date and time the Subscription was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeStarted: string; /** * The date and time the Subscription was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetSelfSubscriptionsSubscriptionCollectionItemAdditionalDetail { /** * Additional attribute for extendedMetadata. */ key: string; /** * It contains the value of above key. */ value: string; } interface GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetail { /** * Tha amount for the currency type. */ amount: number; /** * Sku details for billing subscription. */ billingDetails: outputs.oci.GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetailBillingDetail[]; /** * The currency supported, in the format specified by ISO-4217 */ currency: string; /** * Whether subscription should be auto-renewed at the end of cycle. */ isAutoRenew: boolean; /** * The activation link given by the partner. */ partnerRegistrationUrl: string; /** * A pricing plan details provided by the Publisher. */ pricingPlans: outputs.oci.GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetailPricingPlan[]; } interface GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetailBillingDetail { /** * Whether this sku is assign to gov product. */ hasGovSku: boolean; /** * The meters associated with sku. */ meters: outputs.oci.GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetailBillingDetailMeter[]; /** * The part's metric. */ metricType: string; /** * Tha rate of this sku meter. */ rateAllocation: number; /** * Sku for service. */ sku: string; } interface GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetailBillingDetailMeter { /** * Additional data give by sku. */ extendedMetadatas: outputs.oci.GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetailBillingDetailMeterExtendedMetadata[]; /** * Name of meter. */ name: string; /** * Tha rate of this sku meter. */ rateAllocation: number; } interface GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetailBillingDetailMeterExtendedMetadata { /** * Additional attribute for extendedMetadata. */ key: string; /** * It contains the value of above key. */ value: string; } interface GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetailPricingPlan { /** * Specifies the interval at which billing occurs for the subscription plan. */ billingFrequency: string; /** * A detailed explanation of the subscription plan. */ planDescription: string; /** * Specifies the interval at which billing occurs for the subscription plan. */ planDuration: string; /** * The name of the subscription plan used to identify the plan. */ planName: string; /** * The type of the subscription plan. */ planType: string; /** * The pricing details of the subscription plan in various supported currencies. */ rates: outputs.oci.GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetailPricingPlanRate[]; } interface GetSelfSubscriptionsSubscriptionCollectionItemSubscriptionDetailPricingPlanRate { /** * The currency supported, in the format specified by ISO-4217 */ currency: string; /** * The amount charged for the plan in the specified currency. */ rate: number; } interface GetWlmsManagedInstanceConfiguration { /** * Frequency of domain discovery to be run on the managed instance. The unit is in hours. */ discoveryInterval: number; /** * The whitelisted paths which domain discovery are run against. */ domainSearchPaths: string[]; } interface GetWlmsManagedInstanceScanResultsFilter { name: string; regex?: boolean; values: string[]; } interface GetWlmsManagedInstanceScanResultsScanResultCollection { /** * List of scan results. */ items: outputs.oci.GetWlmsManagedInstanceScanResultsScanResultCollectionItem[]; } interface GetWlmsManagedInstanceScanResultsScanResultCollectionItem { /** * The name of the check performed. */ serverCheckName: string; /** * The result of the server check. */ serverCheckResult: string; /** * The identifier of the the server check result. */ serverCheckResultId: string; /** * The status of the server check which is OK, FAILURE, or WARNING. */ serverCheckStatus: string; /** * The name of the server. */ serverName: string; /** * The date when the WebLogic server health check is performed (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeOfServerCheck: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WebLogic domain. */ wlsDomainId: string; } interface GetWlmsManagedInstanceServerInstalledPatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetWlmsManagedInstanceServerInstalledPatchesInstalledPatchCollection { /** * List of installed patches per server */ items: outputs.oci.GetWlmsManagedInstanceServerInstalledPatchesInstalledPatchCollectionItem[]; } interface GetWlmsManagedInstanceServerInstalledPatchesInstalledPatchCollectionItem { /** * The description of the WebLogic patch. */ description: string; /** * The name of the WebLogic patch. */ displayName: string; /** * The ID of the WebLogic patch. */ id: string; } interface GetWlmsManagedInstanceServersFilter { /** * The name of the resource. */ name: string; regex?: boolean; values: string[]; } interface GetWlmsManagedInstanceServersServerCollection { items: outputs.oci.GetWlmsManagedInstanceServersServerCollectionItem[]; } interface GetWlmsManagedInstanceServersServerCollectionItem { /** * The name of the server. */ hostName: string; /** * The unique identifier of the server. */ id: string; /** * Whether or not the server is an admin node. */ isAdmin: boolean; /** * The JDK path on the server. */ jdkPath: string; /** * The JDK version on the server. */ jdkVersion: string; /** * Whether or not the server has installed the latest patches. */ latestPatchesStatus: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance. */ managedInstanceId: string; /** * The middleware path on the server. */ middlewarePath: string; /** * The middleware type on the server. */ middlewareType: string; /** * The name of the resource. */ name: string; /** * The patch readiness status of the server. */ patchReadinessStatus: string; /** * The restart order assigned to the server. */ restartOrder: number; /** * The status of the server. */ status: string; /** * The date and time the server was first reported (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the server was last reported (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * The version of the WebLogic domain of the server */ weblogicVersion: string; /** * The ID of the WebLogic domain to which the server belongs. */ wlsDomainId: string; /** * The name of the WebLogic domain to which the server belongs. */ wlsDomainName: string; /** * The path of the WebLogic domain to which the server belongs. */ wlsDomainPath: string; } interface GetWlmsManagedInstancesFilter { name: string; regex?: boolean; values: string[]; } interface GetWlmsManagedInstancesManagedInstanceCollection { items: outputs.oci.GetWlmsManagedInstancesManagedInstanceCollectionItem[]; } interface GetWlmsManagedInstancesManagedInstanceCollectionItem { /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * The configuration for a managed instance. */ configurations: outputs.oci.GetWlmsManagedInstancesManagedInstanceCollectionItemConfiguration[]; /** * The display name. */ displayName: string; /** * The FQDN of the managed instance. */ hostName: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance. */ id: string; /** * The operating system architecture on the managed instance. */ osArch: string; /** * The operating system name on the managed instance. */ osName: string; /** * The plugin status of the managed instance. */ pluginStatus: string; /** * The number of servers running in the managed instance. */ serverCount: number; /** * The date and time the managed instance was first reported (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the managed instance was last report (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; } interface GetWlmsManagedInstancesManagedInstanceCollectionItemConfiguration { /** * Frequency of domain discovery to be run on the managed instance. The unit is in hours. */ discoveryInterval: number; /** * The whitelisted paths which domain discovery are run against. */ domainSearchPaths: string[]; } interface GetWlmsWlsDomainAgreementRecordsAgreementRecordCollection { /** * The agreement signature. */ agreementSignature: string; /** * The ID of the accepted agreement. */ agreementUuid: string; /** * List of agreement records. */ items: outputs.oci.GetWlmsWlsDomainAgreementRecordsAgreementRecordCollectionItem[]; /** * The accepted time for the agreement record. */ timeAccepted: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WebLogic domain. */ wlsDomainId: string; } interface GetWlmsWlsDomainAgreementRecordsAgreementRecordCollectionItem { /** * The agreement signature. */ agreementSignature: string; /** * The ID of the accepted agreement. */ agreementUuid: string; /** * The accepted time for the agreement record. */ timeAccepted: string; } interface GetWlmsWlsDomainAgreementRecordsFilter { name: string; regex?: boolean; values: string[]; } interface GetWlmsWlsDomainApplicablePatchesApplicablePatchCollection { /** * List of patches per WebLogic version and middleware type. */ items: outputs.oci.GetWlmsWlsDomainApplicablePatchesApplicablePatchCollectionItem[]; } interface GetWlmsWlsDomainApplicablePatchesApplicablePatchCollectionItem { /** * The description of the WebLogic patch. */ description: string; /** * The name of the WebLogic patch. */ displayName: string; /** * The ID of the WebLogic patch. */ id: string; /** * The type of middleware for which this patch is applicable. A patch can be applicable to more than one type of middleware. */ middlewareTypes: string[]; /** * The operating system architecture for which the patch can be applied. */ osArch: string; /** * The WebLogic version for this patch. The patch can be installed to domains with this version. */ weblogicVersion: string; } interface GetWlmsWlsDomainApplicablePatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetWlmsWlsDomainConfiguration { /** * Whether to manage the admin server using Node Manager or scripts. */ adminServerControlMode: string; /** * Path to admin server start script. */ adminServerStartScriptPath: string; /** * Path to admin server stop script. */ adminServerStopScriptPath: string; /** * Whether or not the WebLogic domain is enabled for patching. */ isPatchEnabled: boolean; /** * Whether or not to rollback on failure during patching of WebLogic domain. */ isRollbackOnFailure: boolean; /** * Whether to manage the managed server using Node Manager or scripts. */ managedServerControlMode: string; /** * Path to managed server start script. */ managedServerStartScriptPath: string; /** * Path to managed server stop script. */ managedServerStopScriptPath: string; /** * Servers shutdown timeout. */ serversShutdownTimeout: number; } interface GetWlmsWlsDomainScanResultsFilter { name: string; regex?: boolean; values: string[]; } interface GetWlmsWlsDomainScanResultsScanResultCollection { /** * List of scan results. */ items: outputs.oci.GetWlmsWlsDomainScanResultsScanResultCollectionItem[]; } interface GetWlmsWlsDomainScanResultsScanResultCollectionItem { /** * The name of the check performed. */ serverCheckName: string; /** * The result of the server check. */ serverCheckResult: string; /** * The identifier of the the server check result. */ serverCheckResultId: string; /** * The status of the server check which is OK, FAILURE, or WARNING. */ serverCheckStatus: string; /** * The name of the server. */ serverName: string; /** * The date when the WebLogic server health check is performed (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeOfServerCheck: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WebLogic domain. */ wlsDomainId: string; } interface GetWlmsWlsDomainServerBackupContentMiddleware { /** * The list of patches installed in the middleware included in the backup. */ patches: outputs.oci.GetWlmsWlsDomainServerBackupContentMiddlewarePatch[]; /** * The version of the middleware binaries included in the backup. */ version: string; } interface GetWlmsWlsDomainServerBackupContentMiddlewarePatch { /** * The description of the WebLogic patch. */ description: string; /** * The display name of the WebLogic patch. */ displayName: string; /** * The ID of the WebLogic patch. */ id: string; } interface GetWlmsWlsDomainServerBackupsBackupCollection { items: outputs.oci.GetWlmsWlsDomainServerBackupsBackupCollectionItem[]; } interface GetWlmsWlsDomainServerBackupsBackupCollectionItem { /** * The location of the backup. For backups of type LOCAL_FILE this is the absolute path of the backup file. */ backupLocation: string; /** * The type of content of the backup. */ contentType: string; /** * The unique identifier of the backup. */ id: string; /** * The managed instance ID of the server for which the backup was created. */ managedInstanceId: string; /** * The date and time when the backup was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The type of the backup. */ type: string; } interface GetWlmsWlsDomainServerBackupsFilter { name: string; regex?: boolean; values: string[]; } interface GetWlmsWlsDomainServerInstalledPatchesFilter { name: string; regex?: boolean; values: string[]; } interface GetWlmsWlsDomainServerInstalledPatchesInstalledPatchCollection { /** * List of installed patches per server */ items: outputs.oci.GetWlmsWlsDomainServerInstalledPatchesInstalledPatchCollectionItem[]; } interface GetWlmsWlsDomainServerInstalledPatchesInstalledPatchCollectionItem { /** * The description of the WebLogic patch. */ description: string; /** * The name of the WebLogic patch. */ displayName: string; /** * The ID of the WebLogic patch. */ id: string; } interface GetWlmsWlsDomainServersFilter { /** * The name of the resource. */ name: string; regex?: boolean; values: string[]; } interface GetWlmsWlsDomainServersServerCollection { items: outputs.oci.GetWlmsWlsDomainServersServerCollectionItem[]; } interface GetWlmsWlsDomainServersServerCollectionItem { /** * The name of the server. */ hostName: string; /** * The unique identifier of the server. */ id: string; /** * Whether or not the server is an admin node. */ isAdmin: boolean; /** * The JDK path on the server. */ jdkPath: string; /** * The JDK version on the server. */ jdkVersion: string; /** * Whether or not the server has installed the latest patches. */ latestPatchesStatus: string; /** * The managed instance ID of the server. */ managedInstanceId: string; /** * The middleware path on the server. */ middlewarePath: string; /** * The middleware type on the server. */ middlewareType: string; /** * The name of the resource. */ name: string; /** * The patch readiness status of the server. */ patchReadinessStatus: string; /** * The restart order assigned to the server. */ restartOrder: number; /** * The status of the server. */ status: string; /** * The date and time the server was first reported (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the server was last reported (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * The version of the WebLogic domain of the server */ weblogicVersion: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WebLogic domain. */ wlsDomainId: string; /** * The name of the WebLogic domain to which the server belongs. */ wlsDomainName: string; /** * The path of the WebLogic domain to which the server belongs. */ wlsDomainPath: string; } interface GetWlmsWlsDomainsFilter { name: string; regex?: boolean; values: string[]; } interface GetWlmsWlsDomainsWlsDomainCollection { items: outputs.oci.GetWlmsWlsDomainsWlsDomainCollectionItem[]; } interface GetWlmsWlsDomainsWlsDomainCollectionItem { /** * The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. */ compartmentId: string; /** * The WebLogic domain configuration. */ configurations: outputs.oci.GetWlmsWlsDomainsWlsDomainCollectionItemConfiguration[]; /** * 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"}` */ definedTags: { [key: string]: string; }; /** * The display name. */ displayName: string; /** * Free-form tags for this resource. Each tag is a 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"}` */ freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WebLogic domain. */ id: string; /** * Whether or not the terms of use agreement has been accepted for the WebLogic domain. */ isAcceptedTermsAndConditions: boolean; /** * A message that describes the current state of the WebLogic domain in more detail. For example, it can be used to provide actionable information for a resource in the Failed state. */ lifecycleDetails: string; /** * A filter to return WebLogic domains based on the type of middleware of the WebLogic domain. */ middlewareType: string; /** * A filter to return domains based on the patch readiness status. */ patchReadinessStatus: string; /** * A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. */ state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags: { [key: string]: string; }; /** * The date and time the WebLogic domain was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * The date and time the WebLogic domain was updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). Example: `2016-08-25T21:10:29.600Z` */ timeUpdated: string; /** * A filter to return WebLogic domains based on the WebLogic version. */ weblogicVersion: string; } interface GetWlmsWlsDomainsWlsDomainCollectionItemConfiguration { /** * Whether to manage the admin server using Node Manager or scripts. */ adminServerControlMode: string; /** * Path to admin server start script. */ adminServerStartScriptPath: string; /** * Path to admin server stop script. */ adminServerStopScriptPath: string; /** * Whether or not the WebLogic domain is enabled for patching. */ isPatchEnabled: boolean; /** * Whether or not to rollback on failure during patching of WebLogic domain. */ isRollbackOnFailure: boolean; /** * Whether to manage the managed server using Node Manager or scripts. */ managedServerControlMode: string; /** * Path to managed server start script. */ managedServerStartScriptPath: string; /** * Path to managed server stop script. */ managedServerStopScriptPath: string; /** * Servers shutdown timeout. */ serversShutdownTimeout: number; } interface IotDigitalTwinAdapterInboundEnvelope { /** * (Updatable) Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions. */ envelopeMapping: outputs.oci.IotDigitalTwinAdapterInboundEnvelopeEnvelopeMapping; /** * (Updatable) The device endpoint. */ referenceEndpoint: string; /** * (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the `dataFormat` property. */ referencePayload: outputs.oci.IotDigitalTwinAdapterInboundEnvelopeReferencePayload; } interface IotDigitalTwinAdapterInboundEnvelopeEnvelopeMapping { /** * (Updatable) JSON Path string to override the context root before delegating to the adapter of the target digital twin instance. */ contentRoot: string; /** * (Updatable) Optional. JQ expression to map the target resource, which is externalKey of digital twin instance, the incoming data belongs to. */ target: string; /** * (Updatable) JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using `timeReceived` as the timestamp. Example: For payload `{"time": "","temp": 65,"hum": 55}` 'timeObserved' can be mapped as [JQ Expression](https://jqplay.org/) `$.time`. */ timeObserved: string; } interface IotDigitalTwinAdapterInboundEnvelopeReferencePayload { /** * (Updatable) JSON raw data. */ data: { [key: string]: string; }; /** * (Updatable) Data format of the payload. */ dataFormat: string; } interface IotDigitalTwinAdapterInboundRoute { /** * (Updatable) A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the `payloadMapping`. */ condition: string; /** * (Updatable) Meaningful write up about the inbound route. */ description: string; /** * (Updatable) A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema. * * The keys are target fields (in the digital twin model), and values are JQ expressions pointing to data in the reference payload. * * Example: Given payload: { "time": "", "temp": 65, "hum": 55 } And mapping: { "temperature": "$.temp", "humidity": "$.hum", "timeObserved": "$.time" } The output will be: { "temperature": 65, "humidity": 55, "timeObserved": "" } */ payloadMapping: { [key: string]: string; }; /** * (Updatable) Reference payload structure template received from IoT device. This payload must specify its content type using the `dataFormat` property. */ referencePayload: outputs.oci.IotDigitalTwinAdapterInboundRouteReferencePayload; } interface IotDigitalTwinAdapterInboundRouteReferencePayload { /** * (Updatable) JSON raw data. */ data: { [key: string]: string; }; /** * (Updatable) Data format of the payload. */ dataFormat: string; } interface IotIotDomainDataRetentionPeriodsInDay { /** * Number of days for which any normalized data sent to IoT devices would be retained for. */ historizedData: number; /** * Number of days for which any raw command data sent to IoT devices would be retained for. */ rawCommandData: number; /** * Number of days for which any raw data sent to IoT devices would be retained for. */ rawData: number; /** * Number of days for which any data sent to IoT devices would be retained for. */ rejectedData: number; } interface ManagedKafkaKafkaClusterAccessSubnet { /** * (Updatable) Subnets OCIDs */ subnets: string[]; } interface ManagedKafkaKafkaClusterBrokerShape { /** * (Updatable) Number of Kafka broker nodes */ nodeCount: number; /** * (Updatable) Node shape for broker is passed as part of cluster creation, similar to VM.Standard.A1.Flex */ nodeShape: string; /** * (Updatable) Number of OCPUs per nodes */ ocpuCount: number; /** * (Updatable) Size of the storage per nodes. */ storageSizeInGbs: number; } interface ManagedKafkaKafkaClusterConfigLatestConfig { /** * (Updatable) ID cluster configuration */ configId: string; /** * (Updatable) Cluster configuration key-value pairs */ properties: { [key: string]: string; }; /** * (Updatable) The date and time the KafkaClusterConfigVersion was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeCreated: string; /** * (Updatable) Version of the cluster configuration * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ versionNumber: number; } interface ManagedKafkaKafkaClusterKafkaBootstrapUrl { /** * Name of the Kafka listener providing this bootstrap URL */ name: string; /** * Bootstrap URL */ url: string; } interface ResourceAnalyticsResourceAnalyticsInstanceAdwAdminPassword { /** * Password for the ADW to be created in User Tenancy. The password must be between 12 and 30 characters long, and must contain at least 1 uppercase, 1 lowercase, and 1 numeric character. It cannot contain the double quote symbol (") or the username "admin", regardless of casing. */ password: string; /** * Password type */ passwordType: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the vault secret to use as the ADW admin password. */ secretId: string; } interface ResourceAnalyticsResourceAnalyticsInstanceOacManagementAttachmentDetails { /** * The capacity model to use for the Analytics Instance. */ capacityType: string; /** * 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 Analytics Instance. */ capacityValue: number; /** * IDCS domain [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) identifying a stripe and service administrator user. */ idcsDomainId: string; /** * The Oracle license model that applies to the OAC instance. */ licenseModel: string; /** * Details required when provisioning OAC on a private network. Example: `{"subnetId":"ocid...", ...}` */ networkDetails: outputs.oci.ResourceAnalyticsResourceAnalyticsInstanceOacManagementAttachmentDetailsNetworkDetails; /** * List of Network Security Group [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)'s for the private network details. Example: `["ocid...", "ocid..."]` */ nsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet for the private network details. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ subnetId: string; } interface ResourceAnalyticsResourceAnalyticsInstanceOacManagementAttachmentDetailsNetworkDetails { /** * List of Network Security Group [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)'s for the private network details. Example: `["ocid...", "ocid..."]` */ nsgIds: string[]; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet for the private network details. * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ subnetId: string; } interface ResourceAnalyticsTenancyAttachmentMonitoredRegion { /** * Data population status for a monitored region in the tenancy. */ dataPopulations: outputs.oci.ResourceAnalyticsTenancyAttachmentMonitoredRegionDataPopulation[]; /** * The [Region Identifier](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm) of the monitored region. E.g. us-ashburn-1 */ regionId: string; } interface ResourceAnalyticsTenancyAttachmentMonitoredRegionDataPopulation { /** * The number of data population tasks currently in progress. */ inProgressCount: number; /** * The overall status of the data population from the monitored region of the tenancy. */ status: string; /** * The number of data population tasks that have succeeded. */ succeededCount: number; /** * The date and time the data population task completed, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeEnded: string; /** * The date and time the data population task was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` */ timeStarted: string; /** * The total number of data population tasks. */ totalCount: number; } interface SelfSubscriptionAdditionalDetail { /** * Additional attribute for extendedMetadata. */ key: string; /** * It contains the value of above key. */ value: string; } interface SelfSubscriptionSubscriptionDetails { /** * Tha amount for the currency type. */ amount: number; /** * Sku details for billing subscription. */ billingDetails: outputs.oci.SelfSubscriptionSubscriptionDetailsBillingDetails; /** * The currency supported, in the format specified by ISO-4217 */ currency: string; /** * Whether subscription should be auto-renewed at the end of cycle. */ isAutoRenew: boolean; /** * The activation link given by the partner. */ partnerRegistrationUrl: string; /** * A pricing plan details provided by the Publisher. */ pricingPlan: outputs.oci.SelfSubscriptionSubscriptionDetailsPricingPlan; } interface SelfSubscriptionSubscriptionDetailsBillingDetails { /** * Whether this sku is assign to gov product. */ hasGovSku: boolean; /** * The meters associated with sku. */ meters: outputs.oci.SelfSubscriptionSubscriptionDetailsBillingDetailsMeter[]; /** * The part's metric. */ metricType: string; /** * Tha rate of this sku meter. */ rateAllocation: number; /** * Sku for service. */ sku: string; } interface SelfSubscriptionSubscriptionDetailsBillingDetailsMeter { /** * Additional data give by sku. */ extendedMetadatas: outputs.oci.SelfSubscriptionSubscriptionDetailsBillingDetailsMeterExtendedMetadata[]; /** * Name of meter. */ name: string; /** * Tha rate of this sku meter. */ rateAllocation: number; } interface SelfSubscriptionSubscriptionDetailsBillingDetailsMeterExtendedMetadata { /** * Additional attribute for extendedMetadata. */ key: string; /** * It contains the value of above key. */ value: string; } interface SelfSubscriptionSubscriptionDetailsPricingPlan { /** * Specifies the interval at which billing occurs for the subscription plan. */ billingFrequency: string; /** * A detailed explanation of the subscription plan. */ planDescription: string; /** * Specifies the interval at which billing occurs for the subscription plan. */ planDuration: string; /** * The name of the subscription plan used to identify the plan. */ planName: string; /** * The type of the subscription plan. */ planType: string; /** * The pricing details of the subscription plan in various supported currencies. */ rates: outputs.oci.SelfSubscriptionSubscriptionDetailsPricingPlanRate[]; } interface SelfSubscriptionSubscriptionDetailsPricingPlanRate { /** * The currency supported, in the format specified by ISO-4217 */ currency: string; /** * The amount charged for the plan in the specified currency. */ rate: number; } } //# sourceMappingURL=output.d.ts.map